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

package/src/models/tracking/track-event.ts

@@ -1,37 +1,37 @@
-import { LatLong } from './lat-long';
-import { StandardizedStatusCodes } from './standardized-status-codes';
-import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
-
-/** @description Basic structure for tracking events */
-export class TrackEvent {
-  /** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
-  event_datetime?: string;
-  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
-  event_datetime_local?: string;
-  /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
-  event_code?: string;
-  /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
-  carrier_detail_code?: string;
-  /** @description A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
-  proof_of_delivery_url?: string;
-  /** @description Description of the package status at this event */
-  description?: string;
-  /** @description City or Locality for this event */
-  city?: string;
-  /** @description State or province */
-  state?: string;
-  /** @description Zip or postal code */
-  postal_code?: string;
-  /** @description Country for this event */
-  country?: string;
-  /** @description The name of the company this is being delivered to */
-  company?: string;
-  /** @description If the event had a signer associated, normally on delivery */
-  signer?: string;
-  /** @description Geographical location */
-  geo?: LatLong;
-  /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
-  status_code?: StandardizedStatusCodes;
-  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
-  status_detail_code?: StandardizedStatusDetailCodes;
-}
+import { LatLong } from './lat-long';
+import { StandardizedStatusCodes } from './standardized-status-codes';
+import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+
+/** @description Basic structure for tracking events */
+export class TrackEvent {
+  /** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+  event_datetime?: string;
+  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
+  event_datetime_local?: string;
+  /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
+  event_code?: string;
+  /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
+  carrier_detail_code?: string;
+  /** @description A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
+  proof_of_delivery_url?: string;
+  /** @description Description of the package status at this event */
+  description?: string;
+  /** @description City or Locality for this event */
+  city?: string;
+  /** @description State or province */
+  state?: string;
+  /** @description Zip or postal code */
+  postal_code?: string;
+  /** @description Country for this event */
+  country?: string;
+  /** @description The name of the company this is being delivered to */
+  company?: string;
+  /** @description If the event had a signer associated, normally on delivery */
+  signer?: string;
+  /** @description Geographical location */
+  geo?: LatLong;
+  /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
+  status_code?: StandardizedStatusCodes;
+  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
+  status_detail_code?: StandardizedStatusDetailCodes;
+}

package/src/models/tracking/tracking-attribute.ts

@@ -1,5 +1,5 @@
-/** @description Attributes from the shipping provider about a shipment necessary for tracking */
-export class TrackingAttribute {
-  type!: string;
-  value!: string;
-}
+/** @description Attributes from the shipping provider about a shipment necessary for tracking */
+export class TrackingAttribute {
+  type!: string;
+  value!: string;
+}

package/src/models/tracking/tracking-identifier.ts

@@ -1,5 +1,5 @@
-/** @description Key value pair to allow for custom attributes required for tracking */
-export class TrackingIdentifier {
-  type!: string;
-  value!: string;
-}
+/** @description Key value pair to allow for custom attributes required for tracking */
+export class TrackingIdentifier {
+  type!: string;
+  value!: string;
+}

package/src/models/tracking/tracking-info-schema.ts

