@shipengine/connect-carrier-api 2.1.19 → 2.1.23

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 (232) hide show
  1. package/lib/app/carrier-app-definition.d.ts +12 -2
  2. package/lib/app/carrier-app.js +79 -53
  3. package/lib/app/carrier-app.js.map +1 -1
  4. package/lib/app/constants.d.ts +14 -0
  5. package/lib/app/constants.js +19 -0
  6. package/lib/app/constants.js.map +1 -0
  7. package/lib/app/internal/{carrier-app-specificaion.d.ts → carrier-app-specification.d.ts} +4 -1
  8. package/lib/app/internal/{carrier-app-specificaion.js → carrier-app-specification.js} +1 -1
  9. package/lib/app/internal/carrier-app-specification.js.map +1 -0
  10. package/lib/app/internal/{carrier-specificaion.d.ts → carrier-specification.d.ts} +0 -0
  11. package/lib/app/internal/{carrier-specificaion.js → carrier-specification.js} +1 -1
  12. package/lib/app/internal/carrier-specification.js.map +1 -0
  13. package/lib/app/internal/metadata.d.ts +4 -2
  14. package/lib/app/internal/metadata.js +6 -2
  15. package/lib/app/internal/metadata.js.map +1 -1
  16. package/lib/app/internal/route.d.ts +1 -0
  17. package/lib/app/metadata/auth-identifier.d.ts +10 -0
  18. package/lib/app/metadata/auth-identifier.js +18 -0
  19. package/lib/app/metadata/auth-identifier.js.map +1 -0
  20. package/lib/app/metadata/auth-specification.d.ts +19 -0
  21. package/lib/app/metadata/auth-specification.js +20 -0
  22. package/lib/app/metadata/auth-specification.js.map +1 -0
  23. package/lib/app/metadata/carrier-app-metadata.d.ts +3 -1
  24. package/lib/app/metadata/carrier-app-metadata.js +3 -2
  25. package/lib/app/metadata/carrier-app-metadata.js.map +1 -1
  26. package/lib/app/metadata/index.d.ts +4 -1
  27. package/lib/app/metadata/index.js +4 -1
  28. package/lib/app/metadata/index.js.map +1 -1
  29. package/lib/app/metadata/monoauth.d.ts +102 -0
  30. package/lib/app/metadata/monoauth.js +82 -0
  31. package/lib/app/metadata/monoauth.js.map +1 -0
  32. package/lib/models/billing/billing-categories.d.ts +2 -0
  33. package/lib/models/billing/billing-categories.js +4 -1
  34. package/lib/models/billing/billing-categories.js.map +1 -1
  35. package/lib/models/billing/billing-line-item.d.ts +2 -0
  36. package/lib/models/billing/billing-line-item.js +12 -1
  37. package/lib/models/billing/billing-line-item.js.map +1 -1
  38. package/lib/models/currency.d.ts +2 -0
  39. package/lib/models/currency.js +7 -1
  40. package/lib/models/currency.js.map +1 -1
  41. package/lib/models/documents/document-type.d.ts +2 -0
  42. package/lib/models/documents/document-type.js +4 -1
  43. package/lib/models/documents/document-type.js.map +1 -1
  44. package/lib/models/documents/document.d.ts +2 -0
  45. package/lib/models/documents/document.js +10 -1
  46. package/lib/models/documents/document.js.map +1 -1
  47. package/lib/models/identifier.d.ts +2 -0
  48. package/lib/models/identifier.js +7 -1
  49. package/lib/models/identifier.js.map +1 -1
  50. package/lib/models/inbound-content-types.d.ts +7 -0
  51. package/lib/models/inbound-content-types.js +13 -0
  52. package/lib/models/inbound-content-types.js.map +1 -0
  53. package/lib/models/index.d.ts +1 -0
  54. package/lib/models/index.js +1 -0
  55. package/lib/models/index.js.map +1 -1
  56. package/lib/models/labels/document-formats.d.ts +2 -0
  57. package/lib/models/labels/document-formats.js +4 -1
  58. package/lib/models/labels/document-formats.js.map +1 -1
  59. package/lib/models/labels/form-download.d.ts +2 -0
  60. package/lib/models/labels/form-download.js +6 -1
  61. package/lib/models/labels/form-download.js.map +1 -1
  62. package/lib/models/labels/label-download.d.ts +2 -0
  63. package/lib/models/labels/label-download.js +6 -1
  64. package/lib/models/labels/label-download.js.map +1 -1
  65. package/lib/models/labels/label-package.d.ts +2 -0
  66. package/lib/models/labels/label-package.js +10 -1
  67. package/lib/models/labels/label-package.js.map +1 -1
  68. package/lib/models/labels/void-response.d.ts +5 -0
  69. package/lib/models/labels/void-response.js +10 -1
  70. package/lib/models/labels/void-response.js.map +1 -1
  71. package/lib/models/manifests/manifest.d.ts +2 -0
  72. package/lib/models/manifests/manifest.js +10 -1
  73. package/lib/models/manifests/manifest.js.map +1 -1
  74. package/lib/models/pickup/pickup-confirmation.d.ts +2 -0
  75. package/lib/models/pickup/pickup-confirmation.js +10 -1
  76. package/lib/models/pickup/pickup-confirmation.js.map +1 -1
  77. package/lib/models/pickup/pickup-window.d.ts +2 -0
  78. package/lib/models/pickup/pickup-window.js +9 -1
  79. package/lib/models/pickup/pickup-window.js.map +1 -1
  80. package/lib/models/pickup/shipment-identifier.d.ts +2 -0
  81. package/lib/models/pickup/shipment-identifier.js +8 -1
  82. package/lib/models/pickup/shipment-identifier.js.map +1 -1
  83. package/lib/models/rates/rate.d.ts +2 -0
  84. package/lib/models/rates/rate.js +18 -1
  85. package/lib/models/rates/rate.js.map +1 -1
  86. package/lib/models/registration/credentials.d.ts +2 -0
  87. package/lib/models/registration/credentials.js +7 -1
  88. package/lib/models/registration/credentials.js.map +1 -1
  89. package/lib/models/resource-download.d.ts +2 -0
  90. package/lib/models/resource-download.js +7 -1
  91. package/lib/models/resource-download.js.map +1 -1
  92. package/lib/models/time-window.d.ts +2 -0
  93. package/lib/models/time-window.js +8 -1
  94. package/lib/models/time-window.js.map +1 -1
  95. package/lib/models/tracking/index.d.ts +1 -0
  96. package/lib/models/tracking/index.js +1 -0
  97. package/lib/models/tracking/index.js.map +1 -1
  98. package/lib/models/tracking/lat-long.d.ts +2 -0
  99. package/lib/models/tracking/lat-long.js +7 -1
  100. package/lib/models/tracking/lat-long.js.map +1 -1
  101. package/lib/models/tracking/service.d.ts +2 -0
  102. package/lib/models/tracking/service.js +7 -1
  103. package/lib/models/tracking/service.js.map +1 -1
  104. package/lib/models/tracking/standardized-status-codes.d.ts +2 -0
  105. package/lib/models/tracking/standardized-status-codes.js +4 -1
  106. package/lib/models/tracking/standardized-status-codes.js.map +1 -1
  107. package/lib/models/tracking/track-event.d.ts +2 -0
  108. package/lib/models/tracking/track-event.js +18 -1
  109. package/lib/models/tracking/track-event.js.map +1 -1
  110. package/lib/models/tracking/tracking-info.d.ts +2 -0
  111. package/lib/models/tracking/tracking-info.js +27 -1
  112. package/lib/models/tracking/tracking-info.js.map +1 -1
  113. package/lib/models/tracking/update-method.d.ts +9 -0
  114. package/lib/models/tracking/update-method.js +15 -0
  115. package/lib/models/tracking/update-method.js.map +1 -0
  116. package/lib/models/units/dimensions.d.ts +2 -0
  117. package/lib/models/units/dimensions.js +8 -1
  118. package/lib/models/units/dimensions.js.map +1 -1
  119. package/lib/requests/index.d.ts +2 -0
  120. package/lib/requests/index.js +2 -0
  121. package/lib/requests/index.js.map +1 -1
  122. package/lib/requests/normalize-tracking-data-request.d.ts +8 -0
  123. package/lib/requests/normalize-tracking-data-request.js +3 -0
  124. package/lib/requests/normalize-tracking-data-request.js.map +1 -0
  125. package/lib/requests/validate-inbound-data-request.d.ts +8 -0
  126. package/lib/requests/validate-inbound-data-request.js +3 -0
  127. package/lib/requests/validate-inbound-data-request.js.map +1 -0
  128. package/lib/responses/base-response.d.ts +2 -0
  129. package/lib/responses/base-response.js +6 -1
  130. package/lib/responses/base-response.js.map +1 -1
  131. package/lib/responses/cancel-notification-response.d.ts +2 -0
  132. package/lib/responses/cancel-notification-response.js +7 -1
  133. package/lib/responses/cancel-notification-response.js.map +1 -1
  134. package/lib/responses/cancel-pickup-response.d.ts +2 -0
  135. package/lib/responses/cancel-pickup-response.js +9 -1
  136. package/lib/responses/cancel-pickup-response.js.map +1 -1
  137. package/lib/responses/create-label-response.d.ts +2 -0
  138. package/lib/responses/create-label-response.js +19 -1
  139. package/lib/responses/create-label-response.js.map +1 -1
  140. package/lib/responses/create-manifest-response.d.ts +2 -0
  141. package/lib/responses/create-manifest-response.js +8 -1
  142. package/lib/responses/create-manifest-response.js.map +1 -1
  143. package/lib/responses/create-notification-response.d.ts +2 -0
  144. package/lib/responses/create-notification-response.js +6 -1
  145. package/lib/responses/create-notification-response.js.map +1 -1
  146. package/lib/responses/get-rates-response.d.ts +2 -0
  147. package/lib/responses/get-rates-response.js +7 -1
  148. package/lib/responses/get-rates-response.js.map +1 -1
  149. package/lib/responses/index.d.ts +2 -0
  150. package/lib/responses/index.js +2 -0
  151. package/lib/responses/index.js.map +1 -1
  152. package/lib/responses/normalize-tracking-data-response.d.ts +14 -0
  153. package/lib/responses/normalize-tracking-data-response.js +16 -0
  154. package/lib/responses/normalize-tracking-data-response.js.map +1 -0
  155. package/lib/responses/register-response.d.ts +2 -0
  156. package/lib/responses/register-response.js +8 -1
  157. package/lib/responses/register-response.js.map +1 -1
  158. package/lib/responses/schedule-pickup-response.d.ts +2 -0
  159. package/lib/responses/schedule-pickup-response.js +11 -1
  160. package/lib/responses/schedule-pickup-response.js.map +1 -1
  161. package/lib/responses/tracking-response.d.ts +1 -0
  162. package/lib/responses/tracking-response.js +5 -1
  163. package/lib/responses/tracking-response.js.map +1 -1
  164. package/lib/responses/validate-inbound-data-response.d.ts +9 -0
  165. package/lib/responses/validate-inbound-data-response.js +15 -0
  166. package/lib/responses/validate-inbound-data-response.js.map +1 -0
  167. package/lib/responses/void-labels-response.d.ts +2 -0
  168. package/lib/responses/void-labels-response.js +7 -1
  169. package/lib/responses/void-labels-response.js.map +1 -1
  170. package/package.json +2 -2
  171. package/spec.json +31 -1
  172. package/src/app/carrier-app-definition.ts +18 -0
  173. package/src/app/carrier-app.ts +108 -56
  174. package/src/app/constants.ts +14 -0
  175. package/src/app/internal/{carrier-app-specificaion.ts → carrier-app-specification.ts} +4 -1
  176. package/src/app/internal/{carrier-specificaion.ts → carrier-specification.ts} +0 -0
  177. package/src/app/internal/metadata.ts +8 -2
  178. package/src/app/internal/route.ts +1 -0
  179. package/src/app/metadata/auth-identifier.ts +17 -0
  180. package/src/app/metadata/auth-specification.ts +39 -0
  181. package/src/app/metadata/carrier-app-metadata.ts +9 -1
  182. package/src/app/metadata/index.ts +4 -1
  183. package/src/app/metadata/monoauth.ts +171 -0
  184. package/src/models/billing/billing-categories.ts +6 -0
  185. package/src/models/billing/billing-line-item.ts +14 -2
  186. package/src/models/currency.ts +7 -0
  187. package/src/models/documents/document-type.ts +6 -0
  188. package/src/models/documents/document.ts +11 -2
  189. package/src/models/identifier.ts +7 -0
  190. package/src/models/inbound-content-types.ts +10 -0
  191. package/src/models/index.ts +1 -0
  192. package/src/models/labels/document-formats.ts +5 -0
  193. package/src/models/labels/form-download.ts +6 -1
  194. package/src/models/labels/label-download.ts +6 -1
  195. package/src/models/labels/label-package.ts +9 -2
  196. package/src/models/labels/void-response.ts +11 -0
  197. package/src/models/manifests/manifest.ts +9 -1
  198. package/src/models/pickup/pickup-confirmation.ts +11 -2
  199. package/src/models/pickup/pickup-window.ts +8 -0
  200. package/src/models/pickup/shipment-identifier.ts +7 -1
  201. package/src/models/rates/rate.ts +20 -2
  202. package/src/models/registration/credentials.ts +7 -0
  203. package/src/models/resource-download.ts +7 -0
  204. package/src/models/time-window.ts +8 -0
  205. package/src/models/tracking/index.ts +1 -0
  206. package/src/models/tracking/lat-long.ts +7 -0
  207. package/src/models/tracking/service.ts +6 -0
  208. package/src/models/tracking/standardized-status-codes.ts +6 -0
  209. package/src/models/tracking/track-event.ts +16 -0
  210. package/src/models/tracking/tracking-info.ts +29 -4
  211. package/src/models/tracking/update-method.ts +13 -0
  212. package/src/models/units/dimensions.ts +7 -0
  213. package/src/requests/index.ts +2 -0
  214. package/src/requests/normalize-tracking-data-request.ts +9 -0
  215. package/src/requests/validate-inbound-data-request.ts +9 -0
  216. package/src/responses/base-response.ts +6 -0
  217. package/src/responses/cancel-notification-response.ts +7 -1
  218. package/src/responses/cancel-pickup-response.ts +9 -1
  219. package/src/responses/create-label-response.ts +25 -1
  220. package/src/responses/create-manifest-response.ts +8 -2
  221. package/src/responses/create-notification-response.ts +6 -1
  222. package/src/responses/get-rates-response.ts +7 -2
  223. package/src/responses/index.ts +2 -0
  224. package/src/responses/normalize-tracking-data-response.ts +24 -0
  225. package/src/responses/register-response.ts +6 -1
  226. package/src/responses/schedule-pickup-response.ts +18 -2
  227. package/src/responses/tracking-response.ts +6 -2
  228. package/src/responses/validate-inbound-data-response.ts +16 -0
  229. package/src/responses/void-labels-response.ts +7 -2
  230. package/tsconfig.tsbuildinfo +1 -1
  231. package/lib/app/internal/carrier-app-specificaion.js.map +0 -1
  232. package/lib/app/internal/carrier-specificaion.js.map +0 -1
