@shipengine/connect-carrier-api 4.16.5 → 4.16.7

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 (88) hide show
  1. package/lib/app/carrier-app-definition.d.ts +7 -2
  2. package/lib/app/constants.d.ts +2 -1
  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/addresses/pickup-address.d.ts +3 -0
  8. package/lib/models/addresses/pickup-address.js +8 -0
  9. package/lib/models/addresses/pickup-address.js.map +1 -0
  10. package/lib/models/dangerous-good/dangerous-goods-declaration.d.ts +13 -0
  11. package/lib/models/dangerous-good/dangerous-goods-declaration.js +16 -0
  12. package/lib/models/dangerous-good/dangerous-goods-declaration.js.map +1 -0
  13. package/lib/models/dangerous-good/dangerous-goods-inner-packaging.d.ts +7 -0
  14. package/lib/models/dangerous-good/dangerous-goods-inner-packaging.js +12 -0
  15. package/lib/models/dangerous-good/dangerous-goods-inner-packaging.js.map +1 -0
  16. package/lib/models/dangerous-good/dangerous-goods-package-info.d.ts +19 -0
  17. package/lib/models/dangerous-good/dangerous-goods-package-info.js +22 -0
  18. package/lib/models/dangerous-good/dangerous-goods-package-info.js.map +1 -0
  19. package/lib/models/dangerous-good/dangerous-goods.d.ts +5 -0
  20. package/lib/models/dangerous-good/dangerous-goods.js +4 -0
  21. package/lib/models/dangerous-good/dangerous-goods.js.map +1 -1
  22. package/lib/models/labels/void-request.d.ts +0 -2
  23. package/lib/models/labels/void-request.js +0 -2
  24. package/lib/models/labels/void-request.js.map +1 -1
  25. package/lib/models/manifests/manifest-request-shipment.d.ts +0 -1
  26. package/lib/models/manifests/manifest-request-shipment.js +0 -1
  27. package/lib/models/manifests/manifest-request-shipment.js.map +1 -1
  28. package/lib/models/package.d.ts +3 -0
  29. package/lib/models/package.js +2 -0
  30. package/lib/models/package.js.map +1 -1
  31. package/lib/models/pickup/pickup-schema.d.ts +2 -0
  32. package/lib/models/pickup/pickup-schema.js +11 -0
  33. package/lib/models/pickup/pickup-schema.js.map +1 -0
  34. package/lib/models/pickup/pickup.d.ts +5 -0
  35. package/lib/models/pickup/pickup.js +10 -0
  36. package/lib/models/pickup/pickup.js.map +1 -0
  37. package/lib/models/pickup/shipped-shipment.d.ts +2 -0
  38. package/lib/models/pickup/shipped-shipment.js +2 -0
  39. package/lib/models/pickup/shipped-shipment.js.map +1 -1
  40. package/lib/models/tracking/index.d.ts +2 -0
  41. package/lib/models/tracking/index.js +2 -0
  42. package/lib/models/tracking/index.js.map +1 -1
  43. package/lib/requests/create-label-request.d.ts +3 -0
  44. package/lib/requests/create-label-request.js +2 -0
  45. package/lib/requests/create-label-request.js.map +1 -1
  46. package/lib/requests/get-rates-request.d.ts +3 -0
  47. package/lib/requests/get-rates-request.js +2 -0
  48. package/lib/requests/get-rates-request.js.map +1 -1
  49. package/lib/requests/index.d.ts +1 -0
  50. package/lib/requests/index.js +1 -0
  51. package/lib/requests/index.js.map +1 -1
  52. package/lib/requests/list-pickups-request.d.ts +9 -0
  53. package/lib/requests/list-pickups-request.js +12 -0
  54. package/lib/requests/list-pickups-request.js.map +1 -0
  55. package/lib/responses/index.d.ts +2 -0
  56. package/lib/responses/index.js +2 -0
  57. package/lib/responses/index.js.map +1 -1
  58. package/lib/responses/list-pickups-response-schema.d.ts +1 -0
  59. package/lib/responses/list-pickups-response-schema.js +9 -0
  60. package/lib/responses/list-pickups-response-schema.js.map +1 -0
  61. package/lib/responses/list-pickups-response.d.ts +6 -0
  62. package/lib/responses/list-pickups-response.js +10 -0
  63. package/lib/responses/list-pickups-response.js.map +1 -0
  64. package/package.json +1 -1
  65. package/spec.json +588 -429
  66. package/src/app/carrier-app-definition.ts +7 -0
  67. package/src/app/constants.ts +1 -0
  68. package/src/app/create-endpoint-mapping.ts +1 -0
  69. package/src/models/addresses/pickup-address.ts +3 -0
  70. package/src/models/dangerous-good/dangerous-goods-declaration.ts +14 -0
  71. package/src/models/dangerous-good/dangerous-goods-inner-packaging.ts +7 -0
  72. package/src/models/dangerous-good/dangerous-goods-package-info.ts +20 -0
  73. package/src/models/dangerous-good/dangerous-goods.ts +5 -0
  74. package/src/models/labels/void-request.ts +0 -2
  75. package/src/models/manifests/manifest-request-shipment.ts +0 -1
  76. package/src/models/package.ts +3 -0
  77. package/src/models/pickup/pickup-schema.ts +7 -0
  78. package/src/models/pickup/pickup.ts +5 -0
  79. package/src/models/pickup/shipped-shipment.ts +2 -0
  80. package/src/models/tracking/index.ts +2 -0
  81. package/src/requests/create-label-request.ts +3 -0
  82. package/src/requests/get-rates-request.ts +3 -0
  83. package/src/requests/index.ts +1 -0
  84. package/src/requests/list-pickups-request.ts +10 -0
  85. package/src/responses/index.ts +2 -0
  86. package/src/responses/list-pickups-response-schema.ts +6 -0
  87. package/src/responses/list-pickups-response.ts +7 -0
  88. package/tsconfig.tsbuildinfo +1 -1