@@ -1,29 +1,29 @@
-import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
-import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
-import { DimensionsSchema } from '../units/dimensions-schema';
-import { ServiceSchema } from './service-schema';
-import { TrackEventSchema } from './track-event-schema';
-import Joi from 'joi';
-
-export const TrackingInfoSchema = Joi.object({
-  carrier_name: Joi.string().optional().empty(),
-  tracking_number: Joi.string().optional().empty(),
-  standardized_status_code: StandardizedStatusCodesSchema,
-  standardized_status_detail_code: StandardizedStatusDetailCodesSchema,
-  carrier_status_code: Joi.string().optional().empty(),
-  carrier_detail_code: Joi.string().optional().empty(),
-  carrier_status_description: Joi.string().optional().empty(),
-  shipped_datetime: Joi.string().optional().empty().isoDate(),
-  estimated_delivery_datetime: Joi.string().optional().empty(),
-  actual_delivery_datetime: Joi.string().optional().empty().isoDate(),
-  shipping_problem_description: Joi.string().optional().empty(),
-  weight: Joi.number().optional().empty(),
-  dimensions: DimensionsSchema.optional(),
-  service: ServiceSchema.optional(),
-  packaging: Joi.string().optional().empty(),
-  package_count: Joi.number().optional().empty(),
-  events: Joi.array().optional().items(TrackEventSchema),
-  shipping_problem: Joi.boolean().optional().empty(),
-  shipping_problem_code: Joi.string().optional().empty(),
-  error_description: Joi.string().optional().empty(),
-}).or('standardized_status_code', 'standardized_status_detail_code');
+import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
+import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
+import { DimensionsSchema } from '../units/dimensions-schema';
+import { ServiceSchema } from './service-schema';
+import { TrackEventSchema } from './track-event-schema';
+import Joi from 'joi';
+
+export const TrackingInfoSchema = Joi.object({
+  carrier_name: Joi.string().optional().empty(),
+  tracking_number: Joi.string().optional().empty(),
+  standardized_status_code: StandardizedStatusCodesSchema,
+  standardized_status_detail_code: StandardizedStatusDetailCodesSchema,
+  carrier_status_code: Joi.string().optional().empty(),
+  carrier_detail_code: Joi.string().optional().empty(),
+  carrier_status_description: Joi.string().optional().empty(),
+  shipped_datetime: Joi.string().optional().empty().isoDate(),
+  estimated_delivery_datetime: Joi.string().optional().empty(),
+  actual_delivery_datetime: Joi.string().optional().empty().isoDate(),
+  shipping_problem_description: Joi.string().optional().empty(),
+  weight: Joi.number().optional().empty(),
+  dimensions: DimensionsSchema.optional(),
+  service: ServiceSchema.optional(),
+  packaging: Joi.string().optional().empty(),
+  package_count: Joi.number().optional().empty(),
+  events: Joi.array().optional().items(TrackEventSchema),
+  shipping_problem: Joi.boolean().optional().empty(),
+  shipping_problem_code: Joi.string().optional().empty(),
+  error_description: Joi.string().optional().empty(),
+}).or('standardized_status_code', 'standardized_status_detail_code');

package/src/models/tracking/tracking-info.ts

