@shipengine/connect-carrier-api 4.16.7 → 4.16.8-beta.1

package/src/models/billing/index.ts

@@ -1,6 +1,6 @@
-export * from './billing-categories';
-export * from './billing-categories-schema';
-export * from './billing-line-item';
-export * from './billing-line-item-schema';
-export * from './billing-to-party';
-export * from './tax-details';
+export * from './billing-categories';
+export * from './billing-categories-schema';
+export * from './billing-line-item';
+export * from './billing-line-item-schema';
+export * from './billing-to-party';
+export * from './tax-details';

package/src/models/billing/tax-details.ts

@@ -1,8 +1,8 @@
-import { TaxType } from '../taxes';
-
-export class TaxDetails {
-  tax_type?: TaxType;
-  tax_code?: string;
-  /** @description Tax percentage, e.g. 20, 23.7 */
-  tax_percentage?: number;
-}
+import { TaxType } from '../taxes';
+
+export class TaxDetails {
+  tax_type?: TaxType;
+  tax_code?: string;
+  /** @description Tax percentage, e.g. 20, 23.7 */
+  tax_percentage?: number;
+}

package/src/models/cod-payment-type.ts

@@ -1,9 +1,9 @@
-/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
-export enum CodPaymentType {
-  /** @description Any payment method is permitted */
-  Any = 'any',
-  /** @description Only cash is permitted */
-  Cash = 'cash',
-  /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
-  GuaranteedFunds = 'guaranteed_funds',
-}
+/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
+export enum CodPaymentType {
+  /** @description Any payment method is permitted */
+  Any = 'any',
+  /** @description Only cash is permitted */
+  Cash = 'cash',
+  /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
+  GuaranteedFunds = 'guaranteed_funds',
+}

package/src/models/collect-on-delivery.ts

@@ -1,10 +1,10 @@
-import { CodPaymentType } from './cod-payment-type';
-import { Currency } from './currency';
-
-/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
-export class CollectOnDelivery {
-  /** @description The payment amount for Collect on Delivery (COD) */
-  payment_amount!: Currency;
-  /** @description The payment method permitted for Collect on Delivery (COD) */
-  payment_type?: CodPaymentType;
-}
+import { CodPaymentType } from './cod-payment-type';
+import { Currency } from './currency';
+
+/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
+export class CollectOnDelivery {
+  /** @description The payment amount for Collect on Delivery (COD) */
+  payment_amount!: Currency;
+  /** @description The payment method permitted for Collect on Delivery (COD) */
+  payment_type?: CodPaymentType;
+}

package/src/models/confirmation-types.ts

@@ -1,13 +1,13 @@
-/** @description Types of delivery confirmation */
-export enum ConfirmationTypes {
-  /** @description No confirmation is requested */
-  None = 'None',
-  /** @description Delivery confirmation is requested */
-  Delivery = 'Delivery',
-  /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present) */
-  Signature = 'Signature',
-  /** @description A signature of an adult is required */
-  AdultSignature = 'AdultSignature',
-  /** @description Only supported by FedEx. The signature of somebody at the address is required */
-  DirectSignature = 'DirectSignature',
-}
+/** @description Types of delivery confirmation */
+export enum ConfirmationTypes {
+  /** @description No confirmation is requested */
+  None = 'None',
+  /** @description Delivery confirmation is requested */
+  Delivery = 'Delivery',
+  /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present) */
+  Signature = 'Signature',
+  /** @description A signature of an adult is required */
+  AdultSignature = 'AdultSignature',
+  /** @description Only supported by FedEx. The signature of somebody at the address is required */
+  DirectSignature = 'DirectSignature',
+}

package/src/models/currency-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const CurrencySchema = Joi.object({
-  currency: Joi.string().required(),
-  amount: Joi.string().required(),
-});
+import Joi from 'joi';
+
+export const CurrencySchema = Joi.object({
+  currency: Joi.string().required(),
+  amount: Joi.string().required(),
+});

package/src/models/currency.ts