@@ -1,9 +1,17 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CancelPickupResponse = void 0;
3
+ exports.CancelPickupResponseSchema = exports.CancelPickupResponse = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const joi_1 = tslib_1.__importDefault(require("joi"));
4
6
  const base_response_1 = require("./base-response");
5
7
  /** @description Basic structure for a response to cancel pickup */
6
8
  class CancelPickupResponse extends base_response_1.BaseResponse {
7
9
  }
8
10
  exports.CancelPickupResponse = CancelPickupResponse;
11
+ exports.CancelPickupResponseSchema = base_response_1.BaseResponseSchema.keys({
12
+ confirmationa_id: joi_1.default.string().optional(),
13
+ successful: joi_1.default.boolean().required(),
14
+ status: joi_1.default.string().optional().empty(),
15
+ custom_properties: joi_1.default.object().pattern(/.*/, [joi_1.default.string()]).optional(),
16
+ });
9
17
  //# sourceMappingURL=cancel-pickup-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"cancel-pickup-response.js","sourceRoot":"","sources":["../../src/responses/cancel-pickup-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAE/C,mEAAmE;AACnE,MAAa,oBAAqB,SAAQ,4BAAY;CAKrD;AALD,oDAKC"}
1
+ {"version":3,"file":"cancel-pickup-response.js","sourceRoot":"","sources":["../../src/responses/cancel-pickup-response.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mDAAmE;AAEnE,mEAAmE;AACnE,MAAa,oBAAqB,SAAQ,4BAAY;CAKrD;AALD,oDAKC;AAEY,QAAA,0BAA0B,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAChE,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,UAAU,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACzE,CAAC,CAAC"}
@@ -1,5 +1,6 @@
1
1
  import { BaseResponse } from './base-response';
2
2
  import { LabelDownload, FormDownload, Document, BillingLineItem, LabelPackage, Identifier, TimeWindow } from '../models';
3
+ import Joi from 'joi';
3
4
  /** @description Basic structure for a response to create a label */
4
5
  export declare class CreateLabelResponse extends BaseResponse {
5
6
  transaction_id: string;
@@ -18,3 +19,4 @@ export declare class CreateLabelResponse extends BaseResponse {
18
19
  /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
19
20
  delivery_window?: TimeWindow;
20
21
  }
22
+ export declare const CreateLabelResponseSchema: Joi.ObjectSchema<any>;
@@ -1,9 +1,27 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateLabelResponse = void 0;
3
+ exports.CreateLabelResponseSchema = exports.CreateLabelResponse = void 0;
4
+ const tslib_1 = require("tslib");
4
5
  const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
5
8
  /** @description Basic structure for a response to create a label */
6
9
  class CreateLabelResponse extends base_response_1.BaseResponse {
7
10
  }
8
11
  exports.CreateLabelResponse = CreateLabelResponse;
12
+ exports.CreateLabelResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ transaction_id: joi_1.default.string().required(),
14
+ label_download: models_1.LabelDownloadSchema.optional(),
15
+ form_download: models_1.FormDownloadSchema.optional(),
16
+ documents: joi_1.default.array().optional().items(models_1.DocumentSchema),
17
+ packages: joi_1.default.array().optional().items(models_1.LabelPackageSchema),
18
+ billing_line_items: joi_1.default.array().optional().items(models_1.BillingLineItemSchema),
19
+ tracking_number: joi_1.default.string().optional().empty(),
20
+ trackable: joi_1.default.boolean().optional(),
21
+ alternative_identifiers: joi_1.default.array().optional().items(models_1.IdentifierSchema),
22
+ estimated_delivery_datetime: joi_1.default.string().optional().empty().isoDate(),
23
+ consolidator_service_code: joi_1.default.string().optional().empty(),
24
+ carrier_pickup_window: models_1.TimeWindowSchema.optional(),
25
+ delivery_window: models_1.TimeWindowSchema.optional(),
26
+ });
9
27
  //# sourceMappingURL=create-label-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAW/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;CAgBpD;AAhBD,kDAgBC"}
