@sp-api-sdk/shipping-api-v2 2.1.4 → 2.1.6

package/dist/types/api-model/models/linkable-carrier.d.ts

@@ -12,20 +12,14 @@
 import type { LinkableAccountType } from './linkable-account-type';
 /**
  * Info About Linkable Carrier
- * @export
- * @interface LinkableCarrier
  */
 export interface LinkableCarrier {
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof LinkableCarrier
      */
     'carrierId'?: string;
     /**
      * A list of LinkableAccountType
-     * @type {Array<LinkableAccountType>}
-     * @memberof LinkableCarrier
      */
     'linkableAccountTypes'?: Array<LinkableAccountType>;
 }

package/dist/types/api-model/models/liquid-volume.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Liquid Volume.
- * @export
- * @interface LiquidVolume
  */
 export interface LiquidVolume {
     /**
      * The unit of measurement.
-     * @type {string}
-     * @memberof LiquidVolume
      */
     'unit': LiquidVolumeUnitEnum;
     /**
      * The measurement value.
-     * @type {number}
-     * @memberof LiquidVolume
      */
     'value': number;
 }

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

@@ -11,32 +11,22 @@
  */
 /**
  * The location where the person, business or institution is located.
- * @export
- * @interface Location
  */
 export interface Location {
     /**
      * The state, county or region where the person, business or institution is located.
-     * @type {string}
-     * @memberof Location
      */
     'stateOrRegion'?: string;
     /**
      * The city or town where the person, business or institution is located.
-     * @type {string}
-     * @memberof Location
      */
     'city'?: string;
     /**
      * The two digit country code. Follows ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Location
      */
     'countryCode'?: string;
     /**
      * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
-     * @type {string}
-     * @memberof Location
      */
     'postalCode'?: 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/ndr-action.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The type of NDR action shipper wants to take for a particular shipment.
- * @export
- * @enum {string}
  */
 export declare const NdrAction: {
     readonly Reschedule: "RESCHEDULE";

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

@@ -11,20 +11,14 @@
  */
 /**
  * Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field.
- * @export
- * @interface NdrRequestData
  */
 export interface NdrRequestData {
     /**
      * The date on which the Seller wants to reschedule shipment delivery, in ISO-8601 date/time format
-     * @type {string}
-     * @memberof NdrRequestData
      */
     'rescheduleDate'?: string;
     /**
      * Address notes to re-attempt delivery with.
-     * @type {string}
-     * @memberof NdrRequestData
      */
     'additionalAddressNotes'?: string;
 }

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

@@ -21,86 +21,31 @@ import type { ShipperInstruction } from './shipper-instruction';
 import type { TaxDetail } from './tax-detail';
 /**
  * The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.
- * @export
- * @interface OneClickShipmentRequest
  */
 export interface OneClickShipmentRequest {
-    /**
-     *
-     * @type {Address}
-     * @memberof OneClickShipmentRequest
-     */
     'shipTo'?: Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof OneClickShipmentRequest
-     */
     'shipFrom': Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof OneClickShipmentRequest
-     */
     'returnTo'?: Address;
     /**
      * The ship date and time (the requested pickup). This defaults to the current date and time.
-     * @type {string}
-     * @memberof OneClickShipmentRequest
      */
     'shipDate'?: string;
-    /**
-     *
-     * @type {GoodsOwner}
-     * @memberof OneClickShipmentRequest
-     */
     'goodsOwner'?: GoodsOwner;
     /**
      * A list of packages to be shipped through a shipping service offering.
-     * @type {Array<Package>}
-     * @memberof OneClickShipmentRequest
      */
     'packages': Array<Package>;
     /**
      * The value-added services to be added to a shipping service purchase.
-     * @type {Array<OneClickShipmentValueAddedService>}
-     * @memberof OneClickShipmentRequest
      */
     'valueAddedServicesDetails'?: Array<OneClickShipmentValueAddedService>;
     /**
      * A list of tax detail information.
-     * @type {Array<TaxDetail>}
-     * @memberof OneClickShipmentRequest
      */
     'taxDetails'?: Array<TaxDetail>;
-    /**
-     *
-     * @type {ChannelDetails}
-     * @memberof OneClickShipmentRequest
-     */
     'channelDetails': ChannelDetails;
-    /**
-     *
-     * @type {RequestedDocumentSpecification}
-     * @memberof OneClickShipmentRequest
-     */
     'labelSpecifications': RequestedDocumentSpecification;
-    /**
-     *
-     * @type {ServiceSelection}
-     * @memberof OneClickShipmentRequest
-     */
     'serviceSelection': ServiceSelection;
-    /**
-     *
-     * @type {ShipperInstruction}
-     * @memberof OneClickShipmentRequest
-     */
     'shipperInstruction'?: ShipperInstruction;
-    /**
-     *
-     * @type {AccessPointDetails}
-     * @memberof OneClickShipmentRequest
-     */
     'destinationAccessPointDetails'?: AccessPointDetails;
 }

package/dist/types/api-model/models/one-click-shipment-response.d.ts

@@ -12,14 +12,7 @@
 import type { OneClickShipmentResult } from './one-click-shipment-result';
 /**
  * The response schema for the OneClickShipment operation.
- * @export
- * @interface OneClickShipmentResponse
  */
 export interface OneClickShipmentResponse {
-    /**
-     *
-     * @type {OneClickShipmentResult}
-     * @memberof OneClickShipmentResponse
-     */
     'payload'?: OneClickShipmentResult;
 }

package/dist/types/api-model/models/one-click-shipment-result.d.ts

@@ -16,44 +16,18 @@ import type { Promise } from './promise';
 import type { Service } from './service';
 /**
  * The payload for the OneClickShipment API.
- * @export
- * @interface OneClickShipmentResult
  */
 export interface OneClickShipmentResult {
     /**
      * The unique shipment identifier provided by a shipping service.
-     * @type {string}
-     * @memberof OneClickShipmentResult
      */
     'shipmentId': string;
     /**
      * A list of post-purchase details about a package that will be shipped using a shipping service.
-     * @type {Array<PackageDocumentDetail>}
-     * @memberof OneClickShipmentResult
      */
     'packageDocumentDetails': Array<PackageDocumentDetail>;
-    /**
-     *
-     * @type {Promise}
-     * @memberof OneClickShipmentResult
-     */
     'promise': Promise;
-    /**
-     *
-     * @type {Carrier}
-     * @memberof OneClickShipmentResult
-     */
     'carrier': Carrier;
-    /**
-     *
-     * @type {Service}
-     * @memberof OneClickShipmentResult
-     */
     'service': Service;
-    /**
-     *
-     * @type {Currency}
-     * @memberof OneClickShipmentResult
-     */
     'totalCharge': Currency;
 }

package/dist/types/api-model/models/one-click-shipment-value-added-service.d.ts

@@ -12,20 +12,11 @@
 import type { Currency } from './currency';
 /**
  * A value-added service to be applied to a shipping service purchase.
- * @export
- * @interface OneClickShipmentValueAddedService
  */
 export interface OneClickShipmentValueAddedService {
     /**
      * The identifier of the selected value-added service.
-     * @type {string}
-     * @memberof OneClickShipmentValueAddedService
      */
     'id': string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof OneClickShipmentValueAddedService
-     */
     'amount'?: Currency;
 }

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

@@ -12,26 +12,12 @@
 import type { TimeOfDay } from './time-of-day';
 /**
  * The hours in which the access point shall remain operational
- * @export
- * @interface OperatingHours
  */
 export interface OperatingHours {
-    /**
-     *
-     * @type {TimeOfDay}
-     * @memberof OperatingHours
-     */
     'closingTime'?: TimeOfDay;
-    /**
-     *
-     * @type {TimeOfDay}
-     * @memberof OperatingHours
-     */
     'openingTime'?: TimeOfDay;
     /**
      * midDayClosures operating hours array
-     * @type {Array<TimeOfDay>}
-     * @memberof OperatingHours
      */
     'midDayClosures'?: Array<TimeOfDay>;
 }

package/dist/types/api-model/models/package-document-detail.d.ts

@@ -12,26 +12,18 @@
 import type { PackageDocument } from './package-document';
 /**
  * The post-purchase details of a package that will be shipped using a shipping service.
- * @export
- * @interface PackageDocumentDetail
  */
 export interface PackageDocumentDetail {
     /**
      * A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.
-     * @type {string}
-     * @memberof PackageDocumentDetail
      */
     'packageClientReferenceId': string;
     /**
      * A list of documents related to a package.
-     * @type {Array<PackageDocument>}
-     * @memberof PackageDocumentDetail
      */
     'packageDocuments': Array<PackageDocument>;
     /**
      * The carrier generated identifier for a package in a purchased shipment.
-     * @type {string}
-     * @memberof PackageDocumentDetail
      */
     'trackingId'?: string;
 }

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

@@ -13,26 +13,12 @@ import type { DocumentFormat } from './document-format';
 import type { DocumentType } from './document-type';
 /**
  * A document related to a package.
- * @export
- * @interface PackageDocument
  */
 export interface PackageDocument {
-    /**
-     *
-     * @type {DocumentType}
-     * @memberof PackageDocument
-     */
     'type': DocumentType;
-    /**
-     *
-     * @type {DocumentFormat}
-     * @memberof PackageDocument
-     */
     'format': DocumentFormat;
     /**
      * A Base64 encoded string of the file contents.
-     * @type {string}
-     * @memberof PackageDocument
      */
     'contents': string;
 }

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

@@ -16,56 +16,29 @@ import type { Item } from './item';
 import type { Weight } from './weight';
 /**
  * A package to be shipped through a shipping service offering.
- * @export
- * @interface Package
  */
 export interface Package {
-    /**
-     *
-     * @type {Dimensions}
-     * @memberof Package
-     */
     'dimensions': Dimensions;
-    /**
-     *
-     * @type {Weight}
-     * @memberof Package
-     */
     'weight': Weight;
-    /**
-     *
-     * @type {Currency}
-     * @memberof Package
-     */
     'insuredValue': Currency;
     /**
      * When true, the package contains hazardous materials. Defaults to false.
-     * @type {boolean}
-     * @memberof Package
      */
     'isHazmat'?: boolean;
     /**
      * The seller name displayed on the label.
-     * @type {string}
-     * @memberof Package
      */
     'sellerDisplayName'?: string;
     /**
      * A list of charges based on the shipping service charges applied on a package.
-     * @type {Array<ChargeComponent>}
-     * @memberof Package
      */
     'charges'?: Array<ChargeComponent>;
     /**
      * A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.
-     * @type {string}
-     * @memberof Package
      */
     'packageClientReferenceId': string;
     /**
      * A list of items.
-     * @type {Array<Item>}
-     * @memberof Package
      */
     'items': Array<Item>;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Payment type of the purchase.
- * @export
- * @enum {string}
  */
 export declare const PaymentType: {
     readonly PayThroughAmazon: "PAY_THROUGH_AMAZON";

package/dist/types/api-model/models/print-option.d.ts

@@ -12,32 +12,22 @@
 import type { SupportedDocumentDetail } from './supported-document-detail';
 /**
  * The format options available for a label.
- * @export
- * @interface PrintOption
  */
 export interface PrintOption {
     /**
      * A list of the supported DPI options for a document.
-     * @type {Array<number>}
-     * @memberof PrintOption
      */
     'supportedDPIs'?: Array<number>;
     /**
      * A list of the supported page layout options for a document.
-     * @type {Array<string>}
-     * @memberof PrintOption
      */
     'supportedPageLayouts': Array<string>;
     /**
      * A list of the supported needFileJoining boolean values for a document.
-     * @type {Array<boolean>}
-     * @memberof PrintOption
      */
     'supportedFileJoiningOptions': Array<boolean>;
     /**
      * A list of the supported documented details.
-     * @type {Array<SupportedDocumentDetail>}
-     * @memberof PrintOption
      */
     'supportedDocumentDetails': Array<SupportedDocumentDetail>;
 }

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

@@ -12,20 +12,8 @@
 import type { TimeWindow } from './time-window';
 /**
  * The time windows promised for pickup and delivery events.
- * @export
- * @interface Promise
  */
 export interface Promise {
-    /**
-     *
-     * @type {TimeWindow}
-     * @memberof Promise
-     */
     'deliveryWindow'?: TimeWindow;
-    /**
-     *
-     * @type {TimeWindow}
-     * @memberof Promise
-     */
     'pickupWindow'?: TimeWindow;
 }

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

@@ -13,38 +13,23 @@ import type { RequestedDocumentSpecification } from './requested-document-specif
 import type { RequestedValueAddedService } from './requested-value-added-service';
 /**
  * The request schema for the purchaseShipment operation.
- * @export
- * @interface PurchaseShipmentRequest
  */
 export interface PurchaseShipmentRequest {
     /**
      * A unique token generated to identify a getRates operation.
-     * @type {string}
-     * @memberof PurchaseShipmentRequest
      */
     'requestToken': string;
     /**
      * An identifier for the rate (shipment offering) provided by a shipping service provider.
-     * @type {string}
-     * @memberof PurchaseShipmentRequest
      */
     'rateId': string;
-    /**
-     *
-     * @type {RequestedDocumentSpecification}
-     * @memberof PurchaseShipmentRequest
-     */
     'requestedDocumentSpecification': RequestedDocumentSpecification;
     /**
      * The value-added services to be added to a shipping service purchase.
-     * @type {Array<RequestedValueAddedService>}
-     * @memberof PurchaseShipmentRequest
      */
     'requestedValueAddedServices'?: Array<RequestedValueAddedService>;
     /**
      * The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation.  Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.
-     * @type {{ [key: string]: object; }}
-     * @memberof PurchaseShipmentRequest
      */
     'additionalInputs'?: {
         [key: string]: object;

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

@@ -12,14 +12,7 @@
 import type { PurchaseShipmentResult } from './purchase-shipment-result';
 /**
  * The response schema for the purchaseShipment operation.
- * @export
- * @interface PurchaseShipmentResponse
  */
 export interface PurchaseShipmentResponse {
-    /**
-     *
-     * @type {PurchaseShipmentResult}
-     * @memberof PurchaseShipmentResponse
-     */
     'payload'?: PurchaseShipmentResult;
 }

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

@@ -14,32 +14,16 @@ import type { PackageDocumentDetail } from './package-document-detail';
 import type { Promise } from './promise';
 /**
  * The payload for the purchaseShipment operation.
- * @export
- * @interface PurchaseShipmentResult
  */
 export interface PurchaseShipmentResult {
     /**
      * The unique shipment identifier provided by a shipping service.
-     * @type {string}
-     * @memberof PurchaseShipmentResult
      */
     'shipmentId': string;
     /**
      * A list of post-purchase details about a package that will be shipped using a shipping service.
-     * @type {Array<PackageDocumentDetail>}
-     * @memberof PurchaseShipmentResult
      */
     'packageDocumentDetails': Array<PackageDocumentDetail>;
-    /**
-     *
-     * @type {Promise}
-     * @memberof PurchaseShipmentResult
-     */
     'promise': Promise;
-    /**
-     *
-     * @type {Benefits}
-     * @memberof PurchaseShipmentResult
-     */
     'benefits'?: Benefits;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Unique ID for the rateItem.
- * @export
- * @enum {string}
  */
 export declare const RateItemID: {
     readonly BaseRate: "BASE_RATE";

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

@@ -11,8 +11,6 @@
  */
 /**
  * Type of the rateItem.
- * @export
- * @enum {string}
  */
 export declare const RateItemType: {
     readonly Mandatory: "MANDATORY";

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

@@ -14,32 +14,13 @@ import type { RateItemID } from './rate-item-id';
 import type { RateItemType } from './rate-item-type';
 /**
  * Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition:
- * @export
- * @interface RateItem
  */
 export interface RateItem {
-    /**
-     *
-     * @type {RateItemID}
-     * @memberof RateItem
-     */
     'rateItemID'?: RateItemID;
-    /**
-     *
-     * @type {RateItemType}
-     * @memberof RateItem
-     */
     'rateItemType'?: RateItemType;
-    /**
-     *
-     * @type {Currency}
-     * @memberof RateItem
-     */
     'rateItemCharge'?: Currency;
     /**
      * Used for the localization.
-     * @type {string}
-     * @memberof RateItem
      */
     'rateItemNameLocalization'?: string;
 }