@@ -1,7 +1,7 @@
-/** @description Basic structure for defining an amount of money and its currency */
-export class Currency {
-  /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
-  currency!: string;
-  /** @description The amount */
-  amount!: string;
-}
+/** @description Basic structure for defining an amount of money and its currency */
+export class Currency {
+  /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
+  currency!: string;
+  /** @description The amount */
+  amount!: string;
+}

package/src/models/customs/customs-charges-schema.ts

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-import { CurrencySchema } from '../currency-schema';
-
-export const CustomsChargesSchema = Joi.object({
-  freight_charge: CurrencySchema.optional(),
-  other_charge: CurrencySchema.optional(),
-  insurance_charge: CurrencySchema.optional(),
-  discount: CurrencySchema.optional(),
-});
+import Joi from 'joi';
+import { CurrencySchema } from '../currency-schema';
+
+export const CustomsChargesSchema = Joi.object({
+  freight_charge: CurrencySchema.optional(),
+  other_charge: CurrencySchema.optional(),
+  insurance_charge: CurrencySchema.optional(),
+  discount: CurrencySchema.optional(),
+});

package/src/models/customs/customs-charges.ts

@@ -1,20 +1,20 @@
-import { Currency } from '../currency';
-import { EstimatedImportCharges } from './estimated-import-charges';
-
-/** @description This model represents the charges related with customs. */
-export class CustomsCharges {
-  /** @description Freight charge for international shipments. */
-  freight_charge?: Currency;
-  /** @description Other charge for international shipments. */
-  other_charge?: Currency;
-  /** @description : Description for other charge for international shipments.*/
-  other_charge_description?: string;
-  /** @description Insurance charge for international shipments. */
-  insurance_charge?: Currency;
-  /** @description Discount for international shipments. */
-  discount?: Currency;
-  /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
-  estimated_import_charges?: EstimatedImportCharges;
-  /** @description : The invoice number to be used in the customs.*/
-  invoice_number?: string;
-}
+import { Currency } from '../currency';
+import { EstimatedImportCharges } from './estimated-import-charges';
+
+/** @description This model represents the charges related with customs. */
+export class CustomsCharges {
+  /** @description Freight charge for international shipments. */
+  freight_charge?: Currency;
+  /** @description Other charge for international shipments. */
+  other_charge?: Currency;
+  /** @description : Description for other charge for international shipments.*/
+  other_charge_description?: string;
+  /** @description Insurance charge for international shipments. */
+  insurance_charge?: Currency;
+  /** @description Discount for international shipments. */
+  discount?: Currency;
+  /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+  estimated_import_charges?: EstimatedImportCharges;
+  /** @description : The invoice number to be used in the customs.*/
+  invoice_number?: string;
+}

package/src/models/customs/customs-content-types-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { CustomsContentTypes } from './customs-content-types';
-
-export const CustomsContentTypesSchema = Joi.string().valid(...Object.values(CustomsContentTypes));
+import Joi from 'joi';
+import { CustomsContentTypes } from './customs-content-types';
+
+export const CustomsContentTypesSchema = Joi.string().valid(...Object.values(CustomsContentTypes));

package/src/models/customs/customs-content-types.ts

@@ -1,15 +1,15 @@
-/** @description Denotes the type of content for customs  */
-export enum CustomsContentTypes {
-  /** @description This is generalized merchandise that someone has purchased */
-  Merchandise = 'merchandise',
-  /** @description Documents that are being shipped */
-  Documents = 'documents',
-  /** @description An item that is being shipped as a gift (not purchased) */
-  Gift = 'gift',
-  /** @description Sample goods that are being shipped */
-  Sample = 'sample',
-  /** @description Items that are being returned */
-  ReturnedGoods = 'returned_goods',
-  /** @description   What other means in case of the shipment*/
-  Other = 'other',
-}
+/** @description Denotes the type of content for customs  */
+export enum CustomsContentTypes {
+  /** @description This is generalized merchandise that someone has purchased */
+  Merchandise = 'merchandise',
+  /** @description Documents that are being shipped */
+  Documents = 'documents',
+  /** @description An item that is being shipped as a gift (not purchased) */
+  Gift = 'gift',
+  /** @description Sample goods that are being shipped */
+  Sample = 'sample',
+  /** @description Items that are being returned */
+  ReturnedGoods = 'returned_goods',
+  /** @description   What other means in case of the shipment*/
+  Other = 'other',
+}

