@shipengine/connect-carrier-api 4.1.4 → 4.1.6

package/lib/app/carrier-app-definition.d.ts

@@ -94,6 +94,7 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to import tracking events
      */
     ImportTrackingEvents?: (request: ImportTrackingEventsRequest) => AsyncGenerator<ImportedTrackingEvent>;
+    ScheduledFunction?: (request: Record<string, any>) => Promise<{}[] | null> | {}[] | null;
     /** @description A method that gets additional context to log from the request when logging */
     getAdditionalContext?: (req: Request) => Record<string, string>;
     /** @description A method that redacts external HTTP requests and responses to prevent logging sensitive information */

package/lib/app/metadata/native-rating-configuration.d.ts

@@ -4,6 +4,8 @@ import { RateCard } from './rate-card';
 export interface NativeRatingConfiguration {
     /** @description Default rate card to use for rating */
     DefaultRateCardId?: string;
+    /** @description Can users manage their own rates */
+    SupportsUserManagedRates?: boolean;
     /** Path to rating logic and rate card data for this carrier */
     Path?: string;
     /** Array of rate cards for the carrier */

package/lib/app/metadata/native-rating-configuration.js

@@ -7,6 +7,7 @@ const file_exists_1 = require("./custom-validators/file-exists");
 const rate_card_1 = require("./rate-card");
 exports.NativeRatingConfigurationSchema = joi_1.default.object({
     DefaultRateCardId: joi_1.default.string().optional(),
+    SupportsUserManagedRates: joi_1.default.boolean().optional(),
     Path: joi_1.default.string().optional().custom(file_exists_1.fileExists, 'implementation path exists'),
     RateCards: joi_1.default.array().optional().items(rate_card_1.RateCardSchema).unique('Id'),
 });

package/lib/app/metadata/native-rating-configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"native-rating-configuration.js","sourceRoot":"","sources":["../../../src/app/metadata/native-rating-configuration.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA6D;AAC7D,2CAAuD;AAY1C,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,wBAAU,EAAE,4BAA4B,CAAC;IAC9E,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAc,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;CACrE,CAAC,CAAC"}
+{"version":3,"file":"native-rating-configuration.js","sourceRoot":"","sources":["../../../src/app/metadata/native-rating-configuration.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA6D;AAC7D,2CAAuD;AAc1C,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,wBAAwB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,wBAAU,EAAE,4BAA4B,CAAC;IAC9E,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAc,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;CACrE,CAAC,CAAC"}

package/lib/models/insurance-providers.d.ts

@@ -3,5 +3,7 @@ export declare enum InsuranceProviders {
     None = "None",
     ShipStation = "ShipStation",
     Carrier = "Carrier",
-    External = "External"
+    External = "External",
+    XCover = "XCover",
+    ParcelGuard = "ParcelGuard"
 }

package/lib/models/insurance-providers.js

@@ -8,5 +8,7 @@ var InsuranceProviders;
     InsuranceProviders["ShipStation"] = "ShipStation";
     InsuranceProviders["Carrier"] = "Carrier";
     InsuranceProviders["External"] = "External";
+    InsuranceProviders["XCover"] = "XCover";
+    InsuranceProviders["ParcelGuard"] = "ParcelGuard";
 })(InsuranceProviders = exports.InsuranceProviders || (exports.InsuranceProviders = {}));
 //# sourceMappingURL=insurance-providers.js.map

package/lib/models/insurance-providers.js.map

