@shipengine/connect-carrier-api 2.12.20 → 4.0.0-beta.2

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

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

package/src/models/advanced-options.ts

@@ -1,4 +1,3 @@
-import { CollectOnDelivery } from './collect-on-delivery';
 import { Currency } from './currency';
 
 /** @description Basic structure for shipping options */
@@ -15,10 +14,6 @@ export class AdvancedOptions {
   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 Any other custom shipping options */
   [key: string]: any;
 }

package/src/models/authorization-schema.ts

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

package/src/models/billing/index.ts

@@ -2,4 +2,3 @@ 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';

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

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

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

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

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

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

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

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

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

@@ -0,0 +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).required(),
+  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

@@ -3,7 +3,7 @@ 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 { ImporterOfRecord } from '../importer-records/importer-of-record';
 import { CustomsCharges } from './customs-charges';
 
 /** @description Basic structure for a customs declaration */
@@ -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*/
-  terms_of_trade_code?: TermsOfTradeCode;
+  termsOfTradeCode?: 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/importer-records/importer-of-record-schema.ts

@@ -0,0 +1,16 @@
+import Joi from 'joi';
+import { TaxIdentifierSchema } from '../taxes/tax-identifier-schema';
+
+export const ImporterOfRecordSchema = Joi.object({
+  tax_identifiers: Joi.array().items(TaxIdentifierSchema).optional(),
+  name: Joi.string().optional(),
+  company_name: Joi.string().optional(),
+  address_line1: Joi.string().required(),
+  address_line2: Joi.string().optional(),
+  city_locality: Joi.string().optional(),
+  state_province: Joi.string().optional(),
+  postal_code: Joi.string().optional(),
+  country_code: Joi.string().optional(),
+  phone: Joi.string().optional(),
+  email: Joi.string().optional(),
+});

package/src/models/inconterms/terms-of-trade-code-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { TermsOfTradeCode } from './terms-of-trade-code';
+
+export const TermsOfTradeCodeSchema = Joi.string().valid(...Object.values(TermsOfTradeCode));

package/src/models/index.ts

@@ -1,8 +1,6 @@
 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';
@@ -32,4 +30,3 @@ export * from './time-window-schema';
 export * from './time-window';
 export * from './tracking';
 export * from './units';
-export * from './bill-to';

package/src/models/labels/label-message-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+
+export const LabelMessageSchema = Joi.object({
+  reference1: Joi.string().optional(),
+  reference2: Joi.string().optional(),
+  reference3: Joi.string().optional(),
+});

package/src/models/pickup/shipped-package-schema.ts

@@ -0,0 +1,21 @@
+import Joi from 'joi';
+import { IdentifierSchema } from '../identifier-schema';
+import { DimensionsSchema } from '../units';
+import { CurrencySchema } from '../currency-schema';
+import { DimensionDetailsSchema } from '../units/dimension-details-schema';
+import { WeightDetailsSchema } from '../units/weight-details-schema';
+import { LabelMessageSchema } from '../labels/label-message-schema';
+import { CustomsSchema } from '../customs/customs-schema';
+
+export const ShippedPackageSchema = Joi.object({
+  tracking_number: Joi.string().optional(),
+  alternative_identifiers: Joi.array().items(IdentifierSchema).optional(),
+  dimension_details: DimensionDetailsSchema.optional(),
+  weight_details: WeightDetailsSchema.optional(),
+  package_code: Joi.string().optional(),
+  weight: Joi.number().optional(),
+  dimensions: DimensionsSchema.optional(),
+  insured_value: CurrencySchema.required(),
+  label_messages: LabelMessageSchema.optional(),
+  customs: CustomsSchema.optional(),
+});

package/src/models/pickup/shipped-shipment-schema.ts