@@ -1,49 +1,49 @@
-import { StandardizedStatusCodes } from './standardized-status-codes';
-import { Dimensions } from '../units/dimensions';
-import { Service } from './service';
-import { TrackEvent } from './track-event';
-import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
-
-/** @description Basic structure for tracking information */
-export class TrackingInfo {
-  /** @description The human readable name of the carrier tracking this shipment. */
-  carrier_name?: string;
-  /** @description The carrier specific tracking identifier for this shipment. */
-  tracking_number?: string;
-  /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
-  standardized_status_code?: StandardizedStatusCodes;
-  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
-  standardized_status_detail_code?: StandardizedStatusDetailCodes;
-  /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
-  carrier_status_code?: string;
-  /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
-  carrier_detail_code?: string;
-  /** @description The human readable description of this shipment's tracking status. */
-  carrier_status_description?: string;
-  /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
-  shipped_datetime?: string;
-  /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
-  estimated_delivery_datetime?: string;
-  /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
-  actual_delivery_datetime?: string;
-  /** @description A human readable description of why the shipment is in an error state. */
-  shipping_problem_description?: string;
-  /** @description The weight measured by the carrier of the package(s) in this shipment. */
-  weight?: number;
-  /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
-  dimensions?: Dimensions;
-  /** @description A shipping provider specific service. */
-  service?: Service;
-  /** @description The carrier packaging code. */
-  packaging?: string;
-  /** @description The carrier observed count of packages in this shipment. */
-  package_count?: number;
-  /** @description A list of tracking events for this shipment */
-  events?: TrackEvent[];
-  /** @description Whether or not this shipment has entered an error state. */
-  shipping_problem?: boolean;
-  /** @description The unique identifying code for the type of error encountered by this shipment. */
-  shipping_problem_code?: string;
-  /** @description The human readable explanation of the error encountered by this shipment. */
-  error_description?: string;
-}
+import { StandardizedStatusCodes } from './standardized-status-codes';
+import { Dimensions } from '../units/dimensions';
+import { Service } from './service';
+import { TrackEvent } from './track-event';
+import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+
+/** @description Basic structure for tracking information */
+export class TrackingInfo {
+  /** @description The human readable name of the carrier tracking this shipment. */
+  carrier_name?: string;
+  /** @description The carrier specific tracking identifier for this shipment. */
+  tracking_number?: string;
+  /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
+  standardized_status_code?: StandardizedStatusCodes;
+  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
+  standardized_status_detail_code?: StandardizedStatusDetailCodes;
+  /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
+  carrier_status_code?: string;
+  /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+  carrier_detail_code?: string;
+  /** @description The human readable description of this shipment's tracking status. */
+  carrier_status_description?: string;
+  /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+  shipped_datetime?: string;
+  /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+  estimated_delivery_datetime?: string;
+  /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+  actual_delivery_datetime?: string;
+  /** @description A human readable description of why the shipment is in an error state. */
+  shipping_problem_description?: string;
+  /** @description The weight measured by the carrier of the package(s) in this shipment. */
+  weight?: number;
+  /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
+  dimensions?: Dimensions;
+  /** @description A shipping provider specific service. */
+  service?: Service;
+  /** @description The carrier packaging code. */
+  packaging?: string;
+  /** @description The carrier observed count of packages in this shipment. */
+  package_count?: number;
+  /** @description A list of tracking events for this shipment */
+  events?: TrackEvent[];
+  /** @description Whether or not this shipment has entered an error state. */
+  shipping_problem?: boolean;
+  /** @description The unique identifying code for the type of error encountered by this shipment. */
+  shipping_problem_code?: string;
+  /** @description The human readable explanation of the error encountered by this shipment. */
+  error_description?: string;
+}

package/src/models/tracking/update-method-schema.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { UpdateMethods } from './update-method';
-
-export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));
+import Joi from 'joi';
+import { UpdateMethods } from './update-method';
+
+export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));

package/src/models/tracking/update-method.ts

@@ -1,7 +1,7 @@
-/** @description Update method to use for the tracking information */
-export enum UpdateMethods {
-  /** @description Append the new data to the existing data set */
-  Append = 'append',
-  /** @description Replace the existing data set with the new data */
-  Replace = 'replace',
-}
+/** @description Update method to use for the tracking information */
+export enum UpdateMethods {
+  /** @description Append the new data to the existing data set */
+  Append = 'append',
+  /** @description Replace the existing data set with the new data */
+  Replace = 'replace',
+}

package/src/models/units/carrier-weight.ts

@@ -1,9 +1,9 @@
-import { WeightUnit } from './weight-unit';
-
-/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
-export class CarrierWeight {
-  /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
-  value?: number;
-  /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
-  unit!: WeightUnit;
-}
+import { WeightUnit } from './weight-unit';
+
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+export class CarrierWeight {
+  /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+  value?: number;
+  /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+  unit!: WeightUnit;
+}

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

@@ -1,10 +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(),
-});
+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-details.ts

