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

package/dist/types/api-model/models/get-carrier-account-form-inputs-response.d.ts

@@ -12,14 +12,10 @@
 import type { LinkableCarrier } from './linkable-carrier';
 /**
  * The Response  for the GetCarrierAccountFormInputsResponse operation.
- * @export
- * @interface GetCarrierAccountFormInputsResponse
  */
 export interface GetCarrierAccountFormInputsResponse {
     /**
      * A list of LinkableCarrier
-     * @type {Array<LinkableCarrier>}
-     * @memberof GetCarrierAccountFormInputsResponse
      */
     'linkableCarriersList'?: Array<LinkableCarrier>;
 }

package/dist/types/api-model/models/get-carrier-accounts-request.d.ts

@@ -12,14 +12,10 @@
 import type { ClientReferenceDetail } from './client-reference-detail';
 /**
  * The request schema for the GetCarrierAccounts operation.
- * @export
- * @interface GetCarrierAccountsRequest
  */
 export interface GetCarrierAccountsRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof GetCarrierAccountsRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
 }

package/dist/types/api-model/models/get-carrier-accounts-response.d.ts

@@ -12,14 +12,10 @@
 import type { ActiveAccount } from './active-account';
 /**
  * The Response  for the GetCarrierAccountsResponse operation.
- * @export
- * @interface GetCarrierAccountsResponse
  */
 export interface GetCarrierAccountsResponse {
     /**
      * A list of ActiveAccount
-     * @type {Array<ActiveAccount>}
-     * @memberof GetCarrierAccountsResponse
      */
     'activeAccounts': Array<ActiveAccount>;
 }

package/dist/types/api-model/models/get-collection-form-history-request.d.ts

@@ -14,38 +14,20 @@ import type { ClientReferenceDetail } from './client-reference-detail';
 import type { DateRange } from './date-range';
 /**
  * The request schema to get query collections form history API .
- * @export
- * @interface GetCollectionFormHistoryRequest
  */
 export interface GetCollectionFormHistoryRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof GetCollectionFormHistoryRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
     /**
      * max Number of Results for query .
-     * @type {number}
-     * @memberof GetCollectionFormHistoryRequest
      */
     'maxResults'?: number;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof GetCollectionFormHistoryRequest
      */
     'carrierId'?: string;
-    /**
-     *
-     * @type {Address}
-     * @memberof GetCollectionFormHistoryRequest
-     */
     'shipFromAddress'?: Address;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof GetCollectionFormHistoryRequest
-     */
     'dateRange'?: DateRange;
 }

package/dist/types/api-model/models/get-collection-form-history-response.d.ts

@@ -12,20 +12,14 @@
 import type { CollectionFormsHistoryRecord } from './collection-forms-history-record';
 /**
  * The Response  for the GetCollectionFormHistoryResponse operation.
- * @export
- * @interface GetCollectionFormHistoryResponse
  */
 export interface GetCollectionFormHistoryResponse {
     /**
      * A list of CollectionFormsHistoryRecord
-     * @type {Array<CollectionFormsHistoryRecord>}
-     * @memberof GetCollectionFormHistoryResponse
      */
     'collectionFormsHistoryRecordList'?: Array<CollectionFormsHistoryRecord>;
     /**
      * Last Refereshed Date of collection
-     * @type {string}
-     * @memberof GetCollectionFormHistoryResponse
      */
     'lastRefreshedDate'?: string;
 }

package/dist/types/api-model/models/get-collection-form-response.d.ts

@@ -12,14 +12,7 @@
 import type { CollectionsFormDocument } from './collections-form-document';
 /**
  * The Response  for the GetCollectionFormResponse operation.
- * @export
- * @interface GetCollectionFormResponse
  */
 export interface GetCollectionFormResponse {
-    /**
-     *
-     * @type {CollectionsFormDocument}
-     * @memberof GetCollectionFormResponse
-     */
     'collectionsFormDocument'?: CollectionsFormDocument;
 }

package/dist/types/api-model/models/get-rates-request.d.ts

