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

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

@@ -19,92 +19,47 @@ import type { SupportedDocumentSpecification } from './supported-document-specif
 import type { Weight } from './weight';
 /**
  * The details of a shipping service offering.
- * @export
- * @interface Rate
  */
 export interface Rate {
     /**
      * An identifier for the rate (shipment offering) provided by a shipping service provider.
-     * @type {string}
-     * @memberof Rate
      */
     'rateId': string;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof Rate
      */
     'carrierId': string;
     /**
      * The carrier name for the offering.
-     * @type {string}
-     * @memberof Rate
      */
     'carrierName': string;
     /**
      * An identifier for the shipping service.
-     * @type {string}
-     * @memberof Rate
      */
     'serviceId': string;
     /**
      * The name of the shipping service.
-     * @type {string}
-     * @memberof Rate
      */
     'serviceName': string;
-    /**
-     *
-     * @type {Weight}
-     * @memberof Rate
-     */
     'billedWeight'?: Weight;
-    /**
-     *
-     * @type {Currency}
-     * @memberof Rate
-     */
     'totalCharge': Currency;
-    /**
-     *
-     * @type {Promise}
-     * @memberof Rate
-     */
     'promise': Promise;
     /**
      * A list of the document specifications supported for a shipment service offering.
-     * @type {Array<SupportedDocumentSpecification>}
-     * @memberof Rate
      */
     'supportedDocumentSpecifications': Array<SupportedDocumentSpecification>;
     /**
      * A list of value-added services available for a shipping service offering.
-     * @type {Array<AvailableValueAddedServiceGroup>}
-     * @memberof Rate
      */
     'availableValueAddedServiceGroups'?: Array<AvailableValueAddedServiceGroup>;
     /**
      * When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation.
-     * @type {boolean}
-     * @memberof Rate
      */
     'requiresAdditionalInputs': boolean;
     /**
      * A list of RateItem
-     * @type {Array<RateItem>}
-     * @memberof Rate
      */
     'rateItemList'?: Array<RateItem>;
-    /**
-     *
-     * @type {PaymentType}
-     * @memberof Rate
-     */
     'paymentType'?: PaymentType;
-    /**
-     *
-     * @type {Benefits}
-     * @memberof Rate
-     */
     'benefits'?: Benefits;
 }

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

@@ -15,50 +15,25 @@ import type { DocumentType } from './document-type';
 import type { RequestedLabelCustomization } from './requested-label-customization';
 /**
  * The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.
- * @export
- * @interface RequestedDocumentSpecification
  */
 export interface RequestedDocumentSpecification {
-    /**
-     *
-     * @type {DocumentFormat}
-     * @memberof RequestedDocumentSpecification
-     */
     'format': DocumentFormat;
-    /**
-     *
-     * @type {DocumentSize}
-     * @memberof RequestedDocumentSpecification
-     */
     'size': DocumentSize;
     /**
      * The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.
-     * @type {number}
-     * @memberof RequestedDocumentSpecification
      */
     'dpi'?: number;
     /**
      * Indicates the position of the label on the paper. Should be the same value as returned in getRates response.
-     * @type {string}
-     * @memberof RequestedDocumentSpecification
      */
     'pageLayout'?: string;
     /**
      * When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.
-     * @type {boolean}
-     * @memberof RequestedDocumentSpecification
      */
     'needFileJoining': boolean;
     /**
      * A list of the document types requested.
-     * @type {Array<DocumentType>}
-     * @memberof RequestedDocumentSpecification
      */
     'requestedDocumentTypes': Array<DocumentType>;
-    /**
-     *
-     * @type {RequestedLabelCustomization}
-     * @memberof RequestedDocumentSpecification
-     */
     'requestedLabelCustomization'?: RequestedLabelCustomization;
 }

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

