@shipengine/connect-carrier-api 4.25.0 → 4.26.1

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

@@ -1,21 +1,14 @@
 import { ImportedTrackingEvent } from '../models';
 import type { Request } from 'express';
-import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest } from '../requests';
-import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse } from '../responses';
+import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest, UploadDocumentRequest } from '../requests';
+import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse, UploadDocumentResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
-import { UploadDocumentsRequest } from '../requests/upload-documents-request';
-import { UploadDocumentsResponse } from '../responses/upload-documents-response';
 /**
  * @description This defines a connect carrier app
  */
 export interface CarrierAppDefinition {
     Metadata: CarrierAppMetadata;
-    /**
-     * @description This method is used to upload documents to carrier
-     * @param request Data needed by the provider to upload documents
-     */
-    UploadDocuments?: (request: UploadDocumentsRequest) => UploadDocumentsResponse | Promise<UploadDocumentsResponse>;
     /**
      * @description This method is used to register an account
      * @param request The information needed to register or initialize a connection with the shipping provider
@@ -123,6 +116,11 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to start tracking shipments
      */
     StartTracking?: (request: StartTrackingRequest) => StartTrackingResponse | Promise<StartTrackingResponse>;
+    /**
+     * @description This method is used to upload a document to carrier
+     * @param request Data needed by the provider to upload a document
+     */
+    UploadDocument?: (request: UploadDocumentRequest) => UploadDocumentResponse | Promise<UploadDocumentResponse>;
     /**
      * @description A collection of additional routes that can be used to extend the functionality of the app.
      * Extension methods are not automatically called by the ShipEngine platform, and require working with Auctane developers to implement.

package/lib/app/constants.d.ts

@@ -19,5 +19,5 @@ export declare enum ApiEndpoints {
     UpdateSettings = "/UpdateSettings",
     ListPickups = "/ListPickups",
     StartTracking = "/StartTracking",
-    UploadDocuments = "/UploadDocuments"
+    UploadDocument = "/UploadDocument"
 }

package/lib/app/constants.js

@@ -23,6 +23,6 @@ var ApiEndpoints;
     ApiEndpoints["UpdateSettings"] = "/UpdateSettings";
     ApiEndpoints["ListPickups"] = "/ListPickups";
     ApiEndpoints["StartTracking"] = "/StartTracking";
-    ApiEndpoints["UploadDocuments"] = "/UploadDocuments";
+    ApiEndpoints["UploadDocument"] = "/UploadDocument";
 })(ApiEndpoints || (exports.ApiEndpoints = ApiEndpoints = {}));
 //# sourceMappingURL=constants.js.map

package/lib/app/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,gDAAgC,CAAA;IAChC,oDAAoC,CAAA;AACtC,CAAC,EAtBW,YAAY,4BAAZ,YAAY,QAsBvB"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,gDAAgC,CAAA;IAChC,kDAAkC,CAAA;AACpC,CAAC,EAtBW,YAAY,4BAAZ,YAAY,QAsBvB"}

package/lib/app/create-endpoint-mapping.js

@@ -9,7 +9,6 @@ const createEndpointMapping = (definition) => [
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelNotification, definition.CancelNotification],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelPickup, definition.CancelPickup],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateLabel, definition.CreateLabel],
-    [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UploadDocuments, definition.UploadDocuments],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateManifest, definition.CreateManifest],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetManifest, definition.GetManifest],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateNotification, definition.CreateNotification],
@@ -27,6 +26,7 @@ const createEndpointMapping = (definition) => [
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UpdateSettings, definition.UpdateSettings],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ListPickups, definition.ListPickups],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.StartTracking, definition.StartTracking],
+    [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UploadDocument, definition.UploadDocument],
     ...(0, connect_runtime_1.mapExtensions)(definition.Extensions),
 ];
 exports.createEndpointMapping = createEndpointMapping;

package/lib/app/create-endpoint-mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC;IACnE,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AA3BW,QAAA,qBAAqB,yBA2BhC"}
+{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC;IACnE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AA3BW,QAAA,qBAAqB,yBA2BhC"}

package/lib/models/addresses/pudo-location-schema.js

@@ -7,5 +7,15 @@ const address_base_schema_1 = require("./address-base-schema");
 exports.PudoLocationSchema = address_base_schema_1.AddressBaseSchema.keys({
     carrier_code: joi_1.default.string().optional(),
     location_id: joi_1.default.string().optional(),
+    postal_code: joi_1.default.string().when('location_id', {
+        is: joi_1.default.exist(),
+        then: joi_1.default.optional().allow(''),
+        otherwise: joi_1.default.required(),
+    }),
+    country_code: joi_1.default.string().when('location_id', {
+        is: joi_1.default.exist(),
+        then: joi_1.default.optional().allow(''),
+        otherwise: joi_1.default.required(),
+    }),
 });
 //# sourceMappingURL=pudo-location-schema.js.map

package/lib/models/addresses/pudo-location-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"pudo-location-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/pudo-location-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+DAA0D;AAE7C,QAAA,kBAAkB,GAAG,uCAAiB,CAAC,IAAI,CAAC;IACvD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC"}
+{"version":3,"file":"pudo-location-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/pudo-location-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+DAA0D;AAE7C,QAAA,kBAAkB,GAAG,uCAAiB,CAAC,IAAI,CAAC;IACvD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;QAC5C,EAAE,EAAE,aAAG,CAAC,KAAK,EAAE;QACf,IAAI,EAAE,aAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,SAAS,EAAE,aAAG,CAAC,QAAQ,EAAE;KAC1B,CAAC;IACF,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;QAC7C,EAAE,EAAE,aAAG,CAAC,KAAK,EAAE;QACf,IAAI,EAAE,aAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,SAAS,EAAE,aAAG,CAAC,QAAQ,EAAE;KAC1B,CAAC;CACH,CAAC,CAAC"}

package/lib/models/documents/index.d.ts

@@ -1,3 +1,4 @@
 export * from './document';
 export * from './document-type';
 export * from './document-type-schema';
+export * from './uploads';

package/lib/models/documents/index.js

@@ -4,4 +4,5 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./document"), exports);
 tslib_1.__exportStar(require("./document-type"), exports);
 tslib_1.__exportStar(require("./document-type-schema"), exports);
+tslib_1.__exportStar(require("./uploads"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/documents/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/documents/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,0DAAgC;AAChC,iEAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/documents/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,0DAAgC;AAChC,iEAAuC;AACvC,oDAA0B"}

package/lib/models/documents/uploads/document-upload-format-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const DocumentUploadFormatSchema: Joi.StringSchema;

package/lib/models/documents/uploads/document-upload-format-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadFormatSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const document_upload_format_1 = require("./document-upload-format");
+exports.DocumentUploadFormatSchema = joi_1.default.string().valid(...Object.values(document_upload_format_1.DocumentUploadFormat));
+//# sourceMappingURL=document-upload-format-schema.js.map

package/lib/models/documents/uploads/document-upload-format-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-format-schema.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/document-upload-format-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,qEAAgE;AAEnD,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,6CAAoB,CAAC,CACvC,CAAC"}

package/lib/models/documents/uploads/document-upload-format.d.ts

@@ -0,0 +1,5 @@
+/** @description Accepted document upload formats */
+export declare enum DocumentUploadFormat {
+    Pdf = "PDF",
+    Png = "PNG"
+}

package/lib/models/documents/uploads/document-upload-format.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadFormat = void 0;
+/** @description Accepted document upload formats */
+var DocumentUploadFormat;
+(function (DocumentUploadFormat) {
+    DocumentUploadFormat["Pdf"] = "PDF";
+    DocumentUploadFormat["Png"] = "PNG";
+})(DocumentUploadFormat || (exports.DocumentUploadFormat = DocumentUploadFormat = {}));
+//# sourceMappingURL=document-upload-format.js.map

package/lib/models/documents/uploads/document-upload-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-format.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/document-upload-format.ts"],"names":[],"mappings":";;;AAAA,oDAAoD;AACpD,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;AACb,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B"}

package/lib/models/documents/uploads/document-upload-type-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const DocumentUploadTypeSchema: Joi.StringSchema;

package/lib/models/documents/uploads/document-upload-type-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadTypeSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const document_upload_type_1 = require("./document-upload-type");
+exports.DocumentUploadTypeSchema = joi_1.default.string().valid(...Object.values(document_upload_type_1.DocumentUploadType));
+//# sourceMappingURL=document-upload-type-schema.js.map

package/lib/models/documents/uploads/document-upload-type-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-type-schema.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/document-upload-type-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAE/C,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,yCAAkB,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,35 @@
+/** @description Types of uploaded documents */
+export declare enum DocumentUploadType {
+    /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
+    CommercialInvoice = "commercial_invoice",
+    /** @description A certificate of origin */
+    CertificateOfOrigin = "certificate_of_origin",
+    /** @description A USMCA commercial invoice certification of origin */
+    UsmcaCommercialInvoiceCertificationOfOrigin = "usmca_commercial_invoice_certification_of_origin",
+    /** @description A USMCA Certification of origin */
+    UsmcaCertificationOfOrigin = "usmca_certification_of_origin",
+    /** @description A pro forma invoice */
+    ProFormaInvoice = "pro_forma_invoice",
+    /** @description Other document type */
+    Other = "other",
+    /** @description An authorization form */
+    AuthorizationForm = "authorization_form",
+    /** @description An export accompanying document */
+    ExportAccompanyingDocument = "export_accompanying_document",
+    /** @description An export license */
+    ExportLicense = "export_license",
+    /** @description An import permit */
+    ImportPermit = "import_permit",
+    /** @description A one-time NAFTA certificate */
+    OneTimeNafta = "one_time_nafta",
+    /** @description A power of attorney document */
+    PowerOfAttorney = "power_of_attorney",
+    /** @description A packing list */
+    PackingList = "packing_list",
+    /** @description A SED (Shipper's Export Declaration) document */
+    SedDocument = "sed_document",
+    /** @description A shipper's letter of instruction */
+    ShippersLetterOfInstruction = "shippers_letter_of_instruction",
+    /** @description A declaration document */
+    Declaration = "declaration"
+}

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadType = void 0;
+/** @description Types of uploaded documents */
+var DocumentUploadType;
+(function (DocumentUploadType) {
+    /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
+    DocumentUploadType["CommercialInvoice"] = "commercial_invoice";
+    /** @description A certificate of origin */
+    DocumentUploadType["CertificateOfOrigin"] = "certificate_of_origin";
+    /** @description A USMCA commercial invoice certification of origin */
+    DocumentUploadType["UsmcaCommercialInvoiceCertificationOfOrigin"] = "usmca_commercial_invoice_certification_of_origin";
+    /** @description A USMCA Certification of origin */
+    DocumentUploadType["UsmcaCertificationOfOrigin"] = "usmca_certification_of_origin";
+    /** @description A pro forma invoice */
+    DocumentUploadType["ProFormaInvoice"] = "pro_forma_invoice";
+    /** @description Other document type */
+    DocumentUploadType["Other"] = "other";
+    /** @description An authorization form */
+    DocumentUploadType["AuthorizationForm"] = "authorization_form";
+    /** @description An export accompanying document */
+    DocumentUploadType["ExportAccompanyingDocument"] = "export_accompanying_document";
+    /** @description An export license */
+    DocumentUploadType["ExportLicense"] = "export_license";
+    /** @description An import permit */
+    DocumentUploadType["ImportPermit"] = "import_permit";
+    /** @description A one-time NAFTA certificate */
+    DocumentUploadType["OneTimeNafta"] = "one_time_nafta";
+    /** @description A power of attorney document */
+    DocumentUploadType["PowerOfAttorney"] = "power_of_attorney";
+    /** @description A packing list */
+    DocumentUploadType["PackingList"] = "packing_list";
+    /** @description A SED (Shipper's Export Declaration) document */
+    DocumentUploadType["SedDocument"] = "sed_document";
+    /** @description A shipper's letter of instruction */
+    DocumentUploadType["ShippersLetterOfInstruction"] = "shippers_letter_of_instruction";
+    /** @description A declaration document */
+    DocumentUploadType["Declaration"] = "declaration";
+})(DocumentUploadType || (exports.DocumentUploadType = DocumentUploadType = {}));
+//# sourceMappingURL=document-upload-type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-type.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/document-upload-type.ts"],"names":[],"mappings":";;;AAAA,+CAA+C;AAC/C,IAAY,kBAiCX;AAjCD,WAAY,kBAAkB;IAC5B,sMAAsM;IACtM,8DAAwC,CAAA;IACxC,2CAA2C;IAC3C,mEAA6C,CAAA;IAC7C,sEAAsE;IACtE,sHAAgG,CAAA;IAChG,mDAAmD;IACnD,kFAA4D,CAAA;IAC5D,uCAAuC;IACvC,2DAAqC,CAAA;IACrC,uCAAuC;IACvC,qCAAe,CAAA;IACf,yCAAyC;IACzC,8DAAwC,CAAA;IACxC,mDAAmD;IACnD,iFAA2D,CAAA;IAC3D,qCAAqC;IACrC,sDAAgC,CAAA;IAChC,oCAAoC;IACpC,oDAA8B,CAAA;IAC9B,gDAAgD;IAChD,qDAA+B,CAAA;IAC/B,gDAAgD;IAChD,2DAAqC,CAAA;IACrC,kCAAkC;IAClC,kDAA4B,CAAA;IAC5B,iEAAiE;IACjE,kDAA4B,CAAA;IAC5B,qDAAqD;IACrD,oFAA8D,CAAA;IAC9D,0CAA0C;IAC1C,iDAA2B,CAAA;AAC7B,CAAC,EAjCW,kBAAkB,kCAAlB,kBAAkB,QAiC7B"}

package/lib/models/documents/uploads/index.d.ts

@@ -0,0 +1,4 @@
+export * from './document-upload-format';
+export * from './document-upload-format-schema';
+export * from './document-upload-type';
+export * from './document-upload-type-schema';

package/lib/models/documents/uploads/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./document-upload-format"), exports);
+tslib_1.__exportStar(require("./document-upload-format-schema"), exports);
+tslib_1.__exportStar(require("./document-upload-type"), exports);
+tslib_1.__exportStar(require("./document-upload-type-schema"), exports);
+//# sourceMappingURL=index.js.map

package/lib/models/documents/uploads/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,0EAAgD;AAChD,iEAAuC;AACvC,wEAA8C"}

package/lib/models/index.d.ts

@@ -33,7 +33,6 @@ export * from './time-window-schema';
 export * from './time-window';
 export * from './tracking';
 export * from './units';
-export * from './seller-documents';
 export * from './bill-to';
 export * from './labels/paperless-details';
 export * from './native-rating-details';

package/lib/models/index.js

@@ -36,7 +36,6 @@ tslib_1.__exportStar(require("./time-window-schema"), exports);
 tslib_1.__exportStar(require("./time-window"), exports);
 tslib_1.__exportStar(require("./tracking"), exports);
 tslib_1.__exportStar(require("./units"), exports);
-tslib_1.__exportStar(require("./seller-documents"), exports);
 tslib_1.__exportStar(require("./bill-to"), exports);
 tslib_1.__exportStar(require("./labels/paperless-details"), exports);
 tslib_1.__exportStar(require("./native-rating-details"), exports);

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,6DAAmC;AACnC,oDAA0B;AAC1B,qEAA2C;AAC3C,kEAAwC"}
+{"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;AAC3C,kEAAwC"}

package/lib/requests/index.d.ts

@@ -19,4 +19,4 @@ export * from './void-labels-request';
 export * from './update-settings-request';
 export * from './start-tracking-request';
 export * from './start-tracking-request-schema';
-export * from './upload-documents-request';
+export * from './upload-document-request';

package/lib/requests/index.js

@@ -22,5 +22,5 @@ tslib_1.__exportStar(require("./void-labels-request"), exports);
 tslib_1.__exportStar(require("./update-settings-request"), exports);
 tslib_1.__exportStar(require("./start-tracking-request"), exports);
 tslib_1.__exportStar(require("./start-tracking-request-schema"), exports);
-tslib_1.__exportStar(require("./upload-documents-request"), exports);
+tslib_1.__exportStar(require("./upload-document-request"), exports);
 //# sourceMappingURL=index.js.map

package/lib/requests/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C;AAC1C,mEAAyC;AACzC,0EAAgD;AAChD,qEAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C;AAC1C,mEAAyC;AACzC,0EAAgD;AAChD,oEAA0C"}

package/lib/requests/upload-document-request.d.ts

@@ -0,0 +1,21 @@
+import { BaseRequest } from './base-request';
+import { Identifier, DocumentUploadFormat, DocumentUploadType } from '../models';
+/**
+ * A request to upload a document for a shipment.
+ */
+export declare class UploadDocumentRequest extends BaseRequest {
+    /** @description The document id */
+    document_id: string;
+    /** @description The document upload type */
+    document_type: DocumentUploadType;
+    /** @description The document upload format */
+    document_format: DocumentUploadFormat;
+    /** @description The file name */
+    file_name: string;
+    /** @description The file URL */
+    file_url: string;
+    /** @description The carrier tracking number for this shipment */
+    tracking_number: string;
+    /** @description Non-tracking alternative ids associated with this shipment */
+    alternative_identifiers?: Identifier[];
+}

package/lib/requests/upload-document-request.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadDocumentRequest = void 0;
+const base_request_1 = require("./base-request");
+/**
+ * A request to upload a document for a shipment.
+ */
+class UploadDocumentRequest extends base_request_1.BaseRequest {
+    /** @description The document id */
+    document_id;
+    /** @description The document upload type */
+    document_type;
+    /** @description The document upload format */
+    document_format;
+    /** @description The file name */
+    file_name;
+    /** @description The file URL */
+    file_url;
+    /** @description The carrier tracking number for this shipment */
+    tracking_number;
+    /** @description Non-tracking alternative ids associated with this shipment */
+    alternative_identifiers;
+}
+exports.UploadDocumentRequest = UploadDocumentRequest;
+//# sourceMappingURL=upload-document-request.js.map

package/lib/requests/upload-document-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-document-request.js","sourceRoot":"","sources":["../../src/requests/upload-document-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,0BAAW;IACpD,mCAAmC;IACnC,WAAW,CAAU;IACrB,4CAA4C;IAC5C,aAAa,CAAsB;IACnC,8CAA8C;IAC9C,eAAe,CAAwB;IACvC,iCAAiC;IACjC,SAAS,CAAU;IACnB,gCAAgC;IAChC,QAAQ,CAAU;IAClB,iEAAiE;IACjE,eAAe,CAAU;IACzB,8EAA8E;IAC9E,uBAAuB,CAAgB;CACxC;AAfD,sDAeC"}

package/lib/responses/index.d.ts

@@ -35,7 +35,5 @@ export * from './update-settings-response-schema';
 export * from './update-settings-response';
 export * from './start-tracking-response';
 export * from './start-tracking-response-schema';
-export * from './seller-document-result';
-export * from './upload-document-result-schema';
-export * from './upload-documents-response-schema';
-export * from './upload-documents-response';
+export * from './upload-document-response';
+export * from './upload-document-response-schema';

package/lib/responses/index.js

@@ -38,8 +38,6 @@ tslib_1.__exportStar(require("./update-settings-response-schema"), exports);
 tslib_1.__exportStar(require("./update-settings-response"), exports);
 tslib_1.__exportStar(require("./start-tracking-response"), exports);
 tslib_1.__exportStar(require("./start-tracking-response-schema"), exports);
-tslib_1.__exportStar(require("./seller-document-result"), exports);
-tslib_1.__exportStar(require("./upload-document-result-schema"), exports);
-tslib_1.__exportStar(require("./upload-documents-response-schema"), exports);
-tslib_1.__exportStar(require("./upload-documents-response"), exports);
+tslib_1.__exportStar(require("./upload-document-response"), exports);
+tslib_1.__exportStar(require("./upload-document-response-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/responses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C;AAC3C,oEAA0C;AAC1C,2EAAiD;AACjD,mEAAyC;AACzC,0EAAgD;AAChD,6EAAmD;AACnD,sEAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C;AAC3C,oEAA0C;AAC1C,2EAAiD;AACjD,qEAA2C;AAC3C,4EAAkD"}

package/lib/responses/upload-document-response-schema.d.ts

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

package/lib/responses/upload-document-response-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadDocumentResponseSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const base_response_schema_1 = require("./base-response-schema");
+exports.UploadDocumentResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
+    carrier_document_id: joi_1.default.string().optional().empty(''),
+});
+//# sourceMappingURL=upload-document-response-schema.js.map

