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

package/src/models/addresses/address-base.ts

@@ -1,34 +1,34 @@
-import { AddressResidentialIndicator } from './address-residential-indicator';
-
-export class AddressBase {
-  /** @description The full name of the contact contact associated with the address */
-  name?: string;
-  /** @description The first name of the contact associated with the address */
-  first_name?: string;
-  /** @description The last name of the contact associated with the address */
-  last_name?: string;
-  /** @description The email of the contact associated with the address */
-  email?: string;
-  /** @description The phone number of the contact associated with the address (No Newline Characters) */
-  phone_number?: string;
-  /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
-  company_name?: string;
-  /** @description The address lines of the address (No Newline Characters) max length 100 characters */
-  address_lines?: string[];
-  /** @description City or locality (No Newline Characters) */
-  city_locality?: string;
-  /** @description State or province (No Newline Characters) */
-  state_province?: string;
-  /** @description Zip or postal code (No Newline Characters) */
-  postal_code!: string;
-  /** @description ISO 3166-1 two-letter country code max length 2 characters  */
-  country_code!: string;
-  /** @description Whether the address is residential or commercial */
-  address_residential_indicator?: AddressResidentialIndicator;
-  /** @description Whether the country of the shipment address is a member of the EU */
-  is_eu?: boolean;
-  /** @description Additional metadata provided for specific requests */
-  address_metadata?: { [key: string]: string };
-  /** @description Instructions to help the carrier navigate to the address */
-  instructions?: string;
-}
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export class AddressBase {
+  /** @description The full name of the contact contact associated with the address */
+  name?: string;
+  /** @description The first name of the contact associated with the address */
+  first_name?: string;
+  /** @description The last name of the contact associated with the address */
+  last_name?: string;
+  /** @description The email of the contact associated with the address */
+  email?: string;
+  /** @description The phone number of the contact associated with the address (No Newline Characters) */
+  phone_number?: string;
+  /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
+  company_name?: string;
+  /** @description The address lines of the address (No Newline Characters) max length 100 characters */
+  address_lines?: string[];
+  /** @description City or locality (No Newline Characters) */
+  city_locality?: string;
+  /** @description State or province (No Newline Characters) */
+  state_province?: string;
+  /** @description Zip or postal code (No Newline Characters) */
+  postal_code!: string;
+  /** @description ISO 3166-1 two-letter country code max length 2 characters  */
+  country_code!: string;
+  /** @description Whether the address is residential or commercial */
+  address_residential_indicator?: AddressResidentialIndicator;
+  /** @description Whether the country of the shipment address is a member of the EU */
+  is_eu?: boolean;
+  /** @description Additional metadata provided for specific requests */
+  address_metadata?: { [key: string]: string };
+  /** @description Instructions to help the carrier navigate to the address */
+  instructions?: string;
+}

package/src/models/addresses/address-residential-indicator-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { AddressResidentialIndicator } from './address-residential-indicator';
-
-export const AddressResidentialIndicatorSchema = Joi.string().valid(
-  ...Object.values(AddressResidentialIndicator),
-);
+import Joi from 'joi';
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export const AddressResidentialIndicatorSchema = Joi.string().valid(
+  ...Object.values(AddressResidentialIndicator),
+);

package/src/models/addresses/address-residential-indicator.ts

@@ -1,9 +1,9 @@
-/** @description Used for indicating whether an address is residential or commercial */
-export enum AddressResidentialIndicator {
-  /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
-  Unknown = 'unknown',
-  /** @description Indicates that the address is in a residential area */
-  Yes = 'yes',
-  /** @description Indicates that the address is not in a residential area */
-  No = 'no',
-}
+/** @description Used for indicating whether an address is residential or commercial */
+export enum AddressResidentialIndicator {
+  /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
+  Unknown = 'unknown',
+  /** @description Indicates that the address is in a residential area */
+  Yes = 'yes',
+  /** @description Indicates that the address is not in a residential area */
+  No = 'no',
+}

package/src/models/addresses/geolocation-item.ts

