@sp-api-sdk/easy-ship-api-2022-03-23 4.2.3 → 4.2.4

package/dist/types/api-model/api/easy-ship-api.d.ts

@@ -23,7 +23,6 @@ import type { Packages } from '../models';
 import type { UpdateScheduledPackagesRequest } from '../models';
 /**
  * EasyShipApi - axios parameter creator
- * @export
  */
 export declare const EasyShipApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -65,7 +64,6 @@ export declare const EasyShipApiAxiosParamCreator: (configuration?: Configuratio
 };
 /**
  * EasyShipApi - functional programming interface
- * @export
  */
 export declare const EasyShipApiFp: (configuration?: Configuration) => {
     /**
@@ -107,7 +105,6 @@ export declare const EasyShipApiFp: (configuration?: Configuration) => {
 };
 /**
  * EasyShipApi - factory interface
- * @export
  */
 export declare const EasyShipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -148,80 +145,55 @@ export declare const EasyShipApiFactory: (configuration?: Configuration, basePat
 };
 /**
  * Request parameters for createScheduledPackage operation in EasyShipApi.
- * @export
- * @interface EasyShipApiCreateScheduledPackageRequest
  */
 export interface EasyShipApiCreateScheduledPackageRequest {
     /**
      * The request schema for the `createScheduledPackage` operation.
-     * @type {CreateScheduledPackageRequest}
-     * @memberof EasyShipApiCreateScheduledPackage
      */
     readonly createScheduledPackageRequest: CreateScheduledPackageRequest;
 }
 /**
  * Request parameters for createScheduledPackageBulk operation in EasyShipApi.
- * @export
- * @interface EasyShipApiCreateScheduledPackageBulkRequest
  */
 export interface EasyShipApiCreateScheduledPackageBulkRequest {
     /**
      * The request schema for the `createScheduledPackageBulk` operation.
-     * @type {CreateScheduledPackagesRequest}
-     * @memberof EasyShipApiCreateScheduledPackageBulk
      */
     readonly createScheduledPackagesRequest: CreateScheduledPackagesRequest;
 }
 /**
  * Request parameters for getScheduledPackage operation in EasyShipApi.
- * @export
- * @interface EasyShipApiGetScheduledPackageRequest
  */
 export interface EasyShipApiGetScheduledPackageRequest {
     /**
      * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
-     * @type {string}
-     * @memberof EasyShipApiGetScheduledPackage
      */
     readonly amazonOrderId: string;
     /**
      * An identifier for the marketplace in which the seller is selling.
-     * @type {string}
-     * @memberof EasyShipApiGetScheduledPackage
      */
     readonly marketplaceId: string;
 }
 /**
  * Request parameters for listHandoverSlots operation in EasyShipApi.
- * @export
- * @interface EasyShipApiListHandoverSlotsRequest
  */
 export interface EasyShipApiListHandoverSlotsRequest {
     /**
      * The request schema for the `listHandoverSlots` operation.
-     * @type {ListHandoverSlotsRequest}
-     * @memberof EasyShipApiListHandoverSlots
      */
     readonly listHandoverSlotsRequest?: ListHandoverSlotsRequest;
 }
 /**
  * Request parameters for updateScheduledPackages operation in EasyShipApi.
- * @export
- * @interface EasyShipApiUpdateScheduledPackagesRequest
  */
 export interface EasyShipApiUpdateScheduledPackagesRequest {
     /**
      * The request schema for the `updateScheduledPackages` operation.
-     * @type {UpdateScheduledPackagesRequest}
-     * @memberof EasyShipApiUpdateScheduledPackages
      */
     readonly updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest;
 }
 /**
  * EasyShipApi - object-oriented interface
- * @export
- * @class EasyShipApi
- * @extends {BaseAPI}
  */
 export declare class EasyShipApi extends BaseAPI {
     /**
@@ -229,7 +201,6 @@ export declare class EasyShipApi extends BaseAPI {
      * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EasyShipApi
      */
     createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any>>;
     /**
@@ -237,7 +208,6 @@ export declare class EasyShipApi extends BaseAPI {
      * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EasyShipApi
      */
     createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateScheduledPackagesResponse, any>>;
     /**
@@ -245,7 +215,6 @@ export declare class EasyShipApi extends BaseAPI {
      * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EasyShipApi
      */
     getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any>>;
     /**
@@ -253,7 +222,6 @@ export declare class EasyShipApi extends BaseAPI {
      * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EasyShipApi
      */
     listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListHandoverSlotsResponse, any>>;
     /**
@@ -261,7 +229,6 @@ export declare class EasyShipApi extends BaseAPI {
      * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EasyShipApi
      */
     updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Packages, 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/code.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * An error code that identifies the type of error that occurred. The error codes listed below are specific to the Easy Ship section.
- * @export
- * @enum {string}
  */
 export declare const Code: {
     readonly InvalidInput: "InvalidInput";

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

@@ -12,26 +12,15 @@
 import type { PackageDetails } from './package-details';
 /**
  * The request schema for the `createScheduledPackage` operation.
- * @export
- * @interface CreateScheduledPackageRequest
  */
 export interface CreateScheduledPackageRequest {
     /**
      * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
-     * @type {string}
-     * @memberof CreateScheduledPackageRequest
      */
     'amazonOrderId': string;
     /**
      * A string of up to 255 characters.
-     * @type {string}
-     * @memberof CreateScheduledPackageRequest
      */
     'marketplaceId': string;
-    /**
-     *
-     * @type {PackageDetails}
-     * @memberof CreateScheduledPackageRequest
-     */
     'packageDetails': PackageDetails;
 }

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

@@ -13,26 +13,15 @@ import type { LabelFormat } from './label-format';
 import type { OrderScheduleDetails } from './order-schedule-details';
 /**
  * The request body for the POST /easyShip/2022-03-23/packages/bulk API.
- * @export
- * @interface CreateScheduledPackagesRequest
  */
 export interface CreateScheduledPackagesRequest {
     /**
      * A string of up to 255 characters.
-     * @type {string}
-     * @memberof CreateScheduledPackagesRequest
      */
     'marketplaceId': string;
     /**
      * An array allowing users to specify orders to be scheduled.
-     * @type {Array<OrderScheduleDetails>}
-     * @memberof CreateScheduledPackagesRequest
      */
     'orderScheduleDetailsList': Array<OrderScheduleDetails>;
-    /**
-     *
-     * @type {LabelFormat}
-     * @memberof CreateScheduledPackagesRequest
-     */
     'labelFormat': LabelFormat;
 }

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

@@ -13,26 +13,18 @@ import type { Package } from './package';
 import type { RejectedOrder } from './rejected-order';
 /**
  * The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn\'t schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.
- * @export
- * @interface CreateScheduledPackagesResponse
  */
 export interface CreateScheduledPackagesResponse {
     /**
      * A list of packages. Refer to the `Package` object.
-     * @type {Array<Package>}
-     * @memberof CreateScheduledPackagesResponse
      */
     'scheduledPackages'?: Array<Package>;
     /**
      * A list of orders we couldn\'t scheduled on your behalf. Each element contains the reason and details on the error.
-     * @type {Array<RejectedOrder>}
-     * @memberof CreateScheduledPackagesResponse
      */
     'rejectedOrders'?: Array<RejectedOrder>;
     /**
      * A pre-signed URL for the zip document containing the shipping labels and the documents enabled for your marketplace.
-     * @type {string}
-     * @memberof CreateScheduledPackagesResponse
      */
     'printableDocumentsUrl'?: string;
 }

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

@@ -12,38 +12,23 @@
 import type { UnitOfLength } from './unit-of-length';
 /**
  * The dimensions of the scheduled package.
- * @export
- * @interface Dimensions
  */
 export interface Dimensions {
     /**
      * The numerical value of the specified dimension.
-     * @type {number}
-     * @memberof Dimensions
      */
     'length'?: number;
     /**
      * The numerical value of the specified dimension.
-     * @type {number}
-     * @memberof Dimensions
      */
     'width'?: number;
     /**
      * The numerical value of the specified dimension.
-     * @type {number}
-     * @memberof Dimensions
      */
     'height'?: number;
-    /**
-     *
-     * @type {UnitOfLength}
-     * @memberof Dimensions
-     */
     'unit'?: UnitOfLength;
     /**
      * A string of up to 255 characters.
-     * @type {string}
-     * @memberof Dimensions
      */
     'identifier'?: string;
 }

package/dist/types/api-model/models/error-list.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * A list of error responses returned when a request is unsuccessful.
- * @export
- * @interface ErrorList
  */
 export interface ErrorList {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof ErrorList
      */
     'errors': Array<Error>;
 }

package/dist/types/api-model/models/handover-method.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Identifies the method by which a seller will hand a package over to Amazon Logistics.
- * @export
- * @enum {string}
  */
 export declare const HandoverMethod: {
     readonly Pickup: "Pickup";

package/dist/types/api-model/models/invoice-data.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Invoice number and date.
- * @export
- * @interface InvoiceData
  */
 export interface InvoiceData {
     /**
      * A string of up to 255 characters.
-     * @type {string}
-     * @memberof InvoiceData
      */
     'invoiceNumber': string;
     /**
      * A datetime value in ISO 8601 format.
-     * @type {string}
-     * @memberof InvoiceData
      */
     'invoiceDate'?: string;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Item identifier and serial number information.
- * @export
- * @interface Item
  */
 export interface Item {
     /**
      * The Amazon-defined order item identifier.
-     * @type {string}
-     * @memberof Item
      */
     'orderItemId'?: string;
     /**
      * A list of serial numbers for the items associated with the `OrderItemId` value.
-     * @type {Array<string>}
-     * @memberof Item
      */
     'orderItemSerialNumbers'?: Array<string>;
 }

package/dist/types/api-model/models/label-format.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The file format in which the shipping label will be created.
- * @export
- * @enum {string}
  */
 export declare const LabelFormat: {
     readonly Pdf: "PDF";

package/dist/types/api-model/models/list-handover-slots-request.d.ts

@@ -13,32 +13,16 @@ import type { Dimensions } from './dimensions';
 import type { Weight } from './weight';
 /**
  * The request schema for the `listHandoverSlots` operation.
- * @export
- * @interface ListHandoverSlotsRequest
  */
 export interface ListHandoverSlotsRequest {
     /**
      * A string of up to 255 characters.
-     * @type {string}
-     * @memberof ListHandoverSlotsRequest
      */
     'marketplaceId': string;
     /**
      * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
-     * @type {string}
-     * @memberof ListHandoverSlotsRequest
      */
     'amazonOrderId': string;
-    /**
-     *
-     * @type {Dimensions}
-     * @memberof ListHandoverSlotsRequest
-     */
     'packageDimensions': Dimensions;
-    /**
-     *
-     * @type {Weight}
-     * @memberof ListHandoverSlotsRequest
-     */
     'packageWeight': Weight;
 }

package/dist/types/api-model/models/list-handover-slots-response.d.ts

@@ -12,20 +12,14 @@
 import type { TimeSlot } from './time-slot';
 /**
  * The response schema for the `listHandoverSlots` operation.
- * @export
- * @interface ListHandoverSlotsResponse
  */
 export interface ListHandoverSlotsResponse {
     /**
      * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
-     * @type {string}
-     * @memberof ListHandoverSlotsResponse
      */
     'amazonOrderId': string;
     /**
      * A list of time slots.
-     * @type {Array<TimeSlot>}
-     * @memberof ListHandoverSlotsResponse
      */
     'timeSlots': Array<TimeSlot>;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * Error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

package/dist/types/api-model/models/order-schedule-details.d.ts

@@ -12,20 +12,11 @@
 import type { PackageDetails } from './package-details';
 /**
  * This object allows users to specify an order to be scheduled. Only the amazonOrderId is required.
- * @export
- * @interface OrderScheduleDetails
  */
 export interface OrderScheduleDetails {
     /**
      * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
-     * @type {string}
-     * @memberof OrderScheduleDetails
      */
     'amazonOrderId': string;
-    /**
-     *
-     * @type {PackageDetails}
-     * @memberof OrderScheduleDetails
-     */
     'packageDetails'?: PackageDetails;
 }

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

@@ -13,26 +13,15 @@ import type { Item } from './item';
 import type { TimeSlot } from './time-slot';
 /**
  * Package details. Includes `packageItems`, `packageTimeSlot`, and `packageIdentifier`.
- * @export
- * @interface PackageDetails
  */
 export interface PackageDetails {
     /**
      * A list of items contained in the package.
-     * @type {Array<Item>}
-     * @memberof PackageDetails
      */
     'packageItems'?: Array<Item>;
-    /**
-     *
-     * @type {TimeSlot}
-     * @memberof PackageDetails
-     */
     'packageTimeSlot': TimeSlot;
     /**
      * Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
-     * @type {string}
-     * @memberof PackageDetails
      */
     'packageIdentifier'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The status of the package.
- * @export
- * @enum {string}
  */
 export declare const PackageStatus: {
     readonly ReadyForPickup: "ReadyForPickup";