@amazon-sp-api-release/amazon-sp-api-sdk-js 1.5.0 → 1.6.1-alpha.0

package/src/externalfulfillmentshipments_v2024_09_11/index.js

@@ -0,0 +1,441 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import { ApiClient } from './ApiClient.js'
+import { Address } from './model/Address.js'
+import { Amount } from './model/Amount.js'
+import { Cancellation } from './model/Cancellation.js'
+import { Charge } from './model/Charge.js'
+import { ChargeBreakup } from './model/ChargeBreakup.js'
+import { ComplianceAttributes } from './model/ComplianceAttributes.js'
+import { CourierSupportedAttributes } from './model/CourierSupportedAttributes.js'
+import { CustomAttribute } from './model/CustomAttribute.js'
+import { CustomAttributeType } from './model/CustomAttributeType.js'
+import { Dimension } from './model/Dimension.js'
+import { Document } from './model/Document.js'
+import { DocumentV2 } from './model/DocumentV2.js'
+import { Error } from './model/Error.js'
+import { ErrorList } from './model/ErrorList.js'
+import { GiftAttributes } from './model/GiftAttributes.js'
+import { InvoiceInfo } from './model/InvoiceInfo.js'
+import { InvoiceRequirement } from './model/InvoiceRequirement.js'
+import { InvoiceResponse } from './model/InvoiceResponse.js'
+import { LineItem } from './model/LineItem.js'
+import { LineItemWithReason } from './model/LineItemWithReason.js'
+import { MarketplaceAttributes } from './model/MarketplaceAttributes.js'
+import { OriginalLineItem } from './model/OriginalLineItem.js'
+import { Package } from './model/Package.js'
+import { PackageDeliveryStatus } from './model/PackageDeliveryStatus.js'
+import { PackageDimensions } from './model/PackageDimensions.js'
+import { PackageLineItem } from './model/PackageLineItem.js'
+import { PackageShipLabel } from './model/PackageShipLabel.js'
+import { PackageStatus } from './model/PackageStatus.js'
+import { PackageSubStatus } from './model/PackageSubStatus.js'
+import { Packages } from './model/Packages.js'
+import { PackingSlipRequirement } from './model/PackingSlipRequirement.js'
+import { Pagination } from './model/Pagination.js'
+import { PartyIdentificationInfo } from './model/PartyIdentificationInfo.js'
+import { PieceType } from './model/PieceType.js'
+import { PresenceStatus } from './model/PresenceStatus.js'
+import { Priority } from './model/Priority.js'
+import { RecommendedPackage } from './model/RecommendedPackage.js'
+import { RecommendedPackageLineItem } from './model/RecommendedPackageLineItem.js'
+import { ReplacedShipmentInfo } from './model/ReplacedShipmentInfo.js'
+import { RequirementLevel } from './model/RequirementLevel.js'
+import { ShipLabelMetadata } from './model/ShipLabelMetadata.js'
+import { ShipLabelsInput } from './model/ShipLabelsInput.js'
+import { ShipLabelsResponse } from './model/ShipLabelsResponse.js'
+import { Shipment } from './model/Shipment.js'
+import { ShipmentAcknowledgementRequest } from './model/ShipmentAcknowledgementRequest.js'
+import { ShipmentInfo } from './model/ShipmentInfo.js'
+import { ShipmentLineItem } from './model/ShipmentLineItem.js'
+import { ShipmentRequirements } from './model/ShipmentRequirements.js'
+import { ShipmentsResponse } from './model/ShipmentsResponse.js'
+import { ShippingInfo } from './model/ShippingInfo.js'
+import { ShippingOptions } from './model/ShippingOptions.js'
+import { ShippingOptionsResponse } from './model/ShippingOptionsResponse.js'
+import { Status } from './model/Status.js'
+import { Tax } from './model/Tax.js'
+import { TaxRegistrationInfo } from './model/TaxRegistrationInfo.js'
+import { TimeWindow } from './model/TimeWindow.js'
+import { Weight } from './model/Weight.js'
+import { ShipmentProcessingApi } from './api/ShipmentProcessingApi.js'
+import { ShipmentRetrievalApi } from './api/ShipmentRetrievalApi.js'
+
+/**
+* You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon&#39;s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements..<br>
+* The <code>index</code> module provides access to constructors for all the classes which comprise the public API.
+* @module externalfulfillmentshipments_v2024_09_11/index
+* @version 2024-09-11
+*/
+export {
+  /**
+     * The ApiClient constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/ApiClient}
+     */
+  ApiClient,
+
+  /**
+     * The Address model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Address}
+     */
+  Address,
+
+  /**
+     * The Amount model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Amount}
+     */
+  Amount,
+
+  /**
+     * The Cancellation model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Cancellation}
+     */
+  Cancellation,
+
+  /**
+     * The Charge model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Charge}
+     */
+  Charge,
+
+  /**
+     * The ChargeBreakup model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ChargeBreakup}
+     */
+  ChargeBreakup,
+
+  /**
+     * The ComplianceAttributes model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ComplianceAttributes}
+     */
+  ComplianceAttributes,
+
+  /**
+     * The CourierSupportedAttributes model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/CourierSupportedAttributes}
+     */
+  CourierSupportedAttributes,
+
+  /**
+     * The CustomAttribute model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/CustomAttribute}
+     */
+  CustomAttribute,
+
+  /**
+     * The CustomAttributeType model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/CustomAttributeType}
+     */
+  CustomAttributeType,
+
+  /**
+     * The Dimension model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Dimension}
+     */
+  Dimension,
+
+  /**
+     * The Document model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Document}
+     */
+  Document,
+
+  /**
+     * The DocumentV2 model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/DocumentV2}
+     */
+  DocumentV2,
+
+  /**
+     * The Error model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Error}
+     */
+  Error,
+
+  /**
+     * The ErrorList model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ErrorList}
+     */
+  ErrorList,
+
+  /**
+     * The GiftAttributes model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/GiftAttributes}
+     */
+  GiftAttributes,
+
+  /**
+     * The InvoiceInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/InvoiceInfo}
+     */
+  InvoiceInfo,
+
+  /**
+     * The InvoiceRequirement model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/InvoiceRequirement}
+     */
+  InvoiceRequirement,
+
+  /**
+     * The InvoiceResponse model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/InvoiceResponse}
+     */
+  InvoiceResponse,
+
+  /**
+     * The LineItem model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/LineItem}
+     */
+  LineItem,
+
+  /**
+     * The LineItemWithReason model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/LineItemWithReason}
+     */
+  LineItemWithReason,
+
+  /**
+     * The MarketplaceAttributes model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/MarketplaceAttributes}
+     */
+  MarketplaceAttributes,
+
+  /**
+     * The OriginalLineItem model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/OriginalLineItem}
+     */
+  OriginalLineItem,
+
+  /**
+     * The Package model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Package}
+     */
+  Package,
+
+  /**
+     * The PackageDeliveryStatus model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageDeliveryStatus}
+     */
+  PackageDeliveryStatus,
+
+  /**
+     * The PackageDimensions model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageDimensions}
+     */
+  PackageDimensions,
+
+  /**
+     * The PackageLineItem model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageLineItem}
+     */
+  PackageLineItem,
+
+  /**
+     * The PackageShipLabel model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageShipLabel}
+     */
+  PackageShipLabel,
+
+  /**
+     * The PackageStatus model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageStatus}
+     */
+  PackageStatus,
+
+  /**
+     * The PackageSubStatus model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackageSubStatus}
+     */
+  PackageSubStatus,
+
+  /**
+     * The Packages model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Packages}
+     */
+  Packages,
+
+  /**
+     * The PackingSlipRequirement model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PackingSlipRequirement}
+     */
+  PackingSlipRequirement,
+
+  /**
+     * The Pagination model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Pagination}
+     */
+  Pagination,
+
+  /**
+     * The PartyIdentificationInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PartyIdentificationInfo}
+     */
+  PartyIdentificationInfo,
+
+  /**
+     * The PieceType model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PieceType}
+     */
+  PieceType,
+
+  /**
+     * The PresenceStatus model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/PresenceStatus}
+     */
+  PresenceStatus,
+
+  /**
+     * The Priority model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Priority}
+     */
+  Priority,
+
+  /**
+     * The RecommendedPackage model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/RecommendedPackage}
+     */
+  RecommendedPackage,
+
+  /**
+     * The RecommendedPackageLineItem model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/RecommendedPackageLineItem}
+     */
+  RecommendedPackageLineItem,
+
+  /**
+     * The ReplacedShipmentInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ReplacedShipmentInfo}
+     */
+  ReplacedShipmentInfo,
+
+  /**
+     * The RequirementLevel model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/RequirementLevel}
+     */
+  RequirementLevel,
+
+  /**
+     * The ShipLabelMetadata model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelMetadata}
+     */
+  ShipLabelMetadata,
+
+  /**
+     * The ShipLabelsInput model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput}
+     */
+  ShipLabelsInput,
+
+  /**
+     * The ShipLabelsResponse model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse}
+     */
+  ShipLabelsResponse,
+
+  /**
+     * The Shipment model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Shipment}
+     */
+  Shipment,
+
+  /**
+     * The ShipmentAcknowledgementRequest model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest}
+     */
+  ShipmentAcknowledgementRequest,
+
+  /**
+     * The ShipmentInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipmentInfo}
+     */
+  ShipmentInfo,
+
+  /**
+     * The ShipmentLineItem model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipmentLineItem}
+     */
+  ShipmentLineItem,
+
+  /**
+     * The ShipmentRequirements model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipmentRequirements}
+     */
+  ShipmentRequirements,
+
+  /**
+     * The ShipmentsResponse model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShipmentsResponse}
+     */
+  ShipmentsResponse,
+
+  /**
+     * The ShippingInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShippingInfo}
+     */
+  ShippingInfo,
+
+  /**
+     * The ShippingOptions model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShippingOptions}
+     */
+  ShippingOptions,
+
+  /**
+     * The ShippingOptionsResponse model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/ShippingOptionsResponse}
+     */
+  ShippingOptionsResponse,
+
+  /**
+     * The Status model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Status}
+     */
+  Status,
+
+  /**
+     * The Tax model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Tax}
+     */
+  Tax,
+
+  /**
+     * The TaxRegistrationInfo model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/TaxRegistrationInfo}
+     */
+  TaxRegistrationInfo,
+
+  /**
+     * The TimeWindow model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/TimeWindow}
+     */
+  TimeWindow,
+
+  /**
+     * The Weight model constructor.
+     * @property {module:externalfulfillmentshipments_v2024_09_11/model/Weight}
+     */
+  Weight,
+
+  /**
+    * The ShipmentProcessingApi service constructor.
+    * @property {module:externalfulfillmentshipments_v2024_09_11/api/ShipmentProcessingApi}
+    */
+  ShipmentProcessingApi,
+
+  /**
+    * The ShipmentRetrievalApi service constructor.
+    * @property {module:externalfulfillmentshipments_v2024_09_11/api/ShipmentRetrievalApi}
+    */
+  ShipmentRetrievalApi
+}

