@sp-api-sdk/shipping-api-v1 3.1.3 → 3.1.5

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

@@ -29,7 +29,6 @@ import type { RetrieveShippingLabelRequest } from '../models';
 import type { RetrieveShippingLabelResponse } from '../models';
 /**
  * ShippingApi - axios parameter creator
- * @export
  */
 export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -100,7 +99,6 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
 };
 /**
  * ShippingApi - functional programming interface
- * @export
  */
 export declare const ShippingApiFp: (configuration?: Configuration) => {
     /**
@@ -171,7 +169,6 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
 };
 /**
  * ShippingApi - factory interface
- * @export
  */
 export declare const ShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -239,131 +236,90 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
 };
 /**
  * Request parameters for cancelShipment operation in ShippingApi.
- * @export
- * @interface ShippingApiCancelShipmentRequest
  */
 export interface ShippingApiCancelShipmentRequest {
     /**
      * Shipment Id to cancel a shipment
-     * @type {string}
-     * @memberof ShippingApiCancelShipment
      */
     readonly shipmentId: string;
 }
 /**
  * Request parameters for createShipment operation in ShippingApi.
- * @export
- * @interface ShippingApiCreateShipmentRequest
  */
 export interface ShippingApiCreateShipmentRequest {
     /**
      * CreateShipmentRequest Body
-     * @type {CreateShipmentRequest}
-     * @memberof ShippingApiCreateShipment
      */
     readonly body: CreateShipmentRequest;
 }
 /**
  * Request parameters for getRates operation in ShippingApi.
- * @export
- * @interface ShippingApiGetRatesRequest
  */
 export interface ShippingApiGetRatesRequest {
     /**
      * GetRatesRequest body
-     * @type {GetRatesRequest}
-     * @memberof ShippingApiGetRates
      */
     readonly body: GetRatesRequest;
 }
 /**
  * Request parameters for getShipment operation in ShippingApi.
- * @export
- * @interface ShippingApiGetShipmentRequest
  */
 export interface ShippingApiGetShipmentRequest {
     /**
      * Shipment id to return the entire shipment object
-     * @type {string}
-     * @memberof ShippingApiGetShipment
      */
     readonly shipmentId: string;
 }
 /**
  * Request parameters for getTrackingInformation operation in ShippingApi.
- * @export
- * @interface ShippingApiGetTrackingInformationRequest
  */
 export interface ShippingApiGetTrackingInformationRequest {
     /**
      * Tracking Id
-     * @type {string}
-     * @memberof ShippingApiGetTrackingInformation
      */
     readonly trackingId: string;
 }
 /**
  * Request parameters for purchaseLabels operation in ShippingApi.
- * @export
- * @interface ShippingApiPurchaseLabelsRequest
  */
 export interface ShippingApiPurchaseLabelsRequest {
     /**
      * Shipment id for purchase shipping label
-     * @type {string}
-     * @memberof ShippingApiPurchaseLabels
      */
     readonly shipmentId: string;
     /**
      * PurchaseShippingLabelRequest body
-     * @type {PurchaseLabelsRequest}
-     * @memberof ShippingApiPurchaseLabels
      */
     readonly body: PurchaseLabelsRequest;
 }
 /**
  * Request parameters for purchaseShipment operation in ShippingApi.
- * @export
- * @interface ShippingApiPurchaseShipmentRequest
  */
 export interface ShippingApiPurchaseShipmentRequest {
     /**
      * PurchaseShipmentRequest body
-     * @type {PurchaseShipmentRequest}
-     * @memberof ShippingApiPurchaseShipment
      */
     readonly body: PurchaseShipmentRequest;
 }
 /**
  * Request parameters for retrieveShippingLabel operation in ShippingApi.
- * @export
- * @interface ShippingApiRetrieveShippingLabelRequest
  */
 export interface ShippingApiRetrieveShippingLabelRequest {
     /**
      * Shipment Id to retreive label
-     * @type {string}
-     * @memberof ShippingApiRetrieveShippingLabel
      */
     readonly shipmentId: string;
     /**
      * Tracking Id
-     * @type {string}
-     * @memberof ShippingApiRetrieveShippingLabel
      */
     readonly trackingId: string;
     /**
      * RetrieveShippingLabelRequest body
-     * @type {RetrieveShippingLabelRequest}
-     * @memberof ShippingApiRetrieveShippingLabel
      */
     readonly body: RetrieveShippingLabelRequest;
 }
 /**
  * ShippingApi - object-oriented interface
- * @export
- * @class ShippingApi
- * @extends {BaseAPI}
  */
 export declare class ShippingApi extends BaseAPI {
     /**
@@ -371,7 +327,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelShipmentResponse, any>>;
     /**
@@ -379,14 +334,12 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiCreateShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     createShipment(requestParameters: ShippingApiCreateShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateShipmentResponse, any>>;
     /**
      * 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?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetAccountResponse, any>>;
     /**
@@ -394,7 +347,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getRates(requestParameters: ShippingApiGetRatesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetRatesResponse, any>>;
     /**
@@ -402,7 +354,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getShipment(requestParameters: ShippingApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentResponse, any>>;
     /**
@@ -410,7 +361,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiGetTrackingInformationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     getTrackingInformation(requestParameters: ShippingApiGetTrackingInformationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetTrackingInformationResponse, any>>;
     /**
@@ -418,7 +368,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiPurchaseLabelsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseLabels(requestParameters: ShippingApiPurchaseLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PurchaseLabelsResponse, any>>;
     /**
@@ -426,7 +375,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PurchaseShipmentResponse, any>>;
     /**
@@ -434,7 +382,6 @@ export declare class ShippingApi extends BaseAPI {
      * @param {ShippingApiRetrieveShippingLabelRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ShippingApi
      */
     retrieveShippingLabel(requestParameters: ShippingApiRetrieveShippingLabelRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RetrieveShippingLabelResponse, 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 {};

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

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } 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) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -23,49 +23,32 @@ 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;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/dist/types/api-model/models/accepted-rate.d.ts

