@sp-api-sdk/shipment-invoicing-api-v0 4.0.1 → 4.0.2

package/dist/cjs/api-model/api/shipment-invoicing-api.js

@@ -25,7 +25,6 @@ const common_1 = require("../common");
 const base_1 = require("../base");
 /**
  * ShipmentInvoicingApi - axios parameter creator
- * @export
  */
 const ShipmentInvoicingApiAxiosParamCreator = function (configuration) {
     return {
@@ -123,7 +122,6 @@ const ShipmentInvoicingApiAxiosParamCreator = function (configuration) {
 exports.ShipmentInvoicingApiAxiosParamCreator = ShipmentInvoicingApiAxiosParamCreator;
 /**
  * ShipmentInvoicingApi - functional programming interface
- * @export
  */
 const ShipmentInvoicingApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ShipmentInvoicingApiAxiosParamCreator)(configuration);
@@ -170,7 +168,6 @@ const ShipmentInvoicingApiFp = function (configuration) {
 exports.ShipmentInvoicingApiFp = ShipmentInvoicingApiFp;
 /**
  * ShipmentInvoicingApi - factory interface
- * @export
  */
 const ShipmentInvoicingApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ShipmentInvoicingApiFp)(configuration);
@@ -207,9 +204,6 @@ const ShipmentInvoicingApiFactory = function (configuration, basePath, axios) {
 exports.ShipmentInvoicingApiFactory = ShipmentInvoicingApiFactory;
 /**
  * ShipmentInvoicingApi - object-oriented interface
- * @export
- * @class ShipmentInvoicingApi
- * @extends {BaseAPI}
  */
 class ShipmentInvoicingApi extends base_1.BaseAPI {
     /**
@@ -217,7 +211,6 @@ class ShipmentInvoicingApi extends base_1.BaseAPI {
      * @param {ShipmentInvoicingApiGetInvoiceStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getInvoiceStatus(requestParameters, options) {
         return (0, exports.ShipmentInvoicingApiFp)(this.configuration).getInvoiceStatus(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -227,7 +220,6 @@ class ShipmentInvoicingApi extends base_1.BaseAPI {
      * @param {ShipmentInvoicingApiGetShipmentDetailsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getShipmentDetails(requestParameters, options) {
         return (0, exports.ShipmentInvoicingApiFp)(this.configuration).getShipmentDetails(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -237,7 +229,6 @@ class ShipmentInvoicingApi extends base_1.BaseAPI {
      * @param {ShipmentInvoicingApiSubmitInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     submitInvoice(requestParameters, options) {
         return (0, exports.ShipmentInvoicingApiFp)(this.configuration).submitInvoice(requestParameters.shipmentId, 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 = "http://localhost".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/address-type-enum.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AddressTypeEnum = void 0;
 /**
  * The shipping address type.
- * @export
- * @enum {string}
  */
 exports.AddressTypeEnum = {
     Residential: 'Residential',

package/dist/cjs/api-model/models/shipment-invoice-status.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShipmentInvoiceStatus = void 0;
 /**
  * The shipment invoice status.
- * @export
- * @enum {string}
  */
 exports.ShipmentInvoiceStatus = {
     Processing: 'Processing',

package/dist/es/api-model/api/shipment-invoicing-api.js

@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
 import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
 /**
  * ShipmentInvoicingApi - axios parameter creator
- * @export
  */
 export const ShipmentInvoicingApiAxiosParamCreator = function (configuration) {
     return {
@@ -116,7 +115,6 @@ export const ShipmentInvoicingApiAxiosParamCreator = function (configuration) {
 };
 /**
  * ShipmentInvoicingApi - functional programming interface
- * @export
  */
 export const ShipmentInvoicingApiFp = function (configuration) {
     const localVarAxiosParamCreator = ShipmentInvoicingApiAxiosParamCreator(configuration);
@@ -162,7 +160,6 @@ export const ShipmentInvoicingApiFp = function (configuration) {
 };
 /**
  * ShipmentInvoicingApi - factory interface
- * @export
  */
 export const ShipmentInvoicingApiFactory = function (configuration, basePath, axios) {
     const localVarFp = ShipmentInvoicingApiFp(configuration);
@@ -198,9 +195,6 @@ export const ShipmentInvoicingApiFactory = function (configuration, basePath, ax
 };
 /**
  * ShipmentInvoicingApi - object-oriented interface
- * @export
- * @class ShipmentInvoicingApi
- * @extends {BaseAPI}
  */
 export class ShipmentInvoicingApi extends BaseAPI {
     /**
@@ -208,7 +202,6 @@ export class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiGetInvoiceStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getInvoiceStatus(requestParameters, options) {
         return ShipmentInvoicingApiFp(this.configuration).getInvoiceStatus(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -218,7 +211,6 @@ export class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiGetShipmentDetailsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getShipmentDetails(requestParameters, options) {
         return ShipmentInvoicingApiFp(this.configuration).getShipmentDetails(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
@@ -228,7 +220,6 @@ export class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiSubmitInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     submitInvoice(requestParameters, options) {
         return ShipmentInvoicingApiFp(this.configuration).submitInvoice(requestParameters.shipmentId, 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 = "http://localhost".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/address-type-enum.js

@@ -13,8 +13,6 @@
  */
 /**
  * The shipping address type.
- * @export
- * @enum {string}
  */
 export const AddressTypeEnum = {
     Residential: 'Residential',

package/dist/es/api-model/models/shipment-invoice-status.js

@@ -13,8 +13,6 @@
  */
 /**
  * The shipment invoice status.
- * @export
- * @enum {string}
  */
 export const ShipmentInvoiceStatus = {
     Processing: 'Processing',

package/dist/types/api-model/api/shipment-invoicing-api.d.ts

@@ -19,7 +19,6 @@ import type { SubmitInvoiceRequest } from '../models';
 import type { SubmitInvoiceResponse } from '../models';
 /**
  * ShipmentInvoicingApi - axios parameter creator
- * @export
  */
 export declare const ShipmentInvoicingApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -47,7 +46,6 @@ export declare const ShipmentInvoicingApiAxiosParamCreator: (configuration?: Con
 };
 /**
  * ShipmentInvoicingApi - functional programming interface
- * @export
  */
 export declare const ShipmentInvoicingApiFp: (configuration?: Configuration) => {
     /**
@@ -75,7 +73,6 @@ export declare const ShipmentInvoicingApiFp: (configuration?: Configuration) =>
 };
 /**
  * ShipmentInvoicingApi - factory interface
- * @export
  */
 export declare const ShipmentInvoicingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -102,54 +99,34 @@ export declare const ShipmentInvoicingApiFactory: (configuration?: Configuration
 };
 /**
  * Request parameters for getInvoiceStatus operation in ShipmentInvoicingApi.
- * @export
- * @interface ShipmentInvoicingApiGetInvoiceStatusRequest
  */
 export interface ShipmentInvoicingApiGetInvoiceStatusRequest {
     /**
      * The shipment identifier for the shipment.
-     * @type {string}
-     * @memberof ShipmentInvoicingApiGetInvoiceStatus
      */
     readonly shipmentId: string;
 }
 /**
  * Request parameters for getShipmentDetails operation in ShipmentInvoicingApi.
- * @export
- * @interface ShipmentInvoicingApiGetShipmentDetailsRequest
  */
 export interface ShipmentInvoicingApiGetShipmentDetailsRequest {
     /**
      * The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
-     * @type {string}
-     * @memberof ShipmentInvoicingApiGetShipmentDetails
      */
     readonly shipmentId: string;
 }
 /**
  * Request parameters for submitInvoice operation in ShipmentInvoicingApi.
- * @export
- * @interface ShipmentInvoicingApiSubmitInvoiceRequest
  */
 export interface ShipmentInvoicingApiSubmitInvoiceRequest {
     /**
      * The identifier for the shipment.
-     * @type {string}
-     * @memberof ShipmentInvoicingApiSubmitInvoice
      */
     readonly shipmentId: string;
-    /**
-     *
-     * @type {SubmitInvoiceRequest}
-     * @memberof ShipmentInvoicingApiSubmitInvoice
-     */
     readonly body: SubmitInvoiceRequest;
 }
 /**
  * ShipmentInvoicingApi - object-oriented interface
- * @export
- * @class ShipmentInvoicingApi
- * @extends {BaseAPI}
  */
 export declare class ShipmentInvoicingApi extends BaseAPI {
     /**
@@ -157,7 +134,6 @@ export declare class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiGetInvoiceStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getInvoiceStatus(requestParameters: ShipmentInvoicingApiGetInvoiceStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoiceStatusResponse, any>>;
     /**
@@ -165,7 +141,6 @@ export declare class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiGetShipmentDetailsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     getShipmentDetails(requestParameters: ShipmentInvoicingApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
     /**
@@ -173,7 +148,6 @@ export declare class ShipmentInvoicingApi extends BaseAPI {
      * @param {ShipmentInvoicingApiSubmitInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShipmentInvoicingApi
      */
     submitInvoice(requestParameters: ShipmentInvoicingApiSubmitInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitInvoiceResponse, any>>;
 }

package/dist/types/api-model/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};