@amazon-sp-api-release/amazon-sp-api-sdk-js 1.5.0 → 1.6.0

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipLabelMetadata.js

@@ -0,0 +1,98 @@
+/**
+ * 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 { TimeWindow } from './TimeWindow.js'
+
+/**
+ * The ShipLabelMetadata model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipLabelMetadata
+ * @version 2024-09-11
+ */
+export class ShipLabelMetadata {
+  /**
+   * Constructs a new <code>ShipLabelMetadata</code>.
+   * Metadata for a ship label document.
+   * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelMetadata
+   * @class
+   * @param carrierName {String} The name of the carrier.
+   * @param trackingId {String} The tracking number of the package.
+   */
+  constructor (carrierName, trackingId) {
+    this.carrierName = carrierName
+    this.trackingId = trackingId
+  }
+
+  /**
+   * Constructs a <code>ShipLabelMetadata</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 {ShipLabelMetadata} obj Optional instance to populate.
+   * @return {ShipLabelMetadata} The populated <code>ShipLabelMetadata</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new ShipLabelMetadata()
+      if (data.hasOwnProperty('shippingOptionId')) { obj.shippingOptionId = ApiClient.convertToType(data.shippingOptionId, 'String') }
+      if (data.hasOwnProperty('carrierName')) { obj.carrierName = ApiClient.convertToType(data.carrierName, 'String') }
+      if (data.hasOwnProperty('trackingId')) { obj.trackingId = ApiClient.convertToType(data.trackingId, 'String') }
+      if (data.hasOwnProperty('pickupWindow')) { obj.pickupWindow = TimeWindow.constructFromObject(data.pickupWindow) }
+      if (data.hasOwnProperty('timeSlot')) { obj.timeSlot = TimeWindow.constructFromObject(data.timeSlot) }
+    }
+    return obj
+  }
+}
+
+/**
+ * The selected slot for the ship label.
+ * @member {String} shippingOptionId
+ * @type {String}
+ */
+ShipLabelMetadata.prototype.shippingOptionId = undefined
+
+/**
+ * The name of the carrier.
+ * @member {String} carrierName
+ * @type {String}
+ */
+ShipLabelMetadata.prototype.carrierName = undefined
+
+/**
+ * The tracking number of the package.
+ * @member {String} trackingId
+ * @type {String}
+ */
+ShipLabelMetadata.prototype.trackingId = undefined
+
+/**
+ * @member {TimeWindow} pickupWindow
+ * @type {TimeWindow}
+ */
+ShipLabelMetadata.prototype.pickupWindow = undefined
+
+/**
+ * @member {TimeWindow} timeSlot
+ * @type {TimeWindow}
+ */
+ShipLabelMetadata.prototype.timeSlot = undefined

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

@@ -0,0 +1,31 @@
+/**
+ * The ShipLabelsInput model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput
+ * @version 2024-09-11
+ */
+export class ShipLabelsInput {
+    /**
+     * Constructs a <code>ShipLabelsInput</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 {ShipLabelsInput} obj Optional instance to populate.
+     * @return {ShipLabelsInput} The populated <code>ShipLabelsInput</code> instance.
+     */
+    static constructFromObject(data: any, obj: ShipLabelsInput): ShipLabelsInput;
+    /**
+     * Constructs a new <code>ShipLabelsInput</code>.
+     * Tracking details for multiple packages.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput
+     * @class
+     * @param packageIds {[String]} The subset of package IDs used to generate a label.
+     */
+    constructor(packageIds: [string]);
+    packageIds: [string];
+    /**
+     * @member {CourierSupportedAttributes} courierSupportedAttributes
+     * @type {CourierSupportedAttributes}
+     */
+    courierSupportedAttributes: CourierSupportedAttributes;
+}
+import { CourierSupportedAttributes } from './CourierSupportedAttributes.js';
+//# sourceMappingURL=ShipLabelsInput.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShipLabelsInput.d.ts","sourceRoot":"","sources":["ShipLabelsInput.js"],"names":[],"mappings":"AAgBA;;;;GAIG;AACH;IAYE;;;;;;OAMG;IACH,2CAHW,eAAe,GACd,eAAe,CAoB1B;IApCD;;;;;;OAMG;IACH,wBAFsB,QAAQ,EAI7B;IADC,qBAA4B;IAsChC;;;OAGG;IACH,4BAFU,0BAA0B,CAEgB;CAbnD;2CA7C0C,iCAAiC"}

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput.js

@@ -0,0 +1,73 @@
+/**
+ * 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 { CourierSupportedAttributes } from './CourierSupportedAttributes.js'
+
+/**
+ * The ShipLabelsInput model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput
+ * @version 2024-09-11
+ */
+export class ShipLabelsInput {
+  /**
+   * Constructs a new <code>ShipLabelsInput</code>.
+   * Tracking details for multiple packages.
+   * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsInput
+   * @class
+   * @param packageIds {[String]} The subset of package IDs used to generate a label.
+   */
+  constructor (packageIds) {
+    this.packageIds = packageIds
+  }
+
+  /**
+   * Constructs a <code>ShipLabelsInput</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 {ShipLabelsInput} obj Optional instance to populate.
+   * @return {ShipLabelsInput} The populated <code>ShipLabelsInput</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new ShipLabelsInput()
+      if (data.hasOwnProperty('packageIds')) { obj.packageIds = ApiClient.convertToType(data.packageIds, ['String']) }
+      if (data.hasOwnProperty('courierSupportedAttributes')) { obj.courierSupportedAttributes = CourierSupportedAttributes.constructFromObject(data.courierSupportedAttributes) }
+    }
+    return obj
+  }
+}
+
+/**
+ * The subset of package IDs used to generate a label.
+ * @member {[String]} packageIds
+ * @type {[String]}
+ */
+ShipLabelsInput.prototype.packageIds = undefined
+
+/**
+ * @member {CourierSupportedAttributes} courierSupportedAttributes
+ * @type {CourierSupportedAttributes}
+ */
+ShipLabelsInput.prototype.courierSupportedAttributes = undefined

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

@@ -0,0 +1,26 @@
+/**
+ * The ShipLabelsResponse model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse
+ * @version 2024-09-11
+ */
+export class ShipLabelsResponse {
+    /**
+     * Constructs a <code>ShipLabelsResponse</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 {ShipLabelsResponse} obj Optional instance to populate.
+     * @return {ShipLabelsResponse} The populated <code>ShipLabelsResponse</code> instance.
+     */
+    static constructFromObject(data: any, obj: ShipLabelsResponse): ShipLabelsResponse;
+    /**
+     * Constructs a new <code>ShipLabelsResponse</code>.
+     * The response to the &#x60;generateShipLabels&#x60; operation.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse
+     * @class
+     * @param packageShipLabelList {[PackageShipLabel]} A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.
+     */
+    constructor(packageShipLabelList: [PackageShipLabel]);
+    packageShipLabelList: [PackageShipLabel];
+}
+import { PackageShipLabel } from './PackageShipLabel.js';
+//# sourceMappingURL=ShipLabelsResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShipLabelsResponse.d.ts","sourceRoot":"","sources":["ShipLabelsResponse.js"],"names":[],"mappings":"AAgBA;;;;GAIG;AACH;IAYE;;;;;;OAMG;IACH,2CAHW,kBAAkB,GACjB,kBAAkB,CAmB7B;IAnCD;;;;;;OAMG;IACH,kCAFgC,CAAC,gBAAgB,CAAC,EAIjD;IADC,yCAAgD;CA4BnD;iCA5CgC,uBAAuB"}

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse.js

@@ -0,0 +1,66 @@
+/**
+ * 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 { PackageShipLabel } from './PackageShipLabel.js'
+
+/**
+ * The ShipLabelsResponse model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse
+ * @version 2024-09-11
+ */
+export class ShipLabelsResponse {
+  /**
+   * Constructs a new <code>ShipLabelsResponse</code>.
+   * The response to the &#x60;generateShipLabels&#x60; operation.
+   * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipLabelsResponse
+   * @class
+   * @param packageShipLabelList {[PackageShipLabel]} A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.
+   */
+  constructor (packageShipLabelList) {
+    this.packageShipLabelList = packageShipLabelList
+  }
+
+  /**
+   * Constructs a <code>ShipLabelsResponse</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 {ShipLabelsResponse} obj Optional instance to populate.
+   * @return {ShipLabelsResponse} The populated <code>ShipLabelsResponse</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new ShipLabelsResponse()
+      if (data.hasOwnProperty('packageShipLabelList')) { obj.packageShipLabelList = ApiClient.convertToType(data.packageShipLabelList, [PackageShipLabel]) }
+    }
+    return obj
+  }
+}
+
+/**
+ * A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.
+ * @member {[PackageShipLabel]} packageShipLabelList
+ * @type {[PackageShipLabel]}
+ */
+ShipLabelsResponse.prototype.packageShipLabelList = undefined

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

@@ -0,0 +1,122 @@
+/**
+ * The Shipment model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/Shipment
+ * @version 2024-09-11
+ */
+export class Shipment {
+    /**
+     * Constructs a <code>Shipment</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 {Shipment} obj Optional instance to populate.
+     * @return {Shipment} The populated <code>Shipment</code> instance.
+     */
+    static constructFromObject(data: any, obj: Shipment): Shipment;
+    /**
+     * Constructs a new <code>Shipment</code>.
+     * Information about a shipment.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/Shipment
+     * @class
+     * @param id {String} The shipment's ID.
+     * @param locationId {String} The location identifier of the seller's location in the marketplace channel to which the shipment has been created for fulfillment.
+     * @param marketplaceAttributes {MarketplaceAttributes}
+     * @param shipmentInfo {ShipmentInfo}
+     * @param shipmentRequirements {ShipmentRequirements}
+     * @param charges {[Charge]} The charges associated with the shipment.
+     * @param status {String} The current status of the shipment.
+     * @param lineItems {[ShipmentLineItem]} The line items in the shipment.
+     * @param shippingInfo {ShippingInfo}
+     * @param creationDateTime {String} A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     * @param lastUpdatedDateTime {String} A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     */
+    constructor(id: string, locationId: string, marketplaceAttributes: MarketplaceAttributes, shipmentInfo: ShipmentInfo, shipmentRequirements: ShipmentRequirements, charges: [Charge], status: string, lineItems: [ShipmentLineItem], shippingInfo: ShippingInfo, creationDateTime: string, lastUpdatedDateTime: string);
+    id: string;
+    locationId: string;
+    marketplaceAttributes: MarketplaceAttributes;
+    shipmentInfo: ShipmentInfo;
+    shipmentRequirements: ShipmentRequirements;
+    charges: [Charge];
+    status: string;
+    lineItems: [ShipmentLineItem];
+    shippingInfo: ShippingInfo;
+    creationDateTime: string;
+    lastUpdatedDateTime: string;
+    /**
+     * @member {InvoiceInfo} invoiceInfo
+     * @type {InvoiceInfo}
+     */
+    invoiceInfo: InvoiceInfo;
+    /**
+     * All involved party identification and metadata for the vendor, buyer, and seller. Applicable for direct-fulfillment sellers.
+     * @member {[PartyIdentificationInfo]} partyInfoList
+     * @type {[PartyIdentificationInfo]}
+     */
+    partyInfoList: [PartyIdentificationInfo];
+    /**
+     * The sub status of the shipment.
+     * @member {String} subStatus
+     * @type {String}
+     */
+    subStatus: string;
+    /**
+     * The list of packages in the shipment.
+     * @member {[Package]} packages
+     * @type {[Package]}
+     */
+    packages: [Package];
+    /**
+     * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     * @member {String} earliestPackDateTime
+     * @type {String}
+     */
+    earliestPackDateTime: string;
+}
+export namespace Shipment {
+    namespace StatusEnum {
+        let CREATED: string;
+        let ACCEPTED: string;
+        let CONFIRMED: string;
+        let PACKAGE_CREATED: string;
+        let PICKUP_SLOT_RETRIEVED: string;
+        let INVOICE_GENERATED: string;
+        let SHIPLABEL_GENERATED: string;
+        let CANCELLED: string;
+        let SHIPPED: string;
+        let DELIVERED: string;
+    }
+    /**
+     * *
+     */
+    type StatusEnum = string;
+    namespace SubStatusEnum {
+        export let PENDING_SCHEDULE: string;
+        export let PENDING_PICKUP: string;
+        export let PENDING_DROP_OFF: string;
+        export let LABEL_CANCELED: string;
+        export let PICKED_UP: string;
+        export let DROPPED_OFF: string;
+        export let AT_ORIGIN_FC: string;
+        export let AT_DESTINATION_FC: string;
+        let DELIVERED_1: string;
+        export { DELIVERED_1 as DELIVERED };
+        export let NOT_DELIVERED: string;
+        export let UNDELIVERABLE: string;
+        export let LOST: string;
+        export let OUT_FOR_DELIVERY: string;
+        export let DAMAGED: string;
+    }
+    /**
+     * *
+     */
+    type SubStatusEnum = string;
+}
+import { MarketplaceAttributes } from './MarketplaceAttributes.js';
+import { ShipmentInfo } from './ShipmentInfo.js';
+import { ShipmentRequirements } from './ShipmentRequirements.js';
+import { Charge } from './Charge.js';
+import { ShipmentLineItem } from './ShipmentLineItem.js';
+import { ShippingInfo } from './ShippingInfo.js';
+import { InvoiceInfo } from './InvoiceInfo.js';
+import { PartyIdentificationInfo } from './PartyIdentificationInfo.js';
+import { Package } from './Package.js';
+//# sourceMappingURL=Shipment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Shipment.d.ts","sourceRoot":"","sources":["Shipment.js"],"names":[],"mappings":"AAwBA;;;;GAIG;AACH;IAgCE;;;;;;OAMG;IACH,2CAHW,QAAQ,GACP,QAAQ,CAkCnB;IAtED;;;;;;;;;;;;;;;;OAgBG;IACH,mEAViC,qBAAqB,gBAC9B,YAAY,wBACJ,oBAAoB,WACjC,CAAC,MAAM,CAAC,6BAEN,CAAC,gBAAgB,CAAC,gBACf,YAAY,yDAgBnC;IAXC,WAAY;IACZ,mBAA4B;IAC5B,6CAAkD;IAClD,2BAAgC;IAChC,2CAAgD;IAChD,kBAAsB;IACtB,eAAoB;IACpB,8BAA0B;IAC1B,2BAAgC;IAChC,yBAAwC;IACxC,4BAA8C;IAuElD;;;OAGG;IACH,aAFU,WAAW,CAES;IAE9B;;;;OAIG;IACH,eAFU,CAAC,uBAAuB,CAAC,CAEH;IAsLhC;;;;OAIG;IACH,kBAA4B;IAe5B;;;;OAIG;IACH,UAFU,CAAC,OAAO,CAAC,CAEQ;IAgB3B;;;;OAIG;IACH,6BAAuC;CA3QtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCArFqC,4BAA4B;6BAGrC,mBAAmB;qCAEX,2BAA2B;uBAPzC,aAAa;iCAMH,uBAAuB;6BAE3B,mBAAmB;4BAPpB,kBAAkB;wCAGN,8BAA8B;wBAD9C,cAAc"}