@shipengine/connect-carrier-api 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (221) hide show
  1. package/README.md +10 -18
  2. package/lib/app/build-app-deployment.js +3 -3
  3. package/lib/app/build-app-deployment.js.map +1 -1
  4. package/lib/app/carrier-app-definition.d.ts +1 -0
  5. package/lib/app/metadata/auth-identifier.js +3 -0
  6. package/lib/app/metadata/auth-identifier.js.map +1 -1
  7. package/lib/app/metadata/auth-specification.js +12 -0
  8. package/lib/app/metadata/auth-specification.js.map +1 -1
  9. package/lib/app/metadata/monoauth.js +68 -0
  10. package/lib/app/metadata/monoauth.js.map +1 -1
  11. package/lib/app/native-rating-data-validator.js +3 -4
  12. package/lib/app/native-rating-data-validator.js.map +1 -1
  13. package/lib/carrier-app.d.ts +7 -0
  14. package/lib/carrier-app.js +15 -0
  15. package/lib/carrier-app.js.map +1 -0
  16. package/lib/index.d.ts +1 -0
  17. package/lib/index.js +1 -0
  18. package/lib/index.js.map +1 -1
  19. package/lib/models/addresses/address-base.js +30 -0
  20. package/lib/models/addresses/address-base.js.map +1 -1
  21. package/lib/models/addresses/pudo-location.js +4 -0
  22. package/lib/models/addresses/pudo-location.js.map +1 -1
  23. package/lib/models/addresses/service-point-address.js +2 -0
  24. package/lib/models/addresses/service-point-address.js.map +1 -1
  25. package/lib/models/addresses/ship-from.js +2 -0
  26. package/lib/models/addresses/ship-from.js.map +1 -1
  27. package/lib/models/addresses/ship-to.js +2 -0
  28. package/lib/models/addresses/ship-to.js.map +1 -1
  29. package/lib/models/advanced-options.js +16 -0
  30. package/lib/models/advanced-options.js.map +1 -1
  31. package/lib/models/authorization.js +4 -0
  32. package/lib/models/authorization.js.map +1 -1
  33. package/lib/models/bill-to.js +4 -0
  34. package/lib/models/bill-to.js.map +1 -1
  35. package/lib/models/billing/billing-line-item.js +12 -0
  36. package/lib/models/billing/billing-line-item.js.map +1 -1
  37. package/lib/models/collect-on-delivery.js +4 -0
  38. package/lib/models/collect-on-delivery.js.map +1 -1
  39. package/lib/models/currency.js +4 -0
  40. package/lib/models/currency.js.map +1 -1
  41. package/lib/models/customs/customs-charges.js +10 -0
  42. package/lib/models/customs/customs-charges.js.map +1 -1
  43. package/lib/models/customs/customs-item.js +22 -0
  44. package/lib/models/customs/customs-item.js.map +1 -1
  45. package/lib/models/customs/customs.js +20 -0
  46. package/lib/models/customs/customs.js.map +1 -1
  47. package/lib/models/documents/document.js +6 -0
  48. package/lib/models/documents/document.js.map +1 -1
  49. package/lib/models/errors/detailed-error.js +5 -0
  50. package/lib/models/errors/detailed-error.js.map +1 -1
  51. package/lib/models/fulfillment-plans/fulfillment-plan-details.js +6 -0
  52. package/lib/models/fulfillment-plans/fulfillment-plan-details.js.map +1 -1
  53. package/lib/models/fulfillment-plans/fulfillment-plan-items.js +8 -0
  54. package/lib/models/fulfillment-plans/fulfillment-plan-items.js.map +1 -1
  55. package/lib/models/fulfillment-plans/raw-external-source.js +2 -0
  56. package/lib/models/fulfillment-plans/raw-external-source.js.map +1 -1
  57. package/lib/models/identifier.js +2 -0
  58. package/lib/models/identifier.js.map +1 -1
  59. package/lib/models/importer-records/importer-of-record.js +22 -0
  60. package/lib/models/importer-records/importer-of-record.js.map +1 -1
  61. package/lib/models/labels/form-download.js +2 -0
  62. package/lib/models/labels/form-download.js.map +1 -1
  63. package/lib/models/labels/label-download.js +2 -0
  64. package/lib/models/labels/label-download.js.map +1 -1
  65. package/lib/models/labels/label-message.js +3 -0
  66. package/lib/models/labels/label-message.js.map +1 -1
  67. package/lib/models/labels/label-package.js +6 -0
  68. package/lib/models/labels/label-package.js.map +1 -1
  69. package/lib/models/labels/return-label-details.js +2 -0
  70. package/lib/models/labels/return-label-details.js.map +1 -1
  71. package/lib/models/labels/void-request.js +4 -0
  72. package/lib/models/labels/void-request.js.map +1 -1
  73. package/lib/models/labels/void-response.js +8 -0
  74. package/lib/models/labels/void-response.js.map +1 -1
  75. package/lib/models/manifests/label.js +4 -0
  76. package/lib/models/manifests/label.js.map +1 -1
  77. package/lib/models/manifests/manifest-request-shipment.js +1 -0
  78. package/lib/models/manifests/manifest-request-shipment.js.map +1 -1
  79. package/lib/models/manifests/manifest.js +9 -0
  80. package/lib/models/manifests/manifest.js.map +1 -1
  81. package/lib/models/package.js +14 -0
  82. package/lib/models/package.js.map +1 -1
  83. package/lib/models/pickup/cancellation-details.js +6 -0
  84. package/lib/models/pickup/cancellation-details.js.map +1 -1
  85. package/lib/models/pickup/pickup-confirmation.js +6 -0
  86. package/lib/models/pickup/pickup-confirmation.js.map +1 -1
  87. package/lib/models/pickup/pickup-contact-details.js +10 -0
  88. package/lib/models/pickup/pickup-contact-details.js.map +1 -1
  89. package/lib/models/pickup/pickup-location-details.js +6 -0
  90. package/lib/models/pickup/pickup-location-details.js.map +1 -1
  91. package/lib/models/pickup/pickup-package.js +14 -0
  92. package/lib/models/pickup/pickup-package.js.map +1 -1
  93. package/lib/models/pickup/pickup-shipment-details.js +4 -0
  94. package/lib/models/pickup/pickup-shipment-details.js.map +1 -1
  95. package/lib/models/pickup/pickup-window.js +8 -0
  96. package/lib/models/pickup/pickup-window.js.map +1 -1
  97. package/lib/models/pickup/shipment-identifier.js +4 -0
  98. package/lib/models/pickup/shipment-identifier.js.map +1 -1
  99. package/lib/models/pickup/shipped-package.js +20 -0
  100. package/lib/models/pickup/shipped-package.js.map +1 -1
  101. package/lib/models/pickup/shipped-shipment.d.ts +0 -2
  102. package/lib/models/pickup/shipped-shipment.js +12 -0
  103. package/lib/models/pickup/shipped-shipment.js.map +1 -1
  104. package/lib/models/rates/rate.js +26 -0
  105. package/lib/models/rates/rate.js.map +1 -1
  106. package/lib/models/registration/credentials.js +4 -0
  107. package/lib/models/registration/credentials.js.map +1 -1
  108. package/lib/models/relay-points/opening-times.js +7 -0
  109. package/lib/models/relay-points/opening-times.js.map +1 -1
  110. package/lib/models/relay-points/relay-point-address.js +7 -0
  111. package/lib/models/relay-points/relay-point-address.js.map +1 -1
  112. package/lib/models/relay-points/relay-point-details.js +2 -0
  113. package/lib/models/relay-points/relay-point-details.js.map +1 -1
  114. package/lib/models/relay-points/relay-point.js +4 -0
  115. package/lib/models/relay-points/relay-point.js.map +1 -1
  116. package/lib/models/resource-download.js +4 -0
  117. package/lib/models/resource-download.js.map +1 -1
  118. package/lib/models/service-points/hours-of-operation.js +4 -0
  119. package/lib/models/service-points/hours-of-operation.js.map +1 -1
  120. package/lib/models/service-points/search-radius.js +8 -0
  121. package/lib/models/service-points/search-radius.js.map +1 -1
  122. package/lib/models/service-points/service-point-response-address.js +2 -0
  123. package/lib/models/service-points/service-point-response-address.js.map +1 -1
  124. package/lib/models/service-points/service-point.js +10 -0
  125. package/lib/models/service-points/service-point.js.map +1 -1
  126. package/lib/models/service-points/weekly-hours-of-operation.js +7 -0
  127. package/lib/models/service-points/weekly-hours-of-operation.js.map +1 -1
  128. package/lib/models/taxes/tax-identifier.js +10 -0
  129. package/lib/models/taxes/tax-identifier.js.map +1 -1
  130. package/lib/models/time-window.js +14 -0
  131. package/lib/models/time-window.js.map +1 -1
  132. package/lib/models/tracking/imported-tracking-event.js +12 -0
  133. package/lib/models/tracking/imported-tracking-event.js.map +1 -1
  134. package/lib/models/tracking/lat-long.js +4 -0
  135. package/lib/models/tracking/lat-long.js.map +1 -1
  136. package/lib/models/tracking/service.js +4 -0
  137. package/lib/models/tracking/service.js.map +1 -1
  138. package/lib/models/tracking/track-event.js +24 -0
  139. package/lib/models/tracking/track-event.js.map +1 -1
  140. package/lib/models/tracking/tracking-attribute.js +2 -0
  141. package/lib/models/tracking/tracking-attribute.js.map +1 -1
  142. package/lib/models/tracking/tracking-identifier.js +2 -0
  143. package/lib/models/tracking/tracking-identifier.js.map +1 -1
  144. package/lib/models/tracking/tracking-info.js +36 -0
  145. package/lib/models/tracking/tracking-info.js.map +1 -1
  146. package/lib/models/units/dimension-details.js +8 -0
  147. package/lib/models/units/dimension-details.js.map +1 -1
  148. package/lib/models/units/dimensions.js +3 -0
  149. package/lib/models/units/dimensions.js.map +1 -1
  150. package/lib/models/units/weight-details.js +8 -0
  151. package/lib/models/units/weight-details.js.map +1 -1
  152. package/lib/requests/base-request.js +3 -0
  153. package/lib/requests/base-request.js.map +1 -1
  154. package/lib/requests/cancel-notification-request.js +4 -0
  155. package/lib/requests/cancel-notification-request.js.map +1 -1
  156. package/lib/requests/cancel-pickup-request.js +7 -0
  157. package/lib/requests/cancel-pickup-request.js.map +1 -1
  158. package/lib/requests/create-label-request.js +35 -0
  159. package/lib/requests/create-label-request.js.map +1 -1
  160. package/lib/requests/create-manifest-request.js +6 -0
  161. package/lib/requests/create-manifest-request.js.map +1 -1
  162. package/lib/requests/create-notification-request.js +6 -0
  163. package/lib/requests/create-notification-request.js.map +1 -1
  164. package/lib/requests/get-manifest-request.js +10 -0
  165. package/lib/requests/get-manifest-request.js.map +1 -1
  166. package/lib/requests/get-rates-request.js +20 -0
  167. package/lib/requests/get-rates-request.js.map +1 -1
  168. package/lib/requests/get-relay-points-request.js +4 -0
  169. package/lib/requests/get-relay-points-request.js.map +1 -1
  170. package/lib/requests/get-service-point-request.js +4 -0
  171. package/lib/requests/get-service-point-request.js.map +1 -1
  172. package/lib/requests/get-service-points-request.js +8 -0
  173. package/lib/requests/get-service-points-request.js.map +1 -1
  174. package/lib/requests/register-request.js +1 -0
  175. package/lib/requests/register-request.js.map +1 -1
  176. package/lib/requests/schedule-pickup-request.js +4 -0
  177. package/lib/requests/schedule-pickup-request.js.map +1 -1
  178. package/lib/requests/tracking-request.js +4 -0
  179. package/lib/requests/tracking-request.js.map +1 -1
  180. package/lib/requests/void-labels-request.js +2 -0
  181. package/lib/requests/void-labels-request.js.map +1 -1
  182. package/lib/responses/base-response.js +1 -0
  183. package/lib/responses/base-response.js.map +1 -1
  184. package/lib/responses/cancel-notification-response.js +4 -0
  185. package/lib/responses/cancel-notification-response.js.map +1 -1
  186. package/lib/responses/cancel-pickup-response.js +4 -0
  187. package/lib/responses/cancel-pickup-response.js.map +1 -1
  188. package/lib/responses/create-label-response.js +17 -0
  189. package/lib/responses/create-label-response.js.map +1 -1
  190. package/lib/responses/create-manifest-response.js +8 -0
  191. package/lib/responses/create-manifest-response.js.map +1 -1
  192. package/lib/responses/create-notification-response.js +3 -0
  193. package/lib/responses/create-notification-response.js.map +1 -1
  194. package/lib/responses/error-response.js +1 -0
  195. package/lib/responses/error-response.js.map +1 -1
  196. package/lib/responses/get-rates-response.js +1 -0
  197. package/lib/responses/get-rates-response.js.map +1 -1
  198. package/lib/responses/get-relay-points-response.js +1 -0
  199. package/lib/responses/get-relay-points-response.js.map +1 -1
  200. package/lib/responses/get-service-point-response.js +2 -0
  201. package/lib/responses/get-service-point-response.js.map +1 -1
  202. package/lib/responses/get-service-points-response.js +2 -0
  203. package/lib/responses/get-service-points-response.js.map +1 -1
  204. package/lib/responses/normalize-tracking-data-response.js +7 -0
  205. package/lib/responses/normalize-tracking-data-response.js.map +1 -1
  206. package/lib/responses/register-response.js +2 -0
  207. package/lib/responses/register-response.js.map +1 -1
  208. package/lib/responses/schedule-pickup-response.js +5 -0
  209. package/lib/responses/schedule-pickup-response.js.map +1 -1
  210. package/lib/responses/tracking-response.js +1 -0
  211. package/lib/responses/tracking-response.js.map +1 -1
  212. package/lib/responses/validate-inbound-data-response.js +2 -0
  213. package/lib/responses/validate-inbound-data-response.js.map +1 -1
  214. package/lib/responses/void-labels-response.js +2 -0
  215. package/lib/responses/void-labels-response.js.map +1 -1
  216. package/package.json +3 -3
  217. package/src/app/carrier-app-definition.ts +1 -0
  218. package/src/carrier-app.ts +11 -0
  219. package/src/index.ts +1 -0
  220. package/src/models/pickup/shipped-shipment.ts +0 -2
  221. package/tsconfig.tsbuildinfo +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://connect.shipengine.com",