@@ -1,13 +1,13 @@
-/** @description Geolocation additional information for an address. */
-export class GeolocationItem {
-  /** @description Specifies the supported geolocation types. */
-  type?: GeolocationType;
-  /** @description The geolocation value. */
-  value?: string;
-}
-
-/** @description Supported geolocation types. */
-export enum GeolocationType {
-  /** @description what3words field to help identify the location */
-  what3words = 'what3words',
-}
+/** @description Geolocation additional information for an address. */
+export class GeolocationItem {
+  /** @description Specifies the supported geolocation types. */
+  type?: GeolocationType;
+  /** @description The geolocation value. */
+  value?: string;
+}
+
+/** @description Supported geolocation types. */
+export enum GeolocationType {
+  /** @description what3words field to help identify the location */
+  what3words = 'what3words',
+}

package/src/models/addresses/index.ts

@@ -1,7 +1,7 @@
-export * from './address-base';
-export * from './address-residential-indicator';
-export * from './ship-from';
-export * from './ship-from-display';
-export * from './ship-to';
-export * from './pudo-location';
-export * from './pudo-location-schema';
+export * from './address-base';
+export * from './address-residential-indicator';
+export * from './ship-from';
+export * from './ship-from-display';
+export * from './ship-to';
+export * from './pudo-location';
+export * from './pudo-location-schema';

package/src/models/addresses/pickup-address.ts

@@ -1,3 +1,3 @@
-import { AddressBase } from './address-base';
-
-export class PickupAddress extends AddressBase {}
+import { AddressBase } from './address-base';
+
+export class PickupAddress extends AddressBase {}