package/lib/responses/upload-document-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-document-response-schema.js","sourceRoot":"","sources":["../../src/responses/upload-document-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAE/C,QAAA,4BAA4B,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;CACvD,CAAC,CAAC"}

package/lib/responses/upload-document-response.d.ts

@@ -0,0 +1,8 @@
+import { BaseResponse } from './base-response';
+/**
+ * Response for uploading a document to a carrier.
+ */
+export declare class UploadDocumentResponse extends BaseResponse {
+    /** @description The carrier document ID */
+    carrier_document_id?: string;
+}

package/lib/responses/upload-document-response.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadDocumentResponse = void 0;
+const base_response_1 = require("./base-response");
+/**
+ * Response for uploading a document to a carrier.
+ */
+class UploadDocumentResponse extends base_response_1.BaseResponse {
+    /** @description The carrier document ID */
+    carrier_document_id;
+}
+exports.UploadDocumentResponse = UploadDocumentResponse;
+//# sourceMappingURL=upload-document-response.js.map

package/lib/responses/upload-document-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-document-response.js","sourceRoot":"","sources":["../../src/responses/upload-document-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAE/C;;GAEG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,2CAA2C;IAC3C,mBAAmB,CAAU;CAC9B;AAHD,wDAGC"}

package/package.json

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