@@ -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 } from '../requests';
4
- import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse } from '../responses';
3
+ import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest } from '../requests';
4
+ import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse } from '../responses';
5
5
  import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
6
6
  import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
7
7
  /**
@@ -94,6 +94,11 @@ export interface CarrierAppDefinition {
94
94
  * @param request Data needed by the provider to import tracking events
95
95
  */
96
96
  ImportTrackingEvents?: (request: ImportTrackingEventsRequest) => AsyncGenerator<ImportedTrackingEvent>;
97
+ /**
98
+ * @description This endpoint is used to list information about previously scheduled pickups
99
+ * @param request Data needed by the provider to list pickups
100
+ */
101
+ ListPickups?: (request: ListPickupsRequest) => ListPickupsResponse | Promise<ListPickupsResponse>;
97
102
  ScheduledFunction?: (request: Record<string, any>) => Promise<{}[] | null> | {}[] | null;
98
103
  /** @description A method that gets additional context to log from the request when logging */
99
104
  getAdditionalContext?: (req: Request) => Record<string, string>;
@@ -16,5 +16,6 @@ export declare enum ApiEndpoints {
16
16
  GetServicePoints = "/GetServicePoints",
17
17
  GetServicePoint = "/GetServicePoint",
18
18
  ImportTrackingEvents = "/ImportTrackingEvents",
19
- UpdateSettings = "/UpdateSettings"
19
+ UpdateSettings = "/UpdateSettings",
20
+ ListPickups = "/ListPickups"
20
21
  }
@@ -21,5 +21,6 @@ var ApiEndpoints;
21
21
  ApiEndpoints["GetServicePoint"] = "/GetServicePoint";
22
22
  ApiEndpoints["ImportTrackingEvents"] = "/ImportTrackingEvents";
23
23
  ApiEndpoints["UpdateSettings"] = "/UpdateSettings";
24
+ ApiEndpoints["ListPickups"] = "/ListPickups";
24
25
  })(ApiEndpoints || (exports.ApiEndpoints = ApiEndpoints = {}));
25
26
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAmBX;AAnBD,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;AACpC,CAAC,EAnBW,YAAY,4BAAZ,YAAY,QAmBvB"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAoBX;AApBD,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;AAC9B,CAAC,EApBW,YAAY,4BAAZ,YAAY,QAoBvB"}
@@ -24,6 +24,7 @@ const createEndpointMapping = (definition) => [
24
24
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetServicePoint, definition.GetServicePoint],
25
25
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
26
26
  [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UpdateSettings, definition.UpdateSettings],
27
+ [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ListPickups, definition.ListPickups],
27
28
  ...(0, connect_runtime_1.mapExtensions)(definition.Extensions),
28
29
  ];
29
30
  exports.createEndpointMapping = createEndpointMapping;