package/src/models/addresses/pudo-location-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-import { AddressBaseSchema } from './address-base-schema';
-
-export const PudoLocationSchema = AddressBaseSchema.keys({
-  carrier_code: Joi.string().optional(),
-  location_id: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { AddressBaseSchema } from './address-base-schema';
+
+export const PudoLocationSchema = AddressBaseSchema.keys({
+  carrier_code: Joi.string().optional(),
+  location_id: Joi.string().optional(),
+});

package/src/models/addresses/pudo-location.ts

@@ -1,9 +1,9 @@
-import { AddressBase } from './address-base';
-
-/** @description Pickup/Dropoff location used by carriers */
-export class PudoLocation extends AddressBase {
-  /** @description Standardized carrier code the location id belongs to */
-  carrier_code?: string;
-  /** @description Location id needed to look up the location */
-  location_id?: string;
-}
+import { AddressBase } from './address-base';
+
+/** @description Pickup/Dropoff location used by carriers */
+export class PudoLocation extends AddressBase {
+  /** @description Standardized carrier code the location id belongs to */
+  carrier_code?: string;
+  /** @description Location id needed to look up the location */
+  location_id?: string;
+}

package/src/models/addresses/service-point-address.ts

@@ -1,8 +1,8 @@
-import { LatLong } from '../tracking/lat-long';
-import { AddressBase } from './address-base';
-
-/** @description The basic address type related to service points */
-export class ServicePointAddress extends AddressBase {
-  /** @description Geographical location */
-  geo?: LatLong;
-}
+import { LatLong } from '../tracking/lat-long';
+import { AddressBase } from './address-base';
+
+/** @description The basic address type related to service points */
+export class ServicePointAddress extends AddressBase {
+  /** @description Geographical location */
+  geo?: LatLong;
+}

package/src/models/addresses/ship-from-display.ts

@@ -1,4 +1,4 @@
-import { AddressBase } from './address-base';
-
-/** @description The address that should be displayed on the label as the ship from location */
-export class ShipFromDisplay extends AddressBase {}
+import { AddressBase } from './address-base';
+
+/** @description The address that should be displayed on the label as the ship from location */
+export class ShipFromDisplay extends AddressBase {}

package/src/models/addresses/ship-from.ts

@@ -1,8 +1,8 @@
-import { AddressBase } from './address-base';
-import { TaxIdentifier } from '../taxes/tax-identifier';
-
-/** @description The address for where the shipment will be shipped from */
-export class ShipFrom extends AddressBase {
-  /** @description Tax IDs associated with the exporter */
-  tax_identifiers?: TaxIdentifier[];
-}
+import { AddressBase } from './address-base';
+import { TaxIdentifier } from '../taxes/tax-identifier';
+
+/** @description The address for where the shipment will be shipped from */
+export class ShipFrom extends AddressBase {
+  /** @description Tax IDs associated with the exporter */
+  tax_identifiers?: TaxIdentifier[];
+}

package/src/models/addresses/ship-to.ts

@@ -1,11 +1,11 @@
-import { AddressBase } from './address-base';
-import { TaxIdentifier } from '../taxes/tax-identifier';
-import { GeolocationItem } from './geolocation-item';
-
-/** @description The address that a shipment will be delivered to */
-export class ShipTo extends AddressBase {
-  /** @description Tax IDs associated with the consignee */
-  tax_identifiers?: TaxIdentifier[];
-  /** @description List of Geolocation objects to help identify the location. */
-  geolocation?: GeolocationItem[];
-}
+import { AddressBase } from './address-base';
+import { TaxIdentifier } from '../taxes/tax-identifier';
+import { GeolocationItem } from './geolocation-item';
+
+/** @description The address that a shipment will be delivered to */
+export class ShipTo extends AddressBase {
+  /** @description Tax IDs associated with the consignee */
+  tax_identifiers?: TaxIdentifier[];
+  /** @description List of Geolocation objects to help identify the location. */
+  geolocation?: GeolocationItem[];
+}

package/src/models/advanced-options-schema.ts

@@ -1,11 +1,11 @@
-import Joi from 'joi';
-import { CurrencySchema } from './currency-schema';
-
-export const AdvancedOptionsSchema = Joi.object({
-  contains_alcohol: Joi.boolean().optional(),
-  no_postage: Joi.boolean().optional(),
-  nonmachineable: Joi.boolean().optional(),
-  bill_duties_to_sender: Joi.boolean().optional(),
-  saturday_delivery: Joi.boolean().optional(),
-  tip: CurrencySchema.optional(),
-}).pattern(/.*/, Joi.any());
+import Joi from 'joi';
+import { CurrencySchema } from './currency-schema';
+
+export const AdvancedOptionsSchema = Joi.object({
+  contains_alcohol: Joi.boolean().optional(),
+  no_postage: Joi.boolean().optional(),
+  nonmachineable: Joi.boolean().optional(),
+  bill_duties_to_sender: Joi.boolean().optional(),
+  saturday_delivery: Joi.boolean().optional(),
+  tip: CurrencySchema.optional(),
+}).pattern(/.*/, Joi.any());

package/src/models/advanced-options.ts

@@ -1,50 +1,50 @@
-import { CollectOnDelivery } from './collect-on-delivery';
-import { Currency } from './currency';
-import { DangerousGoodsContact } from './dangerous-good/dangerous-goods-contact';
-import { WindsorFrameworkDetails } from './windsor-framework/windsor_framework_details';
-import { AccessibilityTypes } from './accessibility-types';
-import { Signatory } from './signatory';
-import { RegulationLevelTypes } from './dangerous-good/regulation-level-types';
-import { TransportMeanTypes } from './dangerous-good/transport-mean-types';
-
-/** @description Basic structure for shipping options */
-export class AdvancedOptions {
-  /** @description Whether the shipment contains alcohol */
-  contains_alcohol?: boolean;
-  /** @description Whether the shipment does not require postage */
-  no_postage?: boolean;
-  /** @description Whether the shipment can be processed by machine */
-  nonmachineable?: boolean;
-  /** @description Whether the shipment duties should be billed to the sender */
-  bill_duties_to_sender?: boolean;
-  /** @description Whether Saturday delivery is permissible  */
-  saturday_delivery?: boolean;
-  /** @description Amount to be paid to the driver, used for local delivery and courier services */
-  tip?: Currency;
-  /** @description Describes whether Additional Handling is requested for the shipment  */
-  additional_handling?: boolean;
-  /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
-  collect_on_delivery?: CollectOnDelivery;
-  /** @description Whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed */
-  own_document_upload?: boolean;
-  /** @description Indicates if the Dangerous goods are present in the shipment. */
-  dangerous_goods?: boolean;
-  /** @description Contact information for Dangerous goods */
-  dangerous_goods_contact?: DangerousGoodsContact;
-  /** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
-  limited_quantity?: boolean;
-  /** @description Any other custom shipping options */
-  event_notification?: boolean;
-  /** @description Any other custom shipping options */
-  windsor_framework_details?: WindsorFrameworkDetails;
-  /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
-  accessibility?: AccessibilityTypes;
-  /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
-  signatory?: Signatory;
-  /** @description Types of regulation level defined for dangerous good */
-  regulation_level?: RegulationLevelTypes;
-  /** @description Transportation means through which the dangerous goods are transported */
-  transport_mean?: TransportMeanTypes;
-  /** @description Indicates whether the recipient should be notified of events related to the shipment. */
-  [key: string]: any;
-}
+import { CollectOnDelivery } from './collect-on-delivery';
+import { Currency } from './currency';
+import { DangerousGoodsContact } from './dangerous-good/dangerous-goods-contact';
+import { WindsorFrameworkDetails } from './windsor-framework/windsor_framework_details';
+import { AccessibilityTypes } from './accessibility-types';
+import { Signatory } from './signatory';
+import { RegulationLevelTypes } from './dangerous-good/regulation-level-types';
+import { TransportMeanTypes } from './dangerous-good/transport-mean-types';
+
+/** @description Basic structure for shipping options */
+export class AdvancedOptions {
+  /** @description Whether the shipment contains alcohol */
+  contains_alcohol?: boolean;
+  /** @description Whether the shipment does not require postage */
+  no_postage?: boolean;
+  /** @description Whether the shipment can be processed by machine */
+  nonmachineable?: boolean;
+  /** @description Whether the shipment duties should be billed to the sender */
+  bill_duties_to_sender?: boolean;
+  /** @description Whether Saturday delivery is permissible  */
+  saturday_delivery?: boolean;
+  /** @description Amount to be paid to the driver, used for local delivery and courier services */
+  tip?: Currency;
+  /** @description Describes whether Additional Handling is requested for the shipment  */
+  additional_handling?: boolean;
+  /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
+  collect_on_delivery?: CollectOnDelivery;
+  /** @description Whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed */
+  own_document_upload?: boolean;
+  /** @description Indicates if the Dangerous goods are present in the shipment. */
+  dangerous_goods?: boolean;
+  /** @description Contact information for Dangerous goods */
+  dangerous_goods_contact?: DangerousGoodsContact;
+  /** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
+  limited_quantity?: boolean;
+  /** @description Any other custom shipping options */
+  event_notification?: boolean;
+  /** @description Any other custom shipping options */
+  windsor_framework_details?: WindsorFrameworkDetails;
+  /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
+  accessibility?: AccessibilityTypes;
+  /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
+  signatory?: Signatory;
+  /** @description Types of regulation level defined for dangerous good */
+  regulation_level?: RegulationLevelTypes;
+  /** @description Transportation means through which the dangerous goods are transported */
+  transport_mean?: TransportMeanTypes;
+  /** @description Indicates whether the recipient should be notified of events related to the shipment. */
+  [key: string]: any;
+}

package/src/models/authorization-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const AuthorizationSchema = Joi.object({
-  access_token: Joi.string().optional(),
-  connection_context: Joi.object().optional(),
-});
+import Joi from 'joi';
+
+export const AuthorizationSchema = Joi.object({
+  access_token: Joi.string().optional(),
+  connection_context: Joi.object().optional(),
+});

package/src/models/authorization.ts

@@ -1,6 +1,6 @@
-export class Authorization {
-  /** @description The access token used to authorize the request */
-  access_token?: string;
-  /** @description Optional - any additional information required to authorize the request */
-  connection_context?: any;
-}
+export class Authorization {
+  /** @description The access token used to authorize the request */
+  access_token?: string;
+  /** @description Optional - any additional information required to authorize the request */
+  connection_context?: any;
+}

package/src/models/bill-to.ts

@@ -1,15 +1,15 @@
-import { AddressBase } from './addresses';
-import { BillToParty } from './billing';
-
-/**
- * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
-        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
-        since address fields are often required when associating billing to
-        another account.  Additionally, this allows for a contact to be specified, if necessary.
- */
-export class BillTo extends AddressBase {
-  /** @description The bill_to_party mentions the type of billing option*/
-  bill_to_party?: BillToParty;
-  /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
-  account_number?: string;
-}
+import { AddressBase } from './addresses';
+import { BillToParty } from './billing';
+
+/**
+ * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
+        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
+        since address fields are often required when associating billing to
+        another account.  Additionally, this allows for a contact to be specified, if necessary.
+ */
+export class BillTo extends AddressBase {
+  /** @description The bill_to_party mentions the type of billing option*/
+  bill_to_party?: BillToParty;
+  /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
+  account_number?: string;
+}

package/src/models/billing/billing-categories-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { BillingCategories } from './billing-categories';
-
-export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));
+import Joi from 'joi';
+import { BillingCategories } from './billing-categories';
+
+export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