@@ -1 +1 @@
-{"version":3,"file":"insurance-providers.js","sourceRoot":"","sources":["../../src/models/insurance-providers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,iDAA2B,CAAA;IAC3B,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}
+{"version":3,"file":"insurance-providers.js","sourceRoot":"","sources":["../../src/models/insurance-providers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,iDAA2B,CAAA;IAC3B,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;IACrB,uCAAiB,CAAA;IACjB,iDAA2B,CAAA;AAC7B,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.1.4",
+  "version": "4.1.6",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.18.1"
+    "version": "1.18.5"
   },
   "paths": {
     "/Register": {
@@ -1893,6 +1893,99 @@
         "additionalProperties": false,
         "description": "This model represents the amount of the dangerous goods."
       },
+      "DangerousGoods": {
+        "type": "object",
+        "properties": {
+          "id_number": {
+            "type": "string",
+            "description": "UN number to identify the dangerous goods.",
+            "nullable": true
+          },
+          "shipping_name": {
+            "type": "string",
+            "description": "Trade description of the dangerous goods.",
+            "nullable": true
+          },
+          "technical_name": {
+            "type": "string",
+            "description": "Recognized Technical or chemical name of dangerous goods.",
+            "nullable": true
+          },
+          "product_class": {
+            "type": "string",
+            "description": "Dangerous goods product class based on regulation.",
+            "nullable": true
+          },
+          "product_class_subsidiary": {
+            "type": "string",
+            "description": "A secondary of product class for substances presenting more than one particular hazard",
+            "nullable": true
+          },
+          "packaging_group": {
+            "$ref": "#/components/schemas/PackagingGroupEnum"
+          },
+          "dangerous_amount": {
+            "$ref": "#/components/schemas/DangerousAmountDetails"
+          },
+          "quantity": {
+            "type": "number",
+            "description": "Quantity of dangerous goods.",
+            "format": "double",
+            "nullable": true
+          },
+          "packaging_instruction": {
+            "type": "string",
+            "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.",
+            "nullable": true
+          },
+          "packaging_instruction_section": {
+            "$ref": "#/components/schemas/PackageInstructionSectionEnum"
+          },
+          "packaging_type": {
+            "type": "string",
+            "description": "The type of exterior packaging used to contain the dangerous good.",
+            "nullable": true
+          },
+          "transport_mean": {
+            "$ref": "#/components/schemas/TransportMeanEnum"
+          },
+          "transport_category": {
+            "type": "string",
+            "description": "Transport category assign to dangerous goods for the transport purpose.",
+            "nullable": true
+          },
+          "regulation_authority": {
+            "type": "string",
+            "description": "Name of the regulatory authority.",
+            "nullable": true
+          },
+          "regulation_level": {
+            "$ref": "#/components/schemas/RegulationLevelEnum"
+          },
+          "radioactive": {
+            "type": "boolean",
+            "description": "Indication if the substance is radioactive.",
+            "nullable": true
+          },
+          "reportable_quantity": {
+            "type": "boolean",
+            "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.",
+            "nullable": true
+          },
+          "tunnel_code": {
+            "type": "string",
+            "description": "Defines which types of tunnels the shipment is allowed to go through",
+            "nullable": true
+          },
+          "additional_description": {
+            "type": "string",
+            "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "Dangerous Goods information passed to the carrier"
+      },
       "DimensionDetails": {
         "type": "object",
         "properties": {
@@ -2519,7 +2612,9 @@
           "None",
           "ShipStation",
           "Carrier",
-          "External"
+          "External",
+          "XCover",
+          "ParcelGuard"
         ],
         "type": "string"
       },
@@ -2831,98 +2926,22 @@
         "additionalProperties": false,
         "description": "This model represents an individual package that is part of a shipment."
       },
-      "DangerousGoods": {
-        "type": "object",
-        "properties": {
-          "id_number": {
-            "type": "string",
-            "description": "UN number to identify the dangerous goods.",
-            "nullable": true
-          },
-          "shipping_name": {
-            "type": "string",
-            "description": "Trade description of the dangerous goods.",
-            "nullable": true
-          },
-          "technical_name": {
-            "type": "string",
-            "description": "Recognized Technical or chemical name of dangerous goods.",
-            "nullable": true
-          },
-          "product_class": {
-            "type": "string",
-            "description": "Dangerous goods product class based on regulation.",
-            "nullable": true
-          },
-          "product_class_subsidiary": {
-            "type": "string",
-            "description": "A secondary of product class for substances presenting more than one particular hazard.",
-            "nullable": true
-          },
-          "packaging_group": {
-            "$ref": "#/components/schemas/PackagingGroupTypes"
-          },
-          "dangerous_amount": {
-            "$ref": "#/components/schemas/DangerousAmountDetails"
-          },
-          "quantity": {
-            "type": "number",
-            "description": "Quantity of dangerous goods.",
-            "format": "double",
-            "nullable": true
-          },
-          "packaging_instruction": {
-            "type": "string",
-            "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.",
-            "nullable": true
-          },
-          "packaging_instruction_section": {
-            "$ref": "#/components/schemas/PackageInstructionSectionTypes"
-          },
-          "packaging_type": {
-            "type": "string",
-            "description": "The type of exterior packaging used to contain the dangerous good.",
-            "nullable": true
-          },
-          "transport_mean": {
-            "$ref": "#/components/schemas/TransportMeanTypes"
-          },
-          "transport_category": {
-            "type": "string",
-            "description": "Transport category assign to dangerous goods for the transport purpose.",
-            "nullable": true
-          },
-          "regulation_authority": {
-            "type": "string",
-            "description": "Name of the regulatory authority.",
-            "nullable": true
-          },
-          "regulation_level": {
-            "$ref": "#/components/schemas/RegulationLevelTypes"
-          },
-          "radioactive": {
-            "type": "boolean",
-            "description": "Indication if the substance is radioactive.",
-            "nullable": true
-          },
-          "reportable_quantity": {
-            "type": "boolean",
-            "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.",
-            "nullable": true
-          },
-          "tunnel_code": {
-            "type": "string",
-            "description": "Defines which types of tunnels the shipment is allowed to go through.",
-            "nullable": true
-          },
-          "additional_description": {
-            "type": "string",
-            "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier.",
-            "nullable": true
-          }
-        },
-        "additionalProperties": false,
-        "description": "This model represents an dangerous good information that is part of a package."
+      "PackageInstructionSectionEnum": {
+        "enum": [
+          "section_1",
+          "section_2",
+          "section_1A",
+          "section_1B"
+        ],
+        "type": "string"
+      },
+      "PackagingGroupEnum": {
+        "enum": [
+          "i",
+          "ii",
+          "iii"
+        ],
+        "type": "string"
       },
       "PickupConfirmation": {
         "type": "object",
@@ -3234,6 +3253,15 @@
         "additionalProperties": false,
         "description": "This model represents the successful response for a registration request."
       },
+      "RegulationLevelEnum": {
+        "enum": [
+          "lightly_regulated",
+          "fully_regulated",
+          "limited_quantities",
+          "excepted_quantity"
+        ],
+        "type": "string"
+      },
       "RelayPoint": {
         "required": [
           "opening_times",
@@ -3790,7 +3818,11 @@
           "pccc",
           "oss",
           "passport",
-          "abn"
+          "abn",
+          "nif",
+          "inn",
+          "cpf",
+          "cnpj"
         ],
         "type": "string",
         "description": "Specifies the supported tax identification types."
@@ -4115,6 +4147,15 @@
         "additionalProperties": false,
         "description": "This model represents the successful response from a tracking request."
       },
+      "TransportMeanEnum": {
+        "enum": [
+          "ground",
+          "water",
+          "cargo_aircraft_only",
+          "passenger_aircraft"
+        ],
+        "type": "string"
+      },
       "UpdateMethods": {
         "enum": [
           "append",

package/src/app/carrier-app-definition.ts

@@ -156,6 +156,9 @@ export interface CarrierAppDefinition {
   ImportTrackingEvents?: (
     request: ImportTrackingEventsRequest,
   ) => AsyncGenerator<ImportedTrackingEvent>;
+
+  ScheduledFunction?: (request: Record<string, any>) => Promise<{}[] | null> | {}[] | null;
+
   /** @description A method that gets additional context to log from the request when logging */
   getAdditionalContext?: (req: Request) => Record<string, string>;
   /** @description A method that redacts external HTTP requests and responses to prevent logging sensitive information */

package/src/app/metadata/native-rating-configuration.ts

@@ -6,6 +6,8 @@ import { RateCard, RateCardSchema } from './rate-card';
 export interface NativeRatingConfiguration {
   /** @description Default rate card to use for rating */
   DefaultRateCardId?: string;
+  /** @description Can users manage their own rates */
+  SupportsUserManagedRates?: boolean;
   /** Path to rating logic and rate card data for this carrier */
   Path?: string;
   /** Array of rate cards for the carrier */
@@ -14,6 +16,7 @@ export interface NativeRatingConfiguration {
 
 export const NativeRatingConfigurationSchema = Joi.object({
   DefaultRateCardId: Joi.string().optional(),
+  SupportsUserManagedRates: Joi.boolean().optional(),
   Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
   RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
 });

package/src/models/insurance-providers.ts

@@ -4,4 +4,6 @@ export enum InsuranceProviders {
   ShipStation = 'ShipStation',
   Carrier = 'Carrier',
   External = 'External',
+  XCover = 'XCover',
+  ParcelGuard = 'ParcelGuard',
 }