@sp-api-sdk/shipping-api-v1 3.1.4 → 3.1.6

package/dist/cjs/api-model/api/shipping-api.js

@@ -25,7 +25,6 @@ const common_1 = require("../common");
 const base_1 = require("../base");
 /**
  * ShippingApi - axios parameter creator
- * @export
  */
 const ShippingApiAxiosParamCreator = function (configuration) {
     return {
@@ -299,7 +298,6 @@ const ShippingApiAxiosParamCreator = function (configuration) {
 exports.ShippingApiAxiosParamCreator = ShippingApiAxiosParamCreator;
 /**
  * ShippingApi - functional programming interface
- * @export
  */
 const ShippingApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ShippingApiAxiosParamCreator)(configuration);
@@ -419,7 +417,6 @@ const ShippingApiFp = function (configuration) {
 exports.ShippingApiFp = ShippingApiFp;
 /**
  * ShippingApi - factory interface
- * @export
  */
 const ShippingApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ShippingApiFp)(configuration);
@@ -509,9 +506,6 @@ const ShippingApiFactory = function (configuration, basePath, axios) {
 exports.ShippingApiFactory = ShippingApiFactory;
 /**
  * ShippingApi - object-oriented interface
- * @export
- * @class ShippingApi
- * @extends {BaseAPI}
  */
 class ShippingApi extends base_1.BaseAPI {
     /**
@@ -519,7 +513,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     cancelShipment(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).cancelShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -529,7 +522,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiCreateShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     createShipment(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).createShipment(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -538,7 +530,6 @@ class ShippingApi extends base_1.BaseAPI {
      * Verify if the current account is valid.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getAccount(options) {
         return (0, exports.ShippingApiFp)(this.configuration).getAccount(options).then((request) => request(this.axios, this.basePath));
@@ -548,7 +539,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getRates(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).getRates(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -558,7 +548,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiGetShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getShipment(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).getShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -568,7 +557,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiGetTrackingInformationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getTrackingInformation(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).getTrackingInformation(requestParameters.trackingId, options).then((request) => request(this.axios, this.basePath));
@@ -578,7 +566,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiPurchaseLabelsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseLabels(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).purchaseLabels(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -588,7 +575,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseShipment(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).purchaseShipment(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -598,7 +584,6 @@ class ShippingApi extends base_1.BaseAPI {
      * @param {ShippingApiRetrieveShippingLabelRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     retrieveShippingLabel(requestParameters, options) {
         return (0, exports.ShippingApiFp)(this.configuration).retrieveShippingLabel(requestParameters.shipmentId, requestParameters.trackingId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));

package/dist/cjs/api-model/base.js

@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     basePath;
     axios;
@@ -49,12 +40,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/dist/cjs/api-model/common.js

@@ -15,15 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
     }
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
     }
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
 exports.setSearchParams = setSearchParams;
-/**
- *
- * @export
- */
 const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/cjs/api-model/configuration.js

@@ -18,49 +18,32 @@ class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/cjs/api-model/models/service-type.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServiceType = void 0;
 /**
  * The type of shipping service that will be used for the service offering.
- * @export
- * @enum {string}
  */
 exports.ServiceType = {
     AmazonShippingGround: 'Amazon Shipping Ground',

package/dist/es/api-model/api/shipping-api.js

@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
 import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
 /**
  * ShippingApi - axios parameter creator
- * @export
  */
 export const ShippingApiAxiosParamCreator = function (configuration) {
     return {
@@ -292,7 +291,6 @@ export const ShippingApiAxiosParamCreator = function (configuration) {
 };
 /**
  * ShippingApi - functional programming interface
- * @export
  */
 export const ShippingApiFp = function (configuration) {
     const localVarAxiosParamCreator = ShippingApiAxiosParamCreator(configuration);
@@ -411,7 +409,6 @@ export const ShippingApiFp = function (configuration) {
 };
 /**
  * ShippingApi - factory interface
- * @export
  */
 export const ShippingApiFactory = function (configuration, basePath, axios) {
     const localVarFp = ShippingApiFp(configuration);
@@ -500,9 +497,6 @@ export const ShippingApiFactory = function (configuration, basePath, axios) {
 };
 /**
  * ShippingApi - object-oriented interface
- * @export
- * @class ShippingApi
- * @extends {BaseAPI}
  */
 export class ShippingApi extends BaseAPI {
     /**
@@ -510,7 +504,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     cancelShipment(requestParameters, options) {
         return ShippingApiFp(this.configuration).cancelShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -520,7 +513,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiCreateShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     createShipment(requestParameters, options) {
         return ShippingApiFp(this.configuration).createShipment(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -529,7 +521,6 @@ export class ShippingApi extends BaseAPI {
      * Verify if the current account is valid.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getAccount(options) {
         return ShippingApiFp(this.configuration).getAccount(options).then((request) => request(this.axios, this.basePath));
@@ -539,7 +530,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getRates(requestParameters, options) {
         return ShippingApiFp(this.configuration).getRates(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -549,7 +539,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getShipment(requestParameters, options) {
         return ShippingApiFp(this.configuration).getShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -559,7 +548,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetTrackingInformationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getTrackingInformation(requestParameters, options) {
         return ShippingApiFp(this.configuration).getTrackingInformation(requestParameters.trackingId, options).then((request) => request(this.axios, this.basePath));
@@ -569,7 +557,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiPurchaseLabelsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseLabels(requestParameters, options) {
         return ShippingApiFp(this.configuration).purchaseLabels(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -579,7 +566,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseShipment(requestParameters, options) {
         return ShippingApiFp(this.configuration).purchaseShipment(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -589,7 +575,6 @@ export class ShippingApi extends BaseAPI {
      * @param {ShippingApiRetrieveShippingLabelRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     retrieveShippingLabel(requestParameters, options) {
         return ShippingApiFp(this.configuration).retrieveShippingLabel(requestParameters.shipmentId, requestParameters.trackingId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));

package/dist/es/api-model/base.js

@@ -13,21 +13,12 @@
  */
 import globalAxios from 'axios';
 export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     basePath;
     axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
     }
 }
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
         this.name = "RequiredError";
     }
 }
-/**
- *
- * @export
- */
 export const operationServerMap = {};

package/dist/es/api-model/common.js

@@ -12,25 +12,16 @@
  * Do not edit the class manually.
  */
 import { RequiredError } from "./base";
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
         throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
     }
 };
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
         object[keyParamName] = localVarApiKeyValue;
     }
 };
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
         object["Authorization"] = "Bearer " + accessToken;
     }
 };
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 export const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
-/**
- *
- * @export
- */
 export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
         ? JSON.stringify(value !== undefined ? value : {})
         : (value || "");
 };
-/**
- *
- * @export
- */
 export const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/es/api-model/configuration.js

@@ -15,49 +15,32 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/es/api-model/models/service-type.js

@@ -13,8 +13,6 @@
  */
 /**
  * The type of shipping service that will be used for the service offering.
- * @export
- * @enum {string}
  */
 export const ServiceType = {
     AmazonShippingGround: 'Amazon Shipping Ground',