@shipengine/connect-carrier-api 4.6.2 → 4.6.4

package/lib/models/documents/document-type.d.ts

@@ -8,6 +8,6 @@ export declare enum DocumentType {
     CommercialInvoice = "commercial_invoice",
     /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
     BillOfLading = "bill_of_lading",
-    /** @description A paperless label. For example: a QR code that customers can display on their phone */
+    /** @description A paperless label. For example: a paperless label that customers can display on their phone */
     PaperlessLabel = "paperless_label"
 }

package/lib/models/documents/document-type.js

@@ -12,7 +12,7 @@ var DocumentType;
     DocumentType["CommercialInvoice"] = "commercial_invoice";
     /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
     DocumentType["BillOfLading"] = "bill_of_lading";
-    /** @description A paperless label. For example: a QR code that customers can display on their phone */
+    /** @description A paperless label. For example: a paperless label that customers can display on their phone */
     DocumentType["PaperlessLabel"] = "paperless_label";
 })(DocumentType || (exports.DocumentType = DocumentType = {}));
 //# sourceMappingURL=document-type.js.map

package/lib/models/documents/document-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACtC,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,oCAAoC;IACpC,+BAAe,CAAA;IACf,uKAAuK;IACvK,4CAA4B,CAAA;IAC5B,sMAAsM;IACtM,wDAAwC,CAAA;IACxC,8OAA8O;IAC9O,+CAA+B,CAAA;IAC/B,uGAAuG;IACvG,kDAAkC,CAAA;AACpC,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB"}
+{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACtC,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,oCAAoC;IACpC,+BAAe,CAAA;IACf,uKAAuK;IACvK,4CAA4B,CAAA;IAC5B,sMAAsM;IACtM,wDAAwC,CAAA;IACxC,8OAA8O;IAC9O,+CAA+B,CAAA;IAC/B,+GAA+G;IAC/G,kDAAkC,CAAA;AACpC,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB"}

package/lib/models/index.d.ts

@@ -34,3 +34,4 @@ export * from './time-window';
 export * from './tracking';
 export * from './units';
 export * from './bill-to';
+export * from './labels/paperless-details';

package/lib/models/index.js

@@ -37,4 +37,5 @@ tslib_1.__exportStar(require("./time-window"), exports);
 tslib_1.__exportStar(require("./tracking"), exports);
 tslib_1.__exportStar(require("./units"), exports);
 tslib_1.__exportStar(require("./bill-to"), exports);
+tslib_1.__exportStar(require("./labels/paperless-details"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,6DAAmC;AACnC,gEAAsC;AACtC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,0DAAgC;AAChC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB;AACxB,oDAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,6DAAmC;AACnC,gEAAsC;AACtC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,0DAAgC;AAChC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB;AACxB,oDAA0B;AAC1B,qEAA2C"}

package/lib/models/labels/label-package.d.ts

@@ -1,5 +1,6 @@
 import { Identifier } from '../identifier';
 import { Document } from '../documents';
+import { PaperlessDetails } from './paperless-details';
 /** @description Package information provided by the carrier */
 export declare class LabelPackage {
     /** @description Tracking number for the package */
@@ -10,4 +11,6 @@ export declare class LabelPackage {
     alternative_identifiers?: Identifier[];
     /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
     documents?: Document[];
+    /** @description Paperless details */
+    paperless_details?: PaperlessDetails;
 }

package/lib/models/labels/label-package.js

@@ -11,6 +11,8 @@ class LabelPackage {
     alternative_identifiers;
     /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
     documents;
+    /** @description Paperless details */
+    paperless_details;
 }
 exports.LabelPackage = LabelPackage;
 //# sourceMappingURL=label-package.js.map

package/lib/models/labels/label-package.js.map

@@ -1 +1 @@
-{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;AAGA,+DAA+D;AAC/D,MAAa,YAAY;IACvB,mDAAmD;IACnD,eAAe,CAAU;IACzB,gDAAgD;IAChD,YAAY,CAAU;IACtB,6EAA6E;IAC7E,uBAAuB,CAAgB;IACvC,wKAAwK;IACxK,SAAS,CAAc;CACxB;AATD,oCASC"}
+{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;AAIA,+DAA+D;AAC/D,MAAa,YAAY;IACvB,mDAAmD;IACnD,eAAe,CAAU;IACzB,gDAAgD;IAChD,YAAY,CAAU;IACtB,6EAA6E;IAC7E,uBAAuB,CAAgB;IACvC,wKAAwK;IACxK,SAAS,CAAc;IACvB,qCAAqC;IACrC,iBAAiB,CAAoB;CACtC;AAXD,oCAWC"}

package/lib/models/labels/paperless-details-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const PaperlessDetailsSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/paperless-details-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaperlessDetailsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.PaperlessDetailsSchema = joi_1.default.object({
+    instructions: joi_1.default.string().optional(),
+    handoffCode: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=paperless-details-schema.js.map

package/lib/models/labels/paperless-details-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paperless-details-schema.js","sourceRoot":"","sources":["../../../src/models/labels/paperless-details-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC"}

package/lib/models/labels/paperless-details.d.ts

@@ -0,0 +1,5 @@
+/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
+export declare class PaperlessDetails {
+    instructions: string;
+    handoff_code: string;
+}

package/lib/models/labels/paperless-details.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaperlessDetails = void 0;
+/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
+class PaperlessDetails {
+    instructions;
+    handoff_code;
+}
+exports.PaperlessDetails = PaperlessDetails;
+//# sourceMappingURL=paperless-details.js.map

package/lib/models/labels/paperless-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paperless-details.js","sourceRoot":"","sources":["../../../src/models/labels/paperless-details.ts"],"names":[],"mappings":";;;AAAA,6IAA6I;AAC7I,MAAa,gBAAgB;IAC3B,YAAY,CAAU;IACtB,YAAY,CAAU;CACvB;AAHD,4CAGC"}

package/lib/responses/create-label-response-schema.js

@@ -12,10 +12,12 @@ const label_download_schema_1 = require("../models/labels/label-download-schema"
 const label_package_schema_1 = require("../models/labels/label-package-schema");
 const relay_point_details_schema_1 = require("../models/relay-points/relay-point-details-schema");
 const time_window_schema_1 = require("../models/time-window-schema");
+const paperless_details_schema_1 = require("../models/labels/paperless-details-schema");
 exports.CreateLabelResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
     transaction_id: joi_1.default.string().required(),
     label_download: label_download_schema_1.LabelDownloadSchema.optional(),
     form_download: form_download_schema_1.FormDownloadSchema.optional(),
+    paperless_details: paperless_details_schema_1.PaperlessDetailsSchema.optional(),
     documents: joi_1.default.array().optional().items(document_schema_1.DocumentSchema),
     packages: joi_1.default.array().optional().items(label_package_schema_1.LabelPackageSchema),
     billing_line_items: joi_1.default.array().optional().items(billing_line_item_schema_1.BillingLineItemSchema),

package/lib/responses/create-label-response-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-label-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,yFAAmF;AACnF,yEAAqE;AACrE,mEAA+D;AAC/D,gFAA2E;AAC3E,kFAA6E;AAC7E,gFAA2E;AAC3E,kGAA4F;AAC5F,qEAAgE;AAEnD,QAAA,yBAAyB,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAC/D,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC5C,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAkB,CAAC;IAC1D,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gDAAqB,CAAC;IACvE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,SAAS,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;IACvE,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1D,qBAAqB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,oDAAuB,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC"}
+{"version":3,"file":"create-label-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-label-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,yFAAmF;AACnF,yEAAqE;AACrE,mEAA+D;AAC/D,gFAA2E;AAC3E,kFAA6E;AAC7E,gFAA2E;AAC3E,kGAA4F;AAC5F,qEAAgE;AAChE,wFAAmF;AAEtE,QAAA,yBAAyB,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAC/D,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC5C,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAkB,CAAC;IAC1D,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gDAAqB,CAAC;IACvE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,SAAS,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;IACvE,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1D,qBAAqB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,oDAAuB,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC"}

package/lib/responses/create-label-response.d.ts

@@ -1,10 +1,11 @@
 import { BaseResponse } from './base-response';
-import { LabelDownload, FormDownload, Document, BillingLineItem, LabelPackage, Identifier, TimeWindow, RelayPointDetails } from '../models';
+import { LabelDownload, FormDownload, Document, BillingLineItem, LabelPackage, Identifier, TimeWindow, RelayPointDetails, PaperlessDetails } from '../models';
 /** @description Basic structure for a response to create a label */
 export declare class CreateLabelResponse extends BaseResponse {
     transaction_id: string;
     label_download?: LabelDownload;
     form_download?: FormDownload;
+    paperless_details?: PaperlessDetails;
     documents?: Document[];
     packages?: LabelPackage[];
     billing_line_items?: BillingLineItem[];

package/lib/responses/create-label-response.js

@@ -7,6 +7,7 @@ class CreateLabelResponse extends base_response_1.BaseResponse {
     transaction_id;
     label_download;
     form_download;
+    paperless_details;
     documents;
     packages;
     billing_line_items;

package/lib/responses/create-label-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAY/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;CAClC;AAlBD,kDAkBC"}
+{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAa/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,iBAAiB,CAAoB;IACrC,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;CAClC;AAnBD,kDAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.6.2",
+  "version": "4.6.4",
   "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.9"
+    "version": "1.20.0"
   },
   "paths": {
     "/Register": {
@@ -885,6 +885,7 @@
           "metadata": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "nullable": true
             },
             "nullable": true
@@ -903,6 +904,7 @@
           "metadata": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "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.",
@@ -1448,6 +1450,9 @@
           },
           "relay_points": {
             "$ref": "#/components/schemas/RelayPointDetails"
+          },
+          "paperless_details": {
+            "$ref": "#/components/schemas/PaperlessDetails"
           }
         },
         "additionalProperties": false,
@@ -1556,6 +1561,7 @@
           "manifest_identifiers": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "nullable": true
             },
             "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
@@ -2258,6 +2264,7 @@
           "manifest_identifiers": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "nullable": true
             },
             "description": "Carrier specific data needed to retrieve Manifest results",
@@ -2753,6 +2760,9 @@
             },
             "description": "Documents associated with this package, if documents are not specified at a package level, use the\r\nDocuments array at the CarrierApi.Common.Response.CreateLabelResponse level.",
             "nullable": true
+          },
+          "paperless_details": {
+            "$ref": "#/components/schemas/PaperlessDetails"
           }
         },
         "additionalProperties": false,
@@ -3031,6 +3041,21 @@
         ],
         "type": "string"
       },
+      "PaperlessDetails": {
+        "type": "object",
+        "properties": {
+          "instructions": {
+            "type": "string",
+            "nullable": true
+          },
+          "handoff_code": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "The Paperless details for the shipment. This consists of additional information for paperless labels."
+      },
       "PickupConfirmation": {
         "type": "object",
         "properties": {
@@ -3401,6 +3426,7 @@
           "registration_info": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "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.",
@@ -3423,6 +3449,7 @@
           "metadata": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "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.",
@@ -4366,6 +4393,7 @@
           "update_settings": {
             "type": "object",
             "additionalProperties": {
+              "type": "object",
               "nullable": true
             },
             "description": "This is a schemaless object used to contain any required fields for updating carrier settings.",
@@ -4761,4 +4789,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}

package/src/models/documents/document-type.ts

@@ -8,6 +8,6 @@ export enum DocumentType {
   CommercialInvoice = 'commercial_invoice',
   /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
   BillOfLading = 'bill_of_lading',
-  /** @description A paperless label. For example: a QR code that customers can display on their phone */
+  /** @description A paperless label. For example: a paperless label that customers can display on their phone */
   PaperlessLabel = 'paperless_label',
 }

package/src/models/index.ts

@@ -34,3 +34,4 @@ export * from './time-window';
 export * from './tracking';
 export * from './units';
 export * from './bill-to';
+export * from './labels/paperless-details';

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

@@ -1,5 +1,6 @@
 import { Identifier } from '../identifier';
 import { Document } from '../documents';
+import { PaperlessDetails } from './paperless-details';
 
 /** @description Package information provided by the carrier */
 export class LabelPackage {
@@ -11,4 +12,6 @@ export class LabelPackage {
   alternative_identifiers?: Identifier[];
   /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
   documents?: Document[];
+  /** @description Paperless details */
+  paperless_details?: PaperlessDetails;
 }

package/src/models/labels/paperless-details-schema.ts

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

package/src/models/labels/paperless-details.ts

@@ -0,0 +1,5 @@
+/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
+export class PaperlessDetails {
+  instructions!: string;
+  handoff_code!: string;
+}

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

@@ -8,11 +8,13 @@ import { LabelDownloadSchema } from '../models/labels/label-download-schema';
 import { LabelPackageSchema } from '../models/labels/label-package-schema';
 import { RelayPointDetailsSchema } from '../models/relay-points/relay-point-details-schema';
 import { TimeWindowSchema } from '../models/time-window-schema';
+import { PaperlessDetailsSchema } from '../models/labels/paperless-details-schema';
 
 export const CreateLabelResponseSchema = BaseResponseSchema.keys({
   transaction_id: Joi.string().required(),
   label_download: LabelDownloadSchema.optional(),
   form_download: FormDownloadSchema.optional(),
+  paperless_details: PaperlessDetailsSchema.optional(),
   documents: Joi.array().optional().items(DocumentSchema),
   packages: Joi.array().optional().items(LabelPackageSchema),
   billing_line_items: Joi.array().optional().items(BillingLineItemSchema),

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

@@ -8,6 +8,7 @@ import {
   Identifier,
   TimeWindow,
   RelayPointDetails,
+  PaperlessDetails,
 } from '../models';
 
 /** @description Basic structure for a response to create a label */
@@ -15,6 +16,7 @@ export class CreateLabelResponse extends BaseResponse {
   transaction_id!: string;
   label_download?: LabelDownload;
   form_download?: FormDownload;
+  paperless_details?: PaperlessDetails;
   documents?: Document[];
   packages?: LabelPackage[];
   billing_line_items?: BillingLineItem[];