@@ -15,32 +15,10 @@ import type { ShippingPromiseSet } from './shipping-promise-set';
 import type { Weight } from './weight';
 /**
  * The specific rate purchased for the shipment, or null if unpurchased.
- * @export
- * @interface AcceptedRate
  */
 export interface AcceptedRate {
-    /**
-     *
-     * @type {Currency}
-     * @memberof AcceptedRate
-     */
     'totalCharge'?: Currency;
-    /**
-     *
-     * @type {Weight}
-     * @memberof AcceptedRate
-     */
     'billedWeight'?: Weight;
-    /**
-     *
-     * @type {ServiceType}
-     * @memberof AcceptedRate
-     */
     'serviceType'?: ServiceType;
-    /**
-     *
-     * @type {ShippingPromiseSet}
-     * @memberof AcceptedRate
-     */
     'promise'?: ShippingPromiseSet;
 }

package/dist/types/api-model/models/account.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The account related data.
- * @export
- * @interface Account
  */
 export interface Account {
     /**
      * This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.
-     * @type {string}
-     * @memberof Account
      */
     'accountId': string;
 }

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

@@ -11,74 +11,50 @@
  */
 /**
  * The address.
- * @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 that 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 state or region where the person, business or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'stateOrRegion': string;
     /**
      * The city where the person, business or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'city': string;
     /**
      * The two digit country code. In ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Address
      */
     'countryCode': string;
     /**
      * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
-     * @type {string}
-     * @memberof Address
      */
     'postalCode': string;
     /**
      * The email address of the contact associated with the address.
-     * @type {string}
-     * @memberof Address
      */
     'email'?: string;
     /**
      * The email cc addresses of the contact associated with the address.
-     * @type {Array<string>}
-     * @memberof Address
      */
     'copyEmails'?: Array<string>;
     /**
      * The phone number of the person, business or institution located at that address.
-     * @type {string}
-     * @memberof Address
      */
     'phoneNumber'?: string;
 }

