@shipengine/connect-carrier-api 4.18.1 → 4.20.0

package/src/app/metadata/confirmation-type.ts

@@ -15,6 +15,7 @@ export const ConfirmationDictionarySchema = Joi.object({
   Signature: Joi.string().optional(),
   AdultSignature: Joi.string().optional(),
   DirectSignature: Joi.string().optional(),
+  DeliveryCode: Joi.string().optional(),
 });
 
 export enum ConfirmationTypeEnum {
@@ -23,6 +24,7 @@ export enum ConfirmationTypeEnum {
   Signature = 'Signature',
   AdultSignature = 'AdultSignature',
   DirectSignature = 'DirectSignature',
+  DeliveryCode = 'DeliveryCode',
 }
 
 export const ConfirmationTypeEnumSchema = Joi.string().valid(

package/src/models/confirmation-types.ts

@@ -10,4 +10,6 @@ export enum ConfirmationTypes {
   AdultSignature = 'AdultSignature',
   /** @description Only supported by FedEx. The signature of somebody at the address is required */
   DirectSignature = 'DirectSignature',
+  /** @description Delivery code confirmation is requested */
+  DeliveryCode = 'DeliveryCode',
 }

package/src/models/index.ts

@@ -36,3 +36,4 @@ export * from './units';
 export * from './seller-documents';
 export * from './bill-to';
 export * from './labels/paperless-details';
+export * from './native-rating-details';

package/src/models/native-rating-details.ts

@@ -0,0 +1,37 @@
+/** @description Contains detailed information about the parameters used in Native Rating implementations to generate rate lookup keys. */
+export interface NativeRatingDetails {
+  /** @description The complete key used to extract the rate value from the JSON configuration file. */
+  key: string;
+  /** @description Contains the source and destination zones for the shipment. */
+  zones: Zones;
+  /** @description The name of the shipping service used for the shipment. */
+  service_name: string;
+  /** @description The weight classification of the shipment, indicating the weight range bracket. */
+  weight_class: WeightClass;
+  /** @description The type of package used for the shipment. */
+  package_type: string;
+  /** @description The effective date key used in certain Native Rating implementations. */
+  date_key: string;
+  /** @description Identifies the platform from which the shipment originated (e.g., ShipStation or ShipEngine). */
+  platform: string;
+}
+
+/** @description Contains the source and destination zones for the shipment. */
+export interface Zones {
+  /** @description The complete zone string. */
+  key: string;
+  /** @description The source zone identifier. */
+  from_zone: string;
+  /** @description The destination zone identifier. */
+  to_zone: string;
+}
+
+/** @description The weight classification of the shipment, indicating the weight range bracket. */
+export interface WeightClass {
+  /** @description The complete weight class string. */
+  key: string;
+  /** @description The minimum weight value of the weight range. */
+  min_weight: string;
+  /** @description The maximum weight value of the weight range. */
+  max_weight: string;
+}

package/src/models/rates/rate.ts

@@ -1,6 +1,7 @@
 import { BillingLineItem } from '../billing/billing-line-item';
 import { TimeWindow } from '../time-window';
 import { CarrierWeight } from '../units/carrier-weight';
+import { NativeRatingDetails } from '../native-rating-details';
 
 /** @description Basic structure for a rate */
 export class Rate {
@@ -36,4 +37,6 @@ export class Rate {
   guaranteed_delivery_days?: number;
   /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
   carrier_weight?: CarrierWeight;
+  /** @description Additional details about lookup key used in NativeRating for rate value extraction. */
+  native_rating_details?: NativeRatingDetails;
 }

package/src/responses/create-label-response.ts

@@ -10,6 +10,7 @@ import {
   RelayPointDetails,
   PaperlessDetails,
   PudoLocation,
+  NativeRatingDetails,
 } from '../models';
 import { CarrierWeight } from '../models/units/carrier-weight';
 import { LimitIdentifier } from '../models/limit-identifier';
@@ -38,4 +39,5 @@ export class CreateLabelResponse extends BaseResponse {
   pickup_location?: PudoLocation;
   carrier_weight?: CarrierWeight;
   limit_identifiers?: LimitIdentifier[];
+  native_rating_details?: NativeRatingDetails;
 }