@shipengine/connect-carrier-api 4.6.1 → 4.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.6.1",
+  "version": "4.6.2",
   "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.19.8"
+    "version": "1.19.9"
   },
   "paths": {
     "/Register": {
@@ -771,7 +771,8 @@
           "address_metadata": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "Additional metadata provided for specific requests.",
             "nullable": true
@@ -826,7 +827,7 @@
           },
           "own_document_upload": {
             "type": "boolean",
-            "description": "Describes whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed"
+            "description": "Whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed."
           },
           "dangerous_goods": {
             "type": "boolean",
@@ -837,7 +838,7 @@
           },
           "limited_quantity": {
             "type": "boolean",
-            "description": "Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only"
+            "description": "Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only."
           },
           "event_notification": {
             "type": "boolean",
@@ -858,7 +859,8 @@
           "connection_context": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "Optional - any additional information required to authorize the request",
             "nullable": true
@@ -882,7 +884,9 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "nullable": true
           },
           "connection_name": {
@@ -898,7 +902,9 @@
         "properties": {
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
             "nullable": true
           }
@@ -1096,7 +1102,8 @@
           "custom_properties": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "The grab bag of properties necessary to cancel the pickup",
             "nullable": true
@@ -1134,7 +1141,8 @@
           "custom_properties": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "A grab bag used to store additional information that might be useful for logging or internal reporting.",
             "nullable": true
@@ -1232,45 +1240,6 @@
         ],
         "type": "string"
       },
-      "PackagingGroupTypes": {
-        "enum": [
-          "i",
-          "ii",
-          "iii"
-        ],
-        "type": "string",
-        "description": "An enumeration for packaging group for dangerous goods."
-      },
-      "PackageInstructionSectionTypes": {
-        "enum": [
-          "section_1",
-          "section_2",
-          "section_1A",
-          "section_1B"
-        ],
-        "type": "string",
-        "description": "An enumeration for package instruction for dangerous goods."
-      },
-      "TransportMeanTypes": {
-        "enum": [
-          "ground",
-          "water",
-          "cargo_aircraft_only",
-          "passenger_aircraft"
-        ],
-        "type": "string",
-        "description": "An enumeration for transport means for dangerous goods."
-      },
-      "RegulationLevelTypes": {
-        "enum": [
-          "lightly_regulated",
-          "fully_regulated",
-          "limited_quantities",
-          "excepted_quantity"
-        ],
-        "type": "string",
-        "description": "An enumeration for regulation type for dangerous goods."
-      },
       "CreateLabelRequest": {
         "required": [
           "service_code",
@@ -1586,7 +1555,9 @@
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
             "nullable": true
           }
@@ -2241,6 +2212,28 @@
         "additionalProperties": false,
         "description": "This contains information about the fulfillment plan for a set of items."
       },
+      "Geolocation": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/GeolocationType"
+          },
+          "value": {
+            "type": "string",
+            "description": "The geolocation value.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "Geolocation additional information for an address."
+      },
+      "GeolocationType": {
+        "enum": [
+          "what3words"
+        ],
+        "type": "string",
+        "description": "Specifies the supported geolocation types."
+      },
       "GetManifestRequest": {
         "required": [
           "transaction_id"
@@ -2264,7 +2257,9 @@
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "Carrier specific data needed to retrieve Manifest results",
             "nullable": true
           },
@@ -2738,6 +2733,11 @@
             "description": "Tracking number for the package.",
             "nullable": true
           },
+          "tracking_url": {
+            "type": "string",
+            "description": "Tracking URL for the package.",
+            "nullable": true
+          },
           "alternative_identifiers": {
             "type": "array",
             "items": {
@@ -2833,6 +2833,16 @@
             "type": "string",
             "description": "Uniquely identifies this request to manifest a shipment. Used to identify which shipments could not be manifested.",
             "format": "uuid"
+          },
+          "ship_datetime": {
+            "type": "string",
+            "description": "Shipment ship date time.",
+            "format": "date-time"
+          },
+          "reference": {
+            "type": "string",
+            "description": "Shipment reference number.",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -2868,7 +2878,8 @@
               "type": "array",
               "items": {
                 "type": "string"
-              }
+              },
+              "nullable": true
             },
             "description": "Headers sent with the inbound request if it was received via http",
             "nullable": true
@@ -3100,7 +3111,8 @@
           "pickup_options": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "Custom options that are used by the carrier to determine pickup locations",
             "nullable": true
@@ -3388,7 +3400,9 @@
         "properties": {
           "registration_info": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "This is a schemaless object used to contain any required fields for validating a users credentials or\r\nregistering a new account. These fields will be custom to the shipping service provider, and will be\r\ncollected via a form and sent over as key value pairs.",
             "nullable": true
           }
@@ -3408,7 +3422,9 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "This is an optional schemaless object that should be returned for persisted auth and user information.\r\nAnything returned under this key will be included in all future requests. For example, you may store\r\nadditional static properties about the end user or their connection to the carrier. The maximum\r\nstorage size for data under this key is 4KB.",
             "nullable": true
           }
@@ -3616,7 +3632,8 @@
           "custom_properties": {
             "type": "object",
             "additionalProperties": {
-              "type": "string"
+              "type": "string",
+              "nullable": true
             },
             "description": "A grab bag of custom properties that will be persisted and sent back with the cancel pickup request",
             "nullable": true
@@ -3833,10 +3850,8 @@
             "description": "Tax IDs associated with the consignee.",
             "nullable": true
           },
-          "what3words": {
-            "type": "string",
-            "description": "What3words field to help identify the location.",
-            "nullable": true
+          "geolocation": {
+            "$ref": "#/components/schemas/Geolocation"
           }
         },
         "additionalProperties": false
@@ -3869,6 +3884,11 @@
             "description": "The carrier tracking number associated with this package",
             "nullable": true
           },
+          "tracking_url": {
+            "type": "string",
+            "description": "The carrier tracking URL associated with this package",
+            "nullable": true
+          },
           "alternative_identifiers": {
             "type": "array",
             "items": {
@@ -4345,7 +4365,9 @@
         "properties": {
           "update_settings": {
             "type": "object",
-            "additionalProperties": { },
+            "additionalProperties": {
+              "nullable": true
+            },
             "description": "This is a schemaless object used to contain any required fields for updating carrier settings.",
             "nullable": true
           }
@@ -4385,7 +4407,8 @@
               "type": "array",
               "items": {
                 "type": "string"
-              }
+              },
+              "nullable": true
             },
             "description": "Headers sent with the inbound request if it was received via http",
             "nullable": true
@@ -4738,4 +4761,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}