package/dist/types/api-model/models/cancel-shipment-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the cancelShipment operation.
- * @export
- * @interface CancelShipmentResponse
  */
 export interface CancelShipmentResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof CancelShipmentResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/container-item.d.ts

@@ -13,32 +13,16 @@ import type { Currency } from './currency';
 import type { Weight } from './weight';
 /**
  * Item in the container.
- * @export
- * @interface ContainerItem
  */
 export interface ContainerItem {
     /**
      * The quantity of the items of this type in the container.
-     * @type {number}
-     * @memberof ContainerItem
      */
     'quantity': number;
-    /**
-     *
-     * @type {Currency}
-     * @memberof ContainerItem
-     */
     'unitPrice': Currency;
-    /**
-     *
-     * @type {Weight}
-     * @memberof ContainerItem
-     */
     'unitWeight': Weight;
     /**
      * A descriptive title of the item.
-     * @type {string}
-     * @memberof ContainerItem
      */
     'title': string;
 }

package/dist/types/api-model/models/container-specification.d.ts

@@ -13,20 +13,8 @@ import type { Dimensions } from './dimensions';
 import type { Weight } from './weight';
 /**
  * Container specification for checking the service rate.
- * @export
- * @interface ContainerSpecification
  */
 export interface ContainerSpecification {
-    /**
-     *
-     * @type {Dimensions}
-     * @memberof ContainerSpecification
-     */
     'dimensions': Dimensions;
-    /**
-     *
-     * @type {Weight}
-     * @memberof ContainerSpecification
-     */
     'weight': Weight;
 }

package/dist/types/api-model/models/container.d.ts

@@ -15,45 +15,22 @@ import type { Dimensions } from './dimensions';
 import type { Weight } from './weight';
 /**
  * Container in the shipment.
- * @export
- * @interface Container
  */
 export interface Container {
     /**
      * The type of physical container being used. (always \'PACKAGE\')
-     * @type {string}
-     * @memberof Container
      */
     'containerType'?: ContainerContainerTypeEnum;
     /**
      * An identifier for the container. This must be unique within all the containers in the same shipment.
-     * @type {string}
-     * @memberof Container
      */
     'containerReferenceId': string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof Container
-     */
     'value': Currency;
-    /**
-     *
-     * @type {Dimensions}
-     * @memberof Container
-     */
     'dimensions': Dimensions;
     /**
      * A list of the items in the container.
-     * @type {Array<ContainerItem>}
-     * @memberof Container
      */
     'items': Array<ContainerItem>;
-    /**
-     *
-     * @type {Weight}
-     * @memberof Container
-     */
     'weight': Weight;
 }
 export declare const ContainerContainerTypeEnum: {

package/dist/types/api-model/models/create-shipment-request.d.ts

@@ -13,32 +13,16 @@ import type { Address } from './address';
 import type { Container } from './container';
 /**
  * The request schema for the createShipment operation.
- * @export
- * @interface CreateShipmentRequest
  */
 export interface CreateShipmentRequest {
     /**
      * Client reference id.
-     * @type {string}
-     * @memberof CreateShipmentRequest
      */
     'clientReferenceId': string;
-    /**
-     *
-     * @type {Address}
-     * @memberof CreateShipmentRequest
-     */
     'shipTo': Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof CreateShipmentRequest
-     */
     'shipFrom': Address;
     /**
      * A list of container.
-     * @type {Array<Container>}
-     * @memberof CreateShipmentRequest
      */
     'containers': Array<Container>;
 }

package/dist/types/api-model/models/create-shipment-response.d.ts

@@ -12,20 +12,11 @@
 import type { CreateShipmentResult } from './create-shipment-result';
 /**
  * The response schema for the createShipment operation.
- * @export
- * @interface CreateShipmentResponse
  */
 export interface CreateShipmentResponse {
-    /**
-     *
-     * @type {CreateShipmentResult}
-     * @memberof CreateShipmentResponse
-     */
     'payload'?: CreateShipmentResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof CreateShipmentResponse
      */
     'errors'?: Array<Error>;
 }