@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 4.0.0 → 4.0.2

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

@@ -11,32 +11,22 @@
  */
 /**
  * Physical dimensional measurements of a container.
- * @export
- * @interface Dimensions
  */
 export interface Dimensions {
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`.
-     * @type {string}
-     * @memberof Dimensions
      */
     'length': string;
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`.
-     * @type {string}
-     * @memberof Dimensions
      */
     'width': string;
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`.
-     * @type {string}
-     * @memberof Dimensions
      */
     'height': string;
     /**
      * The unit of measure for dimensions.
-     * @type {string}
-     * @memberof Dimensions
      */
     'unitOfMeasure': DimensionsUnitOfMeasureEnum;
 }

package/dist/types/api-model/models/get-customer-invoice-response.d.ts

@@ -12,20 +12,11 @@
 import type { CustomerInvoice } from './customer-invoice';
 /**
  * The response schema for the getCustomerInvoice operation.
- * @export
- * @interface GetCustomerInvoiceResponse
  */
 export interface GetCustomerInvoiceResponse {
-    /**
-     *
-     * @type {CustomerInvoice}
-     * @memberof GetCustomerInvoiceResponse
-     */
     'payload'?: CustomerInvoice;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetCustomerInvoiceResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-customer-invoices-response.d.ts

@@ -12,20 +12,11 @@
 import type { CustomerInvoiceList } from './customer-invoice-list';
 /**
  * The response schema for the getCustomerInvoices operation.
- * @export
- * @interface GetCustomerInvoicesResponse
  */
 export interface GetCustomerInvoicesResponse {
-    /**
-     *
-     * @type {CustomerInvoiceList}
-     * @memberof GetCustomerInvoicesResponse
-     */
     'payload'?: CustomerInvoiceList;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetCustomerInvoicesResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-packing-slip-list-response.d.ts

@@ -12,20 +12,11 @@
 import type { PackingSlipList } from './packing-slip-list';
 /**
  * Response payload with the list of Packing Slips.
- * @export
- * @interface GetPackingSlipListResponse
  */
 export interface GetPackingSlipListResponse {
-    /**
-     *
-     * @type {PackingSlipList}
-     * @memberof GetPackingSlipListResponse
-     */
     'payload'?: PackingSlipList;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetPackingSlipListResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-packing-slip-response.d.ts

@@ -12,20 +12,11 @@
 import type { PackingSlip } from './packing-slip';
 /**
  * Response payload with packing slip.
- * @export
- * @interface GetPackingSlipResponse
  */
 export interface GetPackingSlipResponse {
-    /**
-     *
-     * @type {PackingSlip}
-     * @memberof GetPackingSlipResponse
-     */
     'payload'?: PackingSlip;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetPackingSlipResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-shipping-label-list-response.d.ts

@@ -12,20 +12,11 @@
 import type { ShippingLabelList } from './shipping-label-list';
 /**
  * The response schema for the getShippingLabels operation.
- * @export
- * @interface GetShippingLabelListResponse
  */
 export interface GetShippingLabelListResponse {
-    /**
-     *
-     * @type {ShippingLabelList}
-     * @memberof GetShippingLabelListResponse
-     */
     'payload'?: ShippingLabelList;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetShippingLabelListResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-shipping-label-response.d.ts

@@ -12,20 +12,11 @@
 import type { ShippingLabel } from './shipping-label';
 /**
  * The response schema for the getShippingLabel operation.
- * @export
- * @interface GetShippingLabelResponse
  */
 export interface GetShippingLabelResponse {
-    /**
-     *
-     * @type {ShippingLabel}
-     * @memberof GetShippingLabelResponse
-     */
     'payload'?: ShippingLabel;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetShippingLabelResponse
      */
     'errors'?: Array<Error>;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Details of item quantity.
- * @export
- * @interface ItemQuantity
  */
 export interface ItemQuantity {
     /**
      * Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level.
-     * @type {number}
-     * @memberof ItemQuantity
      */
     'amount': number;
     /**
      * Unit of measure for the shipped quantity.
-     * @type {string}
-     * @memberof ItemQuantity
      */
     'unitOfMeasure': string;
 }

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

@@ -12,32 +12,19 @@
 import type { ItemQuantity } from './item-quantity';
 /**
  * Details of the item being shipped.
- * @export
- * @interface Item
  */
 export interface Item {
     /**
      * Item Sequence Number for the item. This must be the same value as sent in order for a given item.
-     * @type {number}
-     * @memberof Item
      */
     'itemSequenceNumber': number;
     /**
      * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
-     * @type {string}
-     * @memberof Item
      */
     'buyerProductIdentifier'?: string;
     /**
      * The vendor selected product identification of the item. Should be the same as was sent in the purchase order, like SKU Number.
-     * @type {string}
-     * @memberof Item
      */
     'vendorProductIdentifier'?: string;
-    /**
-     *
-     * @type {ItemQuantity}
-     * @memberof Item
-     */
     'shippedQuantity': ItemQuantity;
 }

package/dist/types/api-model/models/label-data.d.ts

@@ -11,38 +11,26 @@
  */
 /**
  * Details of the shipment label.
- * @export
- * @interface LabelData
  */
 export interface LabelData {
     /**
      * Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.
-     * @type {string}
-     * @memberof LabelData
      */
     'packageIdentifier'?: string;
     /**
      * Package tracking identifier from the shipping carrier.
-     * @type {string}
-     * @memberof LabelData
      */
     'trackingNumber'?: string;
     /**
      * Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation.
-     * @type {string}
-     * @memberof LabelData
      */
     'shipMethod'?: string;
     /**
      * Shipping method name for internal reference.
-     * @type {string}
-     * @memberof LabelData
      */
     'shipMethodName'?: string;
     /**
      * This field will contain the Base64encoded string of the shipment label content.
-     * @type {string}
-     * @memberof LabelData
      */
     'content': string;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * Error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

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

@@ -12,32 +12,19 @@
 import type { ItemQuantity } from './item-quantity';
 /**
  * Represents an item that has been packed into a container for shipping.
- * @export
- * @interface PackedItem
  */
 export interface PackedItem {
     /**
      * Item Sequence Number for the item. This must be the same value as sent in the order for a given item.
-     * @type {number}
-     * @memberof PackedItem
      */
     'itemSequenceNumber': number;
     /**
      * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
-     * @type {string}
-     * @memberof PackedItem
      */
     'buyerProductIdentifier'?: string;
     /**
      * The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number.
-     * @type {string}
-     * @memberof PackedItem
      */
     'vendorProductIdentifier'?: string;
-    /**
-     *
-     * @type {ItemQuantity}
-     * @memberof PackedItem
-     */
     'packedQuantity': ItemQuantity;
 }

package/dist/types/api-model/models/packing-slip-list.d.ts

@@ -13,20 +13,11 @@ import type { PackingSlip } from './packing-slip';
 import type { Pagination } from './pagination';
 /**
  * A list of packing slips.
- * @export
- * @interface PackingSlipList
  */
 export interface PackingSlipList {
-    /**
-     *
-     * @type {Pagination}
-     * @memberof PackingSlipList
-     */
     'pagination'?: Pagination;
     /**
      * An array of packing slip objects.
-     * @type {Array<PackingSlip>}
-     * @memberof PackingSlipList
      */
     'packingSlips'?: Array<PackingSlip>;
 }

package/dist/types/api-model/models/packing-slip.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Packing slip information.
- * @export
- * @interface PackingSlip
  */
 export interface PackingSlip {
     /**
      * Purchase order number of the shipment that corresponds to the packing slip.
-     * @type {string}
-     * @memberof PackingSlip
      */
     'purchaseOrderNumber': string;
     /**
      * A Base64encoded string of the packing slip PDF.
-     * @type {string}
-     * @memberof PackingSlip
      */
     'content': string;
     /**
      * The format of the file such as PDF, JPEG etc.
-     * @type {string}
-     * @memberof PackingSlip
      */
     'contentType'?: PackingSlipContentTypeEnum;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The pagination elements required to retrieve the remaining data.
- * @export
- * @interface Pagination
  */
 export interface Pagination {
     /**
      * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.
-     * @type {string}
-     * @memberof Pagination
      */
     'nextToken'?: string;
 }

package/dist/types/api-model/models/party-identification.d.ts

@@ -13,26 +13,15 @@ import type { Address } from './address';
 import type { TaxRegistrationDetails } from './tax-registration-details';
 /**
  * Name, address and tax details of a party.
- * @export
- * @interface PartyIdentification
  */
 export interface PartyIdentification {
     /**
      * Assigned Identification for the party.
-     * @type {string}
-     * @memberof PartyIdentification
      */
     'partyId': string;
-    /**
-     *
-     * @type {Address}
-     * @memberof PartyIdentification
-     */
     'address'?: Address;
     /**
      * Tax registration details of the entity.
-     * @type {Array<TaxRegistrationDetails>}
-     * @memberof PartyIdentification
      */
     'taxRegistrationDetails'?: Array<TaxRegistrationDetails>;
 }

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

@@ -15,44 +15,21 @@ import type { PartyIdentification } from './party-identification';
 import type { ShipmentDetails } from './shipment-details';
 /**
  * Represents the confirmation details of a shipment, including the purchase order number and other shipment details.
- * @export
- * @interface ShipmentConfirmation
  */
 export interface ShipmentConfirmation {
     /**
      * Purchase order number corresponding to the shipment.
-     * @type {string}
-     * @memberof ShipmentConfirmation
      */
     'purchaseOrderNumber': string;
-    /**
-     *
-     * @type {ShipmentDetails}
-     * @memberof ShipmentConfirmation
-     */
     'shipmentDetails': ShipmentDetails;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShipmentConfirmation
-     */
     'sellingParty': PartyIdentification;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShipmentConfirmation
-     */
     'shipFromParty': PartyIdentification;
     /**
      * Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
-     * @type {Array<Item>}
-     * @memberof ShipmentConfirmation
      */
     'items': Array<Item>;
     /**
      * Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
-     * @type {Array<Container>}
-     * @memberof ShipmentConfirmation
      */
     'containers'?: Array<Container>;
 }

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

@@ -11,38 +11,26 @@
  */
 /**
  * Details about a shipment.
- * @export
- * @interface ShipmentDetails
  */
 export interface ShipmentDetails {
     /**
      * This field indicates the date of the departure of the shipment from vendor\'s location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future.
-     * @type {string}
-     * @memberof ShipmentDetails
      */
     'shippedDate': string;
     /**
      * Indicate the shipment status.
-     * @type {string}
-     * @memberof ShipmentDetails
      */
     'shipmentStatus': ShipmentDetailsShipmentStatusEnum;
     /**
      * Provide the priority of the shipment.
-     * @type {boolean}
-     * @memberof ShipmentDetails
      */
     'isPriorityShipment'?: boolean;
     /**
      * The vendor order number is a unique identifier generated by a vendor for their reference.
-     * @type {string}
-     * @memberof ShipmentDetails
      */
     'vendorOrderNumber'?: string;
     /**
      * Date on which the shipment is expected to reach the buyer\'s warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation.
-     * @type {string}
-     * @memberof ShipmentDetails
      */
     'estimatedDeliveryDate'?: string;
 }

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

@@ -13,32 +13,13 @@ import type { PartyIdentification } from './party-identification';
 import type { StatusUpdateDetails } from './status-update-details';
 /**
  * Represents an update to the status of a shipment.
- * @export
- * @interface ShipmentStatusUpdate
  */
 export interface ShipmentStatusUpdate {
     /**
      * Purchase order number of the shipment for which to update the shipment status.
-     * @type {string}
-     * @memberof ShipmentStatusUpdate
      */
     'purchaseOrderNumber': string;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShipmentStatusUpdate
-     */
     'sellingParty': PartyIdentification;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShipmentStatusUpdate
-     */
     'shipFromParty': PartyIdentification;
-    /**
-     *
-     * @type {StatusUpdateDetails}
-     * @memberof ShipmentStatusUpdate
-     */
     'statusUpdateDetails': StatusUpdateDetails;
 }

package/dist/types/api-model/models/shipping-label-list.d.ts

@@ -13,20 +13,11 @@ import type { Pagination } from './pagination';
 import type { ShippingLabel } from './shipping-label';
 /**
  * Response payload with the list of shipping labels
- * @export
- * @interface ShippingLabelList
  */
 export interface ShippingLabelList {
-    /**
-     *
-     * @type {Pagination}
-     * @memberof ShippingLabelList
-     */
     'pagination'?: Pagination;
     /**
      * An array containing the details of the generated shipping labels.
-     * @type {Array<ShippingLabel>}
-     * @memberof ShippingLabelList
      */
     'shippingLabels'?: Array<ShippingLabel>;
 }

package/dist/types/api-model/models/shipping-label-request.d.ts

@@ -13,32 +13,16 @@ import type { Container } from './container';
 import type { PartyIdentification } from './party-identification';
 /**
  * Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment.
- * @export
- * @interface ShippingLabelRequest
  */
 export interface ShippingLabelRequest {
     /**
      * Purchase order number of the order for which to create a shipping label.
-     * @type {string}
-     * @memberof ShippingLabelRequest
      */
     'purchaseOrderNumber': string;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShippingLabelRequest
-     */
     'sellingParty': PartyIdentification;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShippingLabelRequest
-     */
     'shipFromParty': PartyIdentification;
     /**
      * A list of the packages in this shipment.
-     * @type {Array<Container>}
-     * @memberof ShippingLabelRequest
      */
     'containers'?: Array<Container>;
 }

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

@@ -13,38 +13,20 @@ import type { LabelData } from './label-data';
 import type { PartyIdentification } from './party-identification';
 /**
  * Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details.
- * @export
- * @interface ShippingLabel
  */
 export interface ShippingLabel {
     /**
      * This field will contain the Purchase Order Number for this order.
-     * @type {string}
-     * @memberof ShippingLabel
      */
     'purchaseOrderNumber': string;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShippingLabel
-     */
     'sellingParty': PartyIdentification;
-    /**
-     *
-     * @type {PartyIdentification}
-     * @memberof ShippingLabel
-     */
     'shipFromParty': PartyIdentification;
     /**
      * Format of the label.
-     * @type {string}
-     * @memberof ShippingLabel
      */
     'labelFormat': ShippingLabelLabelFormatEnum;
     /**
      * Provides the details of the packages in this shipment.
-     * @type {Array<LabelData>}
-     * @memberof ShippingLabel
      */
     'labelData': Array<LabelData>;
 }

package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Details for the scheduled delivery timeline for a shipment, including the estimated delivery date and time, as well as the start and end times of the appointment window for delivery.
- * @export
- * @interface StatusUpdateDetailsShipmentSchedule
  */
 export interface StatusUpdateDetailsShipmentSchedule {
     /**
      * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
-     * @type {string}
-     * @memberof StatusUpdateDetailsShipmentSchedule
      */
     'estimatedDeliveryDateTime'?: string;
     /**
      * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
-     * @type {string}
-     * @memberof StatusUpdateDetailsShipmentSchedule
      */
     'apptWindowStartDateTime'?: string;
     /**
      * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
-     * @type {string}
-     * @memberof StatusUpdateDetailsShipmentSchedule
      */
     'apptWindowEndDateTime'?: string;
 }