Class SupplySourcesApiClient

Hierarchy

SupplySourcesApi
- SupplySourcesApiClient

Index

Constructors

constructor

Methods

archiveSupplySource createSupplySource getSupplySource getSupplySources updateSupplySource updateSupplySourceStatus

Constructors

constructor

new SupplySourcesApiClient(
parameters: APIConfigurationParameters,
): SupplySourcesApiClient
Parameters
- parameters: APIConfigurationParameters
Returns SupplySourcesApiClient
Overrides SupplySourcesApi.constructor
- Defined in src/api-clients/supply-sources-api-client.ts:7

Methods

archiveSupplySource

archiveSupplySource(
requestParameters: SupplySourcesApiModelSupplySourcesApiArchiveSupplySourceRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Archive a supply source, making it inactive. Cannot be undone.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiArchiveSupplySourceRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.archiveSupplySource
- Defined in src/api-models/supply-sources-api-model/api.ts:1330

createSupplySource

createSupplySource(
requestParameters: SupplySourcesApiModelSupplySourcesApiCreateSupplySourceRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelCreateSupplySourceResponse>>
Create a new supply source.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiCreateSupplySourceRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelCreateSupplySourceResponse>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.createSupplySource
- Defined in src/api-models/supply-sources-api-model/api.ts:1341

getSupplySource

getSupplySource(
requestParameters: SupplySourcesApiModelSupplySourcesApiGetSupplySourceRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelSupplySource>>
Retrieve a supply source.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiGetSupplySourceRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelSupplySource>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.getSupplySource
- Defined in src/api-models/supply-sources-api-model/api.ts:1352

getSupplySources

getSupplySources(
requestParameters?: SupplySourcesApiModelSupplySourcesApiGetSupplySourcesRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelGetSupplySourcesResponse>>
The path to retrieve paginated supply sources.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiGetSupplySourcesRequest = {}
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelGetSupplySourcesResponse>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.getSupplySources
- Defined in src/api-models/supply-sources-api-model/api.ts:1363

updateSupplySource

updateSupplySource(
requestParameters: SupplySourcesApiModelSupplySourcesApiUpdateSupplySourceRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Update the configuration and capabilities of a supply source.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiUpdateSupplySourceRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.updateSupplySource
- Defined in src/api-models/supply-sources-api-model/api.ts:1374

updateSupplySourceStatus

updateSupplySourceStatus(
requestParameters: SupplySourcesApiModelSupplySourcesApiUpdateSupplySourceStatusRequest,
options?: any,
): Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Update the status of a supply source.
Parameters
- requestParameters: SupplySourcesApiModelSupplySourcesApiUpdateSupplySourceStatusRequest
  Request parameters.
- Optionaloptions: any
  Override http request option.
Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>
Throws
Memberof
SupplySourcesApi
Inherited from SupplySourcesApi.updateSupplySourceStatus
- Defined in src/api-models/supply-sources-api-model/api.ts:1385

Class SupplySourcesApiClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SupplySourcesApiClient

Methods

archiveSupplySource

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>

Throws

Memberof

createSupplySource

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelCreateSupplySourceResponse>>

Throws

Memberof

getSupplySource

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelSupplySource>>

Throws

Memberof

getSupplySources

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelGetSupplySourcesResponse>>

Throws

Memberof

updateSupplySource

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>

Throws

Memberof

updateSupplySourceStatus

Parameters

Returns Promise<AxiosResponse<SupplySourcesApiModelErrorList>>

Throws

Memberof

Settings

On This Page