@sp-api-sdk/fulfillment-outbound-api-2020-07-01 4.0.1 → 4.0.2

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/additional-location-info.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Additional location information.
- * @export
- * @enum {string}
  */
 export declare const AdditionalLocationInfo: {
     readonly AsInstructed: "AS_INSTRUCTED";

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

@@ -11,68 +11,46 @@
  */
 /**
  * A physical address.
- * @export
- * @interface Address
  */
 export interface Address {
     /**
      * The name of the person, business or institution at the address.
-     * @type {string}
-     * @memberof Address
      */
     'name': string;
     /**
      * The first line of the 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 city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan.
-     * @type {string}
-     * @memberof Address
      */
     'city'?: string;
     /**
      * The district or county where the person, business, or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'districtOrCounty'?: string;
     /**
      * The state or region where the person, business or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'stateOrRegion': string;
     /**
      * The postal code of the address.
-     * @type {string}
-     * @memberof Address
      */
     'postalCode': string;
     /**
      * The two digit country code. In ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Address
      */
     'countryCode': string;
     /**
      * The phone number of the person, business, or institution located at the address.
-     * @type {string}
-     * @memberof Address
      */
     'phone'?: string;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * A quantity based on unit of measure.
- * @export
- * @interface Amount
  */
 export interface Amount {
     /**
      * The unit of measure for the amount.
-     * @type {string}
-     * @memberof Amount
      */
     'unitOfMeasure': AmountUnitOfMeasureEnum;
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
-     * @type {string}
-     * @memberof Amount
      */
     'value': string;
 }

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

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

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

@@ -12,38 +12,14 @@
 import type { Money } from './money';
 /**
  * The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.
- * @export
- * @interface CODSettings
  */
 export interface CODSettings {
     /**
      * When true, this fulfillment order requires a COD (Cash On Delivery) payment.
-     * @type {boolean}
-     * @memberof CODSettings
      */
     'isCodRequired': boolean;
-    /**
-     *
-     * @type {Money}
-     * @memberof CODSettings
-     */
     'codCharge'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof CODSettings
-     */
     'codChargeTax'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof CODSettings
-     */
     'shippingCharge'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof CODSettings
-     */
     'shippingChargeTax'?: Money;
 }

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

@@ -12,62 +12,33 @@
 import type { Money } from './money';
 /**
  * Item information for creating a fulfillment order.
- * @export
- * @interface CreateFulfillmentOrderItem
  */
 export interface CreateFulfillmentOrderItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderItem
      */
     'sellerSku': string;
     /**
      * A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same `SellerSKU`. For example, the seller might assign different `SellerFulfillmentOrderItemId` values to two items in a fulfillment order that share the same `SellerSKU` but have different `GiftMessage` values.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderItem
      */
     'sellerFulfillmentOrderItemId': string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof CreateFulfillmentOrderItem
      */
     'quantity': number;
     /**
      * A message to the gift recipient, if applicable.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderItem
      */
     'giftMessage'?: string;
     /**
      * Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderItem
      */
     'displayableComment'?: string;
     /**
      * Amazon\'s fulfillment network SKU of the item.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderItem
      */
     'fulfillmentNetworkSku'?: string;
-    /**
-     *
-     * @type {Money}
-     * @memberof CreateFulfillmentOrderItem
-     */
     'perUnitDeclaredValue'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof CreateFulfillmentOrderItem
-     */
     'perUnitPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof CreateFulfillmentOrderItem
-     */
     'perUnitTax'?: Money;
 }

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

@@ -21,110 +21,53 @@ import type { PaymentInformation } from './payment-information';
 import type { ShippingSpeedCategory } from './shipping-speed-category';
 /**
  * The request body schema for the `createFulfillmentOrder` operation.
- * @export
- * @interface CreateFulfillmentOrderRequest
  */
 export interface CreateFulfillmentOrderRequest {
     /**
      * The marketplace the fulfillment order is placed against.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'marketplaceId'?: string;
     /**
      * A fulfillment order identifier that the seller creates to track their fulfillment order. The `SellerFulfillmentOrderId` must be unique for each fulfillment order that a seller creates. If the seller\'s system already creates unique order identifiers, then these might be good values for them to use.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'sellerFulfillmentOrderId': string;
     /**
      * A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of `DisplayableOrderId` should match the order identifier that the seller provides to the recipient. The seller can use the `SellerFulfillmentOrderId` for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.  The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'displayableOrderId': string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'displayableOrderDate': string;
     /**
      * Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'displayableOrderComment': string;
-    /**
-     *
-     * @type {ShippingSpeedCategory}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'shippingSpeedCategory': ShippingSpeedCategory;
-    /**
-     *
-     * @type {DeliveryWindow}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'deliveryWindow'?: DeliveryWindow;
-    /**
-     *
-     * @type {Address}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'destinationAddress': Address;
-    /**
-     *
-     * @type {DeliveryPreferences}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'deliveryPreferences'?: DeliveryPreferences;
-    /**
-     *
-     * @type {FulfillmentAction}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'fulfillmentAction'?: FulfillmentAction;
-    /**
-     *
-     * @type {FulfillmentPolicy}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'fulfillmentPolicy'?: FulfillmentPolicy;
-    /**
-     *
-     * @type {CODSettings}
-     * @memberof CreateFulfillmentOrderRequest
-     */
     'codSettings'?: CODSettings;
     /**
      * The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'shipFromCountryCode'?: string;
     /**
      * A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.
-     * @type {Array<string>}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'notificationEmails'?: Array<string>;
     /**
      * A list of features and their fulfillment policies to apply to the order.
-     * @type {Array<FeatureSettings>}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'featureConstraints'?: Array<FeatureSettings>;
     /**
      * An array of item information for creating a fulfillment order.
-     * @type {Array<CreateFulfillmentOrderItem>}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'items': Array<CreateFulfillmentOrderItem>;
     /**
      * An array of various payment attributes related to this fulfillment order.
-     * @type {Array<PaymentInformation>}
-     * @memberof CreateFulfillmentOrderRequest
      */
     'paymentInformation'?: Array<PaymentInformation>;
 }

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

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

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

@@ -12,14 +12,10 @@
 import type { CreateReturnItem } from './create-return-item';
 /**
  * The `createFulfillmentReturn` operation creates a fulfillment return for items that were fulfilled using the `createFulfillmentOrder` operation. For calls to `createFulfillmentReturn`, you must include `ReturnReasonCode` values returned by a previous call to the `listReturnReasonCodes` operation.
- * @export
- * @interface CreateFulfillmentReturnRequest
  */
 export interface CreateFulfillmentReturnRequest {
     /**
      * An array of items to be returned.
-     * @type {Array<CreateReturnItem>}
-     * @memberof CreateFulfillmentReturnRequest
      */
     'items': Array<CreateReturnItem>;
 }

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

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

package/dist/types/api-model/models/create-fulfillment-return-result.d.ts

@@ -14,26 +14,18 @@ import type { ReturnAuthorization } from './return-authorization';
 import type { ReturnItem } from './return-item';
 /**
  * The result for the createFulfillmentReturn operation.
- * @export
- * @interface CreateFulfillmentReturnResult
  */
 export interface CreateFulfillmentReturnResult {
     /**
      * An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.
-     * @type {Array<ReturnItem>}
-     * @memberof CreateFulfillmentReturnResult
      */
     'returnItems'?: Array<ReturnItem>;
     /**
      * An array of invalid return item information.
-     * @type {Array<InvalidReturnItem>}
-     * @memberof CreateFulfillmentReturnResult
      */
     'invalidReturnItems'?: Array<InvalidReturnItem>;
     /**
      * An array of return authorization information.
-     * @type {Array<ReturnAuthorization>}
-     * @memberof CreateFulfillmentReturnResult
      */
     'returnAuthorizations'?: Array<ReturnAuthorization>;
 }

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

@@ -11,38 +11,26 @@
  */
 /**
  * An item that Amazon accepted for return.
- * @export
- * @interface CreateReturnItem
  */
 export interface CreateReturnItem {
     /**
      * An identifier assigned by the seller to the return item.
-     * @type {string}
-     * @memberof CreateReturnItem
      */
     'sellerReturnItemId': string;
     /**
      * The identifier assigned to the item by the seller when the fulfillment order was created.
-     * @type {string}
-     * @memberof CreateReturnItem
      */
     'sellerFulfillmentOrderItemId': string;
     /**
      * The identifier for the shipment that is associated with the return item.
-     * @type {string}
-     * @memberof CreateReturnItem
      */
     'amazonShipmentId': string;
     /**
      * The return reason code assigned to the return item by the seller.
-     * @type {string}
-     * @memberof CreateReturnItem
      */
     'returnReasonCode': string;
     /**
      * An optional comment about the return item.
-     * @type {string}
-     * @memberof CreateReturnItem
      */
     'returnComment'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The current delivery status of the package.
- * @export
- * @enum {string}
  */
 export declare const CurrentStatus: {
     readonly InTransit: "IN_TRANSIT";

package/dist/types/api-model/models/date-range.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The time range within which something (for example, a delivery) will occur.
- * @export
- * @interface DateRange
  */
 export interface DateRange {
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof DateRange
      */
     'earliest': string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof DateRange
      */
     'latest': string;
 }

package/dist/types/api-model/models/delivery-document.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * A delivery document for a package.
- * @export
- * @interface DeliveryDocument
  */
 export interface DeliveryDocument {
     /**
      * The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`.
-     * @type {string}
-     * @memberof DeliveryDocument
      */
     'documentType': string;
     /**
      * A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again.
-     * @type {string}
-     * @memberof DeliveryDocument
      */
     'url'?: string;
 }

package/dist/types/api-model/models/delivery-information.d.ts

@@ -13,20 +13,11 @@ import type { DeliveryDocument } from './delivery-document';
 import type { DropOffLocation } from './drop-off-location';
 /**
  * The delivery information for the package. This information is available after the package is delivered.
- * @export
- * @interface DeliveryInformation
  */
 export interface DeliveryInformation {
     /**
      * A list of delivery documents for a package.
-     * @type {Array<DeliveryDocument>}
-     * @memberof DeliveryInformation
      */
     'deliveryDocumentList'?: Array<DeliveryDocument>;
-    /**
-     *
-     * @type {DropOffLocation}
-     * @memberof DeliveryInformation
-     */
     'dropOffLocation'?: DropOffLocation;
 }