@shipengine/connect-carrier-api 4.6.5 → 4.6.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 (3) hide show
  1. package/package.json +2 -2
  2. package/spec.json +18 -299
  3. 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.6.5",
3
+ "version": "4.6.7",
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",
@@ -44,7 +44,7 @@
44
44
  "tslib": "^2.6.2"
45
45
  },
46
46
  "peerDependencies": {
47
- "@shipengine/connect-runtime": "^4.6.1",
47
+ "@shipengine/connect-runtime": "^4.6.2",
48
48
  "express": "^4.18.2",
49
49
  "winston": "^3.8.2"
50
50
  }
package/spec.json CHANGED
@@ -20,19 +20,7 @@
20
20
  "schema": {
21
21
  "$ref": "#/components/schemas/ExampleRegisterRequest"
22
22
  },
23
- "example": {
24
- "registration_info": {
25
- "username": "auctane-next-day",
26
- "password": "password!",
27
- "meter_number": "8675309"
28
- },
29
- "transaction_id": "00000000-0000-0000-0000-000000000000",
30
- "metadata": {
31
- "username": "auctane-next-day",
32
- "password": "password!",
33
- "meter_number": "8675309"
34
- }
35
- }
23
+ "example": {"registration_info":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
36
24
  }
37
25
  }
38
26
  },
@@ -44,17 +32,7 @@
44
32
  "schema": {
45
33
  "$ref": "#/components/schemas/RegisterResponse"
46
34
  },
47
- "example": {
48
- "credentials": {
49
- "username": "auctane-next-day",
50
- "password": "password!"
51
- },
52
- "metadata": {
53
- "username": "auctane-next-day",
54
- "password": "password!",
55
- "meter_number": "8675309"
56
- }
57
- }
35
+ "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
58
36
  }
59
37
  }
60
38
  }
@@ -210,19 +188,7 @@
210
188
  "schema": {
211
189
  "$ref": "#/components/schemas/ValidateInboundDataRequest"
212
190
  },
213
- "example": {
214
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
215
- "headers": {
216
- "content-type": [ "application/json" ],
217
- "X-Signature": [ "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b", "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19" ]
218
- },
219
- "transaction_id": "00000000-0000-0000-0000-000000000000",
220
- "metadata": {
221
- "username": "auctane-next-day",
222
- "password": "password!",
223
- "meter_number": "8675309"
224
- }
225
- }
191
+ "example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
226
192
  }
227
193
  }
228
194
  },
@@ -237,7 +203,7 @@
237
203
  "examples": {
238
204
  "Tracking": {
239
205
  "summary": "Tracking",
240
- "value": { "content_types": [ "tracking" ] }
206
+ "value": {"content_types":["tracking"]}
241
207
  }
242
208
  }
243
209
  }
@@ -260,19 +226,7 @@
260
226
  "schema": {
261
227
  "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
262
228
  },
263
- "example": {
264
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
265
- "headers": {
266
- "content-type": [ "application/json" ],
267
- "X-Signature": [ "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b", "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19" ]
268
- },
269
- "transaction_id": "00000000-0000-0000-0000-000000000000",
270
- "metadata": {
271
- "username": "auctane-next-day",
272
- "password": "password!",
273
- "meter_number": "8675309"
274
- }
275
- }
229
+ "example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
276
230
  }
277
231
  }
278
232
  },
@@ -287,28 +241,7 @@
287
241
  "examples": {
288
242
  "Delivered": {
289
243
  "summary": "Delivered",
290
- "value": {
291
- "tracking_info": [
292
- {
293
- "carrier_name": "UPS",
294
- "tracking_number": "12345678901234567890",
295
- "standardized_status_code": "DE",
296
- "carrier_status_code": "11",
297
- "carrier_status_description": "Delivered",
298
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
299
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
300
- "service": {
301
- "code": "03",
302
- "name": "UPS® Ground"
303
- },
304
- "packaging": "package",
305
- "package_count": 1,
306
- "shipping_problem": false,
307
- "carrierEnum": 0
308
- }
309
- ],
310
- "update_method": "append"
311
- }
244
+ "value": {"tracking_info":[{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"shipping_problem":false,"carrierEnum":0}],"update_method":"append"}
312
245
  }
313
246
  }
314
247
  }
@@ -606,32 +539,7 @@
606
539
  "schema": {
607
540
  "$ref": "#/components/schemas/TrackingRequest"
608
541
  },
609
- "example": {
610
- "tracking_number": "12345678901234567890",
611
- "is_return": false,
612
- "identifiers": [
613
- {
614
- "type": "tracking_number",
615
- "value": "12345678901234567890"
616
- },
617
- {
618
- "type": "carrier_transaction_id",
619
- "value": "US-12345678901234567890-1"
620
- }
621
- ],
622
- "attributes": [
623
- {
624
- "type": "marketplace_order_token",
625
- "value": "123456abcdefg7890"
626
- }
627
- ],
628
- "transaction_id": "00000000-0000-0000-0000-000000000000",
629
- "metadata": {
630
- "username": "auctane-next-day",
631
- "password": "password!",
632
- "meter_number": "8675309"
633
- }
634
- }
542
+ "example": {"tracking_number":"12345678901234567890","is_return":false,"identifiers":[{"type":"tracking_number","value":"12345678901234567890"},{"type":"carrier_transaction_id","value":"US-12345678901234567890-1"}],"attributes":[{"type":"marketplace_order_token","value":"123456abcdefg7890"}],"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
635
543
  }