6
6
  "main": "./lib/index.js",
@@ -32,7 +32,7 @@
32
32
  "license": "Apache-2.0",
33
33
  "devDependencies": {
34
34
  "@types/sanitize-html": "^2.6.2",
35
- "prettier": "^2.4.0",
35
+ "prettier": "^2.8.8",
36
36
  "typescript": "^4.9.5",
37
37
  "vitest": "^0.23.4"
38
38
  },
@@ -44,7 +44,7 @@
44
44
  "tslib": "^2.5.0"
45
45
  },
46
46
  "peerDependencies": {
47
- "@shipengine/connect-runtime": "^4.0.0",
47
+ "@shipengine/connect-runtime": "^4.1.0",
48
48
  "express": "^4.18.2",
49
49
  "winston": "^3.8.2"
50
50
  }
@@ -1,4 +1,5 @@
1
1
  import { ImportedTrackingEvent } from '../models';
2
+ import type { Request } from 'express';
2
3
  import {
3
4
  RegisterRequest,
4
5
  CreateLabelRequest,
@@ -0,0 +1,11 @@
1
+ import { obsoleteAppError } from '@shipengine/connect-runtime';
2
+
3
+ /**
4
+ * @deprecated Connect apps should no longer instantiate themselves.
5
+ * See https://connect.shipengine.com/getting-started/v2-v4-upgrade/ for more information on upgrading.
6
+ */
7
+ export class CarrierApp {
8
+ constructor(_: unknown) {
9
+ obsoleteAppError();
10
+ }
11
+ }
package/src/index.ts CHANGED
@@ -8,3 +8,4 @@ export * from './models';
8
8
  export * from './requests';
9
9
  export * from './responses';
10
10
  export * from './spec';
11
+ export * from './carrier-app';
@@ -7,8 +7,6 @@ import { PudoLocation } from '../../models';
7
7
 
8
8
  /** @description Basic structure for a shipment that has been shipped */
9
9
  export class ShippedShipment extends Label {
10
- /** @description The carrier tracking number associated with this package */
11
- tracking_number?: string;
12
10
  /** @description The address that a shipment will be delivered to */
13
11
  ship_to?: ShipTo;
14
12
  /** @description Non-tracking alternative ids associated with this shipment */