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

package/src/externalfulfillmentshipments_v2024_09_11/api/ShipmentRetrievalApi.js

@@ -0,0 +1,182 @@
+/**
+ * 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 { ErrorList } from '../model/ErrorList.js'
+import { Shipment } from '../model/Shipment.js'
+import { ShipmentsResponse } from '../model/ShipmentsResponse.js'
+import { SuperagentRateLimiter } from '../../../helper/SuperagentRateLimiter.mjs'
+import { DefaultRateLimitFetcher } from '../../../helper/DefaultRateLimitFetcher.mjs'
+
+/**
+* ShipmentRetrieval service.
+* @module externalfulfillmentshipments_v2024_09_11/api/ShipmentRetrievalApi
+* @version 2024-09-11
+*/
+export class ShipmentRetrievalApi {
+  // Private member stores the default rate limiters
+  #defaultRateLimiterMap
+
+  /**
+    * Constructs a new ShipmentRetrievalApi.
+    * @alias module:externalfulfillmentshipments_v2024_09_11/api/ShipmentRetrievalApi
+    * @class
+    * @param {ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link ApiClient#instance} if unspecified.
+    */
+  constructor (apiClient) {
+    this.apiClient = apiClient || ApiClient.instance
+    this.initializeDefaultRateLimiterMap()
+  }
+
+  /**
+     * Initialize rate limiters for API operations
+     */
+  initializeDefaultRateLimiterMap () {
+    this.#defaultRateLimiterMap = new Map()
+    const defaultRateLimitFetcher = new DefaultRateLimitFetcher()
+    const operations = [
+      'ShipmentRetrievalApi-getShipment',
+      'ShipmentRetrievalApi-getShipments'
+    ]
+
+    for (const operation of operations) {
+      const config = defaultRateLimitFetcher.getLimit(operation)
+      this.#defaultRateLimiterMap.set(operation, new SuperagentRateLimiter(config))
+    }
+  }
+
+  /**
+     * Get rate limiter for a specific operation
+     * @param {String} operation name
+     */
+  getRateLimiter (operation) {
+    return this.#defaultRateLimiterMap.get(operation)
+  }
+
+  /**
+     * Get a single shipment with the ID you specify.
+     * @param {String} shipmentId The ID of the shipment you want to retrieve.
+     * @return {Promise<Shipment>}
+     */
+  getShipmentWithHttpInfo (shipmentId) {
+    const postBody = null
+
+    // verify the required parameter 'shipmentId' is set
+    if (shipmentId === undefined || shipmentId === null) {
+      throw new Error("Missing the required parameter 'shipmentId' when calling getShipment")
+    }
+
+    const pathParams = {
+      shipmentId
+    }
+    const queryParams = {
+    }
+    const headerParams = {
+    }
+    const formParams = {
+    }
+
+    const contentTypes = []
+    const accepts = ['application/json']
+    const returnType = Shipment
+
+    return this.apiClient.callApi('ShipmentRetrievalApi-getShipment',
+      '/externalFulfillment/2024-09-11/shipments/{shipmentId}', 'GET',
+      pathParams, queryParams, headerParams, formParams, postBody,
+      contentTypes, accepts, returnType, this.getRateLimiter('ShipmentRetrievalApi-getShipment')
+    )
+  }
+
+  /**
+     * Get a single shipment with the ID you specify.
+     * @param {String} shipmentId The ID of the shipment you want to retrieve.
+     * @return {Promise<Shipment>}
+     */
+  getShipment (shipmentId) {
+    return this.getShipmentWithHttpInfo(shipmentId)
+      .then(function (response_and_data) {
+        return response_and_data.data
+      })
+  }
+
+  /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments&#39; last update.
+     * @param {String} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;ACCEPTED&#x60;.
+     * @param {Object} [opts] Optional parameters
+     * @param {String} [opts.locationId] The Amazon channel location identifier for the shipments you want to retrieve.
+     * @param {String} [opts.marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {String} [opts.channelName] The channel name associated with the location.
+     * @param {String} [opts.lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {String} [opts.lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {Number} [opts.maxResults] The maximum number of shipments to include in the response.
+     * @param {String} [opts.paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @return {Promise<ShipmentsResponse>}
+     */
+  getShipmentsWithHttpInfo (status, opts) {
+    opts = opts || {}
+    const postBody = null
+
+    // verify the required parameter 'status' is set
+    if (status === undefined || status === null) {
+      throw new Error("Missing the required parameter 'status' when calling getShipments")
+    }
+
+    const pathParams = {
+    }
+    const queryParams = {
+      locationId: opts.locationId,
+      marketplaceId: opts.marketplaceId,
+      channelName: opts.channelName,
+      status,
+      lastUpdatedAfter: opts.lastUpdatedAfter,
+      lastUpdatedBefore: opts.lastUpdatedBefore,
+      maxResults: opts.maxResults,
+      paginationToken: opts.paginationToken
+    }
+    const headerParams = {
+    }
+    const formParams = {
+    }
+
+    const contentTypes = []
+    const accepts = ['application/json']
+    const returnType = ShipmentsResponse
+
+    return this.apiClient.callApi('ShipmentRetrievalApi-getShipments',
+      '/externalFulfillment/2024-09-11/shipments', 'GET',
+      pathParams, queryParams, headerParams, formParams, postBody,
+      contentTypes, accepts, returnType, this.getRateLimiter('ShipmentRetrievalApi-getShipments')
+    )
+  }
+
+  /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments&#39; last update.
+     * @param {String} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;ACCEPTED&#x60;.
+     * @param {Object} [opts] Optional parameters
+     * @param {String} [opts.locationId] The Amazon channel location identifier for the shipments you want to retrieve.
+     * @param {String} [opts.marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {String} [opts.channelName] The channel name associated with the location.
+     * @param {String} [opts.lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {String} [opts.lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {Number} [opts.maxResults] The maximum number of shipments to include in the response.
+     * @param {String} [opts.paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @return {Promise<ShipmentsResponse>}
+     */
+  getShipments (status, opts) {
+    return this.getShipmentsWithHttpInfo(status, opts)
+      .then(function (response_and_data) {
+        return response_and_data.data
+      })
+  }
+}

package/src/externalfulfillmentshipments_v2024_09_11/index.d.ts

@@ -0,0 +1,62 @@
+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';
+export { ApiClient, Address, Amount, Cancellation, Charge, ChargeBreakup, ComplianceAttributes, CourierSupportedAttributes, CustomAttribute, CustomAttributeType, Dimension, Document, DocumentV2, Error, ErrorList, GiftAttributes, InvoiceInfo, InvoiceRequirement, InvoiceResponse, LineItem, LineItemWithReason, MarketplaceAttributes, OriginalLineItem, Package, PackageDeliveryStatus, PackageDimensions, PackageLineItem, PackageShipLabel, PackageStatus, PackageSubStatus, Packages, PackingSlipRequirement, Pagination, PartyIdentificationInfo, PieceType, PresenceStatus, Priority, RecommendedPackage, RecommendedPackageLineItem, ReplacedShipmentInfo, RequirementLevel, ShipLabelMetadata, ShipLabelsInput, ShipLabelsResponse, Shipment, ShipmentAcknowledgementRequest, ShipmentInfo, ShipmentLineItem, ShipmentRequirements, ShipmentsResponse, ShippingInfo, ShippingOptions, ShippingOptionsResponse, Status, Tax, TaxRegistrationInfo, TimeWindow, Weight, ShipmentProcessingApi, ShipmentRetrievalApi };
+//# sourceMappingURL=index.d.ts.map

package/src/externalfulfillmentshipments_v2024_09_11/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"0BAa0B,gBAAgB;wBAClB,oBAAoB;uBACrB,mBAAmB;6BACb,yBAAyB;uBAC/B,mBAAmB;8BACZ,0BAA0B;qCACnB,iCAAiC;2CAC3B,uCAAuC;gCAClD,4BAA4B;oCACxB,gCAAgC;0BAC1C,sBAAsB;yBACvB,qBAAqB;2BACnB,uBAAuB;sBAC5B,kBAAkB;0BACd,sBAAsB;+BACjB,2BAA2B;4BAC9B,wBAAwB;mCACjB,+BAA+B;gCAClC,4BAA4B;yBACnC,qBAAqB;mCACX,+BAA+B;sCAC5B,kCAAkC;iCACvC,6BAA6B;wBACtC,oBAAoB;sCACN,kCAAkC;kCACtC,8BAA8B;gCAChC,4BAA4B;iCAC3B,6BAA6B;8BAChC,0BAA0B;iCACvB,6BAA6B;yBACrC,qBAAqB;uCACP,mCAAmC;2BAC/C,uBAAuB;wCACV,oCAAoC;0BAClD,sBAAsB;+BACjB,2BAA2B;yBACjC,qBAAqB;mCACX,+BAA+B;2CACvB,uCAAuC;qCAC7C,iCAAiC;iCACrC,6BAA6B;kCAC5B,8BAA8B;gCAChC,4BAA4B;mCACzB,+BAA+B;yBACzC,qBAAqB;+CACC,2CAA2C;6BAC7D,yBAAyB;iCACrB,6BAA6B;qCACzB,iCAAiC;kCACpC,8BAA8B;6BACnC,yBAAyB;gCACtB,4BAA4B;wCACpB,oCAAoC;uBACrD,mBAAmB;oBACtB,gBAAgB;oCACA,gCAAgC;2BACzC,uBAAuB;uBAC3B,mBAAmB;sCACJ,gCAAgC;qCACjC,+BAA+B"}