@shipengine/connect-carrier-api 2.2.1 → 2.3.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 (193) hide show
  1. package/lib/app/metadata/carrier.d.ts +1 -0
  2. package/lib/app/metadata/carrier.js +3 -0
  3. package/lib/app/metadata/carrier.js.map +1 -1
  4. package/lib/app/metadata/package-type.d.ts +1 -0
  5. package/lib/app/metadata/package-type.js +3 -0
  6. package/lib/app/metadata/package-type.js.map +1 -1
  7. package/lib/app/metadata/shipping-service.d.ts +1 -0
  8. package/lib/app/metadata/shipping-service.js +3 -0
  9. package/lib/app/metadata/shipping-service.js.map +1 -1
  10. package/lib/index.d.ts +1 -0
  11. package/lib/index.js +1 -0
  12. package/lib/index.js.map +1 -1
  13. package/lib/models/addresses/address-base.d.ts +13 -13
  14. package/lib/models/addresses/address-base.js.map +1 -1
  15. package/lib/models/addresses/address-residential-indicator.d.ts +3 -0
  16. package/lib/models/addresses/address-residential-indicator.js +3 -0
  17. package/lib/models/addresses/address-residential-indicator.js.map +1 -1
  18. package/lib/models/addresses/ship-from-display.d.ts +1 -0
  19. package/lib/models/addresses/ship-from-display.js +1 -0
  20. package/lib/models/addresses/ship-from-display.js.map +1 -1
  21. package/lib/models/addresses/ship-from.d.ts +1 -0
  22. package/lib/models/addresses/ship-from.js +1 -0
  23. package/lib/models/addresses/ship-from.js.map +1 -1
  24. package/lib/models/addresses/ship-to.d.ts +1 -0
  25. package/lib/models/addresses/ship-to.js +1 -0
  26. package/lib/models/addresses/ship-to.js.map +1 -1
  27. package/lib/models/advanced-options.d.ts +1 -1
  28. package/lib/models/authorization.d.ts +2 -0
  29. package/lib/models/authorization.js.map +1 -1
  30. package/lib/models/billing/billing-categories.d.ts +1 -1
  31. package/lib/models/billing/billing-categories.js +1 -1
  32. package/lib/models/billing/billing-categories.js.map +1 -1
  33. package/lib/models/billing/billing-line-item.d.ts +5 -0
  34. package/lib/models/billing/billing-line-item.js +2 -2
  35. package/lib/models/billing/billing-line-item.js.map +1 -1
  36. package/lib/models/confirmation-types.d.ts +5 -5
  37. package/lib/models/confirmation-types.js +5 -5
  38. package/lib/models/confirmation-types.js.map +1 -1
  39. package/lib/models/currency.d.ts +2 -0
  40. package/lib/models/currency.js.map +1 -1
  41. package/lib/models/customs/customs-content-types.d.ts +5 -1
  42. package/lib/models/customs/customs-content-types.js +5 -1
  43. package/lib/models/customs/customs-content-types.js.map +1 -1
  44. package/lib/models/customs/customs-item.d.ts +9 -1
  45. package/lib/models/customs/customs-item.js +1 -1
  46. package/lib/models/customs/customs-item.js.map +1 -1
  47. package/lib/models/customs/customs-non-delivery.d.ts +2 -0
  48. package/lib/models/customs/customs-non-delivery.js +2 -0
  49. package/lib/models/customs/customs-non-delivery.js.map +1 -1
  50. package/lib/models/customs/customs.d.ts +6 -1
  51. package/lib/models/customs/customs.js +1 -1
  52. package/lib/models/customs/customs.js.map +1 -1
  53. package/lib/models/documents/document-type.d.ts +4 -0
  54. package/lib/models/documents/document-type.js +4 -0
  55. package/lib/models/documents/document-type.js.map +1 -1
  56. package/lib/models/documents/document.d.ts +3 -0
  57. package/lib/models/documents/document.js.map +1 -1
  58. package/lib/models/errors/detailed-error.d.ts +1 -1
  59. package/lib/models/errors/detailed-error.js +1 -1
  60. package/lib/models/errors/detailed-error.js.map +1 -1
  61. package/lib/models/errors/standardized-error-code.d.ts +1 -1
  62. package/lib/models/errors/standardized-error-code.js +1 -1
  63. package/lib/models/errors/standardized-error-code.js.map +1 -1
  64. package/lib/models/fulfillment-plans/fulfillment-plan-details.d.ts +4 -1
  65. package/lib/models/fulfillment-plans/fulfillment-plan-details.js +1 -1
  66. package/lib/models/fulfillment-plans/fulfillment-plan-details.js.map +1 -1
  67. package/lib/models/fulfillment-plans/fulfillment-plan-items.d.ts +4 -4
  68. package/lib/models/fulfillment-plans/raw-external-source.d.ts +2 -0
  69. package/lib/models/fulfillment-plans/raw-external-source.js +1 -0
  70. package/lib/models/fulfillment-plans/raw-external-source.js.map +1 -1
  71. package/lib/models/labels/form-download.d.ts +2 -0
  72. package/lib/models/labels/form-download.js +1 -0
  73. package/lib/models/labels/form-download.js.map +1 -1
  74. package/lib/models/labels/label-download.d.ts +2 -0
  75. package/lib/models/labels/label-download.js +1 -0
  76. package/lib/models/labels/label-download.js.map +1 -1
  77. package/lib/models/labels/label-package.d.ts +2 -0
  78. package/lib/models/labels/label-package.js.map +1 -1
  79. package/lib/models/labels/return-label-details.d.ts +1 -0
  80. package/lib/models/labels/return-label-details.js.map +1 -1
  81. package/lib/models/labels/void-request.d.ts +2 -0
  82. package/lib/models/labels/void-request.js.map +1 -1
  83. package/lib/models/labels/void-response.d.ts +1 -1
  84. package/lib/models/manifests/label.d.ts +2 -0
  85. package/lib/models/manifests/label.js.map +1 -1
  86. package/lib/models/manifests/manifest.d.ts +5 -1
  87. package/lib/models/manifests/manifest.js +1 -1
  88. package/lib/models/manifests/manifest.js.map +1 -1
  89. package/lib/models/package.d.ts +6 -0
  90. package/lib/models/package.js.map +1 -1
  91. package/lib/models/pickup/cancellation-details.d.ts +1 -0
  92. package/lib/models/pickup/cancellation-details.js.map +1 -1
  93. package/lib/models/pickup/pickup-confirmation.d.ts +3 -0
  94. package/lib/models/pickup/pickup-confirmation.js.map +1 -1
  95. package/lib/models/pickup/pickup-contact-details.d.ts +6 -1
  96. package/lib/models/pickup/pickup-contact-details.js +1 -1
  97. package/lib/models/pickup/pickup-contact-details.js.map +1 -1
  98. package/lib/models/pickup/pickup-location-details.d.ts +1 -0
  99. package/lib/models/pickup/pickup-location-details.js.map +1 -1
  100. package/lib/models/pickup/pickup-package.d.ts +7 -0
  101. package/lib/models/pickup/pickup-package.js.map +1 -1
  102. package/lib/models/pickup/pickup-shipment-details.d.ts +1 -0
  103. package/lib/models/pickup/pickup-shipment-details.js.map +1 -1
  104. package/lib/models/pickup/pickup-window.d.ts +5 -1
  105. package/lib/models/pickup/pickup-window.js +1 -1
  106. package/lib/models/pickup/pickup-window.js.map +1 -1
  107. package/lib/models/pickup/shipment-identifier.d.ts +2 -0
  108. package/lib/models/pickup/shipment-identifier.js.map +1 -1
  109. package/lib/models/pickup/shipped-package.d.ts +7 -0
  110. package/lib/models/pickup/shipped-package.js.map +1 -1
  111. package/lib/models/pickup/shipped-shipment.d.ts +6 -0
  112. package/lib/models/pickup/shipped-shipment.js.map +1 -1
  113. package/lib/models/rates/rate.d.ts +2 -4
  114. package/lib/models/rates/rate.js.map +1 -1
  115. package/lib/models/registration/credentials.d.ts +2 -0
  116. package/lib/models/registration/credentials.js.map +1 -1
  117. package/lib/models/resource-download.d.ts +2 -0
  118. package/lib/models/resource-download.js.map +1 -1
  119. package/lib/models/taxes/tax-identifier.d.ts +1 -1
  120. package/lib/models/taxes/tax-identifier.js +1 -1
  121. package/lib/models/taxes/tax-identifier.js.map +1 -1
  122. package/lib/models/tracking/lat-long.d.ts +2 -2
  123. package/lib/models/tracking/service.d.ts +2 -0
  124. package/lib/models/tracking/service.js.map +1 -1
  125. package/lib/models/tracking/track-event.d.ts +9 -0
  126. package/lib/models/tracking/track-event.js.map +1 -1
  127. package/lib/models/tracking/tracking-info.d.ts +18 -0
  128. package/lib/models/tracking/tracking-info.js.map +1 -1
  129. package/lib/models/units/dimension-details.d.ts +4 -0
  130. package/lib/models/units/dimension-details.js.map +1 -1
  131. package/lib/models/units/weight-details.d.ts +4 -0
  132. package/lib/models/units/weight-details.js.map +1 -1
  133. package/lib/requests/create-notification-request.d.ts +3 -1
  134. package/lib/requests/create-notification-request.js.map +1 -1
  135. package/package.json +1 -1
  136. package/spec.json +355 -176
  137. package/src/app/metadata/carrier.ts +4 -0
  138. package/src/app/metadata/package-type.ts +4 -0
  139. package/src/app/metadata/shipping-service.ts +4 -0
  140. package/src/index.ts +1 -0
  141. package/src/models/addresses/address-base.ts +13 -14
  142. package/src/models/addresses/address-residential-indicator.ts +3 -0
  143. package/src/models/addresses/ship-from-display.ts +1 -0
  144. package/src/models/addresses/ship-from.ts +1 -0
  145. package/src/models/addresses/ship-to.ts +1 -0
  146. package/src/models/advanced-options.ts +1 -1
  147. package/src/models/authorization.ts +2 -0
  148. package/src/models/billing/billing-categories.ts +1 -1
  149. package/src/models/billing/billing-line-item.ts +7 -2
  150. package/src/models/confirmation-types.ts +5 -5
  151. package/src/models/currency.ts +2 -0
  152. package/src/models/customs/customs-content-types.ts +5 -1
  153. package/src/models/customs/customs-item.ts +9 -1
  154. package/src/models/customs/customs-non-delivery.ts +2 -0
  155. package/src/models/customs/customs.ts +6 -1
  156. package/src/models/documents/document-type.ts +4 -0
  157. package/src/models/documents/document.ts +3 -0
  158. package/src/models/errors/detailed-error.ts +1 -1
  159. package/src/models/errors/standardized-error-code.ts +1 -1
  160. package/src/models/fulfillment-plans/fulfillment-plan-details.ts +4 -1
  161. package/src/models/fulfillment-plans/fulfillment-plan-items.ts +4 -4
  162. package/src/models/fulfillment-plans/raw-external-source.ts +2 -0
  163. package/src/models/labels/form-download.ts +2 -0
  164. package/src/models/labels/label-download.ts +2 -0
  165. package/src/models/labels/label-package.ts +2 -0
  166. package/src/models/labels/return-label-details.ts +1 -0
  167. package/src/models/labels/void-request.ts +2 -0
  168. package/src/models/labels/void-response.ts +1 -1
  169. package/src/models/manifests/label.ts +2 -0
  170. package/src/models/manifests/manifest.ts +5 -1
  171. package/src/models/package.ts +6 -0
  172. package/src/models/pickup/cancellation-details.ts +1 -0
  173. package/src/models/pickup/pickup-confirmation.ts +3 -0
  174. package/src/models/pickup/pickup-contact-details.ts +6 -1
  175. package/src/models/pickup/pickup-location-details.ts +1 -0
  176. package/src/models/pickup/pickup-package.ts +7 -0
  177. package/src/models/pickup/pickup-shipment-details.ts +1 -0
  178. package/src/models/pickup/pickup-window.ts +5 -1
  179. package/src/models/pickup/shipment-identifier.ts +2 -0
  180. package/src/models/pickup/shipped-package.ts +7 -0
  181. package/src/models/pickup/shipped-shipment.ts +6 -0
  182. package/src/models/rates/rate.ts +2 -4
  183. package/src/models/registration/credentials.ts +2 -0
  184. package/src/models/resource-download.ts +2 -0
  185. package/src/models/taxes/tax-identifier.ts +1 -1
  186. package/src/models/tracking/lat-long.ts +2 -2
  187. package/src/models/tracking/service.ts +2 -0
  188. package/src/models/tracking/track-event.ts +9 -0
  189. package/src/models/tracking/tracking-info.ts +18 -0
  190. package/src/models/units/dimension-details.ts +4 -0
  191. package/src/models/units/weight-details.ts +4 -0
  192. package/src/requests/create-notification-request.ts +3 -1
  193. package/tsconfig.tsbuildinfo +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"resource-download.js","sourceRoot":"","sources":["../../src/models/resource-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,8DAA8D;AAC9D,MAAa,gBAAgB;CAG5B;AAHD,4CAGC;AAEY,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
1
+ {"version":3,"file":"resource-download.js","sourceRoot":"","sources":["../../src/models/resource-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,8DAA8D;AAC9D,MAAa,gBAAgB;CAK5B;AALD,4CAKC;AAEY,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
@@ -1,5 +1,5 @@
1
1
  import { TaxIdentifierType } from './tax-identifier-type';
2
- /** @description Entity representing a Tax Identification number, type, and country of registration. */
2
+ /** @description Entity representing a Tax Identification number, type, and country of registration */
3
3
  export declare class TaxIdentifier {
4
4
  /** @description Identification number */
5
5
  id: string;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.TaxIdentifier = void 0;
4
- /** @description Entity representing a Tax Identification number, type, and country of registration. */
4
+ /** @description Entity representing a Tax Identification number, type, and country of registration */
5
5
  class TaxIdentifier {
6
6
  }
7
7
  exports.TaxIdentifier = TaxIdentifier;
@@ -1 +1 @@
1
- {"version":3,"file":"tax-identifier.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier.ts"],"names":[],"mappings":";;;AAEA,uGAAuG;AACvG,MAAa,aAAa;CASzB;AATD,sCASC"}
1
+ {"version":3,"file":"tax-identifier.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier.ts"],"names":[],"mappings":";;;AAEA,sGAAsG;AACtG,MAAa,aAAa;CASzB;AATD,sCASC"}
@@ -1,9 +1,9 @@
1
1
  import Joi from 'joi';
2
2
  /** @description Latitude and longitude */
3
3
  export declare class LatLong {
4
- /** @description latitude */
4
+ /** @description The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html */
5
5
  lat: number;
6
- /** @description longitude */
6
+ /** @description The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html */
7
7
  long: number;
8
8
  }
9
9
  export declare const LatLongSchema: Joi.ObjectSchema<any>;
@@ -1,7 +1,9 @@
1
1
  import Joi from 'joi';
2
2
  /** @description Basic structure for a tracking service */
3
3
  export declare class Service {
4
+ /** @description The code specific to a shipping provider service. */
4
5
  code?: string;
6
+ /** @description The name of this shipping provider service. */
5
7
  name?: string;
6
8
  }
7
9
  export declare const ServiceSchema: Joi.ObjectSchema<any>;
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/models/tracking/service.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,0DAA0D;AAC1D,MAAa,OAAO;CAGnB;AAHD,0BAGC;AACY,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/models/tracking/service.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,0DAA0D;AAC1D,MAAa,OAAO;CAKnB;AALD,0BAKC;AACY,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}
@@ -3,20 +3,29 @@ import { LatLong } from './lat-long';
3
3
  import { StandardizedStatusCodes } from './standardized-status-codes';
4
4
  /** @description Basic structure for tracking events */
5
5
  export declare class TrackEvent {
6
+ /** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
6
7
  event_datetime?: string;
8
+ /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
7
9
  event_datetime_local?: string;
10
+ /** @description Carrier's specific event code */
8
11
  event_code?: string;
12
+ /** @description Description of the package status at this event */
9
13
  description?: string;
14
+ /** @description City or Locality for this event */
10
15
  city?: string;
11
16
  /** @description State or province */
12
17
  state?: string;
13
18
  /** @description Zip or postal code */
14
19
  postal_code?: string;
20
+ /** @description Country for this event */
15
21
  country?: string;
22
+ /** @description The name of the company this is being delivered to */
16
23
  company?: string;
24
+ /** @description If the event had a signer associated, normally on delivery */
17
25
  signer?: string;
18
26
  /** @description Geographical location */
19
27
  geo?: LatLong;
28
+ /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
20
29
  status_code?: StandardizedStatusCodes;
21
30
  }
22
31
  export declare const TrackEventSchema: Joi.ObjectSchema<any>;
@@ -1 +1 @@
1
- {"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAiE;AAIjE,uDAAuD;AACvD,MAAa,UAAU;CAgBtB;AAhBD,gCAgBC;AACY,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,GAAG,EAAE,gBAAa,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gCAA6B,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}
1
+ {"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAiE;AAIjE,uDAAuD;AACvD,MAAa,UAAU;CAyBtB;AAzBD,gCAyBC;AACY,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,GAAG,EAAE,gBAAa,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gCAA6B,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}
@@ -5,23 +5,41 @@ import { TrackEvent } from './track-event';
5
5
  import Joi from 'joi';
6
6
  /** @description Basic structure for tracking information */
7
7
  export declare class TrackingInfo {
8
+ /** @description The human readable name of the carrier tracking this shipment. */
8
9
  carrier_name?: string;
10
+ /** @description The carrier specific tracking identifier for this shipment. */
9
11
  tracking_number?: string;
12
+ /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
10
13
  standardized_status_code: StandardizedStatusCodes;
14
+ /** @description The carrier specific status code of this shipment's tracking status. */
11
15
  carrier_status_code?: string;
16
+ /** @description The human readable description of this shipment's tracking status. */
12
17
  carrier_status_description?: string;
18
+ /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
13
19
  shipped_datetime?: string;
20
+ /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
14
21
  estimated_delivery_datetime?: string;
22
+ /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
15
23
  actual_delivery_datetime?: string;
24
+ /** @description A human readable description of why the shipment is in an error state. */
16
25
  shipping_problem_description?: string;
26
+ /** @description The weight measured by the carrier of the package(s) in this shipment. */
17
27
  weight?: number;
28
+ /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
18
29
  dimensions?: Dimensions;
30
+ /** @description A shipping provider specific service. */
19
31
  service?: Service;
32
+ /** @description The carrier packaging code. */
20
33
  packaging?: string;
34
+ /** @description The carrier observed count of packages in this shipment. */
21
35
  package_count?: number;
36
+ /** @description A list of tracking events for this shipment */
22
37
  events?: TrackEvent[];
38
+ /** @description Whether or not this shipment has entered an error state. */
23
39
  shipping_problem?: boolean;
40
+ /** @description The unique identifying code for the type of error encountered by this shipment. */
24
41
  shipping_problem_code?: string;
42
+ /** @description The human readable explanation of the error encountered by this shipment. */
25
43
  error_description?: string;
26
44
  }
27
45
  export declare const TrackingInfoSchema: Joi.ObjectSchema<any>;
@@ -1 +1 @@
1
- {"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;CAmBxB;AAnBD,oCAmBC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,yDAA6B,CAAC,QAAQ,EAAE;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC"}
1
+ {"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;CAqCxB;AArCD,oCAqCC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,yDAA6B,CAAC,QAAQ,EAAE;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC"}
@@ -2,8 +2,12 @@ import { Dimensions } from './dimensions';
2
2
  import { DimensionUnit } from './dimension-unit';
3
3
  /** @description Basic structure for package dimensions */
4
4
  export declare class DimensionDetails {
5
+ /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
5
6
  dimensions_in_centimeters?: Dimensions;
7
+ /** @description This contains information about the dimensions in inches. This will always be present on the request */
6
8
  dimensions_in_inches?: Dimensions;
9
+ /** @description This contains information about the dimensions in the source units. This will always be present on the request */
7
10
  source_dimensions?: Dimensions;
11
+ /** @description The source units the customer provided */
8
12
  source_dimension_unit: DimensionUnit;
9
13
  }
@@ -1 +1 @@
1
- {"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;CAK5B;AALD,4CAKC"}
1
+ {"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;CAS5B;AATD,4CASC"}
@@ -1,8 +1,12 @@
1
1
  import { WeightUnit } from './weight-unit';
2
2
  /** @description Basic structure for weight */
3
3
  export declare class WeightDetails {
4
+ /** @description This contains information about the weight in ounces. This will always be present on the request */
4
5
  weight_in_ounces?: number;
6
+ /** @description This contains information about the weight in grams. This will always be present on the request */
5
7
  weight_in_grams?: number;
8
+ /** @description This contains information about the weight in source unit. This will always be present on the request */
6
9
  source_weight?: number;
10
+ /** @description The source units the customer provided */
7
11
  source_weight_unit: WeightUnit;
8
12
  }
@@ -1 +1 @@
1
- {"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;CAKzB;AALD,sCAKC"}
1
+ {"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;CASzB;AATD,sCASC"}
@@ -1,4 +1,4 @@
1
- import { ShippedShipment } from '../models';
1
+ import { ShippedShipment, AdvancedOptions } from '../models';
2
2
  import { BaseRequest } from './base-request';
3
3
  import { CreateLabelRequest } from './create-label-request';
4
4
  export declare class CreateNotificationRequest extends BaseRequest {
@@ -6,4 +6,6 @@ export declare class CreateNotificationRequest extends BaseRequest {
6
6
  shipment_information: ShippedShipment;
7
7
  /** @description The label request for the shipment */
8
8
  create_label_request: CreateLabelRequest;
9
+ /** @description Any additional options a shipment may require, including custom options */
10
+ advanced_options?: AdvancedOptions;
9
11
  }
@@ -1 +1 @@
1
- {"version":3,"file":"create-notification-request.js","sourceRoot":"","sources":["../../src/requests/create-notification-request.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAG7C,MAAa,yBAA0B,SAAQ,0BAAW;CAKzD;AALD,8DAKC"}
1
+ {"version":3,"file":"create-notification-request.js","sourceRoot":"","sources":["../../src/requests/create-notification-request.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAG7C,MAAa,yBAA0B,SAAQ,0BAAW;CAOzD;AAPD,8DAOC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "2.2.1",
3
+ "version": "2.3.0",
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",