@scaleleap/selling-partner-api-sdk/lib/api-models/shipping-api-model-v2/api.d.ts

📦 A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API

/**
 * Amazon Shipping API
 * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
 *
 * The version of the OpenAPI document: v2
 * Contact: swa-api-core@amazon.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
 * Access point details
 * @export
 * @interface AccessPoint
 */
export interface AccessPoint {
    /**
     * Unique identifier for the access point
     * @type {string}
     * @memberof AccessPoint
     */
    accessPointId?: string;
    /**
     * Name of entity (store/hub etc) where this access point is located
     * @type {string}
     * @memberof AccessPoint
     */
    name?: string;
    /**
     * Timezone of access point
     * @type {string}
     * @memberof AccessPoint
     */
    timezone?: string;
    /**
     *
     * @type {AccessPointType}
     * @memberof AccessPoint
     */
    type?: AccessPointType | 'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM';
    /**
     *
     * @type {AccessibilityAttributes}
     * @memberof AccessPoint
     */
    accessibilityAttributes?: AccessibilityAttributes;
    /**
     *
     * @type {Address}
     * @memberof AccessPoint
     */
    address?: Address;
    /**
     *
     * @type {Array<ExceptionOperatingHours>}
     * @memberof AccessPoint
     */
    exceptionOperatingHours?: Array<ExceptionOperatingHours>;
    /**
     *
     * @type {string}
     * @memberof AccessPoint
     */
    assistanceType?: AccessPointAssistanceTypeEnum | 'STAFF_ASSISTED' | 'SELF_ASSISTED';
    /**
     * The score of access point, based on proximity to postal code and sorting preference. This can be used to sort access point results on shipper\'s end.
     * @type {string}
     * @memberof AccessPoint
     */
    score?: string;
    /**
     * Map of day of the week to operating hours of that day
     * @type {{ [key: string]: OperatingHours; }}
     * @memberof AccessPoint
     */
    standardOperatingHours?: {
        [key: string]: OperatingHours;
    };
}
/**
    * @export
    * @enum {string}
    */
export declare enum AccessPointAssistanceTypeEnum {
    StaffAssisted = "STAFF_ASSISTED",
    SelfAssisted = "SELF_ASSISTED"
}
/**
 *
 * @export
 * @interface AccessPointDetails
 */
export interface AccessPointDetails {
    /**
     * Unique identifier for the access point
     * @type {string}
     * @memberof AccessPointDetails
     */
    accessPointId?: string;
}
/**
 * The type of access point, like counter (HELIX), lockers, etc.
 * @export
 * @enum {string}
 */
export declare enum AccessPointType {
    Helix = "HELIX",
    CampusLocker = "CAMPUS_LOCKER",
    OmniLocker = "OMNI_LOCKER",
    OdinLocker = "ODIN_LOCKER",
    DobbyLocker = "DOBBY_LOCKER",
    CoreLocker = "CORE_LOCKER",
    _3P = "3P",
    CampusRoom = "CAMPUS_ROOM"
}
/**
 * Defines the accessibility details of the access point.
 * @export
 * @interface AccessibilityAttributes
 */
export interface AccessibilityAttributes {
    /**
     * The approximate distance of access point from input postalCode\'s centroid.
     * @type {string}
     * @memberof AccessibilityAttributes
     */
    distance?: string;
    /**
     * The approximate (static) drive time from input postal code\'s centroid.
     * @type {number}
     * @memberof AccessibilityAttributes
     */
    driveTime?: number;
}
/**
 * Account Status.
 * @export
 * @enum {string}
 */
export declare enum AccountStatus {
    Active = "ACTIVE",
    Inactive = "INACTIVE",
    Pending = "PENDING",
    Suspended = "SUSPENDED"
}
/**
 * Shipper Account Type.
 * @export
 * @enum {string}
 */