@@ -21,86 +21,34 @@ import type { TaxDetail } from './tax-detail';
 import type { ValueAddedServiceDetails } from './value-added-service-details';
 /**
  * The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.
- * @export
- * @interface GetRatesRequest
  */
 export interface GetRatesRequest {
-    /**
-     *
-     * @type {Address}
-     * @memberof GetRatesRequest
-     */
     'shipTo'?: Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof GetRatesRequest
-     */
     'shipFrom': Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof GetRatesRequest
-     */
     'returnTo'?: Address;
     /**
      * The ship date and time (the requested pickup). This defaults to the current date and time.
-     * @type {string}
-     * @memberof GetRatesRequest
      */
     'shipDate'?: string;
-    /**
-     *
-     * @type {ShipperInstruction}
-     * @memberof GetRatesRequest
-     */
     'shipperInstruction'?: ShipperInstruction;
     /**
      * A list of packages to be shipped through a shipping service offering.
-     * @type {Array<Package>}
-     * @memberof GetRatesRequest
      */
     'packages': Array<Package>;
-    /**
-     *
-     * @type {ValueAddedServiceDetails}
-     * @memberof GetRatesRequest
-     */
     'valueAddedServices'?: ValueAddedServiceDetails;
     /**
      * A list of tax detail information.
-     * @type {Array<TaxDetail>}
-     * @memberof GetRatesRequest
      */
     'taxDetails'?: Array<TaxDetail>;
-    /**
-     *
-     * @type {ChannelDetails}
-     * @memberof GetRatesRequest
-     */
     'channelDetails': ChannelDetails;
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof GetRatesRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
-    /**
-     *
-     * @type {ShipmentType}
-     * @memberof GetRatesRequest
-     */
     'shipmentType'?: ShipmentType;
-    /**
-     *
-     * @type {AccessPointDetails}
-     * @memberof GetRatesRequest
-     */
     'destinationAccessPointDetails'?: AccessPointDetails;
     /**
      * A list of CarrierAccounts
-     * @type {Array<CarrierAccount>}
-     * @memberof GetRatesRequest
      */
     'carrierAccounts'?: Array<CarrierAccount>;
 }

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

@@ -12,14 +12,7 @@
 import type { GetRatesResult } from './get-rates-result';
 /**
  * The response schema for the getRates operation.
- * @export
- * @interface GetRatesResponse
  */
 export interface GetRatesResponse {
-    /**
-     *
-     * @type {GetRatesResult}
-     * @memberof GetRatesResponse
-     */
     'payload'?: GetRatesResult;
 }

package/dist/types/api-model/models/get-rates-result.d.ts

@@ -13,26 +13,18 @@ import type { IneligibleRate } from './ineligible-rate';
 import type { Rate } from './rate';
 /**
  * The payload for the getRates operation.
- * @export
- * @interface GetRatesResult
  */
 export interface GetRatesResult {
     /**
      * A unique token generated to identify a getRates operation.
-     * @type {string}
-     * @memberof GetRatesResult
      */
     'requestToken': string;
     /**
      * A list of eligible shipping service offerings.
-     * @type {Array<Rate>}
-     * @memberof GetRatesResult
      */
     'rates': Array<Rate>;
     /**
      * A list of ineligible shipping service offerings.
-     * @type {Array<IneligibleRate>}
-     * @memberof GetRatesResult
      */
     'ineligibleRates'?: Array<IneligibleRate>;
 }

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

@@ -12,14 +12,7 @@
 import type { GetShipmentDocumentsResult } from './get-shipment-documents-result';
 /**
  * The response schema for the the getShipmentDocuments operation.
- * @export
- * @interface GetShipmentDocumentsResponse
  */
 export interface GetShipmentDocumentsResponse {
-    /**
-     *
-     * @type {GetShipmentDocumentsResult}
-     * @memberof GetShipmentDocumentsResponse
-     */
     'payload'?: GetShipmentDocumentsResult;
 }

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

@@ -13,26 +13,12 @@ import type { Benefits } from './benefits';
 import type { PackageDocumentDetail } from './package-document-detail';
 /**
  * The payload for the getShipmentDocuments operation.
- * @export
- * @interface GetShipmentDocumentsResult
  */
 export interface GetShipmentDocumentsResult {
     /**
      * The unique shipment identifier provided by a shipping service.
-     * @type {string}
-     * @memberof GetShipmentDocumentsResult
      */
     'shipmentId': string;
-    /**
-     *
-     * @type {PackageDocumentDetail}
-     * @memberof GetShipmentDocumentsResult
-     */
     'packageDocumentDetail': PackageDocumentDetail;
-    /**
-     *
-     * @type {Benefits}
-     * @memberof GetShipmentDocumentsResult
-     */
     'benefits'?: Benefits;
 }

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

@@ -12,14 +12,7 @@
 import type { GetTrackingResult } from './get-tracking-result';
 /**
  * The response schema for the getTracking operation.
- * @export
- * @interface GetTrackingResponse
  */
 export interface GetTrackingResponse {
-    /**
-     *
-     * @type {GetTrackingResult}
-     * @memberof GetTrackingResponse
-     */
     'payload'?: GetTrackingResult;
 }

package/dist/types/api-model/models/get-tracking-result.d.ts

