@itentialopensource/adapter-pitney_bowes 0.4.5 → 0.5.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 (45) hide show
  1. package/.eslintrc.js +1 -0
  2. package/AUTH.md +4 -4
  3. package/BROKER.md +4 -4
  4. package/CALLS.md +9 -9
  5. package/ENHANCE.md +3 -3
  6. package/PROPERTIES.md +24 -9
  7. package/README.md +24 -23
  8. package/SUMMARY.md +2 -2
  9. package/SYSTEMINFO.md +1 -1
  10. package/TAB1.md +2 -2
  11. package/TAB2.md +9 -5
  12. package/TROUBLESHOOT.md +10 -1
  13. package/UTILITIES.md +473 -0
  14. package/adapter.js +5 -5
  15. package/adapterBase.js +52 -16
  16. package/package.json +24 -28
  17. package/pronghorn.json +15 -13
  18. package/propertiesSchema.json +68 -7
  19. package/report/adapterInfo.json +7 -7
  20. package/report/auto-adapter-openapi.json +1573 -0
  21. package/report/updateReport1748551848719.json +120 -0
  22. package/sampleProperties.json +4 -0
  23. package/test/integration/adapterTestBasicGet.js +88 -54
  24. package/test/integration/adapterTestConnectivity.js +15 -16
  25. package/test/integration/adapterTestIntegration.js +1 -38
  26. package/test/unit/adapterBaseTestUnit.js +641 -39
  27. package/test/unit/adapterTestUnit.js +17 -54
  28. package/utils/adapterInfo.js +114 -164
  29. package/utils/argParser.js +44 -0
  30. package/utils/checkMigrate.js +77 -38
  31. package/utils/entitiesToDB.js +53 -42
  32. package/utils/logger.js +26 -0
  33. package/utils/modify.js +56 -55
  34. package/utils/mongoDbConnection.js +79 -0
  35. package/utils/mongoUtils.js +162 -0
  36. package/utils/taskMover.js +31 -32
  37. package/utils/tbScript.js +36 -172
  38. package/utils/tbUtils.js +84 -226
  39. package/utils/troubleshootingAdapter.js +68 -84
  40. package/utils/updateAdapterConfig.js +158 -0
  41. package/utils/addAuth.js +0 -94
  42. package/utils/artifactize.js +0 -146
  43. package/utils/basicGet.js +0 -50
  44. package/utils/packModificationScript.js +0 -35
  45. package/utils/patches2bundledDeps.js +0 -90