export declare enum AccountType {
    ShipperAccount = "SHIPPER_ACCOUNT",
    ShipperAccountWithInvoice = "SHIPPER_ACCOUNT_WITH_INVOICE",
    AmazonAccount = "AMAZON_ACCOUNT"
}
/**
 * Active Account Details
 * @export
 * @interface ActiveAccount
 */
export interface ActiveAccount {
    /**
     * Account Id associated with this account.
     * @type {string}
     * @memberof ActiveAccount
     */
    accountId?: string;
    /**
     * The carrier identifier for the offering, provided by the carrier.
     * @type {string}
     * @memberof ActiveAccount
     */
    carrierId?: string;
}
/**
 * The address.
 * @export
 * @interface Address
 */
export interface Address {
    /**
     * The name of the person, business or institution at the address.
     * @type {string}
     * @memberof Address
     */
    name: string;
    /**
     * The first line of the address.
     * @type {string}
     * @memberof Address
     */
    addressLine1: string;
    /**
     * Additional address information, if required.
     * @type {string}
     * @memberof Address
     */
    addressLine2?: string;
    /**
     * Additional address information, if required.
     * @type {string}
     * @memberof Address
     */
    addressLine3?: string;
    /**
     * The name of the business or institution associated with the address.
     * @type {string}
     * @memberof Address
     */
    companyName?: string;
    /**
     * The state, county or region where the person, business or institution is located.
     * @type {string}
     * @memberof Address
     */
    stateOrRegion: string;
    /**
     * The city or town where the person, business or institution is located.
     * @type {string}
     * @memberof Address
     */
    city: string;
    /**
     * The two digit country code. Follows ISO 3166-1 alpha-2 format.
     * @type {string}
     * @memberof Address
     */
    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 Address
     */
    postalCode: string;
    /**
     * The email address of the contact associated with the address.
     * @type {string}
     * @memberof Address
     */
    email?: string;
    /**
     * The phone number of the person, business or institution located at that address, including the country calling code.
     * @type {string}
     * @memberof Address
     */
    phoneNumber?: string;
    /**
     *
     * @type {Geocode}
     * @memberof Address
     */
    geocode?: Geocode;
}
/**
 * Amazon order information. This is required if the shipment source channel is Amazon.
 * @export
 * @interface AmazonOrderDetails
 */
export interface AmazonOrderDetails {
    /**
     * The Amazon order ID associated with the Amazon order fulfilled by this shipment.
     * @type {string}
     * @memberof AmazonOrderDetails
     */
    orderId: string;
}
/**
 * Amazon shipment information.
 * @export
 * @interface AmazonShipmentDetails
 */
export interface AmazonShipmentDetails {
    /**
     * This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID.
     * @type {string}
     * @memberof AmazonShipmentDetails
     */
    shipmentId: string;
}
/**
 * The value-added services available for purchase with a shipping service offering.
 * @export
 * @interface AvailableValueAddedServiceGroup
 */
export interface AvailableValueAddedServiceGroup {
    /**
     * The type of the value-added service group.
     * @type {string}
     * @memberof AvailableValueAddedServiceGroup
     */
    groupId: string;
    /**
     * The name of the value-added service group.
     * @type {string}
     * @memberof AvailableValueAddedServiceGroup
     */
    groupDescription: string;
    /**
     * When true, one or more of the value-added services listed must be specified.
     * @type {boolean}
     * @memberof AvailableValueAddedServiceGroup
     */
    isRequired: boolean;
    /**
     * A list of optional value-added services available for purchase with a shipping service offering.
     * @type {Array<ValueAddedService>}
     * @memberof AvailableValueAddedServiceGroup
     */
    valueAddedServices?: Array<ValueAddedService>;
}
/**
 * Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon.
 * @export
 * @interface Benefits
 */
export interface Benefits {
    /**
     * A list of included benefits.
     * @type {Array<string>}
     * @memberof Benefits
     */
    includedBenefits: Array<string>;
    /**
     * A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation
     * @type {Array<ExcludedBenefit>}
     * @memberof Benefits
     */
    excludedBenefits: Array<ExcludedBenefit>;
}
/**
 * Response schema for the cancelShipment operation.
 * @export
 * @interface CancelShipmentResponse
 */
