@shipengine/connect-carrier-api 4.32.0 → 4.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/lib/app/carrier-app-definition.d.ts +7 -2
  2. package/lib/app/constants.d.ts +1 -0
  3. package/lib/app/constants.js +1 -0
  4. package/lib/app/constants.js.map +1 -1
  5. package/lib/app/create-endpoint-mapping.js +1 -0
  6. package/lib/app/create-endpoint-mapping.js.map +1 -1
  7. package/lib/models/cpsc/cpsc-certificate-schema.js.map +1 -0
  8. package/lib/models/cpsc/cpsc-certificate.js.map +1 -0
  9. package/lib/models/cpsc/cpsc-disclaim-schema.d.ts +2 -0
  10. package/lib/models/cpsc/cpsc-disclaim-schema.js +14 -0
  11. package/lib/models/cpsc/cpsc-disclaim-schema.js.map +1 -0
  12. package/lib/models/cpsc/cpsc-disclaim.d.ts +10 -0
  13. package/lib/models/cpsc/cpsc-disclaim.js +14 -0
  14. package/lib/models/cpsc/cpsc-disclaim.js.map +1 -0
  15. package/lib/models/cpsc/disclaim-code.d.ts +4 -0
  16. package/lib/models/cpsc/disclaim-code.js +9 -0
  17. package/lib/models/cpsc/disclaim-code.js.map +1 -0
  18. package/lib/models/cpsc/index.d.ts +5 -0
  19. package/lib/models/cpsc/index.js +9 -0
  20. package/lib/models/cpsc/index.js.map +1 -0
  21. package/lib/models/index.d.ts +1 -2
  22. package/lib/models/index.js +1 -2
  23. package/lib/models/index.js.map +1 -1
  24. package/lib/models/pickup/shipped-products-schema.js +3 -1
  25. package/lib/models/pickup/shipped-products-schema.js.map +1 -1
  26. package/lib/models/pickup/shipped-products.d.ts +4 -1
  27. package/lib/models/pickup/shipped-products.js +2 -0
  28. package/lib/models/pickup/shipped-products.js.map +1 -1
  29. package/lib/models/products.d.ts +4 -1
  30. package/lib/models/products.js +2 -0
  31. package/lib/models/products.js.map +1 -1
  32. package/lib/models/tracking/bulk-tracking-error.d.ts +7 -0
  33. package/lib/models/tracking/bulk-tracking-error.js +12 -0
  34. package/lib/models/tracking/bulk-tracking-error.js.map +1 -0
  35. package/lib/models/tracking/index.d.ts +1 -0
  36. package/lib/models/tracking/index.js +1 -0
  37. package/lib/models/tracking/index.js.map +1 -1
  38. package/lib/requests/bulk-tracking-request.d.ts +14 -0
  39. package/lib/requests/bulk-tracking-request.js +19 -0
  40. package/lib/requests/bulk-tracking-request.js.map +1 -0
  41. package/lib/requests/index.d.ts +1 -0
  42. package/lib/requests/index.js +1 -0
  43. package/lib/requests/index.js.map +1 -1
  44. package/lib/responses/bulk-tracking-response.d.ts +18 -0
  45. package/lib/responses/bulk-tracking-response.js +22 -0
  46. package/lib/responses/bulk-tracking-response.js.map +1 -0
  47. package/lib/responses/index.d.ts +1 -0
  48. package/lib/responses/index.js +1 -0
  49. package/lib/responses/index.js.map +1 -1
  50. package/package.json +1 -1
  51. package/spec.json +36 -0
  52. package/src/app/carrier-app-definition.ts +9 -0
  53. package/src/app/constants.ts +1 -0
  54. package/src/app/create-endpoint-mapping.ts +1 -0
  55. package/src/models/cpsc/cpsc-disclaim-schema.ts +10 -0
  56. package/src/models/cpsc/cpsc-disclaim.ts +11 -0
  57. package/src/models/cpsc/disclaim-code.ts +4 -0
  58. package/src/models/cpsc/index.ts +5 -0
  59. package/src/models/index.ts +1 -2
  60. package/src/models/pickup/shipped-products-schema.ts +3 -1
  61. package/src/models/pickup/shipped-products.ts +4 -1
  62. package/src/models/products.ts +4 -1
  63. package/src/models/tracking/bulk-tracking-error.ts +7 -0
  64. package/src/models/tracking/index.ts +1 -0
  65. package/src/requests/bulk-tracking-request.ts +16 -0
  66. package/src/requests/index.ts +1 -0
  67. package/src/responses/bulk-tracking-response.ts +20 -0
  68. package/src/responses/index.ts +1 -0
  69. package/tsconfig.tsbuildinfo +1 -1
  70. package/lib/models/cpsc-certificate-schema.js.map +0 -1
  71. package/lib/models/cpsc-certificate.js.map +0 -1
  72. /package/lib/models/{cpsc-certificate-schema.d.ts → cpsc/cpsc-certificate-schema.d.ts} +0 -0
  73. /package/lib/models/{cpsc-certificate-schema.js → cpsc/cpsc-certificate-schema.js} +0 -0
  74. /package/lib/models/{cpsc-certificate.d.ts → cpsc/cpsc-certificate.d.ts} +0 -0
  75. /package/lib/models/{cpsc-certificate.js → cpsc/cpsc-certificate.js} +0 -0
  76. /package/src/models/{cpsc-certificate-schema.ts → cpsc/cpsc-certificate-schema.ts} +0 -0
  77. /package/src/models/{cpsc-certificate.ts → cpsc/cpsc-certificate.ts} +0 -0