1
+ {"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAemB;AACnB,sDAAsB;AAEtB,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;CAgBpD;AAhBD,kDAgBC;AAEY,QAAA,yBAAyB,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAC/D,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,4BAAmB,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,2BAAkB,CAAC,QAAQ,EAAE;IAC5C,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAc,CAAC;IACvD,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAC1D,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAqB,CAAC;IACvE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,SAAS,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yBAAgB,CAAC;IACvE,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1D,qBAAqB,EAAE,yBAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,yBAAgB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC"}
@@ -1,7 +1,9 @@
1
1
  import { BaseResponse } from './base-response';
2
2
  import { Manifest } from '../models';
3
+ import Joi from 'joi';
3
4
  /** @description Basic structure for a response to create a manifest */
4
5
  export declare class CreateManifestResponse extends BaseResponse {
5
6
  transaction_id: string;
6
7
  manifests?: Manifest[];
7
8
  }
9
+ export declare const CreateManifestResponseSchema: Joi.ObjectSchema<any>;
@@ -1,9 +1,16 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateManifestResponse = void 0;
3
+ exports.CreateManifestResponseSchema = exports.CreateManifestResponse = void 0;
4
+ const tslib_1 = require("tslib");
4
5
  const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
5
8
  /** @description Basic structure for a response to create a manifest */