@@ -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,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAxBW,QAAA,qBAAqB,yBAwBhC"}
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,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAzBW,QAAA,qBAAqB,yBAyBhC"}
@@ -0,0 +1,3 @@
1
+ import { AddressBase } from './address-base';
2
+ export declare class PickupAddress extends AddressBase {
3
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PickupAddress = void 0;
4
+ const address_base_1 = require("./address-base");
5
+ class PickupAddress extends address_base_1.AddressBase {
6
+ }
7
+ exports.PickupAddress = PickupAddress;
8
+ //# sourceMappingURL=pickup-address.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pickup-address.js","sourceRoot":"","sources":["../../../src/models/addresses/pickup-address.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,MAAa,aAAc,SAAQ,0BAAW;CAAG;AAAjD,sCAAiD"}
@@ -0,0 +1,13 @@
1
+ import { Signatory } from '../signatory';
2
+ import { DangerousGoodsContact } from './dangerous-goods-contact';
3
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
4
+ export declare class DangerousGoodsDeclaration {
5
+ /** @description Name of the regulatory authority */
6
+ regulation_set?: string;
7
+ /** @description Contact information for Dangerous goods */
8
+ emergency_contact?: DangerousGoodsContact;
9
+ /** @description An object containing details of the person signing the dangerous goods declaration. */
10
+ signatory?: Signatory;
11
+ /** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
12
+ additional_handling_information?: string;
13
+ }
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DangerousGoodsDeclaration = void 0;
4
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
5
+ class DangerousGoodsDeclaration {
6
+ /** @description Name of the regulatory authority */
7
+ regulation_set;
8
+ /** @description Contact information for Dangerous goods */
9
+ emergency_contact;
10
+ /** @description An object containing details of the person signing the dangerous goods declaration. */
11
+ signatory;
12
+ /** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
13
+ additional_handling_information;
14
+ }
15
+ exports.DangerousGoodsDeclaration = DangerousGoodsDeclaration;
16
+ //# sourceMappingURL=dangerous-goods-declaration.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dangerous-goods-declaration.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-declaration.ts"],"names":[],"mappings":";;;AAGA,8HAA8H;AAC9H,MAAa,yBAAyB;IACpC,oDAAoD;IACpD,cAAc,CAAU;IACxB,2DAA2D;IAC3D,iBAAiB,CAAyB;IAC1C,uGAAuG;IACvG,SAAS,CAAa;IACtB,0MAA0M;IAC1M,+BAA+B,CAAU;CAC1C;AATD,8DASC"}
@@ -0,0 +1,7 @@
1
+ /** @description An object detailing the inner packaging of the dangerous good. */
2
+ export declare class DangerousGoodsInnerPackaging {
3
+ /** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
4
+ type?: string;
5
+ /** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
6
+ quantity?: number;
7
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DangerousGoodsInnerPackaging = void 0;
4
+ /** @description An object detailing the inner packaging of the dangerous good. */
5
+ class DangerousGoodsInnerPackaging {
6
+ /** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
7
+ type;
8
+ /** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
9
+ quantity;
10
+ }
11
+ exports.DangerousGoodsInnerPackaging = DangerousGoodsInnerPackaging;
12
+ //# sourceMappingURL=dangerous-goods-inner-packaging.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dangerous-goods-inner-packaging.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-inner-packaging.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,4BAA4B;IACvC,wGAAwG;IACxG,IAAI,CAAU;IACd,kIAAkI;IAClI,QAAQ,CAAU;CACnB;AALD,oEAKC"}
@@ -0,0 +1,19 @@
1
+ import { RegulationLevelTypes } from './regulation-level-types';
2
+ import { TransportMeanTypes } from './transport-mean-types';
3
+ /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
4
+ export declare class DangerousGoodsPackageInfo {
5
+ /** @description Transportation means through which the dangerous goods are transported */
6
+ transport_mean?: TransportMeanTypes;
7
+ /** @description Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
8
+ accessibility?: boolean;
9
+ /** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
10
+ is_overpack?: boolean;
11
+ /** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
12
+ all_packed_in_one?: boolean;
13
+ /** @description The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
14
+ q_value?: number;
15
+ /** @description The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code (e.g., "4G" for fiberboard box, "1A2" for steel drum). */
16
+ outer_packaging_type?: string;
17
+ /** @description Regulation level of the dangerous goods */
18
+ regulation_level?: RegulationLevelTypes;
19
+ }
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DangerousGoodsPackageInfo = void 0;
4
+ /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
5
+ class DangerousGoodsPackageInfo {
6
+ /** @description Transportation means through which the dangerous goods are transported */
7
+ transport_mean;
8
+ /** @description Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
9
+ accessibility;
10
+ /** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
11
+ is_overpack;
12
+ /** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
13
+ all_packed_in_one;
14
+ /** @description The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
15
+ q_value;
16
+ /** @description The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code (e.g., "4G" for fiberboard box, "1A2" for steel drum). */
17
+ outer_packaging_type;
18
+ /** @description Regulation level of the dangerous goods */
19
+ regulation_level;
20
+ }
21
+ exports.DangerousGoodsPackageInfo = DangerousGoodsPackageInfo;
22
+ //# sourceMappingURL=dangerous-goods-package-info.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dangerous-goods-package-info.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-package-info.ts"],"names":[],"mappings":";;;AAGA,sHAAsH;AACtH,MAAa,yBAAyB;IACpC,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,qKAAqK;IACrK,aAAa,CAAW;IACxB,0MAA0M;IAC1M,WAAW,CAAW;IACtB,wKAAwK;IACxK,iBAAiB,CAAW;IAC5B,sOAAsO;IACtO,OAAO,CAAU;IACjB,yLAAyL;IACzL,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;CACzC;AAfD,8DAeC"}
@@ -4,6 +4,7 @@ import { RegulationLevelTypes } from './regulation-level-types';
4
4
  import { TransportMeanTypes } from './transport-mean-types';
5
5
  import { DangerousAmountDetails } from './weight-details';
6
6
  import { AccessibilityTypes } from '../accessibility-types';
7
+ import { DangerousGoodsInnerPackaging } from './dangerous-goods-inner-packaging';
7
8
  /** @description Basic structure for a dangerous goods */
8
9
  export declare class DangerousGoods {
9
10
  /** @description UN number to identify the dangerous goods */
@@ -46,4 +47,8 @@ export declare class DangerousGoods {
46
47
  additional_description?: string;
47
48
  /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
48
49
  accessibility?: AccessibilityTypes;
50
+ /** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
51
+ special_provisions?: string;
52
+ /** @description An object detailing the inner packaging of the dangerous good. */
53
+ inner_packaging?: DangerousGoodsInnerPackaging;
49
54
  }
@@ -43,6 +43,10 @@ class DangerousGoods {
43
43
  additional_description;
44
44
  /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
45
45
  accessibility;
46
+ /** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
47
+ special_provisions;
48
+ /** @description An object detailing the inner packaging of the dangerous good. */
49
+ inner_packaging;
46
50
  }
47
51
  exports.DangerousGoods = DangerousGoods;
48
52
  //# sourceMappingURL=dangerous-goods.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAOA,yDAAyD;AACzD,MAAa,cAAc;IACzB,6DAA6D;IAC7D,SAAS,CAAU;IACnB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,4EAA4E;IAC5E,cAAc,CAAU;IACxB,qEAAqE;IACrE,aAAa,CAAU;IACvB,0GAA0G;IAC1G,wBAAwB,CAAU;IAClC,oFAAoF;IACpF,eAAe,CAAuB;IACtC,qDAAqD;IACrD,gBAAgB,CAA0B;IAC1C,+CAA+C;IAC/C,QAAQ,CAAU;IAClB,uJAAuJ;IACvJ,qBAAqB,CAAU;IAC/B,sGAAsG;IACtG,6BAA6B,CAAkC;IAC/D,qFAAqF;IACrF,cAAc,CAAU;IACxB,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,0FAA0F;IAC1F,kBAAkB,CAAU;IAC5B,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;IACxC,8DAA8D;IAC9D,WAAW,CAAW;IACtB,kHAAkH;IAClH,mBAAmB,CAAW;IAC9B,wFAAwF;IACxF,WAAW,CAAU;IACrB,sKAAsK;IACtK,sBAAsB,CAAU;IAChC,+GAA+G;IAC/G,aAAa,CAAsB;CACpC;AAzCD,wCAyCC"}
1
+ {"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAQA,yDAAyD;AACzD,MAAa,cAAc;IACzB,6DAA6D;IAC7D,SAAS,CAAU;IACnB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,4EAA4E;IAC5E,cAAc,CAAU;IACxB,qEAAqE;IACrE,aAAa,CAAU;IACvB,0GAA0G;IAC1G,wBAAwB,CAAU;IAClC,oFAAoF;IACpF,eAAe,CAAuB;IACtC,qDAAqD;IACrD,gBAAgB,CAA0B;IAC1C,+CAA+C;IAC/C,QAAQ,CAAU;IAClB,uJAAuJ;IACvJ,qBAAqB,CAAU;IAC/B,sGAAsG;IACtG,6BAA6B,CAAkC;IAC/D,qFAAqF;IACrF,cAAc,CAAU;IACxB,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,0FAA0F;IAC1F,kBAAkB,CAAU;IAC5B,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;IACxC,8DAA8D;IAC9D,WAAW,CAAW;IACtB,kHAAkH;IAClH,mBAAmB,CAAW;IAC9B,wFAAwF;IACxF,WAAW,CAAU;IACrB,sKAAsK;IACtK,sBAAsB,CAAU;IAChC,+GAA+G;IAC/G,aAAa,CAAsB;IACnC,uPAAuP;IACvP,kBAAkB,CAAU;IAC5B,kFAAkF;IAClF,eAAe,CAAgC;CAChD;AA7CD,wCA6CC"}
@@ -6,6 +6,4 @@ export declare class VoidRequest extends ShippedShipment {
6
6
  void_request_id: string;
7
7
  /** @description The location the shipment was shipped from */
8
8
  ship_from: ShipFrom;
9
- /** @description The shipment's user provided reference */
10
- reference?: string;
11
9
  }
@@ -8,8 +8,6 @@ class VoidRequest extends shipped_shipment_1.ShippedShipment {
8
8
  void_request_id;
9
9
  /** @description The location the shipment was shipped from */
10
10
  ship_from;
11
- /** @description The shipment's user provided reference */
12
- reference;
13
11
  }
14
12
  exports.VoidRequest = VoidRequest;
15
13
  //# sourceMappingURL=void-request.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;IAC9C,0GAA0G;IAC1G,eAAe,CAAU;IACzB,8DAA8D;IAC9D,SAAS,CAAY;IACrB,0DAA0D;IAC1D,SAAS,CAAU;CACpB;AAPD,kCAOC"}
1
+ {"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;IAC9C,0GAA0G;IAC1G,eAAe,CAAU;IACzB,8DAA8D;IAC9D,SAAS,CAAY;CACtB;AALD,kCAKC"}
@@ -3,6 +3,5 @@ import { ManifestCustoms } from './manifest-customs';
3
3
  export declare class ManifestRequestShipment extends ShippedShipment {
4
4
  manifest_request_shipment_id: string;
5
5
  ship_datetime?: string;
6
- reference?: string;
7
6
  customs?: ManifestCustoms;
8
7
  }
@@ -5,7 +5,6 @@ const shipped_shipment_1 = require("../pickup/shipped-shipment");
5
5
  class ManifestRequestShipment extends shipped_shipment_1.ShippedShipment {
6
6
  manifest_request_shipment_id;
7
7
  ship_datetime;
8
- reference;
9
8
  customs;
10
9
  }
11
10
  exports.ManifestRequestShipment = ManifestRequestShipment;
@@ -1 +1 @@
1
- {"version":3,"file":"manifest-request-shipment.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-request-shipment.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,MAAa,uBAAwB,SAAQ,kCAAe;IAC1D,4BAA4B,CAAU;IACtC,aAAa,CAAU;IACvB,SAAS,CAAU;IACnB,OAAO,CAAmB;CAC3B;AALD,0DAKC"}
1
+ {"version":3,"file":"manifest-request-shipment.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest-request-shipment.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,MAAa,uBAAwB,SAAQ,kCAAe;IAC1D,4BAA4B,CAAU;IACtC,aAAa,CAAU;IACvB,OAAO,CAAmB;CAC3B;AAJD,0DAIC"}
@@ -4,6 +4,7 @@ import { Currency } from './currency';
4
4
  import { LabelMessage } from './labels/label-message';
5
5
  import { Customs } from './customs';
6
6
  import { Products } from './products';
7
+ import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
7
8
  /** @description Basic structure for a package */
8
9
  export declare class Package {
9
10
  /** @description Package code defined for the carrier in ShipEngine. */
@@ -22,4 +23,6 @@ export declare class Package {
22
23
  customs?: Customs;
23
24
  /** @description List of products goods model associated with this package passed to the carrier. */
24
25
  products?: Products[];
26
+ /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
27
+ dangerous_goods_package_info?: DangerousGoodsPackageInfo;
25
28
  }
@@ -19,6 +19,8 @@ class Package {
19
19
  customs;
20
20
  /** @description List of products goods model associated with this package passed to the carrier. */
21
21
  products;
22
+ /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
23
+ dangerous_goods_package_info;
22
24
  }
23
25
  exports.Package = Package;
24
26
  //# sourceMappingURL=package.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,0KAA0K;IAC1K,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;CACvB;AAjBD,0BAiBC"}
1
+ {"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAQA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,0KAA0K;IAC1K,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;IACtB,sHAAsH;IACtH,4BAA4B,CAA6B;CAC1D;AAnBD,0BAmBC"}
@@ -0,0 +1,2 @@
1
+ import Joi from 'joi';
2
+ export declare const PickupSchema: Joi.ObjectSchema<any>;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PickupSchema = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const joi_1 = tslib_1.__importDefault(require("joi"));
6
+ exports.PickupSchema = joi_1.default.object({
7
+ confirmation_number: joi_1.default.string().required(),
8
+ status: joi_1.default.string().required(),
9
+ status_reason: joi_1.default.string().optional(),
10
+ });
11
+ //# sourceMappingURL=pickup-schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pickup-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC;IACrC,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC"}
@@ -0,0 +1,5 @@
1
+ export declare class Pickup {
2
+ confirmation_number: string;
3
+ status: string;
4
+ status_reason?: string;
5
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Pickup = void 0;
4
+ class Pickup {
5
+ confirmation_number;
6
+ status;
7
+ status_reason;
8
+ }
9
+ exports.Pickup = Pickup;
10
+ //# sourceMappingURL=pickup.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pickup.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup.ts"],"names":[],"mappings":";;;AAAA,MAAa,MAAM;IACjB,mBAAmB,CAAU;IAC7B,MAAM,CAAU;IAChB,aAAa,CAAU;CACxB;AAJD,wBAIC"}
@@ -20,6 +20,8 @@ export declare class ShippedShipment extends Label {
20
20
  pickup_location?: PudoLocation;
21
21
  /** @description Add drop-off location detail*/
22
22
  dropoff_location?: PudoLocation;
23
+ /** @description User specified free form string to identify shipment in their own system */
24
+ reference?: string;
23
25
  }
24
26
  export declare class PickupShipment extends ShippedShipment {
25
27
  }
@@ -18,6 +18,8 @@ class ShippedShipment extends label_1.Label {
18
18
  pickup_location;
19
19
  /** @description Add drop-off location detail*/
20
20
  dropoff_location;
21
+ /** @description User specified free form string to identify shipment in their own system */
22
+ reference;
21
23
  }
22
24
  exports.ShippedShipment = ShippedShipment;
23
25
  class PickupShipment extends ShippedShipment {
@@ -1 +1 @@
1
- {"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAO3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;IACxC,oEAAoE;IACpE,OAAO,CAAU;IACjB,8EAA8E;IAC9E,uBAAuB,CAAgB;IACvC,2DAA2D;IAC3D,YAAY,CAAU;IACtB,sEAAsE;IACtE,QAAQ,CAAoB;IAC5B,qFAAqF;IACrF,gBAAgB,CAAmB;IACnC,8CAA8C;IAC9C,eAAe,CAAgB;IAC/B,+CAA+C;IAC/C,gBAAgB,CAAgB;CACjC;AAfD,0CAeC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}
1
+ {"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAO3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;IACxC,oEAAoE;IACpE,OAAO,CAAU;IACjB,8EAA8E;IAC9E,uBAAuB,CAAgB;IACvC,2DAA2D;IAC3D,YAAY,CAAU;IACtB,sEAAsE;IACtE,QAAQ,CAAoB;IAC5B,qFAAqF;IACrF,gBAAgB,CAAmB;IACnC,8CAA8C;IAC9C,eAAe,CAAgB;IAC/B,+CAA+C;IAC/C,gBAAgB,CAAgB;IAChC,4FAA4F;IAC5F,SAAS,CAAU;CACpB;AAjBD,0CAiBC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}
@@ -14,3 +14,5 @@ export * from './tracking-info-schema';
14
14
  export * from './tracking-info';
15
15
  export * from './update-method-schema';
16
16
  export * from './update-method';
17
+ export * from './standardized-status-detail-codes';
18
+ export * from './standardized-status-detail-codes-schema';
@@ -17,4 +17,6 @@ tslib_1.__exportStar(require("./tracking-info-schema"), exports);
17
17
  tslib_1.__exportStar(require("./tracking-info"), exports);
18
18
  tslib_1.__exportStar(require("./update-method-schema"), exports);
19
19
  tslib_1.__exportStar(require("./update-method"), exports);
20
+ tslib_1.__exportStar(require("./standardized-status-detail-codes"), exports);
21
+ tslib_1.__exportStar(require("./standardized-status-detail-codes-schema"), exports);
20
22
  //# sourceMappingURL=index.js.map
@@ -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"}
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"}
@@ -1,5 +1,6 @@
1
1
  import { BaseRequest } from './base-request';
2
2
  import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs, BillTo } from '../models';
3
+ import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
3
4
  /** @description Basic structure for a request to create a label */
4
5
  export declare class CreateLabelRequest extends BaseRequest {
5
6
  service_code?: string;
@@ -38,4 +39,6 @@ export declare class CreateLabelRequest extends BaseRequest {
38
39
  customs?: Customs;
39
40
  /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
40
41
  bill_shipping_to?: BillTo;
42
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
43
+ dangerous_goods_declaration?: DangerousGoodsDeclaration;
41
44
  }
@@ -40,6 +40,8 @@ class CreateLabelRequest extends base_request_1.BaseRequest {
40
40
  customs;
41
41
  /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
42
42
  bill_shipping_to;
43
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
44
+ dangerous_goods_declaration;
43
45
  }
44
46
  exports.CreateLabelRequest = CreateLabelRequest;
45
47
  //# sourceMappingURL=create-label-request.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAsB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,YAAY,CAAkB;IAC9B,YAAY,CAAgB;IAC5B,qDAAqD;IACrD,aAAa,CAAW;IACxB,2FAA2F;IAC3F,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,oDAAoD;IACpD,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,YAAY,CAAqB;IACjC,iBAAiB,CAAmB;IACpC,mEAAmE;IACnE,QAAQ,CAAW;IACnB,yDAAyD;IACzD,aAAa,CAAW;IACxB,SAAS,CAAU;IACnB,cAAc,CAAsB;IACpC,wBAAwB,CAA0B;IAClD,WAAW,CAAc;IACzB,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0DAA0D;IAC1D,eAAe,CAAU;IACzB,oGAAoG;IACpG,eAAe,CAAmB;IAClC,OAAO,CAAW;IAClB,kJAAkJ;IAClJ,gBAAgB,CAAU;CAC3B;AArCD,gDAqCC"}
1
+ {"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAuB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,YAAY,CAAkB;IAC9B,YAAY,CAAgB;IAC5B,qDAAqD;IACrD,aAAa,CAAW;IACxB,2FAA2F;IAC3F,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,oDAAoD;IACpD,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,YAAY,CAAqB;IACjC,iBAAiB,CAAmB;IACpC,mEAAmE;IACnE,QAAQ,CAAW;IACnB,yDAAyD;IACzD,aAAa,CAAW;IACxB,SAAS,CAAU;IACnB,cAAc,CAAsB;IACpC,wBAAwB,CAA0B;IAClD,WAAW,CAAc;IACzB,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0DAA0D;IAC1D,eAAe,CAAU;IACzB,oGAAoG;IACpG,eAAe,CAAmB;IAClC,OAAO,CAAW;IAClB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AAvCD,gDAuCC"}
@@ -1,6 +1,7 @@
1
1
  import { BaseRequest } from './base-request';
2
2
  import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow, BillTo, DisplayScheme } from '../models';
3
3
  import { ShipmentItem } from '../models/shipment-item';
4
+ import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
4
5
  /** @description Basic structure for a request to get rates */
5
6
  export declare class GetRatesRequest extends BaseRequest {
6
7
  service_code?: string;
@@ -25,4 +26,6 @@ export declare class GetRatesRequest extends BaseRequest {
25
26
  bill_shipping_to?: BillTo;
26
27
  /** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
27
28
  display_schemes?: DisplayScheme[];
29
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
30
+ dangerous_goods_declaration?: DangerousGoodsDeclaration;
28
31
  }
@@ -26,6 +26,8 @@ class GetRatesRequest extends base_request_1.BaseRequest {
26
26
  bill_shipping_to;
27
27
  /** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
28
28
  display_schemes;
29
+ /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
30
+ dangerous_goods_declaration;
29
31
  }
30
32
  exports.GetRatesRequest = GetRatesRequest;
31
33
  //# sourceMappingURL=get-rates-request.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAiB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAW;IAClB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,eAAe,CAAgB;IAC/B,aAAa,CAAW;IACxB,QAAQ,CAAW;IACnB,wBAAwB,CAA0B;IAClD,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,qCAAqC;IACrC,KAAK,CAAkB;IACvB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,oGAAoG;IACpG,eAAe,CAAmB;CACnC;AAvBD,0CAuBC"}
1
+ {"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAkB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAW;IAClB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,eAAe,CAAgB;IAC/B,aAAa,CAAW;IACxB,QAAQ,CAAW;IACnB,wBAAwB,CAA0B;IAClD,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,qCAAqC;IACrC,KAAK,CAAkB;IACvB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,oGAAoG;IACpG,eAAe,CAAmB;IAClC,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AAzBD,0CAyBC"}
@@ -12,6 +12,7 @@ export * from './import-tracking-events-request';
12
12
  export * from './normalize-tracking-data-request';
13
13
  export * from './register-request';
14
14
  export * from './schedule-pickup-request';
15
+ export * from './list-pickups-request';
15
16
  export * from './tracking-request';
16
17
  export * from './validate-inbound-data-request';
17
18
  export * from './void-labels-request';
@@ -15,6 +15,7 @@ tslib_1.__exportStar(require("./import-tracking-events-request"), exports);
15
15
  tslib_1.__exportStar(require("./normalize-tracking-data-request"), exports);
16
16
  tslib_1.__exportStar(require("./register-request"), exports);
17
17
  tslib_1.__exportStar(require("./schedule-pickup-request"), exports);
18
+ tslib_1.__exportStar(require("./list-pickups-request"), exports);
18
19
  tslib_1.__exportStar(require("./tracking-request"), exports);
19
20
  tslib_1.__exportStar(require("./validate-inbound-data-request"), exports);
20
21
  tslib_1.__exportStar(require("./void-labels-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,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C"}
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"}
@@ -0,0 +1,9 @@
1
+ import { PickupAddress } from '../models/addresses/pickup-address';
2
+ import { TimeWindow } from '../models/time-window';
3
+ import { BaseRequest } from './base-request';
4
+ /** @description Basic structure for a request to list scheduled pickups */
5
+ export declare class ListPickupsRequest extends BaseRequest {
6
+ /** @description The address to search for scheduled pickups. */
7
+ address?: PickupAddress;
8
+ search_window?: TimeWindow;
9
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ListPickupsRequest = void 0;
4
+ const base_request_1 = require("./base-request");
5
+ /** @description Basic structure for a request to list scheduled pickups */
6
+ class ListPickupsRequest extends base_request_1.BaseRequest {
7
+ /** @description The address to search for scheduled pickups. */
8
+ address;
9
+ search_window;
10
+ }
11
+ exports.ListPickupsRequest = ListPickupsRequest;
12
+ //# sourceMappingURL=list-pickups-request.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list-pickups-request.js","sourceRoot":"","sources":["../../src/requests/list-pickups-request.ts"],"names":[],"mappings":";;;AAEA,iDAA6C;AAE7C,2EAA2E;AAC3E,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,gEAAgE;IAChE,OAAO,CAAiB;IACxB,aAAa,CAAc;CAC5B;AAJD,gDAIC"}
@@ -23,6 +23,8 @@ export * from './register-response-schema';
23
23
  export * from './register-response';
24
24
  export * from './schedule-pickup-response-schema';
25
25
  export * from './schedule-pickup-response';
26
+ export * from './list-pickups-response-schema';
27
+ export * from './list-pickups-response';
26
28
  export * from './tracking-response-schema';
27
29
  export * from './tracking-response';
28
30
  export * from './validate-inbound-data-response-schema';
@@ -26,6 +26,8 @@ tslib_1.__exportStar(require("./register-response-schema"), exports);
26
26
  tslib_1.__exportStar(require("./register-response"), exports);
27
27
  tslib_1.__exportStar(require("./schedule-pickup-response-schema"), exports);
28
28
  tslib_1.__exportStar(require("./schedule-pickup-response"), exports);
29
+ tslib_1.__exportStar(require("./list-pickups-response-schema"), exports);
30
+ tslib_1.__exportStar(require("./list-pickups-response"), exports);
29
31
  tslib_1.__exportStar(require("./tracking-response-schema"), exports);
30
32
  tslib_1.__exportStar(require("./tracking-response"), exports);
31
33
  tslib_1.__exportStar(require("./validate-inbound-data-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,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C"}
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"}
@@ -0,0 +1 @@
1
+ export declare const ListPickupsResponseSchema: import("joi").ObjectSchema<any>;
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ListPickupsResponseSchema = void 0;
4
+ const base_response_schema_1 = require("./base-response-schema");
5
+ const pickup_schema_1 = require("../models/pickup/pickup-schema");
6
+ exports.ListPickupsResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
7
+ pickups: pickup_schema_1.PickupSchema.required(),
8
+ });
9
+ //# sourceMappingURL=list-pickups-response-schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list-pickups-response-schema.js","sourceRoot":"","sources":["../../src/responses/list-pickups-response-schema.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAC5D,kEAA8D;AAEjD,QAAA,yBAAyB,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAC/D,OAAO,EAAE,4BAAY,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC"}
@@ -0,0 +1,6 @@
1
+ import { Pickup } from '../models/pickup/pickup';
2
+ import { BaseResponse } from './base-response';
3
+ /** @description Basic structure for a response to list scheduled pickups */
4
+ export declare class ListPickupsResponse extends BaseResponse {
5
+ pickups: Pickup[];
6
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ListPickupsResponse = void 0;
4
+ const base_response_1 = require("./base-response");
5
+ /** @description Basic structure for a response to list scheduled pickups */
6
+ class ListPickupsResponse extends base_response_1.BaseResponse {
7
+ pickups;
8
+ }
9
+ exports.ListPickupsResponse = ListPickupsResponse;
10
+ //# sourceMappingURL=list-pickups-response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list-pickups-response.js","sourceRoot":"","sources":["../../src/responses/list-pickups-response.ts"],"names":[],"mappings":";;;AACA,mDAA+C;AAE/C,4EAA4E;AAC5E,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,OAAO,CAAY;CACpB;AAFD,kDAEC"}