@@ -1,14 +1,14 @@
-import { Dimensions } from './dimensions';
-import { DimensionUnit } from './dimension-unit';
-
-/** @description Basic structure for package dimensions */
-export class DimensionDetails {
-  /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
-  dimensions_in_centimeters?: Dimensions;
-  /** @description This contains information about the dimensions in inches. This will always be present on the request */
-  dimensions_in_inches?: Dimensions;
-  /** @description This contains information about the dimensions in the source units. This will always be present on the request */
-  source_dimensions?: Dimensions;
-  /** @description The source units the customer provided */
-  source_dimension_unit!: DimensionUnit;
-}
+import { Dimensions } from './dimensions';
+import { DimensionUnit } from './dimension-unit';
+
+/** @description Basic structure for package dimensions */
+export class DimensionDetails {
+  /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
+  dimensions_in_centimeters?: Dimensions;
+  /** @description This contains information about the dimensions in inches. This will always be present on the request */
+  dimensions_in_inches?: Dimensions;
+  /** @description This contains information about the dimensions in the source units. This will always be present on the request */
+  source_dimensions?: Dimensions;
+  /** @description The source units the customer provided */
+  source_dimension_unit!: DimensionUnit;
+}

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

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

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

@@ -1,5 +1,5 @@
-/** @description Unit of measurement for dimensions */
-export enum DimensionUnit {
-  Inches = 'inches',
-  Centimeters = 'centimeters',
-}
+/** @description Unit of measurement for dimensions */
+export enum DimensionUnit {
+  Inches = 'inches',
+  Centimeters = 'centimeters',
+}

package/src/models/units/dimensions-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-
-export const DimensionsSchema = Joi.object({
-  length: Joi.number().optional(),
-  width: Joi.number().optional(),
-  height: Joi.number().optional(),
-});
+import Joi from 'joi';
+
+export const DimensionsSchema = Joi.object({
+  length: Joi.number().optional(),
+  width: Joi.number().optional(),
+  height: Joi.number().optional(),
+});

package/src/models/units/dimensions.ts

@@ -1,6 +1,6 @@
-/** @description Basic structure for dimensions */
-export class Dimensions {
-  length?: number;
-  width?: number;
-  height?: number;
-}
+/** @description Basic structure for dimensions */
+export class Dimensions {
+  length?: number;
+  width?: number;
+  height?: number;
+}

package/src/models/units/index.ts

@@ -1,6 +1,6 @@
-export * from './dimension-details';
-export * from './dimension-unit';
-export * from './dimensions-schema';
-export * from './dimensions';
-export * from './weight-details';
-export * from './weight-unit';
+export * from './dimension-details';
+export * from './dimension-unit';
+export * from './dimensions-schema';
+export * from './dimensions';
+export * from './weight-details';
+export * from './weight-unit';

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

@@ -1,9 +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(),
-});
+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-details.ts

@@ -1,13 +1,13 @@
-import { WeightUnit } from './weight-unit';
-
-/** @description Basic structure for weight */
-export class WeightDetails {
-  /** @description This contains information about the weight in ounces. This will always be present on the request */
-  weight_in_ounces?: number;
-  /** @description This contains information about the weight in grams. This will always be present on the request */
-  weight_in_grams?: number;
-  /** @description This contains information about the weight in source unit. This will always be present on the request */
-  source_weight?: number;
-  /** @description The source units the customer provided */
-  source_weight_unit!: WeightUnit;
-}
+import { WeightUnit } from './weight-unit';
+
+/** @description Basic structure for weight */
+export class WeightDetails {
+  /** @description This contains information about the weight in ounces. This will always be present on the request */
+  weight_in_ounces?: number;
+  /** @description This contains information about the weight in grams. This will always be present on the request */
+  weight_in_grams?: number;
+  /** @description This contains information about the weight in source unit. This will always be present on the request */
+  source_weight?: number;
+  /** @description The source units the customer provided */
+  source_weight_unit!: WeightUnit;
+}

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

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

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

@@ -1,7 +1,7 @@
-/** @description Unit of measurement for weight */
-export enum WeightUnit {
-  Grams = 'grams',
-  Ounces = 'ounces',
-  Kilograms = 'kilograms',
-  Pounds = 'pounds',
-}
+/** @description Unit of measurement for weight */
+export enum WeightUnit {
+  Grams = 'grams',
+  Ounces = 'ounces',
+  Kilograms = 'kilograms',
+  Pounds = 'pounds',
+}

