/** * Selling Partner API for Retail Procurement Transaction Status * The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * The response schema for the getTransaction operation. * @export * @interface GetTransactionResponse */ export interface GetTransactionResponse { /** * * @type {TransactionStatus} * @memberof GetTransactionResponse */ payload?: TransactionStatus; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetTransactionResponse */ errors?: Array; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The transaction status. * @export * @interface Transaction */ export interface Transaction { /** * The unique identifier returned in the \'transactionId\' field in response to the post request of a specific transaction. * @type {string} * @memberof Transaction */ transactionId: string; /** * Current processing status of the transaction. * @type {string} * @memberof Transaction */ status: TransactionStatusEnum | 'Failure' | 'Processing' | 'Success'; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof Transaction */ errors?: Array; } /** * @export * @enum {string} */ export declare enum TransactionStatusEnum { Failure = "Failure", Processing = "Processing", Success = "Success" } /** * Represents the status of a transaction. * @export * @interface TransactionStatus */ export interface TransactionStatus { /** * * @type {Transaction} * @memberof TransactionStatus */ transactionStatus?: Transaction; } /** * VendorTransactionApi - axios parameter creator * @export */ export declare const VendorTransactionApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransaction: (transactionId: string, options?: any) => Promise; }; /** * VendorTransactionApi - functional programming interface * @export */ export declare const VendorTransactionApiFp: (configuration?: Configuration) => { /** * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransaction(transactionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VendorTransactionApi - factory interface * @export */ export declare const VendorTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransaction(transactionId: string, options?: any): AxiosPromise; }; /** * Request parameters for getTransaction operation in VendorTransactionApi. * @export * @interface VendorTransactionApiGetTransactionRequest */ export interface VendorTransactionApiGetTransactionRequest { /** * The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @type {string} * @memberof VendorTransactionApiGetTransaction */ readonly transactionId: string; } /** * VendorTransactionApi - object-oriented interface * @export * @class VendorTransactionApi * @extends {BaseAPI} */ export declare class VendorTransactionApi extends BaseAPI { /** * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorTransactionApiGetTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorTransactionApi */ getTransaction(requestParameters: VendorTransactionApiGetTransactionRequest, options?: any): Promise>; }