636
544
  }
637
545
  },
@@ -646,211 +554,15 @@
646
554
  "examples": {
647
555
  "Delivered with Event History": {
648
556
  "summary": "Delivered with Event History",
649
- "value": {
650
- "tracking_info": {
651
- "carrier_name": "UPS",
652
- "tracking_number": "12345678901234567890",
653
- "standardized_status_code": "DE",
654
- "carrier_status_code": "11",
655
- "carrier_status_description": "Delivered",
656
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
657
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
658
- "weight": 500.0,
659
- "dimensions": {
660
- "length": 10.0,
661
- "width": 10.0,
662
- "height": 10.0
663
- },
664
- "service": {
665
- "code": "03",
666
- "name": "UPS® Ground"
667
- },
668
- "packaging": "package",
669
- "package_count": 1,
670
- "events": [
671
- {
672
- "event_datetime": "2021-08-08T21:15:00Z",
673
- "event_datetime_local": "2021-08-08T16:15:00",
674
- "event_code": "3",
675
- "description": "Order Processed: Ready for UPS",
676
- "city": "Austin",
677
- "state": "TX",
678
- "postal_code": "78756",
679
- "country": "US",
680
- "geo": {
681
- "lat": 30.31,
682
- "long": -97.74
683
- },
684
- "status_code": "AC"
685
- },
686
- {
687
- "event_datetime": "2021-08-09T09:15:00Z",
688
- "event_datetime_local": "2021-08-09T04:15:00",
689
- "event_code": "5",
690
- "description": "In Transit",
691
- "city": "Austin",
692
- "state": "TX",
693
- "postal_code": "78756",
694
- "country": "US",
695
- "geo": {
696
- "lat": 30.2,
697
- "long": -97.66
698
- },
699
- "status_code": "IT"
700
- },
701
- {
702
- "event_datetime": "2021-08-10T09:15:00Z",
703
- "event_datetime_local": "2021-08-10T04:15:00",
704
- "event_code": "6",
705
- "description": "On Vehicle for Delivery",
706
- "city": "Los Angeles",
707
- "state": "CA",
708
- "postal_code": "90045",
709
- "country": "US",
710
- "geo": {
711
- "lat": 33.95,
712
- "long": -118.38
713
- },
714
- "status_code": "IT"
715
- },
716
- {
717
- "event_datetime": "2021-08-10T15:15:00Z",
718
- "event_datetime_local": "2021-08-10T10:15:00",
719
- "event_code": "21",
720
- "description": "On Vehicle for Delivery Today",
721
- "city": "Los Angeles",
722
- "state": "CA",
723
- "postal_code": "90045",
724
- "country": "US",
725
- "geo": {
726
- "lat": 33.95,
727
- "long": -118.38
728
- },
729
- "status_code": "IT"
730
- },
731
- {
732
- "event_datetime": "2021-08-10T21:15:00Z",
733
- "event_datetime_local": "2021-08-10T16:15:00",
734
- "event_code": "22",
735
- "description": "First Attempt Made",
736
- "city": "El Segundo",
737
- "state": "CA",
738
- "postal_code": "90245",
739
- "country": "US",
740
- "geo": {
741
- "lat": 33.95,
742
- "long": -118.38
743
- },
744
- "status_code": "AT"
745
- },
746
- {
747
- "event_datetime": "2021-08-11T03:15:00Z",
748
- "event_datetime_local": "2021-08-10T22:15:00",
749
- "event_code": "21",
750
- "description": "On Vehicle for Delivery Today",
751
- "city": "Los Angeles",
752
- "state": "CA",
753
- "postal_code": "90045",
754
- "country": "US",
755
- "geo": {
756
- "lat": 33.95,
757
- "long": -118.38
758
- },
759
- "status_code": "IT"
760
- },
761
- {
762
- "event_datetime": "2021-08-11T21:15:00Z",
763
- "event_datetime_local": "2021-08-11T16:15:00",
764
- "event_code": "11",
765
- "description": "Delivered",
766
- "city": "El Segundo",
767
- "state": "CA",
768
- "postal_code": "90245",
769
- "country": "US",
770
- "geo": {
771
- "lat": 33.95,
772
- "long": -118.38
773
- },
774
- "status_code": "DE"
775
- }
776
- ],
777
- "shipping_problem": false,
778
- "carrierEnum": 0
779
- }
780
- }
557
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"3","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"6","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"22","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"11","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
781
558
  },
782
559
  "Not Yet in System": {
783
560
  "summary": "Not Yet in System",
784
- "value": {
785
- "tracking_info": {
786
- "carrier_name": "UPS",
787
- "tracking_number": "12345678901234567890",
788
- "standardized_status_code": "NY",
789
- "events": [],
790
- "shipping_problem": false,
791
- "carrierEnum": 0
792
- }
793
- }
561
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
794
562
  },
795
563
  "Fatal Exception": {
796
564
  "summary": "Fatal Exception",
797
- "value": {
798
- "tracking_info": {
799
- "carrier_name": "UPS",
800
- "tracking_number": "12345678901234567890",
801
- "standardized_status_code": "EX",
802
- "carrier_status_code": "64",
803
- "carrier_status_description": "Delivery Refused",
804
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
805
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
806
- "weight": 500.0,
807
- "dimensions": {
808
- "length": 10.0,
809
- "width": 10.0,
810
- "height": 10.0
811
- },
812
- "service": {
813
- "code": "03",
814
- "name": "UPS® Ground"
815
- },
816
- "packaging": "package",
817
- "package_count": 1,
818
- "events": [
819
- {
820
- "event_datetime": "2021-08-09T09:15:00Z",
821
- "event_datetime_local": "2021-08-09T04:15:00",
822
- "event_code": "5",
823
- "description": "In Transit",
824
- "city": "Austin",
825
- "state": "TX",
826
- "postal_code": "78756",
827
- "country": "US",
828
- "geo": {
829
- "lat": 30.2,
830
- "long": -97.66
831
- },
832
- "status_code": "IT"
833
- },
834
- {
835
- "event_datetime": "2021-08-11T21:15:00Z",
836
- "event_datetime_local": "2021-08-11T16:15:00",
837
- "event_code": "59",
838
- "description": "Delivery Refused",
839
- "city": "El Segundo",
840
- "state": "CA",
841
- "postal_code": "90245",
842
- "country": "US",
843
- "geo": {
844
- "lat": 33.95,
845
- "long": -118.38
846
- },
847
- "status_code": "EX"
848
- }
849
- ],
850
- "shipping_problem": false,
851
- "carrierEnum": 0
852
- }
853
- }
565
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"64","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"59","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
854
566
  }
855
567
  }