@@ -13,38 +13,23 @@ import type { Event } from './event';
 import type { TrackingSummary } from './tracking-summary';
 /**
  * The payload for the getTracking operation.
- * @export
- * @interface GetTrackingResult
  */
 export interface GetTrackingResult {
     /**
      * The carrier generated identifier for a package in a purchased shipment.
-     * @type {string}
-     * @memberof GetTrackingResult
      */
     'trackingId': string;
     /**
      * The carrier generated reverse identifier for a returned package in a purchased shipment.
-     * @type {string}
-     * @memberof GetTrackingResult
      */
     'alternateLegTrackingId': string;
     /**
      * A list of tracking events.
-     * @type {Array<Event>}
-     * @memberof GetTrackingResult
      */
     'eventHistory': Array<Event>;
     /**
      * The date and time by which the shipment is promised to be delivered.
-     * @type {string}
-     * @memberof GetTrackingResult
      */
     'promisedDeliveryDate': string;
-    /**
-     *
-     * @type {TrackingSummary}
-     * @memberof GetTrackingResult
-     */
     'summary': TrackingSummary;
 }

package/dist/types/api-model/models/get-unmanifested-shipments-request.d.ts

@@ -12,14 +12,10 @@
 import type { ClientReferenceDetail } from './client-reference-detail';
 /**
  * The request schema for the GetUnmanifestedShipmentsRequest operation.
- * @export
- * @interface GetUnmanifestedShipmentsRequest
  */
 export interface GetUnmanifestedShipmentsRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof GetUnmanifestedShipmentsRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
 }

package/dist/types/api-model/models/get-unmanifested-shipments-response.d.ts