export interface CancelShipmentResponse {
    /**
     * The payload for the cancelShipment operation.
     * @type {{ [key: string]: object; }}
     * @memberof CancelShipmentResponse
     */
    payload?: {
        [key: string]: object;
    };
}
/**
 * Carrier Related Info
 * @export
 * @interface Carrier
 */
export interface Carrier {
    /**
     * The carrier identifier for the offering, provided by the carrier.
     * @type {string}
     * @memberof Carrier
     */
    id: string;
    /**
     * The carrier name for the offering.
     * @type {string}
     * @memberof Carrier
     */
    name: string;
}
/**
 * Attribute Properties required by carrier
 * @export
 * @interface CarrierAccountAttribute
 */
export interface CarrierAccountAttribute {
    /**
     * Attribute Name .
     * @type {string}
     * @memberof CarrierAccountAttribute
     */
    attributeName?: string;
    /**
     * Property Group.
     * @type {string}
     * @memberof CarrierAccountAttribute
     */
    propertyGroup?: string;
    /**
     * Value .
     * @type {string}
     * @memberof CarrierAccountAttribute
     */
    value?: string;
}
/**
 * Info About CarrierAccountInput
 * @export
 * @interface CarrierAccountInput
 */
export interface CarrierAccountInput {
    /**
     * descriptionLocalizationKey value .
     * @type {string}
     * @memberof CarrierAccountInput
     */
    descriptionLocalizationKey?: string;
    /**
     * name value .
     * @type {string}
     * @memberof CarrierAccountInput
     */
    name?: string;
    /**
     * groupName value .
     * @type {string}
     * @memberof CarrierAccountInput
     */
    groupName?: string;
    /**
     *
     * @type {InputType}
     * @memberof CarrierAccountInput
     */
    inputType?: InputType | 'TEXTBOX' | 'PASSWORD';
    /**
     * mandatory or not  value .
     * @type {boolean}
     * @memberof CarrierAccountInput
     */
    isMandatory?: boolean;
    /**
     * is value is Confidential .
     * @type {boolean}
     * @memberof CarrierAccountInput
     */
    isConfidential?: boolean;
    /**
     * is value is hidden .
     * @type {boolean}
     * @memberof CarrierAccountInput
     */
    isHidden?: boolean;
    /**
     * A list of ValidationMetadata
     * @type {Array<ValidationMetadata>}
     * @memberof CarrierAccountInput
     */
    validationMetadata?: Array<ValidationMetadata>;
}
/**
 * Shipment source channel related information.
 * @export
 * @interface ChannelDetails
 */
export interface ChannelDetails {
    /**
     *
     * @type {ChannelType}
     * @memberof ChannelDetails
     */
    channelType: ChannelType | 'AMAZON' | 'EXTERNAL';
    /**
     *
     * @type {AmazonOrderDetails}
     * @memberof ChannelDetails
     */
    amazonOrderDetails?: AmazonOrderDetails;
    /**
     *
     * @type {AmazonShipmentDetails}
     * @memberof ChannelDetails
     */
    amazonShipmentDetails?: AmazonShipmentDetails;
}
/**
 * The shipment source channel type.
 * @export
 * @enum {string}
 */
export declare enum ChannelType {
    Amazon = "AMAZON",
    External = "EXTERNAL"
}
/**
 * The type and amount of a charge applied on a package.
 * @export
 * @interface ChargeComponent
 */
export interface ChargeComponent {
    /**
     *
     * @type {Currency}
     * @memberof ChargeComponent
     */
    amount?: Currency;
    /**
     * The type of charge.
     * @type {string}
     * @memberof ChargeComponent
     */
    chargeType?: ChargeComponentChargeTypeEnum | 'TAX' | 'DISCOUNT';
}
/**
    * @export
    * @enum {string}
    */
