@sp-api-sdk/vendor-orders-api-v1 1.6.15

package/dist/types/src/api-model/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 { RequestArgs } from "./base";
+import { AxiosInstance } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration | undefined) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration | undefined) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;

package/dist/types/src/api-model/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/types/src/api-model/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/src/api-model/models/acknowledgement-status-details.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 { ItemQuantity } from './item-quantity';
+/**
+ * Details of item quantity ordered
+ * @export
+ * @interface AcknowledgementStatusDetails
+ */
+export interface AcknowledgementStatusDetails {
+    /**
+     * The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.
+     * @type {string}
+     * @memberof AcknowledgementStatusDetails
+     */
+    acknowledgementDate?: string;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof AcknowledgementStatusDetails
+     */
+    acceptedQuantity?: ItemQuantity;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof AcknowledgementStatusDetails
+     */
+    rejectedQuantity?: ItemQuantity;
+}

package/dist/types/src/api-model/models/address.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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.
+ */
+/**
+ * Address of the party.
+ * @export
+ * @interface Address
+ */
+export interface Address {
+    /**
+     * The name of the person, business or institution at that address.
+     * @type {string}
+     * @memberof Address
+     */
+    name: string;
+    /**
+     * First line of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    addressLine1: string;
+    /**
+     * Additional address information, if required.
+     * @type {string}
+     * @memberof Address
+     */
+    addressLine2?: string;
+    /**
+     * Additional address information, if required.
+     * @type {string}
+     * @memberof Address
+     */
+    addressLine3?: string;
+    /**
+     * The city where the person, business or institution is located.
+     * @type {string}
+     * @memberof Address
+     */
+    city?: string;
+    /**
+     * The county where person, business or institution is located.
+     * @type {string}
+     * @memberof Address
+     */
+    county?: string;
+    /**
+     * The district where person, business or institution is located.
+     * @type {string}
+     * @memberof Address
+     */
+    district?: string;
+    /**
+     * The state or region where person, business or institution is located.
+     * @type {string}
+     * @memberof Address
+     */
+    stateOrRegion?: string;
+    /**
+     * The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
+     * @type {string}
+     * @memberof Address
+     */
+    postalCode?: string;
+    /**
+     * The two digit country code. In ISO 3166-1 alpha-2 format.
+     * @type {string}
+     * @memberof Address
+     */
+    countryCode: string;
+    /**
+     * The phone number of the person, business or institution located at that address.
+     * @type {string}
+     * @memberof Address
+     */
+    phone?: string;
+}

package/dist/types/src/api-model/models/get-purchase-order-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 { Order } from './order';
+/**
+ * The response schema for the getPurchaseOrder operation.
+ * @export
+ * @interface GetPurchaseOrderResponse
+ */
+export interface GetPurchaseOrderResponse {
+    /**
+     *
+     * @type {Order}
+     * @memberof GetPurchaseOrderResponse
+     */
+    payload?: Order;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof GetPurchaseOrderResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/get-purchase-orders-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 { OrderList } from './order-list';
+/**
+ * The response schema for the getPurchaseOrders operation.
+ * @export
+ * @interface GetPurchaseOrdersResponse
+ */
+export interface GetPurchaseOrdersResponse {
+    /**
+     *
+     * @type {OrderList}
+     * @memberof GetPurchaseOrdersResponse
+     */
+    payload?: OrderList;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof GetPurchaseOrdersResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/get-purchase-orders-status-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 { OrderListStatus } from './order-list-status';
+/**
+ * The response schema for the getPurchaseOrdersStatus operation.
+ * @export
+ * @interface GetPurchaseOrdersStatusResponse
+ */
+export interface GetPurchaseOrdersStatusResponse {
+    /**
+     *
+     * @type {OrderListStatus}
+     * @memberof GetPurchaseOrdersStatusResponse
+     */
+    payload?: OrderListStatus;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof GetPurchaseOrdersStatusResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/import-details.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Selling Partner API for Retail Procurement Orders
+ * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
+ *
+ * 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 details for an import order.
+ * @export
+ * @interface ImportDetails
+ */
+export interface ImportDetails {
+    /**
+     * If the recipient requests, contains the shipment method of payment. This is for import PO\'s only.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    methodOfPayment?: ImportDetailsMethodOfPaymentEnum;
+    /**
+     * Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    internationalCommercialTerms?: ImportDetailsInternationalCommercialTermsEnum;
+    /**
+     * The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    portOfDelivery?: string;
+    /**
+     * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40\'(40-foot container), 40\'HC (40-foot high-capacity container), 45\', 45\'HC, 30\', 30\'HC, 20\', 20\'HC.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    importContainers?: string;
+    /**
+     * Special instructions regarding the shipment. This field is for import purchase orders.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    shippingInstructions?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ImportDetailsMethodOfPaymentEnum {
+    PaidByBuyer = "PaidByBuyer",
+    CollectOnDelivery = "CollectOnDelivery",
+    DefinedByBuyerAndSeller = "DefinedByBuyerAndSeller",
+    FobPortOfCall = "FOBPortOfCall",
+    PrepaidBySeller = "PrepaidBySeller",
+    PaidBySeller = "PaidBySeller"
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ImportDetailsInternationalCommercialTermsEnum {
+    ExWorks = "ExWorks",
+    FreeCarrier = "FreeCarrier",
+    FreeOnBoard = "FreeOnBoard",
+    FreeAlongSideShip = "FreeAlongSideShip",
+    CarriagePaidTo = "CarriagePaidTo",
+    CostAndFreight = "CostAndFreight",
+    CarriageAndInsurancePaidTo = "CarriageAndInsurancePaidTo",
+    CostInsuranceAndFreight = "CostInsuranceAndFreight",
+    DeliveredAtTerminal = "DeliveredAtTerminal",
+    DeliveredAtPlace = "DeliveredAtPlace",
+    DeliverDutyPaid = "DeliverDutyPaid"
+}