@@ -1,7 +1,7 @@
1
1
  import { ImportedTrackingEvent } from '../models';
2
2
  import type { Request } from 'express';
3
- import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest, UploadDocumentRequest } from '../requests';
4
- import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse, UploadDocumentResponse } from '../responses';
3
+ import { RegisterRequest, BulkTrackingRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest, UploadDocumentRequest } from '../requests';
4
+ import { RegisterResponse, BulkTrackingResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse, UploadDocumentResponse } from '../responses';
5
5
  import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
6
6
  import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
7
7
  /**
@@ -54,6 +54,11 @@ export interface CarrierAppDefinition {
54
54
  * @param request Data needed by the provider to track a shipment
55
55
  */
56
56
  Track?: (request: TrackingRequest) => TrackingResponse | Promise<TrackingResponse>;
57
+ /**
58
+ * @description This endpoint is used to get tracking information about multiple shipments in a single call
59
+ * @param request Data needed by the provider to track multiple shipments
60
+ */
61
+ BulkTrack?: (request: BulkTrackingRequest) => BulkTrackingResponse | Promise<BulkTrackingResponse>;
57
62
  /**
58
63
  * @description This endpoint is used to submit notification of the creation of a shipment
59
64
  * @param request Data needed by the provider to inform them of a shipment
@@ -8,6 +8,7 @@ export declare enum ApiEndpoints {
8
8
  SchedulePickup = "/SchedulePickup",
9
9
  CancelPickup = "/CancelPickup",
10
10
  Track = "/Track",
11
+ BulkTrack = "/BulkTrack",
11
12
  CreateNotification = "/CreateNotification",
12
13
  CancelNotification = "/CancelNotification",
13
14
  ValidateInboundData = "/ValidateInboundData",
@@ -12,6 +12,7 @@ var ApiEndpoints;
12
12
  ApiEndpoints["SchedulePickup"] = "/SchedulePickup";
13
13
  ApiEndpoints["CancelPickup"] = "/CancelPickup";
14
14
  ApiEndpoints["Track"] = "/Track";
15
+ ApiEndpoints["BulkTrack"] = "/BulkTrack";
15
16
  ApiEndpoints["CreateNotification"] = "/CreateNotification";
16
17
  ApiEndpoints["CancelNotification"] = "/CancelNotification";
17
18
  ApiEndpoints["ValidateInboundData"] = "/ValidateInboundData";
@@ -1 +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,kDAAkC,CAAA;AACpC,CAAC,EAtBW,YAAY,4BAAZ,YAAY,QAsBvB"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAuBX;AAvBD,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,wCAAwB,CAAA;IACxB,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,EAvBW,YAAY,4BAAZ,YAAY,QAuBvB"}
@@ -6,6 +6,7 @@ const constants_1 = require("./constants");
6
6
  const createEndpointMapping = (definition) => [
7
7
  //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
8
8
  //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
9
+ [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.BulkTrack, definition.BulkTrack],
9
10
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelNotification, definition.CancelNotification],
10
11
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CancelPickup, definition.CancelPickup],
11
12
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.CreateLabel, definition.CreateLabel],
@@ -1 +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,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"}
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,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC;IAC3D,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;AA5BW,QAAA,qBAAqB,yBA4BhC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cpsc-certificate-schema.js","sourceRoot":"","sources":["../../../src/models/cpsc/cpsc-certificate-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cpsc-certificate.js","sourceRoot":"","sources":["../../../src/models/cpsc/cpsc-certificate.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gKAAgK;IAChK,YAAY,CAAU;IACtB,6HAA6H;IAC7H,sBAAsB,CAAU;CACjC;AALD,0CAKC"}
@@ -0,0 +1,2 @@
1
+ import Joi from 'joi';
2
+ export declare const CpscDisclaimSchema: Joi.ObjectSchema<any>;
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CpscDisclaimSchema = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const joi_1 = tslib_1.__importDefault(require("joi"));
6
+ const disclaim_code_1 = require("./disclaim-code");
7
+ exports.CpscDisclaimSchema = joi_1.default.object({
8
+ disclaim_code: joi_1.default.string()
9
+ .valid(...Object.values(disclaim_code_1.DisclaimCode))
10
+ .optional(),
11
+ intended_use_code: joi_1.default.string().max(16).optional(),
12
+ intended_use_description: joi_1.default.string().max(100).optional(),
13
+ });
14
+ //# sourceMappingURL=cpsc-disclaim-schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cpsc-disclaim-schema.js","sourceRoot":"","sources":["../../../src/models/cpsc/cpsc-disclaim-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mDAA+C;AAElC,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE;SACxB,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,4BAAY,CAAC,CAAC;SACrC,QAAQ,EAAE;IACb,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CAC3D,CAAC,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { DisclaimCode } from './disclaim-code';
2
+ /** @description Object for CPSC disclaimer data, submitted when the shipment qualifies for a disclaim message instead of a full CPSC certificate of compliance. Note: Omit this object if the product requires CPSC certification. */
3
+ export declare class CpscDisclaim {
4
+ /** @description Code representing the CPSC declaration status. Accepted values: "A" - Product is not regulated by CPSC. "B" - Data is not required per CPSC. */
5
+ disclaim_code?: DisclaimCode;
6
+ /** @description A code from CBP's Intended Use Code list indicating the product's intended use. Must be submitted alongside any disclaim message. */
7
+ intended_use_code?: string;
8
+ /** @description Description of the product's intended use. If "For Other Use" (980.000) code is used, then a free text description of the intended use should be provided. */
9
+ intended_use_description?: string;
10
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CpscDisclaim = void 0;
4
+ /** @description Object for CPSC disclaimer data, submitted when the shipment qualifies for a disclaim message instead of a full CPSC certificate of compliance. Note: Omit this object if the product requires CPSC certification. */
5
+ class CpscDisclaim {
6
+ /** @description Code representing the CPSC declaration status. Accepted values: "A" - Product is not regulated by CPSC. "B" - Data is not required per CPSC. */
7
+ disclaim_code;
8
+ /** @description A code from CBP's Intended Use Code list indicating the product's intended use. Must be submitted alongside any disclaim message. */
9
+ intended_use_code;
10
+ /** @description Description of the product's intended use. If "For Other Use" (980.000) code is used, then a free text description of the intended use should be provided. */
11
+ intended_use_description;
12
+ }
13
+ exports.CpscDisclaim = CpscDisclaim;
14
+ //# sourceMappingURL=cpsc-disclaim.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cpsc-disclaim.js","sourceRoot":"","sources":["../../../src/models/cpsc/cpsc-disclaim.ts"],"names":[],"mappings":";;;AAEA,sOAAsO;AACtO,MAAa,YAAY;IACvB,gKAAgK;IAChK,aAAa,CAAgB;IAC7B,qJAAqJ;IACrJ,iBAAiB,CAAU;IAC3B,8KAA8K;IAC9K,wBAAwB,CAAU;CACnC;AAPD,oCAOC"}
@@ -0,0 +1,4 @@
1
+ export declare enum DisclaimCode {
2
+ A = "A",
3
+ B = "B"
4
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DisclaimCode = void 0;
4
+ var DisclaimCode;
5
+ (function (DisclaimCode) {
6
+ DisclaimCode["A"] = "A";
7
+ DisclaimCode["B"] = "B";
8
+ })(DisclaimCode || (exports.DisclaimCode = DisclaimCode = {}));
9
+ //# sourceMappingURL=disclaim-code.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"disclaim-code.js","sourceRoot":"","sources":["../../../src/models/cpsc/disclaim-code.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,uBAAO,CAAA;IACP,uBAAO,CAAA;AACT,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}
@@ -0,0 +1,5 @@
1
+ export * from './cpsc-certificate';
2
+ export * from './cpsc-certificate-schema';
3
+ export * from './cpsc-disclaim';
4
+ export * from './cpsc-disclaim-schema';
5
+ export * from './disclaim-code';
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./cpsc-certificate"), exports);
5
+ tslib_1.__exportStar(require("./cpsc-certificate-schema"), exports);
6
+ tslib_1.__exportStar(require("./cpsc-disclaim"), exports);
7
+ tslib_1.__exportStar(require("./cpsc-disclaim-schema"), exports);
8
+ tslib_1.__exportStar(require("./disclaim-code"), exports);
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/cpsc/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,oEAA0C;AAC1C,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC"}
@@ -5,8 +5,7 @@ export * from './cod-payment-type';
5
5
  export * from './collect-on-delivery';
6
6
  export * from './billing';
7
7
  export * from './confirmation-types';
8
- export * from './cpsc-certificate';
9
- export * from './cpsc-certificate-schema';
8
+ export * from './cpsc';
10
9
  export * from './currency-schema';
11
10
  export * from './currency';
12
11
  export * from './customs';
@@ -8,8 +8,7 @@ tslib_1.__exportStar(require("./cod-payment-type"), exports);
8
8
  tslib_1.__exportStar(require("./collect-on-delivery"), exports);
9
9
  tslib_1.__exportStar(require("./billing"), exports);
10
10
  tslib_1.__exportStar(require("./confirmation-types"), exports);
11
- tslib_1.__exportStar(require("./cpsc-certificate"), exports);
12
- tslib_1.__exportStar(require("./cpsc-certificate-schema"), exports);
11
+ tslib_1.__exportStar(require("./cpsc"), exports);
13
12
  tslib_1.__exportStar(require("./currency-schema"), exports);
14
13
  tslib_1.__exportStar(require("./currency"), exports);
15
14
  tslib_1.__exportStar(require("./customs"), exports);
@@ -1 +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,6DAAmC;AACnC,oEAA0C;AAC1C,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,iFAAuD;AACvD,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"}
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,iDAAuB;AACvB,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,iFAAuD;AACvD,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"}
@@ -6,7 +6,8 @@ const joi_1 = tslib_1.__importDefault(require("joi"));
6
6
  const connect_carrier_api_1 = require("@shipengine/connect-carrier-api");
7
7
  const weight_details_schema_1 = require("../units/weight-details-schema");
8
8
  const manufacturer_product_identifier_type_1 = require("../manufacturer-product-identifier-type");
9
- const cpsc_certificate_schema_1 = require("../cpsc-certificate-schema");
9
+ const cpsc_certificate_schema_1 = require("../cpsc/cpsc-certificate-schema");
10
+ const cpsc_disclaim_schema_1 = require("../cpsc/cpsc-disclaim-schema");
10
11
  exports.ShippedProductsSchema = joi_1.default.object({
11
12
  description: joi_1.default.string().optional(),
12
13
  quantity: joi_1.default.number().optional(),
@@ -26,5 +27,6 @@ exports.ShippedProductsSchema = joi_1.default.object({
26
27
  manufacturer_ns_product_id: joi_1.default.string().optional(),
27
28
  dangerous_goods: joi_1.default.object().optional(),
28
29
  cpsc_certificates: joi_1.default.array().items(cpsc_certificate_schema_1.CpscCertificateSchema).optional(),
30
+ cpsc_disclaim: cpsc_disclaim_schema_1.CpscDisclaimSchema.optional(),
29
31
  });
30
32
  //# sourceMappingURL=shipped-products-schema.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipped-products-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAiE;AACjE,0EAAqE;AACrE,kGAA4F;AAC5F,wEAAmE;AAEtD,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,oCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE;SACvC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,wEAAiC,CAAC,CAAC;SAC1D,QAAQ,EAAE;IACb,uBAAuB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnD,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,+CAAqB,CAAC,CAAC,QAAQ,EAAE;CACvE,CAAC,CAAC"}
1
+ {"version":3,"file":"shipped-products-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAiE;AACjE,0EAAqE;AACrE,kGAA4F;AAC5F,6EAAwE;AACxE,uEAAkE;AAErD,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,oCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE;SACvC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,wEAAiC,CAAC,CAAC;SAC1D,QAAQ,EAAE;IACb,uBAAuB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnD,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,+CAAqB,CAAC,CAAC,QAAQ,EAAE;IACtE,aAAa,EAAE,yCAAkB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC"}
@@ -1,7 +1,8 @@
1
1
  import { Currency, WeightDetails } from '@shipengine/connect-carrier-api';
2
2
  import { DangerousGoods } from '../dangerous-good/dangerous-goods';
3
3
  import { ManufacturerProductIdentifierType } from '../manufacturer-product-identifier-type';
4
- import { CpscCertificate } from '../cpsc-certificate';
4
+ import { CpscCertificate } from '../cpsc/cpsc-certificate';
5
+ import { CpscDisclaim } from '../cpsc/cpsc-disclaim';
5
6
  /** @description Basic structure for a product from a shipped shipment*/
6
7
  export declare class ShippedProducts {
7
8
  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
@@ -36,6 +37,8 @@ export declare class ShippedProducts {
36
37
  dangerous_goods?: DangerousGoods[];
37
38
  /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
38
39
  cpsc_certificates?: CpscCertificate[];
40
+ /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
41
+ cpsc_disclaim?: CpscDisclaim;
39
42
  /** @description Additional details for product. */
40
43
  [key: string]: any;
41
44
  }
@@ -35,6 +35,8 @@ class ShippedProducts {
35
35
  dangerous_goods;
36
36
  /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
37
37
  cpsc_certificates;
38
+ /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
39
+ cpsc_disclaim;
38
40
  }
39
41
  exports.ShippedProducts = ShippedProducts;
40
42
  //# sourceMappingURL=shipped-products.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipped-products.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products.ts"],"names":[],"mappings":";;;AAKA,wEAAwE;AACxE,MAAa,eAAe;IAC1B,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,wMAAwM;IACxM,4BAA4B,CAAqC;IACjE,8DAA8D;IAC9D,uBAAuB,CAAU;IACjC,iKAAiK;IACjK,0BAA0B,CAAU;IACpC,qGAAqG;IACrG,eAAe,CAAoB;IACnC,wLAAwL;IACxL,iBAAiB,CAAqB;CAGvC;AAnCD,0CAmCC"}
1
+ {"version":3,"file":"shipped-products.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products.ts"],"names":[],"mappings":";;;AAMA,wEAAwE;AACxE,MAAa,eAAe;IAC1B,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,wMAAwM;IACxM,4BAA4B,CAAqC;IACjE,8DAA8D;IAC9D,uBAAuB,CAAU;IACjC,iKAAiK;IACjK,0BAA0B,CAAU;IACpC,qGAAqG;IACrG,eAAe,CAAoB;IACnC,wLAAwL;IACxL,iBAAiB,CAAqB;IACtC,8IAA8I;IAC9I,aAAa,CAAgB;CAG9B;AArCD,0CAqCC"}
@@ -3,7 +3,8 @@ import { Currency } from './currency';
3
3
  import { DangerousGoods } from './dangerous-good/dangerous-goods';
4
4
  import { UnitOfMeasureTypes } from './customs/unit-of-measure-types';
5
5
  import { ManufacturerProductIdentifierType } from './manufacturer-product-identifier-type';
6
- import { CpscCertificate } from './cpsc-certificate';
6
+ import { CpscCertificate } from './cpsc/cpsc-certificate';
7
+ import { CpscDisclaim } from './cpsc/cpsc-disclaim';
7
8
  /** @description Basic structure for a product */
8
9
  export declare class Products {
9
10
  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
@@ -40,6 +41,8 @@ export declare class Products {
40
41
  manufacturer_ns_product_id?: string;
41
42
  /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
42
43
  cpsc_certificates?: CpscCertificate[];
44
+ /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
45
+ cpsc_disclaim?: CpscDisclaim;
43
46
  /** @description Additional details for product. */
44
47
  [key: string]: any;
45
48
  }
@@ -37,6 +37,8 @@ class Products {
37
37
  manufacturer_ns_product_id;
38
38
  /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
39
39
  cpsc_certificates;
40
+ /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
41
+ cpsc_disclaim;
40
42
  }
41
43
  exports.Products = Products;
42
44
  //# sourceMappingURL=products.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,2EAA2E;IAC3E,eAAe,CAAsB;IACrC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,qGAAqG;IACrG,eAAe,CAAoB;IACnC,wMAAwM;IACxM,4BAA4B,CAAqC;IACjE,8DAA8D;IAC9D,uBAAuB,CAAU;IACjC,iKAAiK;IACjK,0BAA0B,CAAU;IACpC,wLAAwL;IACxL,iBAAiB,CAAqB;CAGvC;AArCD,4BAqCC"}
1
+ {"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAQA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,2EAA2E;IAC3E,eAAe,CAAsB;IACrC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,qGAAqG;IACrG,eAAe,CAAoB;IACnC,wMAAwM;IACxM,4BAA4B,CAAqC;IACjE,8DAA8D;IAC9D,uBAAuB,CAAU;IACjC,iKAAiK;IACjK,0BAA0B,CAAU;IACpC,wLAAwL;IACxL,iBAAiB,CAAqB;IACtC,8IAA8I;IAC9I,aAAa,CAAgB;CAG9B;AAvCD,4BAuCC"}
@@ -0,0 +1,7 @@
1
+ /** @description Error detail for a single item within a bulk tracking response */
2
+ export declare class BulkTrackingError {
3
+ /** @description A code identifying the type of error encountered while tracking this item */
4
+ code: string;
5
+ /** @description A human readable description of the error */
6
+ message: string;
7
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BulkTrackingError = void 0;
4
+ /** @description Error detail for a single item within a bulk tracking response */
5
+ class BulkTrackingError {
6
+ /** @description A code identifying the type of error encountered while tracking this item */
7
+ code;
8
+ /** @description A human readable description of the error */
9
+ message;
10
+ }
11
+ exports.BulkTrackingError = BulkTrackingError;
12
+ //# sourceMappingURL=bulk-tracking-error.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bulk-tracking-error.js","sourceRoot":"","sources":["../../../src/models/tracking/bulk-tracking-error.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,iBAAiB;IAC5B,6FAA6F;IAC7F,IAAI,CAAU;IACd,6DAA6D;IAC7D,OAAO,CAAU;CAClB;AALD,8CAKC"}
@@ -1,3 +1,4 @@
1
+ export * from './bulk-tracking-error';
1
2
  export * from './imported-tracking-event-schema';
2
3
  export * from './imported-tracking-event';
3
4
  export * from './lat-long-schema';
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./bulk-tracking-error"), exports);
4
5
  tslib_1.__exportStar(require("./imported-tracking-event-schema"), exports);
5
6
  tslib_1.__exportStar(require("./imported-tracking-event"), exports);
6
7
  tslib_1.__exportStar(require("./lat-long-schema"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D;AAC1D,kEAAwC;AACxC,yEAA+C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D;AAC1D,kEAAwC;AACxC,yEAA+C"}
@@ -0,0 +1,14 @@
1
+ import { BaseRequest } from './base-request';
2
+ import { TrackingIdentifier, TrackingAttribute } from '../models';
3
+ /** @description A single shipment to request tracking information for as part of a bulk tracking request */
4
+ export declare class BulkTrackingItem {
5
+ /** @description List of identifiers */
6
+ identifiers?: TrackingIdentifier[];
7
+ /** @description List of attributes */
8
+ attributes?: TrackingAttribute[];
9
+ }
10
+ /** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
11
+ export declare class BulkTrackingRequest extends BaseRequest {
12
+ /** @description The shipments to retrieve tracking information for */
13
+ items: BulkTrackingItem[];
14
+ }
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BulkTrackingRequest = exports.BulkTrackingItem = void 0;
4
+ const base_request_1 = require("./base-request");
5
+ /** @description A single shipment to request tracking information for as part of a bulk tracking request */
6
+ class BulkTrackingItem {
7
+ /** @description List of identifiers */
8
+ identifiers;
9
+ /** @description List of attributes */
10
+ attributes;
11
+ }
12
+ exports.BulkTrackingItem = BulkTrackingItem;
13
+ /** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
14
+ class BulkTrackingRequest extends base_request_1.BaseRequest {
15
+ /** @description The shipments to retrieve tracking information for */
16
+ items;
17
+ }
18
+ exports.BulkTrackingRequest = BulkTrackingRequest;
19
+ //# sourceMappingURL=bulk-tracking-request.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bulk-tracking-request.js","sourceRoot":"","sources":["../../src/requests/bulk-tracking-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,4GAA4G;AAC5G,MAAa,gBAAgB;IAC3B,uCAAuC;IACvC,WAAW,CAAwB;IACnC,sCAAsC;IACtC,UAAU,CAAuB;CAClC;AALD,4CAKC;AAED,qHAAqH;AACrH,MAAa,mBAAoB,SAAQ,0BAAW;IAClD,sEAAsE;IACtE,KAAK,CAAsB;CAC5B;AAHD,kDAGC"}
@@ -1,3 +1,4 @@
1
+ export * from './bulk-tracking-request';
1
2
  export * from './cancel-notification-request';
2
3
  export * from './cancel-pickup-request';
3
4
  export * from './create-label-request';
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./bulk-tracking-request"), exports);
4
5
  tslib_1.__exportStar(require("./cancel-notification-request"), exports);
5
6
  tslib_1.__exportStar(require("./cancel-pickup-request"), exports);
6
7
  tslib_1.__exportStar(require("./create-label-request"), exports);
@@ -1 +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,oEAA0C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,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"}
@@ -0,0 +1,18 @@
1
+ import { BaseResponse } from './base-response';
2
+ import { TrackingInfo } from '../models';
3
+ import { BulkTrackingError } from '../models/tracking/bulk-tracking-error';
4
+ /** @description Tracking result for a single item within a bulk tracking response */
5
+ export declare class BulkTrackingResultItem {
6
+ /** @description The carrier specific tracking identifier for this shipment */
7
+ tracking_number: string;
8
+ /** @description Tracking information for this shipment, present when tracking succeeded */
9
+ tracking_info?: TrackingInfo;
10
+ /** @description Error detail for this shipment, present when tracking failed */
11
+ error?: BulkTrackingError;
12
+ }
13
+ /** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
14
+ export declare class BulkTrackingResponse extends BaseResponse {
15
+ transaction_id: string;
16
+ /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
17
+ results: BulkTrackingResultItem[];
18
+ }
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BulkTrackingResponse = exports.BulkTrackingResultItem = void 0;
4
+ const base_response_1 = require("./base-response");
5
+ /** @description Tracking result for a single item within a bulk tracking response */
6
+ class BulkTrackingResultItem {
7
+ /** @description The carrier specific tracking identifier for this shipment */
8
+ tracking_number;
9
+ /** @description Tracking information for this shipment, present when tracking succeeded */
10
+ tracking_info;
11
+ /** @description Error detail for this shipment, present when tracking failed */
12
+ error;
13
+ }
14
+ exports.BulkTrackingResultItem = BulkTrackingResultItem;
15
+ /** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
16
+ class BulkTrackingResponse extends base_response_1.BaseResponse {
17
+ transaction_id;
18
+ /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
19
+ results;
20
+ }
21
+ exports.BulkTrackingResponse = BulkTrackingResponse;
22
+ //# sourceMappingURL=bulk-tracking-response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bulk-tracking-response.js","sourceRoot":"","sources":["../../src/responses/bulk-tracking-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C,qFAAqF;AACrF,MAAa,sBAAsB;IACjC,8EAA8E;IAC9E,eAAe,CAAU;IACzB,2FAA2F;IAC3F,aAAa,CAAgB;IAC7B,gFAAgF;IAChF,KAAK,CAAqB;CAC3B;AAPD,wDAOC;AAED,sHAAsH;AACtH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,cAAc,CAAU;IACxB,qGAAqG;IACrG,OAAO,CAA4B;CACpC;AAJD,oDAIC"}
@@ -1,3 +1,4 @@
1
+ export * from './bulk-tracking-response';
1
2
  export * from './cancel-notification-response-schema';
2
3
  export * from './cancel-notification-response';
3
4
  export * from './cancel-pickup-response-schema';
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./bulk-tracking-response"), exports);
4
5
  tslib_1.__exportStar(require("./cancel-notification-response-schema"), exports);
5
6
  tslib_1.__exportStar(require("./cancel-notification-response"), exports);
6
7
  tslib_1.__exportStar(require("./cancel-pickup-response-schema"), exports);
@@ -1 +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,qEAA2C;AAC3C,4EAAkD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.32.0",
3
+ "version": "4.34.0",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://connect.shipengine.com",
6
6
  "main": "./lib/index.js",
package/spec.json CHANGED
@@ -1422,6 +1422,28 @@
1422
1422
  ],
1423
1423
  "type": "string"
1424
1424
  },
1425
+ "CpscDisclaim": {
1426
+ "type": "object",
1427
+ "properties": {
1428
+ "disclaim_code": {
1429
+ "$ref": "#/components/schemas/DisclaimCode"
1430
+ },
1431
+ "intended_use_code": {
1432
+ "type": "string",
1433
+ "description": "A code from CBP's Intended Use Code list indicating the product's intended use. Must be submitted alongside any disclaim message.",
1434
+ "maxLength": 16,
1435
+ "nullable": true
1436
+ },
1437
+ "intended_use_description": {
1438
+ "type": "string",
1439
+ "description": "Description of the product's intended use. If \"For Other Use\" (980.000) code is used, then a free text description of the intended use should be provided.",
1440
+ "maxLength": 100,
1441
+ "nullable": true
1442
+ }
1443
+ },
1444
+ "additionalProperties": false,
1445
+ "description": "Object for CPSC disclaimer data, submitted when the shipment qualifies for a disclaim message instead of a full CPSC certificate of compliance. Note: Omit this object if the product requires CPSC certification."
1446
+ },
1425
1447
  "CpscCertificate": {
1426
1448
  "type": "object",
1427
1449
  "properties": {
@@ -2391,6 +2413,14 @@
2391
2413
  "additionalProperties": false,
2392
2414
  "description": "This model represents the measurements for dimensions."
2393
2415
  },
2416
+ "DisclaimCode": {
2417
+ "enum": [
2418
+ "A",
2419
+ "B"
2420
+ ],
2421
+ "type": "string",
2422
+ "description": "Code representing the CPSC declaration status. Accepted values: \"A\" - Product is not regulated by CPSC. \"B\" - Data is not required per CPSC."
2423
+ },
2394
2424
  "DisplayScheme": {
2395
2425
  "enum": [
2396
2426
  "label",
@@ -3987,6 +4017,9 @@
3987
4017
  },
3988
4018
  "description": "CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference\r\ndata for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set.",
3989
4019
  "nullable": true
4020
+ },
4021
+ "cpsc_disclaim": {
4022
+ "$ref": "#/components/schemas/CpscDisclaim"
3990
4023
  }
3991
4024
  },
3992
4025
  "additionalProperties": { },
@@ -4872,6 +4905,9 @@
4872
4905
  },
4873
4906
  "description": "CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference\r\ndata for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set.",
4874
4907
  "nullable": true
4908
+ },
4909
+ "cpsc_disclaim": {
4910
+ "$ref": "#/components/schemas/CpscDisclaim"
4875
4911
  }
4876
4912
  },
4877
4913
  "additionalProperties": { },
@@ -2,6 +2,7 @@ import { ImportedTrackingEvent } from '../models';
2
2
  import type { Request } from 'express';
3
3
  import {
4
4
  RegisterRequest,
5
+ BulkTrackingRequest,
5
6
  CreateLabelRequest,
6
7
  VoidLabelsRequest,
7
8
  CreateManifestRequest,
@@ -26,6 +27,7 @@ import {
26
27
 
27
28
  import {
28
29
  RegisterResponse,
30
+ BulkTrackingResponse,
29
31
  CreateLabelResponse,
30
32
  VoidLabelsResponse,
31
33
  CreateManifestResponse,
@@ -108,6 +110,13 @@ export interface CarrierAppDefinition {
108
110
  * @param request Data needed by the provider to track a shipment
109
111
  */
110
112
  Track?: (request: TrackingRequest) => TrackingResponse | Promise<TrackingResponse>;
113
+ /**
114
+ * @description This endpoint is used to get tracking information about multiple shipments in a single call
115
+ * @param request Data needed by the provider to track multiple shipments
116
+ */
117
+ BulkTrack?: (
118
+ request: BulkTrackingRequest,
119
+ ) => BulkTrackingResponse | Promise<BulkTrackingResponse>;
111
120
  /**
112
121
  * @description This endpoint is used to submit notification of the creation of a shipment
113
122
  * @param request Data needed by the provider to inform them of a shipment
@@ -8,6 +8,7 @@ export enum ApiEndpoints {
8
8
  SchedulePickup = '/SchedulePickup',
9
9
  CancelPickup = '/CancelPickup',
10
10
  Track = '/Track',
11
+ BulkTrack = '/BulkTrack',
11
12
  CreateNotification = '/CreateNotification',
12
13
  CancelNotification = '/CancelNotification',
13
14
  ValidateInboundData = '/ValidateInboundData',