6
9
  class CreateManifestResponse extends base_response_1.BaseResponse {
7
10
  }
8
11
  exports.CreateManifestResponse = CreateManifestResponse;
12
+ exports.CreateManifestResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ transaction_id: joi_1.default.string().required(),
14
+ manifests: joi_1.default.array().optional().items(models_1.ManifestSchema),
15
+ });
9
16
  //# sourceMappingURL=create-manifest-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAGvD;AAHD,wDAGC"}
1
+ {"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAqD;AACrD,sDAAsB;AAEtB,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAGvD;AAHD,wDAGC;AAEY,QAAA,4BAA4B,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAClE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAc,CAAC;CACxD,CAAC,CAAC"}
@@ -1,5 +1,7 @@
1
+ import Joi from 'joi';
1
2
  import { BaseResponse } from './base-response';
2
3
  export declare class CreateNotificationResponse extends BaseResponse {
3
4
  /** @description The id of the sucessfully created notification*/
4
5
  notification_id: string;
5
6
  }
7
+ export declare const CreateNotificationResponseSchema: Joi.ObjectSchema<any>;
@@ -1,8 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateNotificationResponse = void 0;
3
+ exports.CreateNotificationResponseSchema = exports.CreateNotificationResponse = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const joi_1 = tslib_1.__importDefault(require("joi"));
4
6
  const base_response_1 = require("./base-response");