package/src/models/customs/customs-item-schema.ts

@@ -1,17 +1,17 @@
-import Joi from 'joi';
-import { CurrencySchema } from '../currency-schema';
-import { WeightDetailsSchema } from '../units/weight-details-schema';
-
-export const CustomsItemSchema = Joi.object({
-  description: Joi.string().optional(),
-  quantity: Joi.number().optional(),
-  value: CurrencySchema.optional(),
-  country_of_origin: Joi.string().optional(),
-  harmonized_tariff_code: Joi.string().optional(),
-  sku: Joi.string().optional(),
-  sku_description: Joi.string().optional(),
-  item_weight: WeightDetailsSchema.optional(),
-  product_url: Joi.string().optional(),
-  vat_rate: Joi.number().optional(),
-  mid_code: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { CurrencySchema } from '../currency-schema';
+import { WeightDetailsSchema } from '../units/weight-details-schema';
+
+export const CustomsItemSchema = Joi.object({
+  description: Joi.string().optional(),
+  quantity: Joi.number().optional(),
+  value: CurrencySchema.optional(),
+  country_of_origin: Joi.string().optional(),
+  harmonized_tariff_code: Joi.string().optional(),
+  sku: Joi.string().optional(),
+  sku_description: Joi.string().optional(),
+  item_weight: WeightDetailsSchema.optional(),
+  product_url: Joi.string().optional(),
+  vat_rate: Joi.number().optional(),
+  mid_code: Joi.string().optional(),
+});

package/src/models/customs/customs-item.ts

@@ -1,30 +1,30 @@
-import { Currency } from '../currency';
-import { WeightDetails } from '../units';
-
-/** @deprecated This object has been deprecated, please use packages.products[] instead */
-export class CustomsItem {
-  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
-  description?: string;
-  /** @description The user specified count of items in this declaration. This value should be 1 or greater */
-  quantity?: number;
-  /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
-  value?: Currency;
-  /** @description The user specified declared country of origin of this customs item */
-  country_of_origin?: string;
-  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
-  harmonized_tariff_code?: string;
-  /** @description The user specified SKU of this customs item. This field is completely free form. */
-  sku?: string;
-  /** @description The user specified SKU description of this customs item. This field is completely free form. */
-  sku_description?: string;
-  /** @description Detailed information about the weight of this item */
-  item_weight?: WeightDetails;
-  /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
-  product_url?: string;
-  /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
-  vat_rate?: number;
-  /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
-  mid_code?: string;
-  /** @description Additional details for product. */
-  [key: string]: any;
-}
+import { Currency } from '../currency';
+import { WeightDetails } from '../units';
+
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
+export class CustomsItem {
+  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
+  description?: string;
+  /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+  quantity?: number;
+  /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+  value?: Currency;
+  /** @description The user specified declared country of origin of this customs item */
+  country_of_origin?: string;
+  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+  harmonized_tariff_code?: string;
+  /** @description The user specified SKU of this customs item. This field is completely free form. */
+  sku?: string;
+  /** @description The user specified SKU description of this customs item. This field is completely free form. */
+  sku_description?: string;
+  /** @description Detailed information about the weight of this item */
+  item_weight?: WeightDetails;
+  /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+  product_url?: string;
+  /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+  vat_rate?: number;
+  /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+  mid_code?: string;
+  /** @description Additional details for product. */
+  [key: string]: any;
+}

package/src/models/customs/customs-non-delivery-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { CustomsNonDelivery } from './customs-non-delivery';
-
-export const CustomsNonDeliverySchema = Joi.string().valid(...Object.values(CustomsNonDelivery));
+import Joi from 'joi';
+import { CustomsNonDelivery } from './customs-non-delivery';
+
+export const CustomsNonDeliverySchema = Joi.string().valid(...Object.values(CustomsNonDelivery));

package/src/models/customs/customs-non-delivery.ts

@@ -1,7 +1,7 @@
-/** @description Denotes the action that should be taken when a shipment is not deliverable */
-export enum CustomsNonDelivery {
-  /** @description Make an attempt to return this package to sender if unable to deliver */
-  ReturnToSender = 'return_to_sender',
-  /** @description Do not make an attempt to return this package to sender if unable to deliver */
-  TreatAsAbandoned = 'treat_as_abandoned',
-}
+/** @description Denotes the action that should be taken when a shipment is not deliverable */
+export enum CustomsNonDelivery {
+  /** @description Make an attempt to return this package to sender if unable to deliver */
+  ReturnToSender = 'return_to_sender',
+  /** @description Do not make an attempt to return this package to sender if unable to deliver */
+  TreatAsAbandoned = 'treat_as_abandoned',
+}

package/src/models/customs/customs-schema.ts

@@ -1,21 +1,21 @@
-import Joi from 'joi';
-import { CustomsContentTypesSchema } from './customs-content-types-schema';
-import { CustomsNonDeliverySchema } from './customs-non-delivery-schema';
-import { CustomsItemSchema } from './customs-item-schema';
-import { CurrencySchema } from '../currency-schema';
-import { TermsOfTradeCodeSchema } from '../inconterms/terms-of-trade-code-schema';
-import { ImporterOfRecordSchema } from '../importer-records/importer-of-record-schema';
-import { CustomsChargesSchema } from './customs-charges-schema';
-
-export const CustomsSchema = Joi.object({
-  contents: CustomsContentTypesSchema.optional(),
-  non_delivery: CustomsNonDeliverySchema.optional(),
-  customs_items: Joi.array().items(CustomsItemSchema).optional(),
-  buyer_shipping_amount_paid: CurrencySchema.optional(),
-  duties_paid: CurrencySchema.optional(),
-  declaration: Joi.string().optional(),
-  termsOfTradeCode: TermsOfTradeCodeSchema.optional(),
-  importer_of_record: ImporterOfRecordSchema.optional(),
-  invoice_additional_details: CustomsChargesSchema.optional(),
-  contents_explanation: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { CustomsContentTypesSchema } from './customs-content-types-schema';
+import { CustomsNonDeliverySchema } from './customs-non-delivery-schema';
+import { CustomsItemSchema } from './customs-item-schema';
+import { CurrencySchema } from '../currency-schema';
+import { TermsOfTradeCodeSchema } from '../inconterms/terms-of-trade-code-schema';
+import { ImporterOfRecordSchema } from '../importer-records/importer-of-record-schema';
+import { CustomsChargesSchema } from './customs-charges-schema';
+
+export const CustomsSchema = Joi.object({
+  contents: CustomsContentTypesSchema.optional(),
+  non_delivery: CustomsNonDeliverySchema.optional(),
+  customs_items: Joi.array().items(CustomsItemSchema).optional(),
+  buyer_shipping_amount_paid: CurrencySchema.optional(),
+  duties_paid: CurrencySchema.optional(),
+  declaration: Joi.string().optional(),
+  termsOfTradeCode: TermsOfTradeCodeSchema.optional(),
+  importer_of_record: ImporterOfRecordSchema.optional(),
+  invoice_additional_details: CustomsChargesSchema.optional(),
+  contents_explanation: Joi.string().optional(),
+});

package/src/models/customs/customs.ts

@@ -1,37 +1,37 @@
-import { CustomsContentTypes } from './customs-content-types';
-import { CustomsNonDelivery } from './customs-non-delivery';
-import { CustomsItem } from './customs-item';
-import { Currency } from '../currency';
-import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
-import { ImporterOfRecord } from '../importer-records/importer-of-record';
-import { CustomsCharges } from './customs-charges';
-
-/** @description Basic structure for a customs declaration */
-export class Customs {
-  /** @description Indicates the type of contents associated with this shipment */
-  contents?: CustomsContentTypes;
-  /** @description Indicates what the seller would like done in case of an issue with delivery */
-  non_delivery?: CustomsNonDelivery;
-  /** @deprecated This object has been deprecated, please use packages.products[] instead */
-  customs_items!: CustomsItem[];
-  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
-  buyer_shipping_amount_paid?: Currency;
-  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
-  duties_paid?: Currency;
-  /** @description Declaration statement to be placed on the commercial invoice */
-  declaration?: string;
-  /** @description  Incoterms specify who is responsible for paying for and managing the shipment*/
-  terms_of_trade_code?: TermsOfTradeCode;
-  /** @description The owner or purchaser of the products being imported into a destination country.*/
-  importer_of_record?: ImporterOfRecord;
-  /** @description The charges related with customs.*/
-  invoice_additional_details?: CustomsCharges;
-  /**@description:   text explanation for the content */
-  contents_explanation?: String;
-  /**@description:   An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
-  export_declaration_number?: String;
-  /**@description:   The license number to be used in the customs. */
-  license_number?: String;
-  /**@description:   The certificate number to be used in the customs. */
-  certificate_number?: String;
-}
+import { CustomsContentTypes } from './customs-content-types';
+import { CustomsNonDelivery } from './customs-non-delivery';
+import { CustomsItem } from './customs-item';
+import { Currency } from '../currency';
+import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
+import { ImporterOfRecord } from '../importer-records/importer-of-record';
+import { CustomsCharges } from './customs-charges';
+
+/** @description Basic structure for a customs declaration */
+export class Customs {
+  /** @description Indicates the type of contents associated with this shipment */
+  contents?: CustomsContentTypes;
+  /** @description Indicates what the seller would like done in case of an issue with delivery */
+  non_delivery?: CustomsNonDelivery;
+  /** @deprecated This object has been deprecated, please use packages.products[] instead */
+  customs_items!: CustomsItem[];
+  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
+  buyer_shipping_amount_paid?: Currency;
+  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
+  duties_paid?: Currency;
+  /** @description Declaration statement to be placed on the commercial invoice */
+  declaration?: string;
+  /** @description  Incoterms specify who is responsible for paying for and managing the shipment*/
+  terms_of_trade_code?: TermsOfTradeCode;
+  /** @description The owner or purchaser of the products being imported into a destination country.*/
+  importer_of_record?: ImporterOfRecord;
+  /** @description The charges related with customs.*/
+  invoice_additional_details?: CustomsCharges;
+  /**@description:   text explanation for the content */
+  contents_explanation?: String;
+  /**@description:   An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
+  export_declaration_number?: String;
+  /**@description:   The license number to be used in the customs. */
+  license_number?: String;
+  /**@description:   The certificate number to be used in the customs. */
+  certificate_number?: String;
+}

package/src/models/customs/estimated-import-charges.ts

@@ -1,9 +1,9 @@
-import { Currency } from '../currency';
-
-/** @description Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice. */
-export class EstimatedImportCharges {
-  /** @description Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST). */
-  taxes?: Currency;
-  /** @description Estimated amount and currency of import duties. */
-  duties?: Currency;
-}
+import { Currency } from '../currency';
+
+/** @description Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice. */
+export class EstimatedImportCharges {
+  /** @description Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST). */
+  taxes?: Currency;
+  /** @description Estimated amount and currency of import duties. */
+  duties?: Currency;
+}

package/src/models/customs/index.ts

@@ -1,4 +1,4 @@
-export * from './customs';
-export * from './customs-item';
-export * from './customs-content-types';
-export * from './customs-non-delivery';
+export * from './customs';
+export * from './customs-item';
+export * from './customs-content-types';
+export * from './customs-non-delivery';