package/report/auto-adapter-openapi.json ADDED
@@ -0,0 +1,1573 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "",
5
+ "version": "1.0.0"
6
+ },
7
+ "paths": {
8
+ "/oauth/token": {
9
+ "post": {
10
+ "tags": [
11
+ "Authentication"
12
+ ],
13
+ "operationId": "oauthToken",
14
+ "description": "The parameters and request body are for method: oauthToken. Same endpoint also used in methods:",
15
+ "responses": {
16
+ "200": {
17
+ "description": "Successful operation",
18
+ "content": {
19
+ "application/json": {
20
+ "schema": {
21
+ "title": "result",
22
+ "type": "object"
23
+ }
24
+ }
25
+ }
26
+ }
27
+ },
28
+ "requestBody": {
29
+ "content": {
30
+ "application/json": {
31
+ "schema": {
32
+ "type": "object"
33
+ },
34
+ "example": {}
35
+ }
36
+ }
37
+ }
38
+ }
39
+ },
40
+ "/shippingservices/v1/information/rules/rating-services": {
41
+ "get": {
42
+ "tags": [
43
+ "CarrierInfo"
44
+ ],
45
+ "operationId": "getCarrierServiceRules",
46
+ "description": "The parameters and request body are for method: getCarrierServiceRules. Same endpoint also used in methods:",
47
+ "responses": {
48
+ "200": {
49
+ "description": "Successful operation",
50
+ "content": {
51
+ "application/json": {
52
+ "schema": {
53
+ "title": "result",
54
+ "type": "object"
55
+ }
56
+ }
57
+ }
58
+ }
59
+ },
60
+ "parameters": [
61
+ {
62
+ "name": "carrier",
63
+ "in": "query",
64
+ "required": true,
65
+ "schema": {
66
+ "type": "string"
67
+ }
68
+ },
69
+ {
70
+ "name": "originCountryCode",
71
+ "in": "query",
72
+ "required": true,
73
+ "schema": {
74
+ "type": "string"
75
+ }
76
+ },
77
+ {
78
+ "name": "destinationCountryCode",
79
+ "in": "query",
80
+ "required": true,
81
+ "schema": {
82
+ "type": "string"
83
+ }
84
+ },
85
+ {
86
+ "name": "rateTypeId",
87
+ "in": "query",
88
+ "required": true,
89
+ "schema": {
90
+ "type": "string"
91
+ }
92
+ },
93
+ {
94
+ "name": "futureShipmentDate",
95
+ "in": "query",
96
+ "required": true,
97
+ "schema": {
98
+ "type": "string"
99
+ }
100
+ },
101
+ {
102
+ "name": "returnShipment",
103
+ "in": "query",
104
+ "required": true,
105
+ "schema": {
106
+ "type": "string"
107
+ }
108
+ },
109
+ {
110
+ "name": "compactResponse",
111
+ "in": "query",
112
+ "required": true,
113
+ "schema": {
114
+ "type": "string"
115
+ }
116
+ }
117
+ ],
118
+ "requestBody": {
119
+ "content": {
120
+ "application/json": {
121
+ "schema": {
122
+ "type": "object"
123
+ },
124
+ "example": {}
125
+ }
126
+ }
127
+ }
128
+ }
129
+ },
130
+ "/shippingservices/v1/carrier/license-agreements": {
131
+ "get": {
132
+ "tags": [
133
+ "CarrierInfo"
134
+ ],
135
+ "operationId": "getCarrierLicenseAgreement",
136
+ "description": "The parameters and request body are for method: getCarrierLicenseAgreement. Same endpoint also used in methods:",
137
+ "responses": {
138
+ "200": {
139
+ "description": "Successful operation",
140
+ "content": {
141
+ "application/json": {
142
+ "schema": {
143
+ "type": "object",
144
+ "properties": {
145
+ "licenseText": {
146
+ "type": "string"
147
+ }
148
+ }
149
+ },
150
+ "example": {
151
+ "licenseText": "<text>"
152
+ }
153
+ }
154
+ }
155
+ }
156
+ },
157
+ "parameters": [
158
+ {
159
+ "name": "carrier",
160
+ "in": "query",
161
+ "required": true,
162
+ "schema": {
163
+ "type": "string"
164
+ }
165
+ },
166
+ {
167
+ "name": "originCountryCode",
168
+ "in": "query",
169
+ "required": true,
170
+ "schema": {
171
+ "type": "string"
172
+ }
173
+ }
174
+ ],
175
+ "requestBody": {
176
+ "content": {
177
+ "application/json": {
178
+ "schema": {
179
+ "type": "object"
180
+ },
181
+ "example": {}
182
+ }
183
+ }
184
+ }
185
+ }
186
+ },
187
+ "/shippingservices/v1/countries": {
188
+ "get": {
189
+ "tags": [
190
+ "CarrierInfo"
191
+ ],
192
+ "operationId": "getCarrierSupportedDestination",
193
+ "description": "The parameters and request body are for method: getCarrierSupportedDestination. Same endpoint also used in methods:",
194
+ "responses": {
195
+ "200": {
196
+ "description": "Successful operation",
197
+ "content": {
198
+ "application/json": {
199
+ "schema": {
200
+ "title": "result",
201
+ "type": "object"
202
+ }
203
+ }
204
+ }
205
+ }
206
+ },
207
+ "parameters": [
208
+ {
209
+ "name": "carrier",
210
+ "in": "query",
211
+ "required": true,
212
+ "schema": {
213
+ "type": "string"
214
+ }
215
+ },
216
+ {
217
+ "name": "originCountryCode",
218
+ "in": "query",
219
+ "required": true,
220
+ "schema": {
221
+ "type": "string"
222
+ }
223
+ }
224
+ ],
225
+ "requestBody": {
226
+ "content": {
227
+ "application/json": {
228
+ "schema": {
229
+ "type": "object"
230
+ },
231
+ "example": {}
232
+ }
233
+ }
234
+ }
235
+ }
236
+ },
237
+ "/shippingservices/v1/carrier-facility": {
238
+ "post": {
239
+ "tags": [
240
+ "CarrierInfo"
241
+ ],
242
+ "operationId": "getCarrierFacilities",
243
+ "description": "The parameters and request body are for method: getCarrierFacilities. Same endpoint also used in methods:",
244
+ "responses": {
245
+ "200": {
246
+ "description": "Successful operation",
247
+ "content": {
248
+ "application/json": {
249
+ "schema": {
250
+ "title": "result",
251
+ "type": "object"
252
+ }
253
+ }
254
+ }
255
+ }
256
+ },
257
+ "requestBody": {
258
+ "description": "indeterminate body object",
259
+ "content": {
260
+ "application/json": {
261
+ "schema": {
262
+ "type": "object"
263
+ }
264
+ }
265
+ }
266
+ }
267
+ }
268
+ },
269
+ "/shippingservices/v1/rates": {
270
+ "post": {
271
+ "tags": [
272
+ "RateParcels"
273
+ ],
274
+ "operationId": "rateParcel",
275
+ "description": "The parameters and request body are for method: rateParcel. Same endpoint also used in methods:",
276
+ "responses": {
277
+ "200": {
278
+ "description": "Successful operation",
279
+ "content": {
280
+ "application/json": {
281
+ "schema": {
282
+ "title": "result",
283
+ "type": "object"
284
+ }
285
+ }
286
+ }
287
+ }
288
+ },
289
+ "parameters": [
290
+ {
291
+ "name": "includeDeliveryCommitment",
292
+ "in": "query",
293
+ "required": true,
294
+ "schema": {
295
+ "type": "string"
296
+ }
297
+ },
298
+ {
299
+ "name": "carrier",
300
+ "in": "query",
301
+ "required": true,
302
+ "schema": {
303
+ "type": "string"
304
+ }
305
+ }
306
+ ],
307
+ "requestBody": {
308
+ "description": "indeterminate body object",
309
+ "content": {
310
+ "application/json": {
311
+ "schema": {
312
+ "type": "object"
313
+ }
314
+ }
315
+ }
316
+ }
317
+ }
318
+ },
319
+ "/shippingservices/v1/shipments": {
320
+ "post": {
321
+ "tags": [
322
+ "Shipment"
323
+ ],
324
+ "operationId": "createShipmentLabel",
325
+ "description": "The parameters and request body are for method: createShipmentLabel. Same endpoint also used in methods:",
326
+ "responses": {
327
+ "200": {
328
+ "description": "Successful operation",
329
+ "content": {
330
+ "application/json": {
331
+ "schema": {
332
+ "title": "result",
333
+ "type": "object"
334
+ }
335
+ }
336
+ }
337
+ }
338
+ },
339
+ "parameters": [
340
+ {
341
+ "name": "includeDeliveryCommitment",
342
+ "in": "query",
343
+ "required": true,
344
+ "schema": {
345
+ "type": "string"
346
+ }
347
+ }
348
+ ],
349
+ "requestBody": {
350
+ "description": "indeterminate body object",
351
+ "content": {
352
+ "application/json": {
353
+ "schema": {
354
+ "type": "object"
355
+ }
356
+ }
357
+ }
358
+ }
359
+ },
360
+ "get": {
361
+ "tags": [
362
+ "Shipment"
363
+ ],
364
+ "operationId": "retryShipment",
365
+ "description": "The parameters and request body are for method: retryShipment. Same endpoint also used in methods:",
366
+ "responses": {
367
+ "200": {
368
+ "description": "Successful operation",
369
+ "content": {
370
+ "application/json": {
371
+ "schema": {
372
+ "title": "result",
373
+ "type": "object"
374
+ }
375
+ }
376
+ }
377
+ }
378
+ },
379
+ "parameters": [
380
+ {
381
+ "name": "originalTransactionId",
382
+ "in": "query",
383
+ "required": true,
384
+ "schema": {
385
+ "type": "string"
386
+ }
387
+ }
388
+ ],
389
+ "requestBody": {
390
+ "content": {
391
+ "application/json": {
392
+ "schema": {
393
+ "type": "object"
394
+ },
395
+ "example": {}
396
+ }
397
+ }
398
+ }
399
+ }
400
+ },
401
+ "/shippingservices/v1/shipments/{shipmentId}": {
402
+ "get": {
403
+ "tags": [
404
+ "Shipment"
405
+ ],
406
+ "operationId": "reprintShipment",
407
+ "description": "The parameters and request body are for method: reprintShipment. Same endpoint also used in methods:",
408
+ "responses": {
409
+ "200": {
410
+ "description": "Successful operation",
411
+ "content": {
412
+ "application/json": {
413
+ "schema": {
414
+ "title": "result",
415
+ "type": "object"
416
+ }
417
+ }
418
+ }
419
+ }
420
+ },
421
+ "parameters": [
422
+ {
423
+ "name": "shipmentId",
424
+ "in": "path",
425
+ "required": true,
426
+ "schema": {
427
+ "title": "shipmentId",
428
+ "type": "string"
429
+ }
430
+ }
431
+ ],
432
+ "requestBody": {
433
+ "content": {
434
+ "application/json": {
435
+ "schema": {
436
+ "type": "object"
437
+ },
438
+ "example": {}
439
+ }
440
+ }
441
+ }
442
+ },
443
+ "delete": {
444
+ "tags": [
445
+ "Shipment"
446
+ ],
447
+ "operationId": "cancelShipment",
448
+ "description": "The parameters and request body are for method: cancelShipment. Same endpoint also used in methods:",
449
+ "responses": {
450
+ "200": {
451
+ "description": "Successful operation",
452
+ "content": {
453
+ "application/json": {
454
+ "schema": {
455
+ "title": "result",
456
+ "type": "object"
457
+ }
458
+ }
459
+ }
460
+ }
461
+ },
462
+ "parameters": [
463
+ {
464
+ "name": "shipmentId",
465
+ "in": "path",
466
+ "required": true,
467
+ "schema": {
468
+ "title": "shipmentId",
469
+ "type": "string"
470
+ }
471
+ },
472
+ {
473
+ "name": "cancelInitiator",
474
+ "in": "query",
475
+ "required": true,
476
+ "schema": {
477
+ "type": "string"
478
+ }
479
+ },
480
+ {
481
+ "name": "carrier",
482
+ "in": "query",
483
+ "required": true,
484
+ "schema": {
485
+ "type": "string"
486
+ }
487
+ }
488
+ ],
489
+ "requestBody": {
490
+ "content": {
491
+ "application/json": {
492
+ "schema": {
493
+ "type": "object"
494
+ },
495
+ "example": {}
496
+ }
497
+ }
498
+ }
499
+ }
500
+ },
501
+ "/shippingservices/v1/manifests": {
502
+ "post": {
503
+ "tags": [
504
+ "Manifests"
505
+ ],
506
+ "operationId": "createManifest",
507
+ "description": "The parameters and request body are for method: createManifest. Same endpoint also used in methods:",
508
+ "responses": {
509
+ "200": {
510
+ "description": "Successful operation",
511
+ "content": {
512
+ "application/json": {
513
+ "schema": {
514
+ "title": "result",
515
+ "type": "object"
516
+ }
517
+ }
518
+ }
519
+ }
520
+ },
521
+ "requestBody": {
522
+ "description": "indeterminate body object",
523
+ "content": {
524
+ "application/json": {
525
+ "schema": {
526
+ "type": "object"
527
+ }
528
+ }
529
+ }
530
+ }
531
+ },
532
+ "get": {
533
+ "tags": [
534
+ "Manifests"
535
+ ],
536
+ "operationId": "retryManifest",
537
+ "description": "The parameters and request body are for method: retryManifest. Same endpoint also used in methods:",
538
+ "responses": {
539
+ "200": {
540
+ "description": "Successful operation",
541
+ "content": {
542
+ "application/json": {
543
+ "schema": {
544
+ "title": "result",
545
+ "type": "object"
546
+ }
547
+ }
548
+ }
549
+ }
550
+ },
551
+ "parameters": [
552
+ {
553
+ "name": "originalTransactionId",
554
+ "in": "query",
555
+ "required": true,
556
+ "schema": {
557
+ "type": "string"
558
+ }
559
+ }
560
+ ],
561
+ "requestBody": {
562
+ "content": {
563
+ "application/json": {
564
+ "schema": {
565
+ "type": "object"
566
+ },
567
+ "example": {}
568
+ }
569
+ }
570
+ }
571
+ }
572
+ },
573
+ "/shippingservices/v1/manifests/{manifestId}": {
574
+ "get": {
575
+ "tags": [
576
+ "Manifests"
577
+ ],
578
+ "operationId": "reprintManifest",
579
+ "description": "The parameters and request body are for method: reprintManifest. Same endpoint also used in methods:",
580
+ "responses": {
581
+ "200": {
582
+ "description": "Successful operation",
583
+ "content": {
584
+ "application/json": {
585
+ "schema": {
586
+ "title": "result",
587
+ "type": "object"
588
+ }
589
+ }
590
+ }
591
+ }
592
+ },
593
+ "parameters": [
594
+ {
595
+ "name": "manifestId",
596
+ "in": "path",
597
+ "required": true,
598
+ "schema": {
599
+ "title": "manifestId",
600
+ "type": "string"
601
+ }
602
+ }
603
+ ],
604
+ "requestBody": {
605
+ "content": {
606
+ "application/json": {
607
+ "schema": {
608
+ "type": "object"
609
+ },
610
+ "example": {}
611
+ }
612
+ }
613
+ }
614
+ }
615
+ },
616
+ "/v4/ledger/developers/{developerId}/transactions/reports": {
617
+ "get": {
618
+ "tags": [
619
+ "TransactionReports"
620
+ ],
621
+ "operationId": "getTransactionReport",
622
+ "description": "The parameters and request body are for method: getTransactionReport. Same endpoint also used in methods:",
623
+ "responses": {
624
+ "200": {
625
+ "description": "Successful operation",
626
+ "content": {
627
+ "application/json": {
628
+ "schema": {
629
+ "title": "result",
630
+ "type": "object"
631
+ }
632
+ }
633
+ }
634
+ }
635
+ },
636
+ "parameters": [
637
+ {
638
+ "name": "developerId",
639
+ "in": "path",
640
+ "required": true,
641
+ "schema": {
642
+ "title": "developerId",
643
+ "type": "string"
644
+ }
645
+ },
646
+ {
647
+ "name": "fromDate",
648
+ "in": "query",
649
+ "required": true,
650
+ "schema": {
651
+ "type": "string"
652
+ }
653
+ },
654
+ {
655
+ "name": "shipDetails",
656
+ "in": "query",
657
+ "required": true,
658
+ "schema": {
659
+ "type": "string"
660
+ }
661
+ },
662
+ {
663
+ "name": "page",
664
+ "in": "query",
665
+ "required": true,
666
+ "schema": {
667
+ "type": "string"
668
+ }
669
+ },
670
+ {
671
+ "name": "size",
672
+ "in": "query",
673
+ "required": true,
674
+ "schema": {
675
+ "type": "string"
676
+ }
677
+ },
678
+ {
679
+ "name": "printStatus",
680
+ "in": "query",
681
+ "required": true,
682
+ "schema": {
683
+ "type": "string"
684
+ }
685
+ },
686
+ {
687
+ "name": "toDate",
688
+ "in": "query",
689
+ "required": true,
690
+ "schema": {
691
+ "type": "string"
692
+ }
693
+ },
694
+ {
695
+ "name": "transactionType",
696
+ "in": "query",
697
+ "required": true,
698
+ "schema": {
699
+ "type": "string"
700
+ }
701
+ },
702
+ {
703
+ "name": "merchantId",
704
+ "in": "query",
705
+ "required": true,
706
+ "schema": {
707
+ "type": "string"
708
+ }
709
+ },
710
+ {
711
+ "name": "sort",
712
+ "in": "query",
713
+ "required": true,
714
+ "schema": {
715
+ "type": "string"
716
+ }
717
+ },
718
+ {
719
+ "name": "parcelTrackingNumber",
720
+ "in": "query",
721
+ "required": true,
722
+ "schema": {
723
+ "type": "string"
724
+ }
725
+ }
726
+ ],
727
+ "requestBody": {
728
+ "content": {
729
+ "application/json": {
730
+ "schema": {
731
+ "type": "object"
732
+ },
733
+ "example": {}
734
+ }
735
+ }
736
+ }
737
+ }
738
+ },
739
+ "/shippingservices/v1/pickups/schedule": {
740
+ "post": {
741
+ "tags": [
742
+ "Pickup"
743
+ ],
744
+ "operationId": "getPickupschedule",
745
+ "description": "The parameters and request body are for method: getPickupschedule. Same endpoint also used in methods:",
746
+ "responses": {
747
+ "200": {
748
+ "description": "Successful operation",
749
+ "content": {
750
+ "application/json": {
751
+ "schema": {
752
+ "title": "result",
753
+ "type": "object"
754
+ }
755
+ }
756
+ }
757
+ }
758
+ },
759
+ "requestBody": {
760
+ "description": "indeterminate body object",
761
+ "content": {
762
+ "application/json": {
763
+ "schema": {
764
+ "type": "object"
765
+ }
766
+ }
767
+ }
768
+ }
769
+ }
770
+ },
771
+ "/shippingservices/v1/pickups/{pickupId}/cancel": {
772
+ "post": {
773
+ "tags": [
774
+ "Pickup"
775
+ ],
776
+ "operationId": "cancelPickup",
777
+ "description": "The parameters and request body are for method: cancelPickup. Same endpoint also used in methods:",
778
+ "responses": {
779
+ "200": {
780
+ "description": "Successful operation",
781
+ "content": {
782
+ "application/json": {
783
+ "schema": {
784
+ "title": "result",
785
+ "type": "object"
786
+ }
787
+ }
788
+ }
789
+ }
790
+ },
791
+ "parameters": [
792
+ {
793
+ "name": "pickupId",
794
+ "in": "path",
795
+ "required": true,
796
+ "schema": {
797
+ "title": "pickupId",
798
+ "type": "string"
799
+ }
800
+ }
801
+ ],
802
+ "requestBody": {
803
+ "content": {
804
+ "application/json": {
805
+ "schema": {
806
+ "type": "object"
807
+ },
808
+ "example": {}
809
+ }
810
+ }
811
+ }
812
+ }
813
+ },
814
+ "/shippingservices/v1/addresses/verify": {
815
+ "post": {
816
+ "tags": [
817
+ "AddressValidation"
818
+ ],
819
+ "operationId": "verifyAddress",
820
+ "description": "The parameters and request body are for method: verifyAddress. Same endpoint also used in methods:",
821
+ "responses": {
822
+ "200": {
823
+ "description": "Successful operation",
824
+ "content": {
825
+ "application/json": {
826
+ "schema": {
827
+ "title": "result",
828
+ "type": "object"
829
+ }
830
+ }
831
+ }
832
+ }
833
+ },
834
+ "parameters": [
835
+ {
836
+ "name": "minimalAddressValidation",
837
+ "in": "query",
838
+ "required": true,
839
+ "schema": {
840
+ "type": "string"
841
+ }
842
+ }
843
+ ],
844
+ "requestBody": {
845
+ "description": "indeterminate body object",
846
+ "content": {
847
+ "application/json": {
848
+ "schema": {
849
+ "type": "object"
850
+ }
851
+ }
852
+ }
853
+ }
854
+ }
855
+ },
856
+ "/shippingservices/v1/addresses/verify-suggest": {
857
+ "post": {
858
+ "tags": [
859
+ "AddressValidation"
860
+ ],
861
+ "operationId": "verifyAndSuggestAddress",
862
+ "description": "The parameters and request body are for method: verifyAndSuggestAddress. Same endpoint also used in methods:",
863
+ "responses": {
864
+ "200": {
865
+ "description": "Successful operation",
866
+ "content": {
867
+ "application/json": {
868
+ "schema": {
869
+ "title": "result",
870
+ "type": "object"
871
+ }
872
+ }
873
+ }
874
+ }
875
+ },
876
+ "parameters": [
877
+ {
878
+ "name": "returnSuggestions",
879
+ "in": "query",
880
+ "required": true,
881
+ "schema": {
882
+ "type": "string"
883
+ }
884
+ }
885
+ ],
886
+ "requestBody": {
887
+ "description": "indeterminate body object",
888
+ "content": {
889
+ "application/json": {
890
+ "schema": {
891
+ "type": "object"
892
+ }
893
+ }
894
+ }
895
+ }
896
+ }
897
+ },
898
+ "/shippingservices/v1/parcel-protection/quote": {
899
+ "post": {
900
+ "tags": [
901
+ "ParcelProtection"
902
+ ],
903
+ "operationId": "getParcelProtectionQuote",
904
+ "description": "The parameters and request body are for method: getParcelProtectionQuote. Same endpoint also used in methods:",
905
+ "responses": {
906
+ "200": {
907
+ "description": "Successful operation",
908
+ "content": {
909
+ "application/json": {
910
+ "schema": {
911
+ "type": "object",
912
+ "properties": {
913
+ "parcelProtectionFees": {
914
+ "type": "number"
915
+ },
916
+ "parcelProtectionFeesCurrencyCode": {
917
+ "type": "string"
918
+ },
919
+ "parcelProtectionFeesBreakup": {
920
+ "type": "object",
921
+ "properties": {
922
+ "basePremium": {
923
+ "type": "number"
924
+ },
925
+ "technologyFee": {
926
+ "type": "number"
927
+ }
928
+ }
929
+ }
930
+ }
931
+ },
932
+ "example": {
933
+ "parcelProtectionFees": 7.5,
934
+ "parcelProtectionFeesCurrencyCode": "USD",
935
+ "parcelProtectionFeesBreakup": {
936
+ "basePremium": 7.25,
937
+ "technologyFee": 0.25
938
+ }
939
+ }
940
+ }
941
+ }
942
+ }
943
+ },
944
+ "requestBody": {
945
+ "description": "indeterminate body object",
946
+ "content": {
947
+ "application/json": {
948
+ "schema": {
949
+ "type": "object"
950
+ }
951
+ }
952
+ }
953
+ }
954
+ }
955
+ },
956
+ "/shippingservices/v1/parcel-protection/create": {
957
+ "post": {
958
+ "tags": [
959
+ "ParcelProtection"
960
+ ],
961
+ "operationId": "getParcelProtectionCoverage",
962
+ "description": "The parameters and request body are for method: getParcelProtectionCoverage. Same endpoint also used in methods:",
963
+ "responses": {
964
+ "200": {
965
+ "description": "Successful operation",
966
+ "content": {
967
+ "application/json": {
968
+ "schema": {
969
+ "type": "object",
970
+ "properties": {
971
+ "transactionID": {
972
+ "type": "string"
973
+ },
974
+ "parcelProtectionReferenceID": {
975
+ "type": "string"
976
+ },
977
+ "parcelProtectionDate": {
978
+ "type": "string"
979
+ },
980
+ "parcelProtectionFees": {
981
+ "type": "number"
982
+ },
983
+ "parcelProtectionFeesCurrencyCode": {
984
+ "type": "string"
985
+ },
986
+ "parcelProtectionFeesBreakup": {
987
+ "type": "object",
988
+ "properties": {
989
+ "basePremium": {
990
+ "type": "number"
991
+ },
992
+ "technologyFee": {
993
+ "type": "number"
994
+ }
995
+ }
996
+ }
997
+ }
998
+ },
999
+ "example": {
1000
+ "transactionID": "44397664_ABCD1234_28d6fb80-6b92-4e69-b5bb-6656a00ce435",
1001
+ "parcelProtectionReferenceID": "IPPOL0000000012345678",
1002
+ "parcelProtectionDate": "2019-05-20 15:00:25.279+0000",
1003
+ "parcelProtectionFees": 7.5,
1004
+ "parcelProtectionFeesCurrencyCode": "USD",
1005
+ "parcelProtectionFeesBreakup": {
1006
+ "basePremium": 7.25,
1007
+ "technologyFee": 0.25
1008
+ }
1009
+ }
1010
+ }
1011
+ }
1012
+ }
1013
+ },
1014
+ "requestBody": {
1015
+ "description": "indeterminate body object",
1016
+ "content": {
1017
+ "application/json": {
1018
+ "schema": {
1019
+ "type": "object"
1020
+ }
1021
+ }
1022
+ }
1023
+ }
1024
+ }
1025
+ },
1026
+ "/shippingservices/v1/parcel-protection/void": {
1027
+ "post": {
1028
+ "tags": [
1029
+ "ParcelProtection"
1030
+ ],
1031
+ "operationId": "cancelParcelProtection",
1032
+ "description": "The parameters and request body are for method: cancelParcelProtection. Same endpoint also used in methods:",
1033
+ "responses": {
1034
+ "200": {
1035
+ "description": "Successful operation",
1036
+ "content": {
1037
+ "application/json": {
1038
+ "schema": {
1039
+ "type": "object",
1040
+ "properties": {
1041
+ "status": {
1042
+ "type": "string"
1043
+ }
1044
+ }
1045
+ },
1046
+ "example": {
1047
+ "status": "Void_Success"
1048
+ }
1049
+ }
1050
+ }
1051
+ }
1052
+ },
1053
+ "parameters": [
1054
+ {
1055
+ "name": "parcelProtectionReferenceId",
1056
+ "in": "query",
1057
+ "required": true,
1058
+ "schema": {
1059
+ "type": "string"
1060
+ }
1061
+ }
1062
+ ],
1063
+ "requestBody": {
1064
+ "description": "indeterminate body object",
1065
+ "content": {
1066
+ "application/json": {
1067
+ "schema": {
1068
+ "type": "object"
1069
+ }
1070
+ }
1071
+ }
1072
+ }
1073
+ }
1074
+ },
1075
+ "/shippingservices/v1/parcel-protection/{developerId}/policies": {
1076
+ "get": {
1077
+ "tags": [
1078
+ "ParcelProtection"
1079
+ ],
1080
+ "operationId": "getParcelProtectionReports",
1081
+ "description": "The parameters and request body are for method: getParcelProtectionReports. Same endpoint also used in methods:",
1082
+ "responses": {
1083
+ "200": {
1084
+ "description": "Successful operation",
1085
+ "content": {
1086
+ "application/json": {
1087
+ "schema": {
1088
+ "title": "result",
1089
+ "type": "object"
1090
+ }
1091
+ }
1092
+ }
1093
+ }
1094
+ },
1095
+ "parameters": [
1096
+ {
1097
+ "name": "developerId",
1098
+ "in": "path",
1099
+ "required": true,
1100
+ "schema": {
1101
+ "title": "developerId",
1102
+ "type": "string"
1103
+ }
1104
+ },
1105
+ {
1106
+ "name": "policyCreatedFromDate",
1107
+ "in": "query",
1108
+ "required": true,
1109
+ "schema": {
1110
+ "type": "string"
1111
+ }
1112
+ },
1113
+ {
1114
+ "name": "policyCreatedToDate",
1115
+ "in": "query",
1116
+ "required": true,
1117
+ "schema": {
1118
+ "type": "string"
1119
+ }
1120
+ },
1121
+ {
1122
+ "name": "policyReferenceId",
1123
+ "in": "query",
1124
+ "required": true,
1125
+ "schema": {
1126
+ "type": "string"
1127
+ }
1128
+ },
1129
+ {
1130
+ "name": "parcelTrackingNumber",
1131
+ "in": "query",
1132
+ "required": true,
1133
+ "schema": {
1134
+ "type": "string"
1135
+ }
1136
+ },
1137
+ {
1138
+ "name": "merchantId",
1139
+ "in": "query",
1140
+ "required": true,
1141
+ "schema": {
1142
+ "type": "string"
1143
+ }
1144
+ },
1145
+ {
1146
+ "name": "policyStatus",
1147
+ "in": "query",
1148
+ "required": true,
1149
+ "schema": {
1150
+ "type": "string"
1151
+ }
1152
+ },
1153
+ {
1154
+ "name": "size",
1155
+ "in": "query",
1156
+ "required": true,
1157
+ "schema": {
1158
+ "type": "string"
1159
+ }
1160
+ },
1161
+ {
1162
+ "name": "page",
1163
+ "in": "query",
1164
+ "required": true,
1165
+ "schema": {
1166
+ "type": "string"
1167
+ }
1168
+ },
1169
+ {
1170
+ "name": "sort",
1171
+ "in": "query",
1172
+ "required": true,
1173
+ "schema": {
1174
+ "type": "string"
1175
+ }
1176
+ }
1177
+ ],
1178
+ "requestBody": {
1179
+ "content": {
1180
+ "application/json": {
1181
+ "schema": {
1182
+ "type": "object"
1183
+ },
1184
+ "example": {}
1185
+ }
1186
+ }
1187
+ }
1188
+ }
1189
+ },
1190
+ "/shippingservices/v1/tracking/{trackingNumber}": {
1191
+ "get": {
1192
+ "tags": [
1193
+ "Tracking"
1194
+ ],
1195
+ "operationId": "getTrackingDetails",
1196
+ "description": "The parameters and request body are for method: getTrackingDetails. Same endpoint also used in methods:",
1197
+ "responses": {
1198
+ "200": {
1199
+ "description": "Successful operation",
1200
+ "content": {
1201
+ "application/json": {
1202
+ "schema": {
1203
+ "title": "result",
1204
+ "type": "object"
1205
+ }
1206
+ }
1207
+ }
1208
+ }
1209
+ },
1210
+ "parameters": [
1211
+ {
1212
+ "name": "trackingNumber",
1213
+ "in": "path",
1214
+ "required": true,
1215
+ "schema": {
1216
+ "title": "trackingNumber",
1217
+ "type": "string"
1218
+ }
1219
+ },
1220
+ {
1221
+ "name": "packageIdentifierType",
1222
+ "in": "query",
1223
+ "required": true,
1224
+ "schema": {
1225
+ "type": "string"
1226
+ }
1227
+ },
1228
+ {
1229
+ "name": "carrier",
1230
+ "in": "query",
1231
+ "required": true,
1232
+ "schema": {
1233
+ "type": "string"
1234
+ }
1235
+ }
1236
+ ],
1237
+ "requestBody": {
1238
+ "content": {
1239
+ "application/json": {
1240
+ "schema": {
1241
+ "type": "object"
1242
+ },
1243
+ "example": {}
1244
+ }
1245
+ }
1246
+ }
1247
+ }
1248
+ },
1249
+ "/v2/track/events": {
1250
+ "post": {
1251
+ "tags": [
1252
+ "Tracking"
1253
+ ],
1254
+ "operationId": "addTrackingEvents",
1255
+ "description": "The parameters and request body are for method: addTrackingEvents. Same endpoint also used in methods:",
1256
+ "responses": {
1257
+ "200": {
1258
+ "description": "Successful operation",
1259
+ "content": {
1260
+ "application/json": {
1261
+ "schema": {
1262
+ "type": "object",
1263
+ "properties": {
1264
+ "status": {
1265
+ "type": "string"
1266
+ }
1267
+ }
1268
+ },
1269
+ "example": {
1270
+ "status": "success"
1271
+ }
1272
+ }
1273
+ }
1274
+ }
1275
+ },
1276
+ "requestBody": {
1277
+ "description": "indeterminate body object",
1278
+ "content": {
1279
+ "application/json": {
1280
+ "schema": {
1281
+ "type": "object"
1282
+ }
1283
+ }
1284
+ }
1285
+ }
1286
+ }
1287
+ },
1288
+ "/shippingservices/v1/crossborder/checkout/quotes": {
1289
+ "post": {
1290
+ "tags": [
1291
+ "CrossBorderQuotes"
1292
+ ],
1293
+ "operationId": "getCrossBorderQuotes",
1294
+ "description": "The parameters and request body are for method: getCrossBorderQuotes. Same endpoint also used in methods:",
1295
+ "responses": {
1296
+ "200": {
1297
+ "description": "Successful operation",
1298
+ "content": {
1299
+ "application/json": {
1300
+ "schema": {
1301
+ "type": "object",
1302
+ "properties": {
1303
+ "quote": {
1304
+ "type": "array",
1305
+ "items": {
1306
+ "type": "object",
1307
+ "properties": {
1308
+ "quoteCurrency": {
1309
+ "type": "string"
1310
+ },
1311
+ "quoteLines": {
1312
+ "type": "array",
1313
+ "items": {
1314
+ "type": "object",
1315
+ "properties": {
1316
+ "lineId": {
1317
+ "type": "string"
1318
+ },
1319
+ "itemId": {
1320
+ "type": "string"
1321
+ },
1322
+ "quoteLineId": {
1323
+ "type": "string"
1324
+ },
1325
+ "quantity": {
1326
+ "type": "number"
1327
+ },
1328
+ "unitRates": {
1329
+ "type": "object",
1330
+ "properties": {
1331
+ "unitPrice": {
1332
+ "type": "number"
1333
+ },
1334
+ "totalTaxAmount": {
1335
+ "type": "number"
1336
+ },
1337
+ "totalDutyAmount": {
1338
+ "type": "number"
1339
+ },
1340
+ "serviceId": {
1341
+ "type": "string"
1342
+ },
1343
+ "baseCharge": {
1344
+ "type": "number"
1345
+ },
1346
+ "deliveryCommitment": {
1347
+ "type": "object",
1348
+ "properties": {
1349
+ "minEstimatedNumberOfDays": {
1350
+ "type": "number"
1351
+ },
1352
+ "maxEstimatedNumberOfDays": {
1353
+ "type": "number"
1354
+ }
1355
+ }
1356
+ },
1357
+ "totalCarrierCharge": {
1358
+ "type": "number"
1359
+ }
1360
+ }
1361
+ },
1362
+ "lineRates": {
1363
+ "type": "object",
1364
+ "properties": {
1365
+ "linePrice": {
1366
+ "type": "number"
1367
+ },
1368
+ "totalTaxAmount": {
1369
+ "type": "number"
1370
+ },
1371
+ "totalDutyAmount": {
1372
+ "type": "number"
1373
+ },
1374
+ "serviceId": {
1375
+ "type": "string"
1376
+ },
1377
+ "baseCharge": {
1378
+ "type": "number"
1379
+ },
1380
+ "deliveryCommitment": {
1381
+ "type": "object",
1382
+ "properties": {
1383
+ "minEstimatedNumberOfDays": {
1384
+ "type": "number"
1385
+ },
1386
+ "maxEstimatedNumberOfDays": {
1387
+ "type": "number"
1388
+ }
1389
+ }
1390
+ },
1391
+ "totalCarrierCharge": {
1392
+ "type": "number"
1393
+ }
1394
+ }
1395
+ }
1396
+ }
1397
+ }
1398
+ },
1399
+ "totalPrice": {
1400
+ "type": "number"
1401
+ },
1402
+ "totalRates": {
1403
+ "type": "object",
1404
+ "properties": {
1405
+ "serviceId": {
1406
+ "type": "string"
1407
+ },
1408
+ "baseCharge": {
1409
+ "type": "number"
1410
+ },
1411
+ "deliveryCommitment": {
1412
+ "type": "object",
1413
+ "properties": {
1414
+ "minEstimatedNumberOfDays": {
1415
+ "type": "number"
1416
+ },
1417
+ "maxEstimatedNumberOfDays": {
1418
+ "type": "number"
1419
+ }
1420
+ }
1421
+ },
1422
+ "totalCarrierCharge": {
1423
+ "type": "number"
1424
+ },
1425
+ "totalDutyAmount": {
1426
+ "type": "number"
1427
+ },
1428
+ "totalTaxAmount": {
1429
+ "type": "number"
1430
+ }
1431
+ }
1432
+ }
1433
+ }
1434
+ }
1435
+ }
1436
+ }
1437
+ },
1438
+ "example": {
1439
+ "quote": [
1440
+ {
1441
+ "quoteCurrency": "USD",
1442
+ "quoteLines": [
1443
+ {
1444
+ "lineId": "1",
1445
+ "itemId": "G_123456",
1446
+ "quoteLineId": "1",
1447
+ "quantity": 2,
1448
+ "unitRates": {
1449
+ "unitPrice": 19.99,
1450
+ "totalTaxAmount": 3.12,
1451
+ "totalDutyAmount": 4,
1452
+ "serviceId": "PBXPS",
1453
+ "baseCharge": 23.62,
1454
+ "deliveryCommitment": {
1455
+ "minEstimatedNumberOfDays": 3,
1456
+ "maxEstimatedNumberOfDays": 6
1457
+ },
1458
+ "totalCarrierCharge": 30.74
1459
+ },
1460
+ "lineRates": {
1461
+ "linePrice": 39.98,
1462
+ "totalTaxAmount": 6.24,
1463
+ "totalDutyAmount": 8,
1464
+ "serviceId": "PBXPS",
1465
+ "baseCharge": 47.24,
1466
+ "deliveryCommitment": {
1467
+ "minEstimatedNumberOfDays": 3,
1468
+ "maxEstimatedNumberOfDays": 6
1469
+ },
1470
+ "totalCarrierCharge": 61.48
1471
+ }
1472
+ }
1473
+ ],
1474
+ "totalPrice": 39.98,
1475
+ "totalRates": {
1476
+ "serviceId": "PBXPS",
1477
+ "baseCharge": 47.24,
1478
+ "deliveryCommitment": {
1479
+ "minEstimatedNumberOfDays": 3,
1480
+ "maxEstimatedNumberOfDays": 6
1481
+ },
1482
+ "totalCarrierCharge": 61.48,
1483
+ "totalDutyAmount": 8,
1484
+ "totalTaxAmount": 6.24
1485
+ }
1486
+ }
1487
+ ]
1488
+ }
1489
+ }
1490
+ }
1491
+ }
1492
+ },
1493
+ "requestBody": {
1494
+ "description": "indeterminate body object",
1495
+ "content": {
1496
+ "application/json": {
1497
+ "schema": {
1498
+ "type": "object"
1499
+ }
1500
+ }
1501
+ }
1502
+ }
1503
+ }
1504
+ },
1505
+ "/shippingservices/v1/crossborder/hs-classification/items": {
1506
+ "post": {
1507
+ "tags": [
1508
+ "CrossBorderQuotes"
1509
+ ],
1510
+ "operationId": "predictedHSCode",
1511
+ "description": "The parameters and request body are for method: predictedHSCode. Same endpoint also used in methods:",
1512
+ "responses": {
1513
+ "200": {
1514
+ "description": "Successful operation",
1515
+ "content": {
1516
+ "application/json": {
1517
+ "schema": {
1518
+ "title": "result",
1519
+ "type": "object"
1520
+ }
1521
+ }
1522
+ }
1523
+ }
1524
+ },
1525
+ "requestBody": {
1526
+ "description": "indeterminate body object",
1527
+ "content": {
1528
+ "application/json": {
1529
+ "schema": {
1530
+ "type": "object"
1531
+ }
1532
+ }
1533
+ }
1534
+ }
1535
+ }
1536
+ },
1537
+ "/shippingservices/v1/container-manifest": {
1538
+ "post": {
1539
+ "tags": [
1540
+ "Container"
1541
+ ],
1542
+ "operationId": "getContainerizedParcelsLabels",
1543
+ "description": "The parameters and request body are for method: getContainerizedParcelsLabels. Same endpoint also used in methods:",
1544
+ "responses": {
1545
+ "200": {
1546
+ "description": "Successful operation",
1547
+ "content": {
1548
+ "application/json": {
1549
+ "schema": {
1550
+ "title": "result",
1551
+ "type": "object"
1552
+ }
1553
+ }
1554
+ }
1555
+ }
1556
+ },
1557
+ "requestBody": {
1558
+ "description": "indeterminate body object",
1559
+ "content": {
1560
+ "application/json": {
1561
+ "schema": {
1562
+ "type": "object"
1563
+ }
1564
+ }
1565
+ }
1566
+ }
1567
+ }
1568
+ }
1569
+ },
1570
+ "components": {
1571
+ "schemas": {}
1572
+ }
1573
+ }