5
7
  class CreateNotificationResponse extends base_response_1.BaseResponse {
6
8
  }
7
9
  exports.CreateNotificationResponse = CreateNotificationResponse;
10
+ exports.CreateNotificationResponseSchema = base_response_1.BaseResponseSchema.keys({
11
+ notification_id: joi_1.default.string().required(),
12
+ });
8
13
  //# sourceMappingURL=create-notification-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-notification-response.js","sourceRoot":"","sources":["../../src/responses/create-notification-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAE/C,MAAa,0BAA2B,SAAQ,4BAAY;CAG3D;AAHD,gEAGC"}
1
+ {"version":3,"file":"create-notification-response.js","sourceRoot":"","sources":["../../src/responses/create-notification-response.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mDAAmE;AAEnE,MAAa,0BAA2B,SAAQ,4BAAY;CAG3D;AAHD,gEAGC;AAEY,QAAA,gCAAgC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACtE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC"}
@@ -1,6 +1,8 @@
1
1
  import { BaseResponse } from './base-response';
2
2
  import { Rate } from '../models';
3
+ import Joi from 'joi';
3
4
  /** @description Basic structure for a response to get rates */
4
5
  export declare class GetRatesResponse extends BaseResponse {
5
6
  rates: Rate[];
6
7
  }
8
+ export declare const GetRatesResponseSchema: Joi.ObjectSchema<any>;
@@ -1,9 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.GetRatesResponse = void 0;
3
+ exports.GetRatesResponseSchema = exports.GetRatesResponse = void 0;
4
+ const tslib_1 = require("tslib");
4
5
  const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
5
8
  /** @description Basic structure for a response to get rates */
6
9
  class GetRatesResponse extends base_response_1.BaseResponse {
7
10
  }
8
11
  exports.GetRatesResponse = GetRatesResponse;
12
+ exports.GetRatesResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ rates: joi_1.default.array().required().items(models_1.RateSchema),
14
+ });
9
15
  //# sourceMappingURL=get-rates-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"get-rates-response.js","sourceRoot":"","sources":["../../src/responses/get-rates-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,+DAA+D;AAC/D,MAAa,gBAAiB,SAAQ,4BAAY;CAEjD;AAFD,4CAEC"}
