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

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

@@ -11,8 +11,6 @@
  */
 /**
  * The reason for which shipper is filing the claim for a particular shipment.
- * @export
- * @enum {string}
  */
 export declare const ClaimReason: {
     readonly LostInTransit: "LOST_IN_TRANSIT";

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

@@ -11,20 +11,14 @@
  */
 /**
  * Client Reference Details
- * @export
- * @interface ClientReferenceDetail
  */
 export interface ClientReferenceDetail {
     /**
      * Client Reference type.
-     * @type {string}
-     * @memberof ClientReferenceDetail
      */
     'clientReferenceType': ClientReferenceDetailClientReferenceTypeEnum;
     /**
      * The Client Reference Id.
-     * @type {string}
-     * @memberof ClientReferenceDetail
      */
     'clientReferenceId': string;
 }

package/dist/types/api-model/models/collect-on-delivery.d.ts

@@ -12,14 +12,7 @@
 import type { Currency } from './currency';
 /**
  * The amount to collect on delivery.
- * @export
- * @interface CollectOnDelivery
  */
 export interface CollectOnDelivery {
-    /**
-     *
-     * @type {Currency}
-     * @memberof CollectOnDelivery
-     */
     'amount': Currency;
 }

package/dist/types/api-model/models/collection-forms-history-record.d.ts

@@ -13,38 +13,20 @@ import type { Address } from './address';
 import type { GenerationStatus } from './generation-status';
 /**
  * Active Account Details
- * @export
- * @interface CollectionFormsHistoryRecord
  */
 export interface CollectionFormsHistoryRecord {
     /**
      * The carrier name for the offering.
-     * @type {string}
-     * @memberof CollectionFormsHistoryRecord
      */
     'carrierName'?: string;
     /**
      * Creation Time for this account.
-     * @type {string}
-     * @memberof CollectionFormsHistoryRecord
      */
     'creationDate'?: string;
-    /**
-     *
-     * @type {GenerationStatus}
-     * @memberof CollectionFormsHistoryRecord
-     */
     'generationStatus'?: GenerationStatus;
     /**
      * Collection Form Id for Reprint .
-     * @type {string}
-     * @memberof CollectionFormsHistoryRecord
      */
     'collectionFormId'?: string;
-    /**
-     *
-     * @type {Address}
-     * @memberof CollectionFormsHistoryRecord
-     */
     'shipFromAddress'?: Address;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Collection Form Document Details
- * @export
- * @interface CollectionsFormDocument
  */
 export interface CollectionsFormDocument {
     /**
      * Base64 document Value of Collection.
-     * @type {string}
-     * @memberof CollectionsFormDocument
      */
     'base64EncodedContent'?: string;
     /**
      * Collection Document format is PDF.
-     * @type {string}
-     * @memberof CollectionsFormDocument
      */
     'documentFormat'?: string;
 }

package/dist/types/api-model/models/create-claim-request.d.ts

@@ -14,44 +14,21 @@ import type { Currency } from './currency';
 import type { SettlementType } from './settlement-type';
 /**
  * The request schema for the CreateClaim operation
- * @export
- * @interface CreateClaimRequest
  */
 export interface CreateClaimRequest {
     /**
      * The carrier generated identifier for a package in a purchased shipment.
-     * @type {string}
-     * @memberof CreateClaimRequest
      */
     'trackingId': string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof CreateClaimRequest
-     */
     'declaredValue'?: Currency;
-    /**
-     *
-     * @type {ClaimReason}
-     * @memberof CreateClaimRequest
-     */
     'claimReason': ClaimReason;
     /**
      * Applicable for only On Amazon shipments to identify if replacement was sent
-     * @type {boolean}
-     * @memberof CreateClaimRequest
      */
     'isReplacementPackageSent'?: boolean;
     /**
      * A list of proof URLs for a claim. Basic URL validation will happen for each URLs present in the list
-     * @type {Array<string>}
-     * @memberof CreateClaimRequest
      */
     'proofs'?: Array<string>;
-    /**
-     *
-     * @type {SettlementType}
-     * @memberof CreateClaimRequest
-     */
     'settlementType': SettlementType;
 }

package/dist/types/api-model/models/create-claim-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the createClaim operation.
- * @export
- * @interface CreateClaimResponse
  */
 export interface CreateClaimResponse {
     /**
      * The claim identifier originally returned by the createClaim operation.
-     * @type {string}
-     * @memberof CreateClaimResponse
      */
     'claimId'?: string;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * The monetary value in the currency indicated, in ISO 4217 standard format.
- * @export
- * @interface Currency
  */
 export interface Currency {
     /**
      * The monetary value.
-     * @type {number}
-     * @memberof Currency
      */
     'value': number;
     /**
      * The ISO 4217 format 3-character currency code.
-     * @type {string}
-     * @memberof Currency
      */
     'unit': string;
 }

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

@@ -11,32 +11,22 @@
  */
 /**
  * Details related to any dangerous goods/items that are being shipped.
- * @export
- * @interface DangerousGoodsDetails
  */
 export interface DangerousGoodsDetails {
     /**
      * The specific UNID of the item being shipped.
-     * @type {string}
-     * @memberof DangerousGoodsDetails
      */
     'unitedNationsRegulatoryId'?: string;
     /**
      * The specific regulatory class  of the item being shipped.
-     * @type {string}
-     * @memberof DangerousGoodsDetails
      */
     'transportationRegulatoryClass'?: string;
     /**
      * The specific packaging group of the item being shipped.
-     * @type {string}
-     * @memberof DangerousGoodsDetails
      */
     'packingGroup'?: DangerousGoodsDetailsPackingGroupEnum;
     /**
      * The specific packing instruction of the item being shipped.
-     * @type {string}
-     * @memberof DangerousGoodsDetails
      */
     'packingInstruction'?: DangerousGoodsDetailsPackingInstructionEnum;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Date Range for query the results.
- * @export
- * @interface DateRange
  */
 export interface DateRange {
     /**
      * Start Date for query .
-     * @type {string}
-     * @memberof DateRange
      */
     'startDate'?: string;
     /**
      * end date for query.
-     * @type {string}
-     * @memberof DateRange
      */
     'endDate'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * A list of codes used to provide additional shipment information.
- * @export
- * @enum {string}
  */
 export declare const DetailCodes: {
     readonly BusinessClosed: "BusinessClosed";

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

@@ -11,32 +11,22 @@
  */
 /**
  * A set of measurements for a three-dimensional object.
- * @export
- * @interface Dimensions
  */
 export interface Dimensions {
     /**
      * The length of the package.
-     * @type {number}
-     * @memberof Dimensions
      */
     'length': number;
     /**
      * The width of the package.
-     * @type {number}
-     * @memberof Dimensions
      */
     'width': number;
     /**
      * The height of the package.
-     * @type {number}
-     * @memberof Dimensions
      */
     'height': number;
     /**
      * The unit of measurement.
-     * @type {string}
-     * @memberof Dimensions
      */
     'unit': DimensionsUnitEnum;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Item identifiers for an item in a direct fulfillment shipment.
- * @export
- * @interface DirectFulfillmentItemIdentifiers
  */
 export interface DirectFulfillmentItemIdentifiers {
     /**
      * A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped.
-     * @type {string}
-     * @memberof DirectFulfillmentItemIdentifiers
      */
     'lineItemID': string;
     /**
      * A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1.
-     * @type {string}
-     * @memberof DirectFulfillmentItemIdentifiers
      */
     'pieceNumber'?: string;
 }

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

@@ -15,44 +15,15 @@ import type { Package } from './package';
 import type { RequestedDocumentSpecification } from './requested-document-specification';
 /**
  * The request schema for the directPurchaseShipment operation. When the channel type is Amazon, the shipTo address is not required and will be ignored.
- * @export
- * @interface DirectPurchaseRequest
  */
 export interface DirectPurchaseRequest {
-    /**
-     *
-     * @type {Address}
-     * @memberof DirectPurchaseRequest
-     */
     'shipTo'?: Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof DirectPurchaseRequest
-     */
     'shipFrom'?: Address;
-    /**
-     *
-     * @type {Address}
-     * @memberof DirectPurchaseRequest
-     */
     'returnTo'?: Address;
     /**
      * A list of packages to be shipped through a shipping service offering.
-     * @type {Array<Package>}
-     * @memberof DirectPurchaseRequest
      */
     'packages'?: Array<Package>;
-    /**
-     *
-     * @type {ChannelDetails}
-     * @memberof DirectPurchaseRequest
-     */
     'channelDetails': ChannelDetails;
-    /**
-     *
-     * @type {RequestedDocumentSpecification}
-     * @memberof DirectPurchaseRequest
-     */
     'labelSpecifications'?: RequestedDocumentSpecification;
 }

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

@@ -12,14 +12,7 @@
 import type { DirectPurchaseResult } from './direct-purchase-result';
 /**
  * The response schema for the directPurchaseShipment operation.
- * @export
- * @interface DirectPurchaseResponse
  */
 export interface DirectPurchaseResponse {
-    /**
-     *
-     * @type {DirectPurchaseResult}
-     * @memberof DirectPurchaseResponse
-     */
     'payload'?: DirectPurchaseResult;
 }

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

@@ -12,20 +12,14 @@
 import type { PackageDocumentDetail } from './package-document-detail';
 /**
  * The payload for the directPurchaseShipment operation.
- * @export
- * @interface DirectPurchaseResult
  */
 export interface DirectPurchaseResult {
     /**
      * The unique shipment identifier provided by a shipping service.
-     * @type {string}
-     * @memberof DirectPurchaseResult
      */
     'shipmentId': string;
     /**
      * A list of post-purchase details about a package that will be shipped using a shipping service.
-     * @type {Array<PackageDocumentDetail>}
-     * @memberof DirectPurchaseResult
      */
     'packageDocumentDetailList'?: Array<PackageDocumentDetail>;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The file format of the document.
- * @export
- * @enum {string}
  */
 export declare const DocumentFormat: {
     readonly Pdf: "PDF";

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

@@ -11,26 +11,18 @@
  */
 /**
  * The size dimensions of the label.
- * @export
- * @interface DocumentSize
  */
 export interface DocumentSize {
     /**
      * The width of the document measured in the units specified.
-     * @type {number}
-     * @memberof DocumentSize
      */
     'width': number;
     /**
      * The length of the document measured in the units specified.
-     * @type {number}
-     * @memberof DocumentSize
      */
     'length': number;
     /**
      * The unit of measurement.
-     * @type {string}
-     * @memberof DocumentSize
      */
     'unit': DocumentSizeUnitEnum;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The type of shipping document.
- * @export
- * @enum {string}
  */
 export declare const DocumentType: {
     readonly Packslip: "PACKSLIP";

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

@@ -11,14 +11,10 @@
  */
 /**
  * A list of error responses returned when a request is unsuccessful.
- * @export
- * @interface ErrorList
  */
 export interface ErrorList {
     /**
      * Array of Errors
-     * @type {Array<Error>}
-     * @memberof ErrorList
      */
     'errors': Array<Error>;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The tracking event type.
- * @export
- * @enum {string}
  */
 export declare const EventCode: {
     readonly ReadyForReceive: "ReadyForReceive";

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

@@ -14,32 +14,13 @@ import type { Location } from './location';
 import type { ShipmentType } from './shipment-type';
 /**
  * A tracking event.
- * @export
- * @interface Event
  */
 export interface Event {
-    /**
-     *
-     * @type {EventCode}
-     * @memberof Event
-     */
     'eventCode': EventCode;
-    /**
-     *
-     * @type {Location}
-     * @memberof Event
-     */
     'location'?: Location;
     /**
      * The ISO 8601 formatted timestamp of the event.
-     * @type {string}
-     * @memberof Event
      */
     'eventTime': string;
-    /**
-     *
-     * @type {ShipmentType}
-     * @memberof Event
-     */
     'shipmentType'?: ShipmentType;
 }

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

@@ -13,20 +13,8 @@ import type { DateRange } from './date-range';
 import type { OperatingHours } from './operating-hours';
 /**
  * Defines exceptions to standard operating hours for certain date ranges.
- * @export
- * @interface ExceptionOperatingHours
  */
 export interface ExceptionOperatingHours {
-    /**
-     *
-     * @type {DateRange}
-     * @memberof ExceptionOperatingHours
-     */
     'dateRange'?: DateRange;
-    /**
-     *
-     * @type {OperatingHours}
-     * @memberof ExceptionOperatingHours
-     */
     'operatingHours'?: OperatingHours;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Object representing a benefit that is excluded for a shipping offer or rate.
- * @export
- * @interface ExcludedBenefit
  */
 export interface ExcludedBenefit {
     /**
      * benefit
-     * @type {string}
-     * @memberof ExcludedBenefit
      */
     'benefit': string;
     /**
      * List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.
-     * @type {Array<string>}
-     * @memberof ExcludedBenefit
      */
     'reasonCodes'?: Array<string>;
 }

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

@@ -13,26 +13,15 @@ import type { Address } from './address';
 import type { ClientReferenceDetail } from './client-reference-detail';
 /**
  * The request schema Call to generate the collection form.
- * @export
- * @interface GenerateCollectionFormRequest
  */
 export interface GenerateCollectionFormRequest {
     /**
      * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
-     * @type {Array<ClientReferenceDetail>}
-     * @memberof GenerateCollectionFormRequest
      */
     'clientReferenceDetails'?: Array<ClientReferenceDetail>;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof GenerateCollectionFormRequest
      */
     'carrierId': string;
-    /**
-     *
-     * @type {Address}
-     * @memberof GenerateCollectionFormRequest
-     */
     'shipFromAddress'?: Address;
 }

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

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

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

@@ -11,8 +11,6 @@
  */
 /**
  * Generation Status.
- * @export
- * @enum {string}
  */
 export declare const GenerationStatus: {
     readonly Completed: "Completed";

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

@@ -11,20 +11,14 @@
  */
 /**
  * Defines the latitude and longitude of the access point.
- * @export
- * @interface Geocode
  */
 export interface Geocode {
     /**
      * The latitude of access point.
-     * @type {string}
-     * @memberof Geocode
      */
     'latitude'?: string;
     /**
      * The longitude of access point.
-     * @type {string}
-     * @memberof Geocode
      */
     'longitude'?: string;
 }

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

@@ -12,14 +12,7 @@
 import type { GetAccessPointsResult } from './get-access-points-result';
 /**
  * The response schema for the GetAccessPoints operation.
- * @export
- * @interface GetAccessPointsResponse
  */
 export interface GetAccessPointsResponse {
-    /**
-     *
-     * @type {GetAccessPointsResult}
-     * @memberof GetAccessPointsResponse
-     */
     'payload'?: GetAccessPointsResult;
 }

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

@@ -12,14 +12,10 @@
 import type { AccessPoint } from './access-point';
 /**
  * The payload for the GetAccessPoints API.
- * @export
- * @interface GetAccessPointsResult
  */
 export interface GetAccessPointsResult {
     /**
      * Map of type of access point to list of access points
-     * @type {{ [key: string]: Array<AccessPoint>; }}
-     * @memberof GetAccessPointsResult
      */
     'accessPointsMap': {
         [key: string]: Array<AccessPoint>;

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

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the getAdditionalInputs operation.
- * @export
- * @interface GetAdditionalInputsResponse
  */
 export interface GetAdditionalInputsResponse {
     /**
      * The JSON schema to use to provide additional inputs when required to purchase a shipping offering.
-     * @type {{ [key: string]: object; }}
-     * @memberof GetAdditionalInputsResponse
      */
     'payload'?: {
         [key: string]: object;