856
568
  }
@@ -1133,7 +845,7 @@
1133
845
  "description": "Indicates whether the recipient should be notified of events related to the shipment."
1134
846
  }
1135
847
  },
1136
- "additionalProperties": {},
848
+ "additionalProperties": { },
1137
849
  "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."
1138
850
  },
1139
851
  "Authorization": {
@@ -1173,6 +885,7 @@
1173
885
  "metadata": {
1174
886
  "type": "object",
1175
887
  "additionalProperties": {
888
+ "type": "object",
1176
889
  "nullable": true
1177
890
  },
1178
891
  "nullable": true
@@ -1191,6 +904,7 @@
1191
904
  "metadata": {
1192
905
  "type": "object",
1193
906
  "additionalProperties": {
907
+ "type": "object",
1194
908
  "nullable": true
1195
909
  },
1196
910
  "description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
@@ -1847,6 +1561,7 @@
1847
1561
  "manifest_identifiers": {
1848
1562
  "type": "object",
1849
1563
  "additionalProperties": {
1564
+ "type": "object",
1850
1565
  "nullable": true
1851
1566
  },
1852
1567
  "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
@@ -2549,6 +2264,7 @@
2549
2264
  "manifest_identifiers": {
2550
2265
  "type": "object",
2551
2266
  "additionalProperties": {
2267
+ "type": "object",
2552
2268
  "nullable": true
2553
2269
  },
2554
2270
  "description": "Carrier specific data needed to retrieve Manifest results",
@@ -3710,6 +3426,7 @@
3710
3426
  "registration_info": {
3711
3427
  "type": "object",
3712
3428
  "additionalProperties": {
3429
+ "type": "object",
3713
3430
  "nullable": true
3714
3431
  },
3715
3432
  "description": "This is a schemaless object used to contain any required fields for validating a users credentials or\r\nregistering a new account. These fields will be custom to the shipping service provider, and will be\r\ncollected via a form and sent over as key value pairs.",
@@ -3732,6 +3449,7 @@
3732
3449
  "metadata": {
3733
3450
  "type": "object",
3734
3451
  "additionalProperties": {
3452
+ "type": "object",
3735
3453
  "nullable": true
3736
3454
  },
3737
3455
  "description": "This is an optional schemaless object that should be returned for persisted auth and user information.\r\nAnything returned under this key will be included in all future requests. For example, you may store\r\nadditional static properties about the end user or their connection to the carrier. The maximum\r\nstorage size for data under this key is 4KB.",
@@ -4680,6 +4398,7 @@
4680
4398
  "update_settings": {
4681
4399
  "type": "object",
4682
4400
  "additionalProperties": {
4401
+ "type": "object",
4683
4402
  "nullable": true
4684
4403
  },
4685
4404
  "description": "This is a schemaless object used to contain any required fields for updating carrier settings.",