package/src/externalfulfillmentshipments_v2024_09_11/model/Address.d.ts

@@ -0,0 +1,103 @@
+/**
+ * The Address model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/Address
+ * @version 2024-09-11
+ */
+export class Address {
+    /**
+     * Constructs a <code>Address</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {Address} obj Optional instance to populate.
+     * @return {Address} The populated <code>Address</code> instance.
+     */
+    static constructFromObject(data: any, obj: Address): Address;
+    /**
+     * Constructs a new <code>Address</code>.
+     * The address.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/Address
+     * @class
+     * @param postalCode {String} The postal code of the address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
+     */
+    constructor(postalCode: string);
+    postalCode: string;
+    /**
+     * The name of the person, business or institution at that address.
+     * @member {String} name
+     * @type {String}
+     */
+    name: string;
+    /**
+     * The first line of the address.
+     * @member {String} addressLine1
+     * @type {String}
+     */
+    addressLine1: string;
+    /**
+     * Additional address information, if required.
+     * @member {String} addressLine2
+     * @type {String}
+     */
+    addressLine2: string;
+    /**
+     * Additional address information, if required.
+     * @member {String} addressLine3
+     * @type {String}
+     */
+    addressLine3: string;
+    /**
+     * The district or state where the person, business, or institution is located.
+     * @member {String} district
+     * @type {String}
+     */
+    district: string;
+    /**
+     * The municiplaity where the person, business, or institution is located.
+     * @member {String} municipality
+     * @type {String}
+     */
+    municipality: string;
+    /**
+     * The state or region where the person, business, or institution is located.
+     * @member {String} state
+     * @type {String}
+     */
+    state: string;
+    /**
+     * The city where the person, business, or institution is located.
+     * @member {String} city
+     * @type {String}
+     */
+    city: string;
+    /**
+     * The two digit country code. In ISO 3166-1 alpha-2 format.
+     * @member {String} countryCode
+     * @type {String}
+     */
+    countryCode: string;
+    /**
+     * The email address of the contact associated with the address.
+     * @member {String} email
+     * @type {String}
+     */
+    email: string;
+    /**
+     * The email cc addresses of the contact associated with the address.
+     * @member {[String]} copyEmails
+     * @type {[String]}
+     */
+    copyEmails: [string];
+    /**
+     * The phone number of the person, business, or institution located at the address.
+     * @member {String} phoneNumber
+     * @type {String}
+     */
+    phoneNumber: string;
+    /**
+     * The type of address.
+     * @member {String} addressType
+     * @type {String}
+     */
+    addressType: string;
+}
+//# sourceMappingURL=Address.d.ts.map

package/src/externalfulfillmentshipments_v2024_09_11/model/Address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Address.d.ts","sourceRoot":"","sources":["Address.js"],"names":[],"mappings":"AAeA;;;;GAIG;AACH;IAYE;;;;;;OAMG;IACH,2CAHW,OAAO,GACN,OAAO,CAgClB;IAhDD;;;;;;OAMG;IACH,gCAEC;IADC,mBAA4B;IA2ChC;;;;OAIG;IACH,aAAsB;IAEtB;;;;OAIG;IACH,qBAA8B;IAE9B;;;;OAIG;IACH,qBAA8B;IAE9B;;;;OAIG;IACH,qBAA8B;IAE9B;;;;OAIG;IACH,iBAA0B;IAE1B;;;;OAIG;IACH,qBAA8B;IAE9B;;;;OAIG;IACH,cAAuB;IAEvB;;;;OAIG;IACH,aAAsB;IAEtB;;;;OAIG;IACH,oBAA6B;IAS7B;;;;OAIG;IACH,cAAuB;IAEvB;;;;OAIG;IACH,YAFU,QAAQ,CAEU;IAE5B;;;;OAIG;IACH,oBAA6B;IAE7B;;;;OAIG;IACH,oBAA6B;CAlG5B"}