package/src/models/windsor-framework/movement_indicator.ts

@@ -1,6 +1,6 @@
-export enum MovementIndicator {
-  B2C = 'b2c',
-  B2B = 'b2b',
-  C2C = 'c2c',
-  C2B = 'c2b',
-}
+export enum MovementIndicator {
+  B2C = 'b2c',
+  B2B = 'b2b',
+  C2C = 'c2c',
+  C2B = 'c2b',
+}

package/src/models/windsor-framework/windsor_framework_details.ts

@@ -1,6 +1,6 @@
-import { MovementIndicator } from './movement_indicator';
-
-export class WindsorFrameworkDetails {
-  not_at_risk?: boolean;
-  movement_indicator?: MovementIndicator;
-}
+import { MovementIndicator } from './movement_indicator';
+
+export class WindsorFrameworkDetails {
+  not_at_risk?: boolean;
+  movement_indicator?: MovementIndicator;
+}

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

@@ -1,8 +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(),
-});
+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/base-request.ts

@@ -1,10 +1,10 @@
-import { ConnectionNames } from '../app/metadata/connection-names-configuration';
-import { Authorization } from '../models';
-
-export class BaseRequest {
-  transaction_id!: string;
-  authorization?: Authorization;
-  metadata?: { [key: string]: any };
-  /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
-  connection_name?: ConnectionNames;
-}
+import { ConnectionNames } from '../app/metadata/connection-names-configuration';
+import { Authorization } from '../models';
+
+export class BaseRequest {
+  transaction_id!: string;
+  authorization?: Authorization;
+  metadata?: { [key: string]: any };
+  /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+  connection_name?: ConnectionNames;
+}

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

@@ -1,9 +1,9 @@
-import { ShippedShipment } from '../models';
-import { BaseRequest } from './base-request';
-
-export class CancelNotificationRequest extends BaseRequest {
-  /** @description The id of the notification */
-  notification_id!: string;
-  /** @description The shipment to which the notification pertains */
-  shipment_information!: ShippedShipment;
-}
+import { ShippedShipment } from '../models';
+import { BaseRequest } from './base-request';
+
+export class CancelNotificationRequest extends BaseRequest {
+  /** @description The id of the notification */
+  notification_id!: string;
+  /** @description The shipment to which the notification pertains */
+  shipment_information!: ShippedShipment;
+}

package/src/requests/cancel-pickup-request.ts

@@ -1,20 +1,20 @@
-import { BaseRequest } from './base-request';
-import {
-  CancellationDetails,
-  PickupConfirmation,
-  PickupContactDetails,
-  PickupLocationDetails,
-  PickupShipmentDetails,
-  PickupWindow,
-} from '../models';
-
-/** @description Basic structure for a request to cancel pickup */
-export class CancelPickupRequest extends BaseRequest {
-  confirmation?: PickupConfirmation;
-  location?: PickupLocationDetails;
-  cancellation_details?: CancellationDetails;
-  contact?: PickupContactDetails;
-  pickup_details?: PickupShipmentDetails;
-  pickup_windows?: PickupWindow[];
-  custom_properties?: { [key: string]: string };
-}
+import { BaseRequest } from './base-request';
+import {
+  CancellationDetails,
+  PickupConfirmation,
+  PickupContactDetails,
+  PickupLocationDetails,
+  PickupShipmentDetails,
+  PickupWindow,
+} from '../models';
+
+/** @description Basic structure for a request to cancel pickup */
+export class CancelPickupRequest extends BaseRequest {
+  confirmation?: PickupConfirmation;
+  location?: PickupLocationDetails;
+  cancellation_details?: CancellationDetails;
+  contact?: PickupContactDetails;
+  pickup_details?: PickupShipmentDetails;
+  pickup_windows?: PickupWindow[];
+  custom_properties?: { [key: string]: string };
+}