1
+ {"version":3,"file":"get-rates-response.js","sourceRoot":"","sources":["../../src/responses/get-rates-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAA6C;AAC7C,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,gBAAiB,SAAQ,4BAAY;CAEjD;AAFD,4CAEC;AAEY,QAAA,sBAAsB,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAC5D,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,mBAAU,CAAC;CAChD,CAAC,CAAC"}
@@ -9,3 +9,5 @@ export * from './void-labels-response';
9
9
  export * from './error-response';
10
10
  export * from './cancel-notification-response';
11
11
  export * from './create-notification-response';
12
+ export * from './validate-inbound-data-response';
13
+ export * from './normalize-tracking-data-response';
@@ -12,4 +12,6 @@ tslib_1.__exportStar(require("./void-labels-response"), exports);
12
12
  tslib_1.__exportStar(require("./error-response"), exports);
13
13
  tslib_1.__exportStar(require("./cancel-notification-response"), exports);
14
14
  tslib_1.__exportStar(require("./create-notification-response"), exports);
15
+ tslib_1.__exportStar(require("./validate-inbound-data-response"), exports);
16
+ tslib_1.__exportStar(require("./normalize-tracking-data-response"), exports);
15
17
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,kEAAwC;AACxC,qEAA2C;AAC3C,+DAAqC;AACrC,8DAAoC;AACpC,qEAA2C;AAC3C,8DAAoC;AACpC,iEAAuC;AACvC,2DAAiC;AACjC,yEAA+C;AAC/C,yEAA+C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,kEAAwC;AACxC,qEAA2C;AAC3C,+DAAqC;AACrC,8DAAoC;AACpC,qEAA2C;AAC3C,8DAAoC;AACpC,iEAAuC;AACvC,2DAAiC;AACjC,yEAA+C;AAC/C,yEAA+C;AAC/C,2EAAiD;AACjD,6EAAmD"}
@@ -0,0 +1,14 @@
1
+ import { BaseResponse } from './base-response';
2
+ import { UpdateMethods, TrackingInfo } from '../models';
3
+ import Joi from 'joi';
4
+ /** @description Basic structure for a response to normalize inbound tracking data */
5
+ export declare class NormalizeTrackingDataResponse extends BaseResponse {
6
+ /** @description Collection of normalized tracking updates with one entry per package */
7
+ tracking_info: TrackingInfo[];
8
+ /**
9
+ * @description Method for updating the tracking information state, i.e. is the returned information
10
+ * the complete state of the package or should it be appended to the existing state
11
+ */
12
+ update_method: UpdateMethods;
13
+ }
14
+ export declare const NormalizeTrackingDataResponseSchema: Joi.ObjectSchema<any>;
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NormalizeTrackingDataResponseSchema = exports.NormalizeTrackingDataResponse = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
8
+ /** @description Basic structure for a response to normalize inbound tracking data */
9
+ class NormalizeTrackingDataResponse extends base_response_1.BaseResponse {
10
+ }
11
+ exports.NormalizeTrackingDataResponse = NormalizeTrackingDataResponse;
12
+ exports.NormalizeTrackingDataResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ tracking_info: joi_1.default.array().required().items(models_1.TrackingInfoSchema),
14
+ update_method: models_1.UpdateMethodsSchema,
15
+ });
16
+ //# sourceMappingURL=normalize-tracking-data-response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"normalize-tracking-data-response.js","sourceRoot":"","sources":["../../src/responses/normalize-tracking-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAKmB;AACnB,sDAAsB;AAEtB,qFAAqF;AACrF,MAAa,6BAA8B,SAAQ,4BAAY;CAQ9D;AARD,sEAQC;AAEY,QAAA,mCAAmC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACzE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAC/D,aAAa,EAAE,4BAAmB;CACnC,CAAC,CAAC"}
@@ -1,6 +1,8 @@
1
+ import Joi from 'joi';
1
2
  import { Credentials } from '../models';
2
3
  /** @description Basic structure for a response to register/connect */
3
4
  export declare class RegisterResponse {
4
5
  credentials: Credentials;
5
6
  metadata: object;
6
7
  }
8
+ export declare const RegisterResponseSchema: Joi.ObjectSchema<any>;
@@ -1,8 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RegisterResponse = void 0;
3
+ exports.RegisterResponseSchema = exports.RegisterResponse = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const joi_1 = tslib_1.__importDefault(require("joi"));
6
+ const models_1 = require("../models");
4
7
  /** @description Basic structure for a response to register/connect */
5
8
  class RegisterResponse {
6
9
  }
7
10
  exports.RegisterResponse = RegisterResponse;
11
+ exports.RegisterResponseSchema = joi_1.default.object({
12
+ credentials: models_1.CredentialsSchema.required(),
13
+ metadata: joi_1.default.object().pattern(/.*/, [joi_1.default.any()]).required(),
14
+ });
8
15
  //# sourceMappingURL=register-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"register-response.js","sourceRoot":"","sources":["../../src/responses/register-response.ts"],"names":[],"mappings":";;;AAEA,sEAAsE;AACtE,MAAa,gBAAgB;CAG5B;AAHD,4CAGC"}
1
+ {"version":3,"file":"register-response.js","sourceRoot":"","sources":["../../src/responses/register-response.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,sCAA2D;AAE3D,sEAAsE;AACtE,MAAa,gBAAgB;CAG5B;AAHD,4CAGC;AACY,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,WAAW,EAAE,0BAAiB,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,aAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC7D,CAAC,CAAC"}
@@ -1,5 +1,6 @@
1
1
  import { BaseResponse } from './base-response';
2
2
  import { PickupConfirmation, PickupWindow, BillingLineItem } from '../models';
3
+ import Joi from 'joi';
3
4
  /** @description Basic structure for a response to schedule a pickup */
4
5
  export declare class SchedulePickupResponse extends BaseResponse {
5
6
  confirmation?: PickupConfirmation;
@@ -10,3 +11,4 @@ export declare class SchedulePickupResponse extends BaseResponse {
10
11
  };
11
12
  billing_line_items?: BillingLineItem[];
12
13
  }
14
+ export declare const SchedulePickupResponseSchema: Joi.ObjectSchema<any>;
@@ -1,9 +1,19 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SchedulePickupResponse = void 0;
3
+ exports.SchedulePickupResponseSchema = exports.SchedulePickupResponse = void 0;
4
+ const tslib_1 = require("tslib");
4
5
  const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
5
8
  /** @description Basic structure for a response to schedule a pickup */
6
9
  class SchedulePickupResponse extends base_response_1.BaseResponse {
7
10
  }
8
11
  exports.SchedulePickupResponse = SchedulePickupResponse;
12
+ exports.SchedulePickupResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ confirmation: models_1.PickupConfirmationSchema.optional(),
14
+ pickup_windows: joi_1.default.array().optional().items(models_1.PickupWindowSchema),
15
+ remarks: joi_1.default.string().optional().empty(),
16
+ custom_properties: joi_1.default.object().pattern(/.*/, [joi_1.default.string()]).optional(),
17
+ billing_line_items: joi_1.default.array().optional().items(models_1.BillingLineItemSchema),
18
+ });
9
19
  //# sourceMappingURL=schedule-pickup-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schedule-pickup-response.js","sourceRoot":"","sources":["../../src/responses/schedule-pickup-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAMvD;AAND,wDAMC"}
