@shipengine/connect-carrier-api 4.0.0-beta.3 → 4.0.1

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

@@ -0,0 +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',
+}

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

@@ -0,0 +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;
+}

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

@@ -6,6 +6,8 @@ export class CustomsCharges {
   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. */

package/src/models/customs/customs.ts

@@ -21,7 +21,7 @@ export class Customs {
   /** @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*/
-  termsOfTradeCode?: TermsOfTradeCode;
+  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.*/

package/src/models/index.ts

@@ -1,6 +1,8 @@
 export * from './addresses';
 export * from './advanced-options';
 export * from './authorization';
+export * from './cod-payment-type';
+export * from './collect-on-delivery';
 export * from './billing';
 export * from './confirmation-types';
 export * from './currency-schema';
@@ -31,3 +33,4 @@ export * from './time-window-schema';
 export * from './time-window';
 export * from './tracking';
 export * from './units';
+export * from './bill-to';

package/src/models/taxes/tax-identifier.ts

@@ -6,8 +6,10 @@ export class TaxIdentifier {
   id!: string;
   /** @description The Tax ID type */
   type!: TaxIdentifierType;
-  /** @description The country where the Tax ID is registered with */
+  /** @deprecated This property has been deprecated, please use registration_country instead */
   registration_county?: string;
+  /** @description The country where the Tax ID is registered with */
+  registration_country?: string;
   /** @description Description of the tax ID that may give the customs agent more context */
   description?: string;
 }

package/src/requests/create-label-request.ts

@@ -17,6 +17,7 @@ import {
   RelayPointDetails,
   DisplayScheme,
   Customs,
+  BillTo,
 } from '../models';
 
 /** @description Basic structure for a request to create a label */
@@ -54,4 +55,6 @@ export class CreateLabelRequest extends BaseRequest {
   /** @description Display schemes that the label will be returned in. Label is returned by default */
   display_schemes?: DisplayScheme[];
   customs?: Customs;
+  /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
+  bill_shipping_to?: BillTo;
 }

package/src/requests/get-rates-request.ts

@@ -10,6 +10,7 @@ import {
   PudoLocation,
   FulfillmentPlanDetails,
   TimeWindow,
+  BillTo,
 } from '../models';
 import { ShipmentItem } from '../models/shipment-item';
 
@@ -33,4 +34,6 @@ export class GetRatesRequest extends BaseRequest {
   carrier_pickup_window?: TimeWindow;
   /** Items included in the shipment */
   items?: ShipmentItem[];
+  /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
+  bill_shipping_to?: BillTo;
 }