@sp-api-sdk/orders-api-v0 5.0.0 → 5.1.1

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/address-extended-fields.d.ts

@@ -11,32 +11,22 @@
  */
 /**
  * The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses.
- * @export
- * @interface AddressExtendedFields
  */
 export interface AddressExtendedFields {
     /**
      * The street name.
-     * @type {string}
-     * @memberof AddressExtendedFields
      */
     'StreetName'?: string;
     /**
      * The house, building, or property number associated with the location\'s street address.
-     * @type {string}
-     * @memberof AddressExtendedFields
      */
     'StreetNumber'?: string;
     /**
      * The floor number/unit number in the building/private house number.
-     * @type {string}
-     * @memberof AddressExtendedFields
      */
     'Complement'?: string;
     /**
      * The neighborhood. This value is only used in some countries (such as Brazil).
-     * @type {string}
-     * @memberof AddressExtendedFields
      */
     'Neighborhood'?: string;
 }

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

@@ -12,98 +12,63 @@
 import type { AddressExtendedFields } from './address-extended-fields';
 /**
  * The shipping address for the order.
- * @export
- * @interface Address
  */
 export interface Address {
     /**
      * The name.
-     * @type {string}
-     * @memberof Address
      */
     'Name': string;
     /**
      * The company name of the recipient.  **Note**: This attribute is only available for shipping address.
-     * @type {string}
-     * @memberof Address
      */
     'CompanyName'?: string;
     /**
      * The street address.
-     * @type {string}
-     * @memberof Address
      */
     'AddressLine1'?: string;
     /**
      * Additional street address information, if required.
-     * @type {string}
-     * @memberof Address
      */
     'AddressLine2'?: string;
     /**
      * Additional street address information, if required.
-     * @type {string}
-     * @memberof Address
      */
     'AddressLine3'?: string;
     /**
      * The city.
-     * @type {string}
-     * @memberof Address
      */
     'City'?: string;
     /**
      * The county.
-     * @type {string}
-     * @memberof Address
      */
     'County'?: string;
     /**
      * The district.
-     * @type {string}
-     * @memberof Address
      */
     'District'?: string;
     /**
      * The state or region.
-     * @type {string}
-     * @memberof Address
      */
     'StateOrRegion'?: string;
     /**
      * The municipality.
-     * @type {string}
-     * @memberof Address
      */
     'Municipality'?: string;
     /**
      * The postal code.
-     * @type {string}
-     * @memberof Address
      */
     'PostalCode'?: string;
     /**
      * The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Address
      */
     'CountryCode'?: string;
     /**
      * The phone number of the buyer.  **Note**:  1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed:  a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date.
-     * @type {string}
-     * @memberof Address
      */
     'Phone'?: string;
-    /**
-     *
-     * @type {AddressExtendedFields}
-     * @memberof Address
-     */
     'ExtendedFields'?: AddressExtendedFields;
     /**
      * The address type of the shipping address.
-     * @type {string}
-     * @memberof Address
      */
     'AddressType'?: AddressAddressTypeEnum;
 }

package/dist/types/api-model/models/amazon-programs.d.ts

@@ -10,15 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- * Contains the list of programs that are associated with an item.  Possible programs are:  - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products.
- * @export
- * @interface AmazonPrograms
+ * Contains the list of programs that Amazon associates with an item.  Possible programs are:  - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products. - **FBM Ship+**: Unlocks expedited shipping without the extra cost. Helps you to provide accurate and fast delivery dates to Amazon customers. You also receive protection from late deliveries, a discount on expedited shipping rates, and cash back when you ship.
  */
 export interface AmazonPrograms {
     /**
-     * A list of the programs that are associated with the specified order item.  **Possible values**: `SUBSCRIBE_AND_SAVE`
-     * @type {Array<string>}
-     * @memberof AmazonPrograms
+     * A list of the programs that Amazon associates with the order item.  **Possible values**: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
      */
     'Programs': Array<string>;
 }

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

@@ -12,26 +12,15 @@
 import type { AssociationType } from './association-type';
 /**
  * An item that is associated with an order item. For example, a tire installation service that is purchased with tires.
- * @export
- * @interface AssociatedItem
  */
 export interface AssociatedItem {
     /**
      * The order item\'s order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof AssociatedItem
      */
     'OrderId'?: string;
     /**
      * An Amazon-defined item identifier for the associated item.
-     * @type {string}
-     * @memberof AssociatedItem
      */
     'OrderItemId'?: string;
-    /**
-     *
-     * @type {AssociationType}
-     * @memberof AssociatedItem
-     */
     'AssociationType'?: AssociationType;
 }