1
+ {"version":3,"file":"schedule-pickup-response.js","sourceRoot":"","sources":["../../src/responses/schedule-pickup-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAOmB;AACnB,sDAAsB;AAEtB,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAMvD;AAND,wDAMC;AAEY,QAAA,4BAA4B,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAClE,YAAY,EAAE,iCAAwB,CAAC,QAAQ,EAAE;IACjD,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAChE,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxE,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAqB,CAAC;CACxE,CAAC,CAAC"}
@@ -4,3 +4,4 @@ import { TrackingInfo } from '../models';
4
4
  export declare class TrackingResponse extends BaseResponse {
5
5
  tracking_info: TrackingInfo;
6
6
  }
7
+ export declare const TrackingResponseSchema: import("joi").ObjectSchema<any>;
@@ -1,9 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TrackingResponse = void 0;
3
+ exports.TrackingResponseSchema = exports.TrackingResponse = void 0;
4
4
  const base_response_1 = require("./base-response");
5
+ const models_1 = require("../models");
5
6
  /** @description Basic structure for a response to get tracking information */
6
7
  class TrackingResponse extends base_response_1.BaseResponse {
7
8
  }
8
9
  exports.TrackingResponse = TrackingResponse;
10
+ exports.TrackingResponseSchema = base_response_1.BaseResponseSchema.keys({
11
+ tracking_info: models_1.TrackingInfoSchema.required(),
12
+ });
9
13
  //# sourceMappingURL=tracking-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"tracking-response.js","sourceRoot":"","sources":["../../src/responses/tracking-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,8EAA8E;AAC9E,MAAa,gBAAiB,SAAQ,4BAAY;CAEjD;AAFD,4CAEC"}
1
+ {"version":3,"file":"tracking-response.js","sourceRoot":"","sources":["../../src/responses/tracking-response.ts"],"names":[],"mappings":";;;AAAA,mDAAmE;AACnE,sCAA6D;AAE7D,8EAA8E;AAC9E,MAAa,gBAAiB,SAAQ,4BAAY;CAEjD;AAFD,4CAEC;AAEY,QAAA,sBAAsB,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAC5D,aAAa,EAAE,2BAAkB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC"}
@@ -0,0 +1,9 @@
1
+ import { BaseResponse } from './base-response';
2
+ import { InboundDataContentTypes } from '../models';
3
+ import Joi from 'joi';
4
+ /** @description Basic structure for a response to validate inbound data */
5
+ export declare class ValidateInboundDataResponse extends BaseResponse {
6
+ /** @description List of content types included in the data */
7
+ content_types: InboundDataContentTypes[];
8
+ }
9
+ export declare const ValidateInboundDataResponseSchema: Joi.ObjectSchema<any>;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ValidateInboundDataResponseSchema = exports.ValidateInboundDataResponse = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
8
+ /** @description Basic structure for a response to validate inbound data */
9
+ class ValidateInboundDataResponse extends base_response_1.BaseResponse {
10
+ }
11
+ exports.ValidateInboundDataResponse = ValidateInboundDataResponse;
12
+ exports.ValidateInboundDataResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ content_types: joi_1.default.array().required().items(models_1.InboundDataContentTypesSchema),
14
+ });
15
+ //# sourceMappingURL=validate-inbound-data-response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validate-inbound-data-response.js","sourceRoot":"","sources":["../../src/responses/validate-inbound-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAGmB;AACnB,sDAAsB;AAEtB,2EAA2E;AAC3E,MAAa,2BAA4B,SAAQ,4BAAY;CAG5D;AAHD,kEAGC;AAEY,QAAA,iCAAiC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACvE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAA6B,CAAC;CAC3E,CAAC,CAAC"}
@@ -1,7 +1,9 @@
1
1
  import { BaseResponse } from './base-response';
2
2
  import { VoidResponse } from '../models';
3
+ import Joi from 'joi';
3
4
  /** @description Basic structure for a response to void labels */
4
5
  export declare class VoidLabelsResponse extends BaseResponse {
5
6
  /** @description List of void responses*/
6
7
  void_responses: VoidResponse[];
7
8
  }
9
+ export declare const VoidLabelsResponseSchema: Joi.ObjectSchema<any>;
@@ -1,9 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VoidLabelsResponse = void 0;
3
+ exports.VoidLabelsResponseSchema = exports.VoidLabelsResponse = void 0;
4
+ const tslib_1 = require("tslib");
4
5
  const base_response_1 = require("./base-response");
6
+ const models_1 = require("../models");
7
+ const joi_1 = tslib_1.__importDefault(require("joi"));
5
8
  /** @description Basic structure for a response to void labels */
6
9
  class VoidLabelsResponse extends base_response_1.BaseResponse {
7
10
  }
8
11
  exports.VoidLabelsResponse = VoidLabelsResponse;