@@ -12,14 +12,10 @@
 import type { UnmanifestedCarrierInformation } from './unmanifested-carrier-information';
 /**
  * The Response  for the GetUnmanifestedShipmentsResponse operation.
- * @export
- * @interface GetUnmanifestedShipmentsResponse
  */
 export interface GetUnmanifestedShipmentsResponse {
     /**
      * A list of UnmanifestedCarrierInformation
-     * @type {Array<UnmanifestedCarrierInformation>}
-     * @memberof GetUnmanifestedShipmentsResponse
      */
     'unmanifestedCarrierInformationList'?: Array<UnmanifestedCarrierInformation>;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The seller owning the goods before handing them over to the carrier
- * @export
- * @interface GoodsOwner
  */
 export interface GoodsOwner {
     /**
      * merchant Id of provided merchant
-     * @type {string}
-     * @memberof GoodsOwner
      */
     'merchantId': string;
 }

package/dist/types/api-model/models/ineligibility-reason-code.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Reasons that make a shipment service offering ineligible.
- * @export
- * @enum {string}
  */
 export declare const IneligibilityReasonCode: {
     readonly NoCoverage: "NO_COVERAGE";

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

@@ -12,20 +12,11 @@
 import type { IneligibilityReasonCode } from './ineligibility-reason-code';
 /**
  * The reason why a shipping service offering is ineligible.
- * @export
- * @interface IneligibilityReason
  */
 export interface IneligibilityReason {
-    /**
-     *
-     * @type {IneligibilityReasonCode}
-     * @memberof IneligibilityReason
-     */
     'code': IneligibilityReasonCode;
     /**
      * The ineligibility reason.
-     * @type {string}
-     * @memberof IneligibilityReason
      */
     'message': string;
 }

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

@@ -12,38 +12,26 @@
 import type { IneligibilityReason } from './ineligibility-reason';
 /**
  * Detailed information for an ineligible shipping service offering.
- * @export
- * @interface IneligibleRate
  */
 export interface IneligibleRate {
     /**
      * An identifier for the shipping service.
-     * @type {string}
-     * @memberof IneligibleRate
      */
     'serviceId': string;
     /**
      * The name of the shipping service.
-     * @type {string}
-     * @memberof IneligibleRate
      */
     'serviceName': string;
     /**
      * The carrier name for the offering.
-     * @type {string}
-     * @memberof IneligibleRate
      */
     'carrierName': string;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof IneligibleRate
      */
     'carrierId': string;
     /**
      * A list of reasons why a shipping service offering is ineligible.
-     * @type {Array<IneligibilityReason>}
-     * @memberof IneligibleRate
      */
     'ineligibilityReasons': Array<IneligibilityReason>;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Type of Input.
- * @export
- * @enum {string}
  */
 export declare const InputType: {
     readonly Textbox: "TEXTBOX";

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

@@ -11,20 +11,14 @@
  */
 /**
  * The invoice details for charges associated with the goods in the package. Only applies to certain regions.
- * @export
- * @interface InvoiceDetails
  */
 export interface InvoiceDetails {
     /**
      * The invoice number of the item.
-     * @type {string}
-     * @memberof InvoiceDetails
      */
     'invoiceNumber'?: string;
     /**
      * The invoice date of the item in ISO 8061 format.
-     * @type {string}
-     * @memberof InvoiceDetails
      */
     'invoiceDate'?: string;
 }

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

@@ -17,80 +17,36 @@ import type { LiquidVolume } from './liquid-volume';
 import type { Weight } from './weight';
 /**
  * An item in a package.
- * @export
- * @interface Item
  */
 export interface Item {
-    /**
-     *
-     * @type {Currency}
-     * @memberof Item
-     */
     'itemValue'?: Currency;
     /**
      * The product description of the item.
-     * @type {string}
-     * @memberof Item
      */
     'description'?: string;
     /**
      * A unique identifier for an item provided by the client.
-     * @type {string}
-     * @memberof Item
      */
     'itemIdentifier'?: string;
     /**
      * The number of units. This value is required.
-     * @type {number}
-     * @memberof Item
      */
     'quantity': number;
-    /**
-     *
-     * @type {Weight}
-     * @memberof Item
-     */
     'weight'?: Weight;
-    /**
-     *
-     * @type {LiquidVolume}
-     * @memberof Item
-     */
     'liquidVolume'?: LiquidVolume;
     /**
      * When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
-     * @type {boolean}
-     * @memberof Item
      */
     'isHazmat'?: boolean;
-    /**
-     *
-     * @type {DangerousGoodsDetails}
-     * @memberof Item
-     */
     'dangerousGoodsDetails'?: DangerousGoodsDetails;
     /**
      * The product type of the item.
-     * @type {string}
-     * @memberof Item
      */
     'productType'?: string;
-    /**
-     *
-     * @type {InvoiceDetails}
-     * @memberof Item
-     */
     'invoiceDetails'?: InvoiceDetails;
     /**
      * A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon.
-     * @type {Array<string>}
-     * @memberof Item
      */
     'serialNumbers'?: Array<string>;
-    /**
-     *
-     * @type {DirectFulfillmentItemIdentifiers}
-     * @memberof Item
-     */
     'directFulfillmentItemIdentifiers'?: DirectFulfillmentItemIdentifiers;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Enumerates the attributes supported to be printed on a shipping label. The values for these attributes are retrieved from GetRates/OneClickShipment request
- * @export
- * @enum {string}
  */
 export declare const LabelAttribute: {
     readonly PackageClientReferenceId: "PACKAGE_CLIENT_REFERENCE_ID";

package/dist/types/api-model/models/link-carrier-account-request.d.ts

@@ -13,32 +13,22 @@ import type { CarrierAccountAttribute } from './carrier-account-attribute';
 import type { ClientReferenceDetail } from './client-reference-detail';
 /**
  * The request schema for verify and add the merchant\'s account with a certain carrier.
- * @export
- * @interface LinkCarrierAccountRequest
  */
 export interface LinkCarrierAccountRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof LinkCarrierAccountRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
     /**
      * CarrierAccountType  associated with account.
-     * @type {string}
-     * @memberof LinkCarrierAccountRequest
      */
     'carrierAccountType': string;
     /**
      * A list of all attributes required by the carrier in order to successfully link the merchant\'s account
-     * @type {Array<CarrierAccountAttribute>}
-     * @memberof LinkCarrierAccountRequest
      */
     'carrierAccountAttributes': Array<CarrierAccountAttribute>;
     /**
      * A list of all attributes required by the carrier in order to successfully link the merchant\'s account
-     * @type {Array<CarrierAccountAttribute>}
-     * @memberof LinkCarrierAccountRequest
      */
     'encryptedCarrierAccountAttributes'?: Array<CarrierAccountAttribute>;
 }

package/dist/types/api-model/models/link-carrier-account-response.d.ts

@@ -12,20 +12,11 @@
 import type { AccountStatus } from './account-status';
 /**
  * The Response  for the LinkCarrierAccount operation.
- * @export
- * @interface LinkCarrierAccountResponse
  */
 export interface LinkCarrierAccountResponse {
-    /**
-     *
-     * @type {AccountStatus}
-     * @memberof LinkCarrierAccountResponse
-     */
     'registrationStatus'?: AccountStatus;
     /**
      * Identifier for the seller\'s carrier account.
-     * @type {string}
-     * @memberof LinkCarrierAccountResponse
      */
     'accountId'?: string;
 }

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

@@ -13,20 +13,11 @@ import type { AccountType } from './account-type';
 import type { CarrierAccountInput } from './carrier-account-input';
 /**
  * Info About Linkable Account Type
- * @export
- * @interface LinkableAccountType
  */
 export interface LinkableAccountType {
-    /**
-     *
-     * @type {AccountType}
-     * @memberof LinkableAccountType
-     */
     'accountType'?: AccountType;
     /**
      * A list of CarrierAccountInput
-     * @type {Array<CarrierAccountInput>}
-     * @memberof LinkableAccountType
      */
     'carrierAccountInputs'?: Array<CarrierAccountInput>;
 }