package/src/models/billing/billing-categories.ts

@@ -1,37 +1,37 @@
-/** @description Category for a billing line item */
-export enum BillingCategories {
-  Uncategorized = 'uncategorized',
-  Shipping = 'shipping',
-  Insurance = 'insurance',
-  /** @description Charge for delivery confirmation, e.g. requiring adult signature */
-  Confirm = 'confirm',
-  Discount = 'discount',
-  FuelCharge = 'fuel_charge',
-  AdditionalFees = 'additional_fees',
-  Tariff = 'tariff',
-  Tax = 'tax',
-  Delivery = 'delivery',
-  Handling = 'handling',
-  SpecialGoods = 'special_goods',
-  Pickup = 'pickup',
-  /** @description Charge for the location of the origin or destination */
-  LocationFee = 'location_fee',
-  /** @description Charge for non-standard sizes */
-  Oversize = 'oversize',
-  Returns = 'returns',
-  Notifications = 'notifications',
-  /** @description Amount to be paid to the driver, used for local delivery and courier services */
-  Tip = 'tip',
-  /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
-  DutiesAndTaxes = 'duties_and_taxes',
-  /** @description Fee for managing the import/export process, often separate from duties and taxes. */
-  BrokerageFee = 'brokerage_fee',
-  /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
-  AdminFee = 'admin_fee',
-  /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
-  Adjustment = 'adjustment',
-  /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
-  AuctaneServiceFee = 'auctane_service_fee',
-  /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
-  ProductPrice = 'product_price',
-}
+/** @description Category for a billing line item */
+export enum BillingCategories {
+  Uncategorized = 'uncategorized',
+  Shipping = 'shipping',
+  Insurance = 'insurance',
+  /** @description Charge for delivery confirmation, e.g. requiring adult signature */
+  Confirm = 'confirm',
+  Discount = 'discount',
+  FuelCharge = 'fuel_charge',
+  AdditionalFees = 'additional_fees',
+  Tariff = 'tariff',
+  Tax = 'tax',
+  Delivery = 'delivery',
+  Handling = 'handling',
+  SpecialGoods = 'special_goods',
+  Pickup = 'pickup',
+  /** @description Charge for the location of the origin or destination */
+  LocationFee = 'location_fee',
+  /** @description Charge for non-standard sizes */
+  Oversize = 'oversize',
+  Returns = 'returns',
+  Notifications = 'notifications',
+  /** @description Amount to be paid to the driver, used for local delivery and courier services */
+  Tip = 'tip',
+  /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+  DutiesAndTaxes = 'duties_and_taxes',
+  /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+  BrokerageFee = 'brokerage_fee',
+  /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+  AdminFee = 'admin_fee',
+  /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+  Adjustment = 'adjustment',
+  /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+  AuctaneServiceFee = 'auctane_service_fee',
+  /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+  ProductPrice = 'product_price',
+}