12
+ exports.VoidLabelsResponseSchema = base_response_1.BaseResponseSchema.keys({
13
+ void_responses: joi_1.default.array().required().items(models_1.VoidResponseSchema),
14
+ });
9
15
  //# sourceMappingURL=void-labels-response.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"void-labels-response.js","sourceRoot":"","sources":["../../src/responses/void-labels-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAG/C,iEAAiE;AACjE,MAAa,kBAAmB,SAAQ,4BAAY;CAGnD;AAHD,gDAGC"}
1
+ {"version":3,"file":"void-labels-response.js","sourceRoot":"","sources":["../../src/responses/void-labels-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAA6D;AAC7D,sDAAsB;AAEtB,iEAAiE;AACjE,MAAa,kBAAmB,SAAQ,4BAAY;CAGnD;AAHD,gDAGC;AAEY,QAAA,wBAAwB,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAC9D,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;CACjE,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "2.1.19",
3
+ "version": "2.1.23",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://github.com/ShipEngine/connect",
6
6
  "main": "./lib/index.js",
@@ -31,7 +31,7 @@
31
31
  },
32
32
  "license": "Apache-2.0",
33
33
  "devDependencies": {
34
- "prettier": "2.4.0",
34
+ "prettier": "^2.4.0",
35
35
  "typescript": "^4.3.5"
36
36
  },
37
37
  "dependencies": {
package/spec.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "ShipEngine Connect Carrier API",
5
5
  "description": "This API specification describes the canonical ShipEngine Carrier API connector module. A module which implements one or more endpoints from this specification can be integrated with the ShipEngine Carrier Platform.",
6
- "version": "1.14.10"
6
+ "version": "1.14.13"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -1178,6 +1178,25 @@
1178
1178
  "additionalProperties": { },
1179
1179
  "description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented\r\nkeys are some common options shared by many carriers, but are not definitive. Advanced options you support will\r\nbe defined in ShipEngine. If the field is absent it should be interpreted as the default value for any\r\napplicable options, e.g. false for booleans."
1180
1180
  },
1181
+ "Authorization": {
1182
+ "type": "object",
1183
+ "properties": {
1184
+ "access_token": {
1185
+ "type": "string",
1186
+ "description": "The access token used to authorize the request",
1187
+ "nullable": true
1188
+ },
1189
+ "connection_context": {
1190
+ "type": "object",
1191
+ "additionalProperties": {
1192
+ "type": "string"
1193
+ },
1194
+ "description": "Optional - any additional information required to authorize the request",
1195
+ "nullable": true
1196
+ }
1197
+ },
1198
+ "additionalProperties": false
1199
+ },
1181
1200
  "BadRequestResponse": {
1182
1201
  "type": "object",
1183
1202
  "allOf": [
@@ -1196,6 +1215,9 @@
1196
1215
  "description": "The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.",
1197
1216
  "format": "uuid"
1198
1217
  },
1218
+ "authorization": {
1219
+ "$ref": "#/components/schemas/Authorization"
1220
+ },
1199
1221
  "metadata": {
1200
1222
  "type": "object",
1201
1223
  "additionalProperties": { },
@@ -3449,6 +3471,14 @@
3449
3471
  },
3450
3472
  "description": "A list of errors preventing this label from being voided. If no errors are returned the void is considered\r\nsuccessful. If any errors are returned the void is considered failed.",
3451
3473
  "nullable": true
3474
+ },
3475
+ "billing_line_items": {
3476
+ "type": "array",
3477
+ "items": {
3478
+ "$ref": "#/components/schemas/BillingLineItem"
3479
+ },
3480
+ "description": "Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee.",
3481
+ "nullable": true
3452
3482
  }
3453
3483
  },
3454
3484
  "additionalProperties": false,
@@ -9,6 +9,8 @@ import {
9
9
  TrackingRequest,
10
10
  CancelNotificationRequest,
11
11
  CreateNotificationRequest,
12
+ ValidateInboundDataRequest,
13
+ NormalizeTrackingDataRequest,
12
14
  } from '../requests';
13
15
 
14
16
  import {
@@ -22,6 +24,8 @@ import {
22
24
  TrackingResponse,
23
25
  CancelNotificationResponse,
24
26
  CreateNotificationResponse,
27
+ ValidateInboundDataResponse,
28
+ NormalizeTrackingDataResponse,
25
29
  } from '../responses';
26
30
 
27
31
  import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
@@ -101,4 +105,18 @@ export interface CarrierAppDefinition {
101
105
  CancelNotification?: (
102
106
  request: CancelNotificationRequest,
103
107
  ) => CancelNotificationResponse | Promise<CancelNotificationResponse>;
108
+ /**
109
+ * @description This endpoint is used to validate inbound data and determine the type of data included in the inbound message
110
+ * @param request Data received from the provider via an inbound method, such as a webhook
111
+ */
112
+ ValidateInboundData?: (
113
+ request: ValidateInboundDataRequest,
114
+ ) => ValidateInboundDataResponse | Promise<ValidateInboundDataRequest>;
115
+ /**
116
+ * @description This endpoint is used to normalize inbound tracking data and determine the type of data
117
+ * @param request Tracking data received from the provider via an inbound method, such as a webhook
118
+ */
119
+ NormalizeTrackingData?: (
120
+ request: NormalizeTrackingDataRequest,
121
+ ) => NormalizeTrackingDataResponse | Promise<NormalizeTrackingDataResponse>;
104
122
  }