export declare enum ChargeComponentChargeTypeEnum {
    Tax = "TAX",
    Discount = "DISCOUNT"
}
/**
 * Client Reference Details
 * @export
 * @interface ClientReferenceDetail
 */
export interface ClientReferenceDetail {
    /**
     * Client Reference type.
     * @type {string}
     * @memberof ClientReferenceDetail
     */
    clientReferenceType: ClientReferenceDetailClientReferenceTypeEnum | 'IntegratorShipperId' | 'IntegratorMerchantId';
    /**
     * The Client Reference Id.
     * @type {string}
     * @memberof ClientReferenceDetail
     */
    clientReferenceId: string;
}
/**
    * @export
    * @enum {string}
    */
export declare enum ClientReferenceDetailClientReferenceTypeEnum {
    IntegratorShipperId = "IntegratorShipperId",
    IntegratorMerchantId = "IntegratorMerchantId"
}
/**
 * The amount to collect on delivery.
 * @export
 * @interface CollectOnDelivery
 */
export interface CollectOnDelivery {
    /**
     *
     * @type {Currency}
     * @memberof CollectOnDelivery
     */
    amount: Currency;
}
/**
 * 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 | 'Completed' | 'InProgress';
    /**
     * Collection Form Id for Reprint .
     * @type {string}
     * @memberof CollectionFormsHistoryRecord
     */
    collectionFormId?: string;
    /**
     *
     * @type {Address}
     * @memberof CollectionFormsHistoryRecord
     */
    shipFromAddress?: Address;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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 | 'I' | 'II' | 'III';
    /**
     * The specific packing instruction of the item being shipped.
     * @type {string}
     * @memberof DangerousGoodsDetails
     */
    packingInstruction?: DangerousGoodsDetailsPackingInstructionEnum | 'PI965_SECTION_IA' | 'PI965_SECTION_IB' | 'PI965_SECTION_II' | 'PI966_SECTION_I' | 'PI966_SECTION_II' | 'PI967_SECTION_I' | 'PI967_SECTION_II' | 'PI968_SECTION_IA' | 'PI968_SECTION_IB' | 'PI969_SECTION_I' | 'PI969_SECTION_II' | 'PI970_SECTION_I' | 'PI970_SECTION_II';
}
/**
    * @export
    * @enum {string}
    */
export declare enum DangerousGoodsDetailsPackingGroupEnum {
    I = "I",
    Ii = "II",
    Iii = "III"
}
/**
    * @export
    * @enum {string}
    */
export declare enum DangerousGoodsDetailsPackingInstructionEnum {
    Pi965SectionIa = "PI965_SECTION_IA",
    Pi965SectionIb = "PI965_SECTION_IB",
    Pi965SectionIi = "PI965_SECTION_II",
    Pi966SectionI = "PI966_SECTION_I",
    Pi966SectionIi = "PI966_SECTION_II",
    Pi967SectionI = "PI967_SECTION_I",
    Pi967SectionIi = "PI967_SECTION_II",
    Pi968SectionIa = "PI968_SECTION_IA",
    Pi968SectionIb = "PI968_SECTION_IB",
    Pi969SectionI = "PI969_SECTION_I",
    Pi969SectionIi = "PI969_SECTION_II",
    Pi970SectionI = "PI970_SECTION_I",
    Pi970SectionIi = "PI970_SECTION_II"
}
/**
 * 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;
}
/**
 * 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 | 'INCH' | 'CENTIMETER';
}
/**
    * @export
    * @enum {string}
    */