package/src/models/billing/billing-line-item-schema.ts

@@ -1,12 +1,12 @@
-import { BillingCategoriesSchema } from './billing-categories-schema';
-import { CurrencySchema } from '../currency-schema';
-import Joi from 'joi';
-
-export const BillingLineItemSchema = Joi.object({
-  billing_category: BillingCategoriesSchema.required(),
-  carrier_description: Joi.string().optional().empty().max(100),
-  carrier_billing_code: Joi.string().optional().empty(),
-  memo: Joi.string().optional().empty().max(250),
-  amount: CurrencySchema.required(),
-  provider_billed_amount: CurrencySchema.optional(),
-});
+import { BillingCategoriesSchema } from './billing-categories-schema';
+import { CurrencySchema } from '../currency-schema';
+import Joi from 'joi';
+
+export const BillingLineItemSchema = Joi.object({
+  billing_category: BillingCategoriesSchema.required(),
+  carrier_description: Joi.string().optional().empty().max(100),
+  carrier_billing_code: Joi.string().optional().empty(),
+  memo: Joi.string().optional().empty().max(250),
+  amount: CurrencySchema.required(),
+  provider_billed_amount: CurrencySchema.optional(),
+});

package/src/models/billing/billing-line-item.ts

@@ -1,21 +1,21 @@
-import { BillingCategories } from './billing-categories';
-import { Currency } from '../currency';
-import { TaxDetails } from './tax-details';
-
-/** @description Basic structure of each charge or line item */
-export class BillingLineItem {
-  /** A generalized category for what type of billing line item this is */
-  billing_category!: BillingCategories;
-  /** @description If the carrier provides a description from their API about the billing charge (not specific to the user). Maximum length of 100 characters. */
-  carrier_description?: string;
-  /** @description If the carrier provides a billing code for */
-  carrier_billing_code?: string;
-  /** @description This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters. */
-  memo?: string;
-  /** @description Total amount of the line item displayed and charged to the buyer */
-  amount!: Currency;
-  /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
-  provider_billed_amount?: Currency;
-  /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
-  tax_details?: TaxDetails;
-}
+import { BillingCategories } from './billing-categories';
+import { Currency } from '../currency';
+import { TaxDetails } from './tax-details';
+
+/** @description Basic structure of each charge or line item */
+export class BillingLineItem {
+  /** A generalized category for what type of billing line item this is */
+  billing_category!: BillingCategories;
+  /** @description If the carrier provides a description from their API about the billing charge (not specific to the user). Maximum length of 100 characters. */
+  carrier_description?: string;
+  /** @description If the carrier provides a billing code for */
+  carrier_billing_code?: string;
+  /** @description This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters. */
+  memo?: string;
+  /** @description Total amount of the line item displayed and charged to the buyer */
+  amount!: Currency;
+  /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
+  provider_billed_amount?: Currency;
+  /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+  tax_details?: TaxDetails;
+}

package/src/models/billing/billing-to-party.ts

@@ -1,10 +1,10 @@
-/** @description The type of party responsible for a given category of charges associated with a shipment, such as
- * shipping charges or import duties. */
-export enum BillToParty {
-  /** @description The shipper is generally regarded as the party responsible for the billing. */
-  Shipper = 'shipper',
-  /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
-  Recipient = 'recipient',
-  /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
-  ThirdPartyAccount = 'third_party_account',
-}
+/** @description The type of party responsible for a given category of charges associated with a shipment, such as
+ * shipping charges or import duties. */
+export enum BillToParty {
+  /** @description The shipper is generally regarded as the party responsible for the billing. */
+  Shipper = 'shipper',
+  /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
+  Recipient = 'recipient',
+  /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
+  ThirdPartyAccount = 'third_party_account',
+}