Class VendorDirectFulfillmentSandboxTestDataApiClient

VendorDFSandboxApi - object-oriented interface

Export

VendorDFSandboxApi

Hierarchy (View Summary)

VendorDFSandboxApi
- VendorDirectFulfillmentSandboxTestDataApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

generateOrderScenarios getOrderScenarios

Constructors

constructor

new VendorDirectFulfillmentSandboxTestDataApiClient(
configuration: ClientConfiguration,
): VendorDirectFulfillmentSandboxTestDataApiClient
Parameters
- configuration: ClientConfiguration
Returns VendorDirectFulfillmentSandboxTestDataApiClient
Overrides VendorDFSandboxApi.constructor
- Defined in client.ts:8

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

generateOrderScenarios

generateOrderScenarios(
requestParameters: VendorDFSandboxApiGenerateOrderScenariosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionReference, any>>
Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
Parameters
- requestParameters: VendorDFSandboxApiGenerateOrderScenariosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionReference, any>>
Throws
Memberof
VendorDFSandboxApi
Inherited from VendorDFSandboxApi.generateOrderScenarios
- Defined in api-model/api/vendor-dfsandbox-api.ts:213

getOrderScenarios

getOrderScenarios(
requestParameters: VendorDFSandboxApiGetOrderScenariosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TransactionStatus, any>>
Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.
Parameters
- requestParameters: VendorDFSandboxApiGetOrderScenariosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TransactionStatus, any>>
Throws
Memberof
VendorDFSandboxApi
Inherited from VendorDFSandboxApi.getOrderScenarios
- Defined in api-model/api/vendor-dfsandbox-api.ts:224