@@ -12,14 +12,10 @@
 import type { LabelAttribute } from './label-attribute';
 /**
  * Object contains customised data requested by a shipper to be printed on a shipping label.
- * @export
- * @interface RequestedLabelCustomization
  */
 export interface RequestedLabelCustomization {
     /**
      * Specify the type of attributes to be added on a label.
-     * @type {Array<LabelAttribute>}
-     * @memberof RequestedLabelCustomization
      */
     'requestAttributes'?: Array<LabelAttribute>;
 }

package/dist/types/api-model/models/requested-value-added-service.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * A value-added service to be applied to a shipping service purchase.
- * @export
- * @interface RequestedValueAddedService
  */
 export interface RequestedValueAddedService {
     /**
      * The identifier of the selected value-added service. Must be among those returned in the response to the getRates operation.
-     * @type {string}
-     * @memberof RequestedValueAddedService
      */
     'id': string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * Service Selection Criteria.
- * @export
- * @interface ServiceSelection
  */
 export interface ServiceSelection {
     /**
      * A list of ServiceId.
-     * @type {Array<string>}
-     * @memberof ServiceSelection
      */
     'serviceId': Array<string>;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Service Related Info
- * @export
- * @interface Service
  */
 export interface Service {
     /**
      * An identifier for the shipping service.
-     * @type {string}
-     * @memberof Service
      */
     'id': string;
     /**
      * The name of the shipping service.
-     * @type {string}
-     * @memberof Service
      */
     'name': string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Type of settlement the shipper wants to receive for a particular shipment.
- * @export
- * @enum {string}
  */
 export declare const SettlementType: {
     readonly Refund: "REFUND";

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

@@ -11,8 +11,6 @@
  */
 /**
  * Shipment type.
- * @export
- * @enum {string}
  */
 export declare const ShipmentType: {
     readonly Forward: "FORWARD";

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

@@ -11,14 +11,10 @@
  */
 /**
  * The shipper instruction.
- * @export
- * @interface ShipperInstruction
  */
 export interface ShipperInstruction {
     /**
      * The delivery notes for the shipment
-     * @type {string}
-     * @memberof ShipperInstruction
      */
     'deliveryNotes'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The status of the package being shipped.
- * @export
- * @enum {string}
  */
 export declare const Status: {
     readonly PreTransit: "PreTransit";

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

@@ -13,26 +13,12 @@ import type { NdrAction } from './ndr-action';
 import type { NdrRequestData } from './ndr-request-data';
 /**
  * The request schema for the NdrFeedback operation
- * @export
- * @interface SubmitNdrFeedbackRequest
  */
 export interface SubmitNdrFeedbackRequest {
     /**
      * The carrier generated identifier for a package in a purchased shipment.
-     * @type {string}
-     * @memberof SubmitNdrFeedbackRequest
      */
     'trackingId': string;
-    /**
-     *
-     * @type {NdrAction}
-     * @memberof SubmitNdrFeedbackRequest
-     */
     'ndrAction': NdrAction;
-    /**
-     *
-     * @type {NdrRequestData}
-     * @memberof SubmitNdrFeedbackRequest
-     */
     'ndrRequestData'?: NdrRequestData;
 }

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

@@ -12,20 +12,11 @@
 import type { DocumentType } from './document-type';
 /**
  * The supported document types for a service offering.
- * @export
- * @interface SupportedDocumentDetail
  */
 export interface SupportedDocumentDetail {
-    /**
-     *
-     * @type {DocumentType}
-     * @memberof SupportedDocumentDetail
-     */
     'name': DocumentType;
     /**
      * When true, the supported document type is required.
-     * @type {boolean}
-     * @memberof SupportedDocumentDetail
      */
     'isMandatory': boolean;
 }

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

@@ -14,26 +14,12 @@ import type { DocumentSize } from './document-size';
 import type { PrintOption } from './print-option';
 /**
  * Document specification that is supported for a service offering.
- * @export
- * @interface SupportedDocumentSpecification
  */
 export interface SupportedDocumentSpecification {
-    /**
-     *
-     * @type {DocumentFormat}
-     * @memberof SupportedDocumentSpecification
-     */
     'format': DocumentFormat;
-    /**
-     *
-     * @type {DocumentSize}
-     * @memberof SupportedDocumentSpecification
-     */
     'size': DocumentSize;
     /**
      * A list of the format options for a label.
-     * @type {Array<PrintOption>}
-     * @memberof SupportedDocumentSpecification
      */
     'printOptions': Array<PrintOption>;
 }

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

@@ -12,20 +12,11 @@
 import type { TaxType } from './tax-type';
 /**
  * Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.
- * @export
- * @interface TaxDetail
  */
 export interface TaxDetail {
-    /**
-     *
-     * @type {TaxType}
-     * @memberof TaxDetail
-     */
     'taxType': TaxType;
     /**
      * The shipper\'s tax registration number associated with the shipment for customs compliance purposes in certain regions.
-     * @type {string}
-     * @memberof TaxDetail
      */
     'taxRegistrationNumber': string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * Indicates the type of tax.
- * @export
- * @enum {string}
  */
 export declare const TaxType: {
     readonly Gst: "GST";

package/dist/types/api-model/models/time-of-day.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Denotes time of the day, used for defining opening or closing time of access points
- * @export
- * @interface TimeOfDay
  */
 export interface TimeOfDay {
     /**
      * Denotes hour of the day, used for defining opening or closing time of access points
-     * @type {number}
-     * @memberof TimeOfDay
      */
     'hourOfDay'?: number;
     /**
      * Denotes minute of the hour, used for defining opening or closing time of access points
-     * @type {number}
-     * @memberof TimeOfDay
      */
     'minuteOfHour'?: number;
     /**
      * Denotes second of the minute, used for defining opening or closing time of access points
-     * @type {number}
-     * @memberof TimeOfDay
      */
     'secondOfMinute'?: number;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * The start and end time that specifies the time interval of an event.
- * @export
- * @interface TimeWindow
  */
 export interface TimeWindow {
     /**
      * The start time of the time window.
-     * @type {string}
-     * @memberof TimeWindow
      */
     'start'?: string;
     /**
      * The end time of the time window.
-     * @type {string}
-     * @memberof TimeWindow
      */
     'end'?: string;
 }

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

@@ -12,20 +12,14 @@
 import type { DetailCodes } from './detail-codes';
 /**
  * Contains detail codes that provide additional details related to the forward and return leg of the shipment.
- * @export
- * @interface TrackingDetailCodes
  */
 export interface TrackingDetailCodes {
     /**
      * Contains detail codes that provide additional details related to the forward leg of the shipment.
-     * @type {Array<DetailCodes>}
-     * @memberof TrackingDetailCodes
      */
     'forward': Array<DetailCodes>;
     /**
      * Contains detail codes that provide additional details related to the return leg of the shipment.
-     * @type {Array<DetailCodes>}
-     * @memberof TrackingDetailCodes
      */
     'returns': Array<DetailCodes>;
 }

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

@@ -13,20 +13,8 @@ import type { Status } from './status';
 import type { TrackingDetailCodes } from './tracking-detail-codes';
 /**
  * A package status summary.
- * @export
- * @interface TrackingSummary
  */
 export interface TrackingSummary {
-    /**
-     *
-     * @type {Status}
-     * @memberof TrackingSummary
-     */
     'status'?: Status;
-    /**
-     *
-     * @type {TrackingDetailCodes}
-     * @memberof TrackingSummary
-     */
     'trackingDetailCodes'?: TrackingDetailCodes;
 }

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

@@ -12,20 +12,14 @@
 import type { ClientReferenceDetail } from './client-reference-detail';
 /**
  * The request schema for remove the Carrier Account associated with the provided merchant.
- * @export
- * @interface UnlinkCarrierAccountRequest
  */
 export interface UnlinkCarrierAccountRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof UnlinkCarrierAccountRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
     /**
      * Identifier for the seller\'s carrier account.
-     * @type {string}
-     * @memberof UnlinkCarrierAccountRequest
      */
     'accountId'?: string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The Response  for the UnlinkCarrierAccountResponse operation.
- * @export
- * @interface UnlinkCarrierAccountResponse
  */
 export interface UnlinkCarrierAccountResponse {
     /**
      * Is Carrier unlinked from Merchant
-     * @type {boolean}
-     * @memberof UnlinkCarrierAccountResponse
      */
     'isUnlinked'?: boolean;
 }

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

@@ -12,26 +12,18 @@
 import type { UnmanifestedShipmentLocation } from './unmanifested-shipment-location';
 /**
  * UnmanifestedCarrierInformation like carrierId CarrierName and Location
- * @export
- * @interface UnmanifestedCarrierInformation
  */
 export interface UnmanifestedCarrierInformation {
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof UnmanifestedCarrierInformation
      */
     'carrierId'?: string;
     /**
      * The carrier name for the offering.
-     * @type {string}
-     * @memberof UnmanifestedCarrierInformation
      */
     'carrierName'?: string;
     /**
      * A list of UnmanifestedShipmentLocation
-     * @type {Array<UnmanifestedShipmentLocation>}
-     * @memberof UnmanifestedCarrierInformation
      */
     'unmanifestedShipmentLocationList'?: Array<UnmanifestedShipmentLocation>;
 }

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

@@ -12,20 +12,11 @@
 import type { Address } from './address';
 /**
  * UnmanifestedShipmentLocation info
- * @export
- * @interface UnmanifestedShipmentLocation
  */
 export interface UnmanifestedShipmentLocation {
-    /**
-     *
-     * @type {Address}
-     * @memberof UnmanifestedShipmentLocation
-     */
     'address'?: Address;
     /**
      * Its Last Manifest Date.
-     * @type {string}
-     * @memberof UnmanifestedShipmentLocation
      */
     'lastManifestDate'?: string;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * ValidationMetadata Details
- * @export
- * @interface ValidationMetadata
  */
 export interface ValidationMetadata {
     /**
      * errorMessage for the error.
-     * @type {string}
-     * @memberof ValidationMetadata
      */
     'errorMessage'?: string;
     /**
      * validationStrategy for the error.
-     * @type {string}
-     * @memberof ValidationMetadata
      */
     'validationStrategy'?: string;
     /**
      * Value.
-     * @type {string}
-     * @memberof ValidationMetadata
      */
     'value'?: string;
 }

package/dist/types/api-model/models/value-added-service-details.d.ts

@@ -12,14 +12,7 @@
 import type { CollectOnDelivery } from './collect-on-delivery';
 /**
  * A collection of supported value-added services.
- * @export
- * @interface ValueAddedServiceDetails
  */
 export interface ValueAddedServiceDetails {
-    /**
-     *
-     * @type {CollectOnDelivery}
-     * @memberof ValueAddedServiceDetails
-     */
     'collectOnDelivery'?: CollectOnDelivery;
 }

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

@@ -12,26 +12,15 @@
 import type { Currency } from './currency';
 /**
  * A value-added service available for purchase with a shipment service offering.
- * @export
- * @interface ValueAddedService
  */
 export interface ValueAddedService {
     /**
      * The identifier for the value-added service.
-     * @type {string}
-     * @memberof ValueAddedService
      */
     'id': string;
     /**
      * The name of the value-added service.
-     * @type {string}
-     * @memberof ValueAddedService
      */
     'name': string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof ValueAddedService
-     */
     'cost': Currency;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * The weight in the units indicated.
- * @export
- * @interface Weight
  */
 export interface Weight {
     /**
      * The unit of measurement.
-     * @type {string}
-     * @memberof Weight
      */
     'unit': WeightUnitEnum;
     /**
      * The measurement value.
-     * @type {number}
-     * @memberof Weight
      */
     'value': number;
 }