@@ -0,0 +1,18 @@
+import Joi from 'joi';
+import { IdentifierSchema } from '../../models';
+import { ShipToSchema } from '../addresses/ship-to-schema';
+import { ShippedPackageSchema } from './shipped-package-schema';
+import { AdvancedOptionsSchema } from '../advanced-options-schema';
+import { PudoLocationSchema } from '../addresses/pudo-location-schema';
+
+export const ShippedShipmentSchema = Joi.object({
+  tracking_number: Joi.string().optional(),
+  ship_to: ShipToSchema.optional(),
+  alternative_identifiers: Joi.array().items(IdentifierSchema).optional(),
+  service_code: Joi.string().optional(),
+  packages: Joi.array().items(ShippedPackageSchema).optional(),
+  advanced_options: AdvancedOptionsSchema.optional(),
+  pickup_location: PudoLocationSchema.optional(),
+});
+
+export const PickupShipment = ShippedShipmentSchema;

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

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { TaxIdentifierTypeSchema } from './tax-identifier-type-schema';
+
+export const TaxIdentifierSchema = Joi.object({
+  id: Joi.string(),
+  type: TaxIdentifierTypeSchema,
+  registration_county: Joi.string().optional(),
+  description: Joi.string().optional(),
+});

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

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { TaxIdentifierType } from './tax-identifier-type';
+
+export const TaxIdentifierTypeSchema = Joi.string().valid(...Object.values(TaxIdentifierType));

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

@@ -6,10 +6,8 @@ export class TaxIdentifier {
   id!: string;
   /** @description The Tax ID type */
   type!: TaxIdentifierType;
-  /** @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;
+  registration_county?: string;
   /** @description Description of the tax ID that may give the customs agent more context */
   description?: string;
 }

package/src/models/units/dimension-details-schema.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+import { DimensionsSchema } from './dimensions-schema';
+import { DimensionUnitSchema } from './dimension-unit-schema';
+
+export const DimensionDetailsSchema = Joi.object({
+  dimensions_in_centimeters: DimensionsSchema.optional(),
+  dimensions_in_inches: DimensionsSchema.optional(),
+  source_dimensions: DimensionsSchema.optional(),
+  source_dimension_unit: DimensionUnitSchema.required(),
+});

package/src/models/units/dimension-unit-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { DimensionUnit } from './dimension-unit';
+
+export const DimensionUnitSchema = Joi.string().valid(...Object.values(DimensionUnit));

package/src/models/units/weight-details-schema.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { WeightUnitSchema } from './weight-unit-schema';
+
+export const WeightDetailsSchema = Joi.object({
+  weight_in_ounces: Joi.number().optional,
+  weight_in_grams: Joi.number().optional,
+  source_weight: Joi.number().optional,
+  source_weight_unit: WeightUnitSchema.required(),
+});

package/src/models/units/weight-unit-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { WeightUnit } from './weight-unit';
+
+export const WeightUnitSchema = Joi.string().valid(...Object.values(WeightUnit));

package/src/requests/base-request-schema.ts

@@ -0,0 +1,8 @@
+import Joi from 'joi';
+import { AuthorizationSchema } from '../models/authorization-schema';
+
+export const BaseRequestSchema = Joi.object({
+  transaction_id: Joi.string().required(),
+  authorization: AuthorizationSchema.optional(),
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).optional(),
+});

package/src/requests/cancel-notification-request-schema.ts

@@ -0,0 +1,8 @@
+import Joi from 'joi';
+import { BaseRequestSchema } from './base-request-schema';
+import { ShippedShipmentSchema } from '../models/pickup/shipped-shipment-schema';
+
+export const CancelNotificationRequestSchema = BaseRequestSchema.keys({
+  notification_id: Joi.string().required(),
+  shipment_information: ShippedShipmentSchema.required(),
+});

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

@@ -17,7 +17,6 @@ import {
   RelayPointDetails,
   DisplayScheme,
   Customs,
-  BillTo,
 } from '../models';
 
 /** @description Basic structure for a request to create a label */
@@ -55,6 +54,4 @@ 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,7 +10,6 @@ import {
   PudoLocation,
   FulfillmentPlanDetails,
   TimeWindow,
-  BillTo,
 } from '../models';
 import { ShipmentItem } from '../models/shipment-item';
 
@@ -34,6 +33,4 @@ 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;
 }