package/dist/types/api-model/models/association-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The type of association an item has with an order item.
- * @export
- * @enum {string}
  */
 export declare const AssociationType: {
     readonly ValueAddService: "VALUE_ADD_SERVICE";

package/dist/types/api-model/models/automated-shipping-settings.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Contains information regarding the Shipping Settings Automation program, such as whether the order\'s shipping settings were generated automatically, and what those settings are.
- * @export
- * @interface AutomatedShippingSettings
  */
 export interface AutomatedShippingSettings {
     /**
      * When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
-     * @type {boolean}
-     * @memberof AutomatedShippingSettings
      */
     'HasAutomatedShippingSettings'?: boolean;
     /**
      * Auto-generated carrier for SSA orders.
-     * @type {string}
-     * @memberof AutomatedShippingSettings
      */
     'AutomatedCarrier'?: string;
     /**
      * Auto-generated ship method for SSA orders.
-     * @type {string}
-     * @memberof AutomatedShippingSettings
      */
     'AutomatedShipMethod'?: string;
 }

package/dist/types/api-model/models/business-hours.d.ts

@@ -12,20 +12,14 @@
 import type { OpenInterval } from './open-interval';
 /**
  * Business days and hours when the destination is open for deliveries.
- * @export
- * @interface BusinessHours
  */
 export interface BusinessHours {
     /**
      * Day of the week.
-     * @type {string}
-     * @memberof BusinessHours
      */
     'DayOfWeek'?: BusinessHoursDayOfWeekEnum;
     /**
      * Time window during the day when the business is open.
-     * @type {Array<OpenInterval>}
-     * @memberof BusinessHours
      */
     'OpenIntervals'?: Array<OpenInterval>;
 }

package/dist/types/api-model/models/buyer-customized-info-detail.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Buyer information for custom orders from the Amazon Custom program.
- * @export
- * @interface BuyerCustomizedInfoDetail
  */
 export interface BuyerCustomizedInfoDetail {
     /**
      * The location of a ZIP file containing Amazon Custom data.
-     * @type {string}
-     * @memberof BuyerCustomizedInfoDetail
      */
     'CustomizedURL'?: string;
 }

package/dist/types/api-model/models/buyer-info.d.ts

@@ -12,38 +12,23 @@
 import type { BuyerTaxInfo } from './buyer-tax-info';
 /**
  * Buyer information.
- * @export
- * @interface BuyerInfo
  */
 export interface BuyerInfo {
     /**
      * The anonymized email address of the buyer.
-     * @type {string}
-     * @memberof BuyerInfo
      */
     'BuyerEmail'?: string;
     /**
      * The buyer name or the recipient name.
-     * @type {string}
-     * @memberof BuyerInfo
      */
     'BuyerName'?: string;
     /**
      * The county of the buyer.  **Note**: This attribute is only available in the Brazil marketplace.
-     * @type {string}
-     * @memberof BuyerInfo
      */
     'BuyerCounty'?: string;
-    /**
-     *
-     * @type {BuyerTaxInfo}
-     * @memberof BuyerInfo
-     */
     'BuyerTaxInfo'?: BuyerTaxInfo;
     /**
      * The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
-     * @type {string}
-     * @memberof BuyerInfo
      */
     'PurchaseOrderNumber'?: string;
 }

package/dist/types/api-model/models/buyer-requested-cancel.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Information about whether or not a buyer requested cancellation.
- * @export
- * @interface BuyerRequestedCancel
  */
 export interface BuyerRequestedCancel {
     /**
      * Indicate whether the buyer has requested cancellation.  **Possible Values**: `true`, `false`.
-     * @type {string}
-     * @memberof BuyerRequestedCancel
      */
     'IsBuyerRequestedCancel'?: string;
     /**
      * The reason that the buyer requested cancellation.
-     * @type {string}
-     * @memberof BuyerRequestedCancel
      */
     'BuyerCancelReason'?: string;
 }

package/dist/types/api-model/models/buyer-tax-info.d.ts

@@ -12,26 +12,18 @@
 import type { TaxClassification } from './tax-classification';
 /**
  * Tax information about the buyer.
- * @export
- * @interface BuyerTaxInfo
  */
 export interface BuyerTaxInfo {
     /**
      * The legal name of the company.
-     * @type {string}
-     * @memberof BuyerTaxInfo
      */
     'CompanyLegalName'?: string;
     /**
      * The country or region imposing the tax.
-     * @type {string}
-     * @memberof BuyerTaxInfo
      */
     'TaxingRegion'?: string;
     /**
      * A list of tax classifications that apply to the order.
-     * @type {Array<TaxClassification>}
-     * @memberof BuyerTaxInfo
      */
     'TaxClassifications'?: Array<TaxClassification>;
 }

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

@@ -11,32 +11,22 @@
  */
 /**
  * Contains the business invoice tax information. Available only in the TR marketplace.
- * @export
- * @interface BuyerTaxInformation
  */
 export interface BuyerTaxInformation {
     /**
      * Business buyer\'s company legal name.
-     * @type {string}
-     * @memberof BuyerTaxInformation
      */
     'BuyerLegalCompanyName'?: string;
     /**
      * Business buyer\'s address.
-     * @type {string}
-     * @memberof BuyerTaxInformation
      */
     'BuyerBusinessAddress'?: string;
     /**
      * Business buyer\'s tax registration ID.
-     * @type {string}
-     * @memberof BuyerTaxInformation
      */
     'BuyerTaxRegistrationId'?: string;
     /**
      * Business buyer\'s tax office.
-     * @type {string}
-     * @memberof BuyerTaxInformation
      */
     'BuyerTaxOffice'?: string;
 }

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

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

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

@@ -11,26 +11,18 @@
  */
 /**
  * A single order item.
- * @export
- * @interface ConfirmShipmentOrderItem
  */
 export interface ConfirmShipmentOrderItem {
     /**
      * The order item\'s unique identifier.
-     * @type {string}
-     * @memberof ConfirmShipmentOrderItem
      */
     'orderItemId': string;
     /**
      * The item\'s quantity.
-     * @type {number}
-     * @memberof ConfirmShipmentOrderItem
      */
     'quantity': number;
     /**
      * A list of order items.
-     * @type {Array<string>}
-     * @memberof ConfirmShipmentOrderItem
      */
     'transparencyCodes'?: Array<string>;
 }

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

@@ -12,26 +12,15 @@
 import type { PackageDetail } from './package-detail';
 /**
  * The request schema for an shipment confirmation.
- * @export
- * @interface ConfirmShipmentRequest
  */
 export interface ConfirmShipmentRequest {
-    /**
-     *
-     * @type {PackageDetail}
-     * @memberof ConfirmShipmentRequest
-     */
     'packageDetail': PackageDetail;
     /**
      * The COD collection method (only supported in the JP marketplace).
-     * @type {string}
-     * @memberof ConfirmShipmentRequest
      */
     'codCollectionMethod'?: ConfirmShipmentRequestCodCollectionMethodEnum;
     /**
      * The unobfuscated marketplace identifier.
-     * @type {string}
-     * @memberof ConfirmShipmentRequest
      */
     'marketplaceId': string;
 }

package/dist/types/api-model/models/constraint-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Details the importance of the constraint present on the item
- * @export
- * @enum {string}
  */
 export declare const ConstraintType: {
     readonly Mandatory: "MANDATORY";

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

@@ -13,32 +13,19 @@ import type { OtherDeliveryAttributes } from './other-delivery-attributes';
 import type { PreferredDeliveryTime } from './preferred-delivery-time';
 /**
  * Contains all of the delivery instructions provided by the customer for the shipping address.
- * @export
- * @interface DeliveryPreferences
  */
 export interface DeliveryPreferences {
     /**
      * Drop-off location selected by the customer.
-     * @type {string}
-     * @memberof DeliveryPreferences
      */
     'DropOffLocation'?: string;
-    /**
-     *
-     * @type {PreferredDeliveryTime}
-     * @memberof DeliveryPreferences
-     */
     'PreferredDeliveryTime'?: PreferredDeliveryTime;
     /**
      * Enumerated list of miscellaneous delivery attributes associated with the shipping address.
-     * @type {Array<OtherDeliveryAttributes>}
-     * @memberof DeliveryPreferences
      */
     'OtherAttributes'?: Array<OtherDeliveryAttributes>;
     /**
      * Building instructions, nearby landmark or navigation instructions.
-     * @type {string}
-     * @memberof DeliveryPreferences
      */
     'AddressInstructions'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
- * @export
- * @enum {string}
  */
 export declare const EasyShipShipmentStatus: {
     readonly PendingSchedule: "PendingSchedule";

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

@@ -11,8 +11,6 @@
  */
 /**
  * The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.
- * @export
- * @enum {string}
  */
 export declare const ElectronicInvoiceStatus: {
     readonly NotRequired: "NotRequired";