ClassSupplySourcesApi

SupplySourcesApi - object-oriented interface

Export

SupplySourcesApi

Hierarchy (view full)

BaseAPI
- SupplySourcesApi
  - SupplySourcesApiClient

Index

Constructors

constructor

new SupplySourcesApi(configuration?, basePath?, axios?): SupplySourcesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SupplySourcesApi
Inherited from BaseAPI.constructor
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

archiveSupplySource

archiveSupplySource(requestParameters, options?): Promise<AxiosResponse<ErrorList, any>>
Archive a supply source, making it inactive. Cannot be undone.
Parameters
- requestParameters: SupplySourcesApiArchiveSupplySourceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ErrorList, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:529

createSupplySource

createSupplySource(requestParameters, options?): Promise<AxiosResponse<CreateSupplySourceResponse, any>>
Create a new supply source.
Parameters
- requestParameters: SupplySourcesApiCreateSupplySourceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateSupplySourceResponse, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:540

getSupplySource

getSupplySource(requestParameters, options?): Promise<AxiosResponse<SupplySource, any>>
Retrieve a supply source.
Parameters
- requestParameters: SupplySourcesApiGetSupplySourceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SupplySource, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:551

getSupplySources

getSupplySources(requestParameters?, options?): Promise<AxiosResponse<GetSupplySourcesResponse, any>>
The path to retrieve paginated supply sources.
Parameters
- requestParameters: SupplySourcesApiGetSupplySourcesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetSupplySourcesResponse, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:562

updateSupplySource

updateSupplySource(requestParameters, options?): Promise<AxiosResponse<ErrorList, any>>
Update the configuration and capabilities of a supply source.
Parameters
- requestParameters: SupplySourcesApiUpdateSupplySourceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ErrorList, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:573

updateSupplySourceStatus

updateSupplySourceStatus(requestParameters, options?): Promise<AxiosResponse<ErrorList, any>>
Update the status of a supply source.
Parameters
- requestParameters: SupplySourcesApiUpdateSupplySourceStatusRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ErrorList, any>>
Throws
Memberof
SupplySourcesApi
- Defined in clients/supply-sources-api-2020-07-01/src/api-model/api/supply-sources-api.ts:584

ClassSupplySourcesApi

Export

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SupplySourcesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

archiveSupplySource

Parameters

Returns Promise<AxiosResponse<ErrorList, any>>

Throws

Memberof

createSupplySource

Parameters

Returns Promise<AxiosResponse<CreateSupplySourceResponse, any>>

Throws

Memberof

getSupplySource

Parameters

Returns Promise<AxiosResponse<SupplySource, any>>

Throws

Memberof

getSupplySources

Parameters

Returns Promise<AxiosResponse<GetSupplySourcesResponse, any>>

Throws

Memberof

updateSupplySource

Parameters

Returns Promise<AxiosResponse<ErrorList, any>>

Throws

Memberof

updateSupplySourceStatus

Parameters

Returns Promise<AxiosResponse<ErrorList, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration