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

package/dist/es/src/api-model/models/item.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/location.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/model-error.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/money.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/pallet.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/party-identification.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/route.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/shipment-confirmation.js

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var ShipmentConfirmationShipmentConfirmationTypeEnum;
+(function (ShipmentConfirmationShipmentConfirmationTypeEnum) {
+    ShipmentConfirmationShipmentConfirmationTypeEnum["Original"] = "Original";
+    ShipmentConfirmationShipmentConfirmationTypeEnum["Replace"] = "Replace";
+})(ShipmentConfirmationShipmentConfirmationTypeEnum || (ShipmentConfirmationShipmentConfirmationTypeEnum = {}));
+/**
+    * @export
+    * @enum {string}
+    */
+export var ShipmentConfirmationShipmentTypeEnum;
+(function (ShipmentConfirmationShipmentTypeEnum) {
+    ShipmentConfirmationShipmentTypeEnum["TruckLoad"] = "TruckLoad";
+    ShipmentConfirmationShipmentTypeEnum["LessThanTruckLoad"] = "LessThanTruckLoad";
+    ShipmentConfirmationShipmentTypeEnum["SmallParcel"] = "SmallParcel";
+})(ShipmentConfirmationShipmentTypeEnum || (ShipmentConfirmationShipmentTypeEnum = {}));
+/**
+    * @export
+    * @enum {string}
+    */
+export var ShipmentConfirmationShipmentStructureEnum;
+(function (ShipmentConfirmationShipmentStructureEnum) {
+    ShipmentConfirmationShipmentStructureEnum["PalletizedAssortmentCase"] = "PalletizedAssortmentCase";
+    ShipmentConfirmationShipmentStructureEnum["LooseAssortmentCase"] = "LooseAssortmentCase";
+    ShipmentConfirmationShipmentStructureEnum["PalletOfItems"] = "PalletOfItems";
+    ShipmentConfirmationShipmentStructureEnum["PalletizedStandardCase"] = "PalletizedStandardCase";
+    ShipmentConfirmationShipmentStructureEnum["LooseStandardCase"] = "LooseStandardCase";
+    ShipmentConfirmationShipmentStructureEnum["MasterPallet"] = "MasterPallet";
+    ShipmentConfirmationShipmentStructureEnum["MasterCase"] = "MasterCase";
+})(ShipmentConfirmationShipmentStructureEnum || (ShipmentConfirmationShipmentStructureEnum = {}));

package/dist/es/src/api-model/models/shipment-measurements.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/stop.js

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var StopFunctionCodeEnum;
+(function (StopFunctionCodeEnum) {
+    StopFunctionCodeEnum["PortOfDischarge"] = "PortOfDischarge";
+    StopFunctionCodeEnum["FreightPayableAt"] = "FreightPayableAt";
+    StopFunctionCodeEnum["PortOfLoading"] = "PortOfLoading";
+})(StopFunctionCodeEnum || (StopFunctionCodeEnum = {}));

package/dist/es/src/api-model/models/submit-shipment-confirmations-request.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/submit-shipment-confirmations-response.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/tax-registration-details.js

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var TaxRegistrationDetailsTaxRegistrationTypeEnum;
+(function (TaxRegistrationDetailsTaxRegistrationTypeEnum) {
+    TaxRegistrationDetailsTaxRegistrationTypeEnum["Vat"] = "VAT";
+    TaxRegistrationDetailsTaxRegistrationTypeEnum["Gst"] = "GST";
+})(TaxRegistrationDetailsTaxRegistrationTypeEnum || (TaxRegistrationDetailsTaxRegistrationTypeEnum = {}));

package/dist/es/src/api-model/models/transaction-reference.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+export {};

package/dist/es/src/api-model/models/transportation-details.js

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var TransportationDetailsTransportationModeEnum;
+(function (TransportationDetailsTransportationModeEnum) {
+    TransportationDetailsTransportationModeEnum["Road"] = "Road";
+    TransportationDetailsTransportationModeEnum["Air"] = "Air";
+    TransportationDetailsTransportationModeEnum["Ocean"] = "Ocean";
+})(TransportationDetailsTransportationModeEnum || (TransportationDetailsTransportationModeEnum = {}));

package/dist/es/src/api-model/models/volume.js

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var VolumeUnitOfMeasureEnum;
+(function (VolumeUnitOfMeasureEnum) {
+    VolumeUnitOfMeasureEnum["CuFt"] = "CuFt";
+    VolumeUnitOfMeasureEnum["CuIn"] = "CuIn";
+    VolumeUnitOfMeasureEnum["CuM"] = "CuM";
+    VolumeUnitOfMeasureEnum["CuY"] = "CuY";
+})(VolumeUnitOfMeasureEnum || (VolumeUnitOfMeasureEnum = {}));

package/dist/es/src/api-model/models/weight.js

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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.
+ */
+/**
+    * @export
+    * @enum {string}
+    */
+export var WeightUnitOfMeasureEnum;
+(function (WeightUnitOfMeasureEnum) {
+    WeightUnitOfMeasureEnum["G"] = "G";
+    WeightUnitOfMeasureEnum["Kg"] = "Kg";
+    WeightUnitOfMeasureEnum["Oz"] = "Oz";
+    WeightUnitOfMeasureEnum["Lb"] = "Lb";
+})(WeightUnitOfMeasureEnum || (WeightUnitOfMeasureEnum = {}));

package/dist/es/src/client.js

@@ -0,0 +1,31 @@
+/* eslint-disable prefer-regex-literals */
+import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
+import { Configuration, VendorShippingApi } from './api-model';
+import { VendorShipmentsApiError } from './error';
+export const RATE_LIMITS = [
+    {
+        method: 'post',
+        urlRegex: new RegExp('^/vendor/shipping/v1/shipmentConfirmations$'),
+        rate: 10,
+        burst: 10,
+    },
+];
+export class VendorShipmentsApiClient extends VendorShippingApi {
+    constructor(parameters) {
+        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const { rateLimiting, ...clientParameters } = parameters;
+        const axiosParameters = { ...clientParameters, region };
+        if (rateLimiting?.retry) {
+            axiosParameters.rateLimits = RATE_LIMITS;
+            axiosParameters.onRetry = rateLimiting.onRetry;
+        }
+        const axiosInstance = createAxiosInstance(axiosParameters);
+        const configuration = new Configuration();
+        const environment = parameters.sandbox ? 'sandbox' : 'production';
+        const endpoint = endpoints[environment][region];
+        if (!endpoint) {
+            throw new VendorShipmentsApiError(`Unknown region : ${region}`);
+        }
+        super(configuration, endpoint, axiosInstance);
+    }
+}

package/dist/es/src/error.js

@@ -0,0 +1,6 @@
+export class VendorShipmentsApiError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'VendorShipmentsApiError';
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './src/client';
+export * from './src/error';
+export * from './src/api-model/models';

package/dist/types/src/api-model/api/vendor-shipping-api.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data 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 { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { SubmitShipmentConfirmationsRequest } from '../models';
+import { SubmitShipmentConfirmationsResponse } from '../models';
+/**
+ * VendorShippingApi - axios parameter creator
+ * @export
+ */
+export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Submits one or more shipment confirmations for vendor orders.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+     * @param {SubmitShipmentConfirmationsRequest} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * VendorShippingApi - functional programming interface
+ * @export
+ */
+export declare const VendorShippingApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Submits one or more shipment confirmations for vendor orders.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+     * @param {SubmitShipmentConfirmationsRequest} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
+};
+/**
+ * VendorShippingApi - factory interface
+ * @export
+ */
+export declare const VendorShippingApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Submits one or more shipment confirmations for vendor orders.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+     * @param {SubmitShipmentConfirmationsRequest} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): AxiosPromise<SubmitShipmentConfirmationsResponse>;
+};
+/**
+ * Request parameters for submitShipmentConfirmations operation in VendorShippingApi.
+ * @export
+ * @interface VendorShippingApiSubmitShipmentConfirmationsRequest
+ */
+export interface VendorShippingApiSubmitShipmentConfirmationsRequest {
+    /**
+     *
+     * @type {SubmitShipmentConfirmationsRequest}
+     * @memberof VendorShippingApiSubmitShipmentConfirmations
+     */
+    readonly body: SubmitShipmentConfirmationsRequest;
+}
+/**
+ * VendorShippingApi - object-oriented interface
+ * @export
+ * @class VendorShippingApi
+ * @extends {BaseAPI}
+ */
+export declare class VendorShippingApi extends BaseAPI {
+    /**
+     * Submits one or more shipment confirmations for vendor orders.  **Usage Plans:**  | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable |  The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+     * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VendorShippingApi
+     */
+    submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentConfirmationsResponse>>;
+}