export declare enum DimensionsUnitEnum {
    Inch = "INCH",
    Centimeter = "CENTIMETER"
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * The response schema for the directPurchaseShipment operation.
 * @export
 * @interface DirectPurchaseResponse
 */
export interface DirectPurchaseResponse {
    /**
     *
     * @type {DirectPurchaseResult}
     * @memberof DirectPurchaseResponse
     */
    payload?: DirectPurchaseResult;
}
/**
 * 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>;
}
/**
 * The file format of the document.
 * @export
 * @enum {string}
 */
export declare enum DocumentFormat {
    Pdf = "PDF",
    Png = "PNG",
    Zpl = "ZPL"
}
/**
 * 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 | 'INCH' | 'CENTIMETER';
}
/**
    * @export
    * @enum {string}
    */
export declare enum DocumentSizeUnitEnum {
    Inch = "INCH",
    Centimeter = "CENTIMETER"
}
/**
 * The type of shipping document.
 * @export
 * @enum {string}
 */
export declare enum DocumentType {
    Packslip = "PACKSLIP",
    Label = "LABEL",
    Receipt = "RECEIPT",
    CustomForm = "CUSTOM_FORM"
}
/**
 * A list of error responses returned when a request is unsuccessful.
 * @export
 * @interface ErrorList
 */
export interface ErrorList {
    /**
     *
     * @type {Array<Error>}
     * @memberof ErrorList
     */
    errors: Array<Error>;
}
/**
 * A tracking event.
 * @export
 * @interface Event
 */
export interface Event {
    /**
     *
     * @type {EventCode}
     * @memberof Event
     */
    eventCode: EventCode | 'ReadyForReceive' | 'PickupDone' | 'Delivered' | 'Departed' | 'DeliveryAttempted' | 'Lost' | 'OutForDelivery' | 'ArrivedAtCarrierFacility' | 'Rejected' | 'Undeliverable' | 'PickupCancelled';
    /**
     *
     * @type {Location}
     * @memberof Event
     */
    location?: Location;
    /**
     * The ISO 8601 formatted timestamp of the event.
     * @type {string}
     * @memberof Event
     */
    eventTime: string;
}
/**
 * The tracking event type.
 * @export
 * @enum {string}
 */
export declare enum EventCode {
    ReadyForReceive = "ReadyForReceive",
    PickupDone = "PickupDone",
    Delivered = "Delivered",
    Departed = "Departed",
    DeliveryAttempted = "DeliveryAttempted",
    Lost = "Lost",
    OutForDelivery = "OutForDelivery",
    ArrivedAtCarrierFacility = "ArrivedAtCarrierFacility",
    Rejected = "Rejected",
    Undeliverable = "Undeliverable",
    PickupCancelled = "PickupCancelled"
}
/**
 * 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;
}
/**
 * Object representing an excluded benefit that is excluded for an ShippingOffering/Rate.
 * @export
 * @interface ExcludedBenefit
 */
export interface ExcludedBenefit {
    /**
     *
     * @type {string}
     * @memberof ExcludedBenefit
     */
    benefit: string;
    /**
     *
     * @type {string}
     * @memberof ExcludedBenefit
     */
    reasonCode: string;
}
/**
 * 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;
}
/**
 * The Response  for the GenerateCollectionFormResponse operation.
 * @export
 * @interface GenerateCollectionFormResponse
 */
export interface GenerateCollectionFormResponse {
    /**
     *
     * @type {CollectionsFormDocument}
     * @memberof GenerateCollectionFormResponse
     */
    collectionsFormDocument?: CollectionsFormDocument;
}
/**
 * Generation Status.
 * @export
 * @enum {string}
 */
export declare enum GenerationStatus {
    Completed = "Completed",
    InProgress = "InProgress"
}
/**
 * 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;
}
/**
 * The response schema for the GetAccessPoints operation.
 * @export
 * @interface GetAccessPointsResponse
 */
export interface GetAccessPointsResponse {
    /**
     *
     * @type {GetAccessPointsResult}
     * @memberof GetAccessPointsResponse
     */
    payload?: GetAccessPointsResult;
}
/**
 * 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>;
    };
}
/**
 * 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;
    };
}
/**
 * The Response  for the GetCarrierAccountFormInputsResponse operation.
 * @export
 * @interface GetCarrierAccountFormInputsResponse
 */
export interface GetCarrierAccountFormInputsResponse {
    /**
     * A list of LinkableCarrier
     * @type {Array<LinkableCarrier>}
     * @memberof GetCarrierAccountFormInputsResponse
     */
    linkableCarriersList?: Array<LinkableCarrier>;
}
/**
 * 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>;
}
/**
 * The Response  for the GetCarrierAccountsResponse operation.
 * @export
 * @interface GetCarrierAccountsResponse
 */
export interface GetCarrierAccountsResponse {
    /**
     * A list of ActiveAccount
     * @type {Array<ActiveAccount>}
     * @memberof GetCarrierAccountsResponse
     */
    activeAccounts: Array<ActiveAccount>;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * The Response  for the GetCollectionFormResponse operation.
 * @export
 * @interface GetCollectionFormResponse
 */
export interface GetCollectionFormResponse {
    /**
     *
     * @type {CollectionsFormDocument}
     * @memberof GetCollectionFormResponse
     */
    collectionsFormDocument?: CollectionsFormDocument;
}
/**
 * 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 | 'FORWARD' | 'RETURNS';
    /**
     *
     * @type {AccessPointDetails}
     * @memberof GetRatesRequest
     */
    destinationAccessPointDetails?: AccessPointDetails;
}
/**
 * The response schema for the getRates operation.
 * @export
 * @interface GetRatesResponse
 */
export interface GetRatesResponse {
    /**
     *
     * @type {GetRatesResult}
     * @memberof GetRatesResponse
     */
    payload?: GetRatesResult;
}
/**
 * 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>;
}
/**
 * The response schema for the the getShipmentDocuments operation.
 * @export
 * @interface GetShipmentDocumentsResponse
 */
export interface GetShipmentDocumentsResponse {
    /**
     *
     * @type {GetShipmentDocumentsResult}
     * @memberof GetShipmentDocumentsResponse
     */
    payload?: GetShipmentDocumentsResult;
}
/**
 * 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;
}
/**
 * The response schema for the getTracking operation.
 * @export
 * @interface GetTrackingResponse
 */
export interface GetTrackingResponse {
    /**
     *
     * @type {GetTrackingResult}
     * @memberof GetTrackingResponse
     */
    payload?: GetTrackingResult;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * The Response  for the GetUnmanifestedShipmentsResponse operation.
 * @export
 * @interface GetUnmanifestedShipmentsResponse
 */
export interface GetUnmanifestedShipmentsResponse {
    /**
     * A list of UnmanifestedCarrierInformation
     * @type {Array<UnmanifestedCarrierInformation>}
     * @memberof GetUnmanifestedShipmentsResponse
     */
    unmanifestedCarrierInformationList?: Array<UnmanifestedCarrierInformation>;
}
/**
 * The reason why a shipping service offering is ineligible.
 * @export
 * @interface IneligibilityReason
 */
export interface IneligibilityReason {
    /**
     *
     * @type {IneligibilityReasonCode}
     * @memberof IneligibilityReason
     */
    code: IneligibilityReasonCode | 'NO_COVERAGE' | 'PICKUP_SLOT_RESTRICTION' | 'UNSUPPORTED_VAS' | 'VAS_COMBINATION_RESTRICTION' | 'SIZE_RESTRICTIONS' | 'WEIGHT_RESTRICTIONS' | 'LATE_DELIVERY' | 'PROGRAM_CONSTRAINTS' | 'TERMS_AND_CONDITIONS_NOT_ACCEPTED' | 'UNKNOWN';
    /**
     * The ineligibility reason.
     * @type {string}
     * @memberof IneligibilityReason
     */
    message: string;
}
/**
 * Reasons that make a shipment service offering ineligible.
 * @export
 * @enum {string}
 */
export declare enum IneligibilityReasonCode {
    NoCoverage = "NO_COVERAGE",
    PickupSlotRestriction = "PICKUP_SLOT_RESTRICTION",
    UnsupportedVas = "UNSUPPORTED_VAS",
    VasCombinationRestriction = "VAS_COMBINATION_RESTRICTION",
    SizeRestrictions = "SIZE_RESTRICTIONS",
    WeightRestrictions = "WEIGHT_RESTRICTIONS",
    LateDelivery = "LATE_DELIVERY",
    ProgramConstraints = "PROGRAM_CONSTRAINTS",
    TermsAndConditionsNotAccepted = "TERMS_AND_CONDITIONS_NOT_ACCEPTED",
    Unknown = "UNKNOWN"
}
/**
 * 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>;
}
/**
 * Type of Input.
 * @export
 * @enum {string}
 */
export declare enum InputType {
    Textbox = "TEXTBOX",
    Password = "PASSWORD"
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * The Response  for the LinkCarrierAccount operation.
 * @export
 * @interface LinkCarrierAccountResponse
 */
export interface LinkCarrierAccountResponse {
    /**
     *
     * @type {AccountStatus}
     * @memberof LinkCarrierAccountResponse
     */
    registrationStatus?: AccountStatus | 'ACTIVE' | 'INACTIVE' | 'PENDING' | 'SUSPENDED';
}
/**
 * Info About Linkable Account Type
 * @export
 * @interface LinkableAccountType
 */
export interface LinkableAccountType {
    /**
     *
     * @type {AccountType}
     * @memberof LinkableAccountType
     */
    accountType?: AccountType | 'SHIPPER_ACCOUNT' | 'SHIPPER_ACCOUNT_WITH_INVOICE' | 'AMAZON_ACCOUNT';
    /**
     * A list of CarrierAccountInput
     * @type {Array<CarrierAccountInput>}
     * @memberof LinkableAccountType
     */
    carrierAccountInputs?: Array<CarrierAccountInput>;
}
/**
 * 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>;
}
/**
 * Liquid Volume.
 * @export
 * @interface LiquidVolume
 */
export interface LiquidVolume {
    /**
     * The unit of measurement.
     * @type {string}
     * @memberof LiquidVolume
     */
    unit: LiquidVolumeUnitEnum | 'ML' | 'L' | 'FL_OZ' | 'GAL' | 'PT' | 'QT' | 'C';
    /**
     * The measurement value.
     * @type {number}
     * @memberof LiquidVolume
     */
    value: number;
}
/**
    * @export
    * @enum {string}
    */
export declare enum LiquidVolumeUnitEnum {
    Ml = "ML",
    L = "L",
    FlOz = "FL_OZ",
    Gal = "GAL",
    Pt = "PT",
    Qt = "QT",
    C = "C"
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * The time windows promised for pickup and delivery events.
 * @export
 * @interface ModelPromise
 */
export interface ModelPromise {
    /**
     *
     * @type {TimeWindow}
     * @memberof ModelPromise
     */
    deliveryWindow?: TimeWindow;
    /**
     *
     * @type {TimeWindow}
     * @memberof ModelPromise
     */
    pickupWindow?: TimeWindow;
}
/**
 * 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;
    /**
     * 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;
}
/**
 * The response schema for the OneClickShipment operation.
 * @export
 * @interface OneClickShipmentResponse
 */
export interface OneClickShipmentResponse {
    /**
     *
     * @type {OneClickShipmentResult}
     * @memberof OneClickShipmentResponse
     */
    payload?: OneClickShipmentResult;
}
/**
 * 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 {ModelPromise}
     * @memberof OneClickShipmentResult
     */
    promise: ModelPromise;
    /**
     *
     * @type {Carrier}
     * @memberof OneClickShipmentResult
     */
    carrier: Carrier;
    /**
     *
     * @type {Service}
     * @memberof OneClickShipmentResult
     */
    service: Service;
    /**
     *
     * @type {Currency}
     * @memberof OneClickShipmentResult
     */
    totalCharge: 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;
}
/**
 * The