@dockflow/sdk 0.0.0-stage → 0.2.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.
- package/.openapi-generator/FILES +89 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +157 -2
- package/dist/apis/V3DocumentApi.d.ts +111 -0
- package/dist/apis/V3DocumentApi.js +269 -0
- package/dist/apis/V3DownstreamApi.d.ts +63 -0
- package/dist/apis/V3DownstreamApi.js +138 -0
- package/dist/apis/V3UpstreamApi.d.ts +92 -0
- package/dist/apis/V3UpstreamApi.js +122 -0
- package/dist/apis/WidgetApi.d.ts +38 -0
- package/dist/apis/WidgetApi.js +83 -0
- package/dist/apis/index.d.ts +4 -0
- package/dist/apis/index.js +22 -0
- package/dist/esm/apis/V3DocumentApi.d.ts +111 -0
- package/dist/esm/apis/V3DocumentApi.js +265 -0
- package/dist/esm/apis/V3DownstreamApi.d.ts +63 -0
- package/dist/esm/apis/V3DownstreamApi.js +134 -0
- package/dist/esm/apis/V3UpstreamApi.d.ts +92 -0
- package/dist/esm/apis/V3UpstreamApi.js +118 -0
- package/dist/esm/apis/WidgetApi.d.ts +38 -0
- package/dist/esm/apis/WidgetApi.js +79 -0
- package/dist/esm/apis/index.d.ts +4 -0
- package/dist/esm/apis/index.js +6 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/ContainerReference.d.ts +34 -0
- package/dist/esm/models/ContainerReference.js +45 -0
- package/dist/esm/models/DocumentUpdate.d.ts +38 -0
- package/dist/esm/models/DocumentUpdate.js +45 -0
- package/dist/esm/models/DocumentUpload.d.ts +70 -0
- package/dist/esm/models/DocumentUpload.js +76 -0
- package/dist/esm/models/DownstreamTradeflow.d.ts +150 -0
- package/dist/esm/models/DownstreamTradeflow.js +108 -0
- package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.d.ts +26 -0
- package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.js +31 -0
- package/dist/esm/models/DownstreamTradeflowBookingReference.d.ts +26 -0
- package/dist/esm/models/DownstreamTradeflowBookingReference.js +31 -0
- package/dist/esm/models/DownstreamTradeflowEventsInner.d.ts +46 -0
- package/dist/esm/models/DownstreamTradeflowEventsInner.js +54 -0
- package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +53 -0
- package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.js +59 -0
- package/dist/esm/models/DownstreamTradeflowMockTracking.d.ts +30 -0
- package/dist/esm/models/DownstreamTradeflowMockTracking.js +41 -0
- package/dist/esm/models/DownstreamTradeflowPartnersInner.d.ts +42 -0
- package/dist/esm/models/DownstreamTradeflowPartnersInner.js +49 -0
- package/dist/esm/models/DownstreamTradeflowReferences.d.ts +38 -0
- package/dist/esm/models/DownstreamTradeflowReferences.js +45 -0
- package/dist/esm/models/InlineObject.d.ts +36 -0
- package/dist/esm/models/InlineObject.js +47 -0
- package/dist/esm/models/ListDocumentTypes200ResponseInner.d.ts +34 -0
- package/dist/esm/models/ListDocumentTypes200ResponseInner.js +47 -0
- package/dist/esm/models/UpstreamRecord.d.ts +77 -0
- package/dist/esm/models/UpstreamRecord.js +80 -0
- package/dist/esm/models/UpstreamRecordAdditionalReferences.d.ts +34 -0
- package/dist/esm/models/UpstreamRecordAdditionalReferences.js +43 -0
- package/dist/esm/models/UpstreamRecordDataQuality.d.ts +46 -0
- package/dist/esm/models/UpstreamRecordDataQuality.js +49 -0
- package/dist/esm/models/UpstreamRecordMetadata.d.ts +42 -0
- package/dist/esm/models/UpstreamRecordMetadata.js +48 -0
- package/dist/esm/models/V3DocumentGet200Response.d.ts +39 -0
- package/dist/esm/models/V3DocumentGet200Response.js +52 -0
- package/dist/esm/models/V3DocumentGet200ResponseDataInner.d.ts +63 -0
- package/dist/esm/models/V3DocumentGet200ResponseDataInner.js +76 -0
- package/dist/esm/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +34 -0
- package/dist/esm/models/V3DocumentGet200ResponseDataInnerDocumentType.js +47 -0
- package/dist/esm/models/V3DocumentPost202Response.d.ts +54 -0
- package/dist/esm/models/V3DocumentPost202Response.js +67 -0
- package/dist/esm/models/V3DocumentPost400Response.d.ts +26 -0
- package/dist/esm/models/V3DocumentPost400Response.js +31 -0
- package/dist/esm/models/V3DownstreamPost202Response.d.ts +42 -0
- package/dist/esm/models/V3DownstreamPost202Response.js +56 -0
- package/dist/esm/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +34 -0
- package/dist/esm/models/V3DownstreamPost202ResponseTradeflowsInner.js +47 -0
- package/dist/esm/models/V3UpstreamGet200Response.d.ts +35 -0
- package/dist/esm/models/V3UpstreamGet200Response.js +48 -0
- package/dist/esm/models/V3UpstreamGet400Response.d.ts +26 -0
- package/dist/esm/models/V3UpstreamGet400Response.js +31 -0
- package/dist/esm/models/WidgetContainer.d.ts +47 -0
- package/dist/esm/models/WidgetContainer.js +60 -0
- package/dist/esm/models/WidgetCountry.d.ts +34 -0
- package/dist/esm/models/WidgetCountry.js +47 -0
- package/dist/esm/models/WidgetLeg.d.ts +43 -0
- package/dist/esm/models/WidgetLeg.js +56 -0
- package/dist/esm/models/WidgetLocation.d.ts +48 -0
- package/dist/esm/models/WidgetLocation.js +61 -0
- package/dist/esm/models/WidgetMilestone.d.ts +43 -0
- package/dist/esm/models/WidgetMilestone.js +56 -0
- package/dist/esm/models/WidgetPoint.d.ts +34 -0
- package/dist/esm/models/WidgetPoint.js +47 -0
- package/dist/esm/models/WidgetSearchResult.d.ts +65 -0
- package/dist/esm/models/WidgetSearchResult.js +78 -0
- package/dist/esm/models/WidgetTrack.d.ts +35 -0
- package/dist/esm/models/WidgetTrack.js +48 -0
- package/dist/esm/models/WidgetTrackReading.d.ts +38 -0
- package/dist/esm/models/WidgetTrackReading.js +51 -0
- package/dist/esm/models/index.d.ts +35 -0
- package/dist/esm/models/index.js +37 -0
- package/dist/esm/runtime.d.ts +217 -0
- package/dist/esm/runtime.js +460 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/ContainerReference.d.ts +34 -0
- package/dist/models/ContainerReference.js +52 -0
- package/dist/models/DocumentUpdate.d.ts +38 -0
- package/dist/models/DocumentUpdate.js +52 -0
- package/dist/models/DocumentUpload.d.ts +70 -0
- package/dist/models/DocumentUpload.js +84 -0
- package/dist/models/DownstreamTradeflow.d.ts +150 -0
- package/dist/models/DownstreamTradeflow.js +115 -0
- package/dist/models/DownstreamTradeflowBillOfLadingReference.d.ts +26 -0
- package/dist/models/DownstreamTradeflowBillOfLadingReference.js +38 -0
- package/dist/models/DownstreamTradeflowBookingReference.d.ts +26 -0
- package/dist/models/DownstreamTradeflowBookingReference.js +38 -0
- package/dist/models/DownstreamTradeflowEventsInner.d.ts +46 -0
- package/dist/models/DownstreamTradeflowEventsInner.js +61 -0
- package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +53 -0
- package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.js +67 -0
- package/dist/models/DownstreamTradeflowMockTracking.d.ts +30 -0
- package/dist/models/DownstreamTradeflowMockTracking.js +48 -0
- package/dist/models/DownstreamTradeflowPartnersInner.d.ts +42 -0
- package/dist/models/DownstreamTradeflowPartnersInner.js +56 -0
- package/dist/models/DownstreamTradeflowReferences.d.ts +38 -0
- package/dist/models/DownstreamTradeflowReferences.js +52 -0
- package/dist/models/InlineObject.d.ts +36 -0
- package/dist/models/InlineObject.js +54 -0
- package/dist/models/ListDocumentTypes200ResponseInner.d.ts +34 -0
- package/dist/models/ListDocumentTypes200ResponseInner.js +54 -0
- package/dist/models/UpstreamRecord.d.ts +77 -0
- package/dist/models/UpstreamRecord.js +87 -0
- package/dist/models/UpstreamRecordAdditionalReferences.d.ts +34 -0
- package/dist/models/UpstreamRecordAdditionalReferences.js +50 -0
- package/dist/models/UpstreamRecordDataQuality.d.ts +46 -0
- package/dist/models/UpstreamRecordDataQuality.js +56 -0
- package/dist/models/UpstreamRecordMetadata.d.ts +42 -0
- package/dist/models/UpstreamRecordMetadata.js +55 -0
- package/dist/models/V3DocumentGet200Response.d.ts +39 -0
- package/dist/models/V3DocumentGet200Response.js +59 -0
- package/dist/models/V3DocumentGet200ResponseDataInner.d.ts +63 -0
- package/dist/models/V3DocumentGet200ResponseDataInner.js +83 -0
- package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +34 -0
- package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.js +54 -0
- package/dist/models/V3DocumentPost202Response.d.ts +54 -0
- package/dist/models/V3DocumentPost202Response.js +74 -0
- package/dist/models/V3DocumentPost400Response.d.ts +26 -0
- package/dist/models/V3DocumentPost400Response.js +38 -0
- package/dist/models/V3DownstreamPost202Response.d.ts +42 -0
- package/dist/models/V3DownstreamPost202Response.js +64 -0
- package/dist/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +34 -0
- package/dist/models/V3DownstreamPost202ResponseTradeflowsInner.js +54 -0
- package/dist/models/V3UpstreamGet200Response.d.ts +35 -0
- package/dist/models/V3UpstreamGet200Response.js +55 -0
- package/dist/models/V3UpstreamGet400Response.d.ts +26 -0
- package/dist/models/V3UpstreamGet400Response.js +38 -0
- package/dist/models/WidgetContainer.d.ts +47 -0
- package/dist/models/WidgetContainer.js +67 -0
- package/dist/models/WidgetCountry.d.ts +34 -0
- package/dist/models/WidgetCountry.js +54 -0
- package/dist/models/WidgetLeg.d.ts +43 -0
- package/dist/models/WidgetLeg.js +63 -0
- package/dist/models/WidgetLocation.d.ts +48 -0
- package/dist/models/WidgetLocation.js +68 -0
- package/dist/models/WidgetMilestone.d.ts +43 -0
- package/dist/models/WidgetMilestone.js +63 -0
- package/dist/models/WidgetPoint.d.ts +34 -0
- package/dist/models/WidgetPoint.js +54 -0
- package/dist/models/WidgetSearchResult.d.ts +65 -0
- package/dist/models/WidgetSearchResult.js +85 -0
- package/dist/models/WidgetTrack.d.ts +35 -0
- package/dist/models/WidgetTrack.js +55 -0
- package/dist/models/WidgetTrackReading.d.ts +38 -0
- package/dist/models/WidgetTrackReading.js +58 -0
- package/dist/models/index.d.ts +35 -0
- package/dist/models/index.js +53 -0
- package/dist/runtime.d.ts +217 -0
- package/dist/runtime.js +482 -0
- package/docs/ContainerReference.md +36 -0
- package/docs/DocumentUpdate.md +39 -0
- package/docs/DocumentUpload.md +44 -0
- package/docs/DownstreamTradeflow.md +91 -0
- package/docs/DownstreamTradeflowBillOfLadingReference.md +33 -0
- package/docs/DownstreamTradeflowBookingReference.md +33 -0
- package/docs/DownstreamTradeflowEventsInner.md +42 -0
- package/docs/DownstreamTradeflowFreeTimeOverridesInner.md +40 -0
- package/docs/DownstreamTradeflowMockTracking.md +35 -0
- package/docs/DownstreamTradeflowPartnersInner.md +40 -0
- package/docs/DownstreamTradeflowReferences.md +38 -0
- package/docs/InlineObject.md +36 -0
- package/docs/ListDocumentTypes200ResponseInner.md +36 -0
- package/docs/UpstreamRecord.md +57 -0
- package/docs/UpstreamRecordAdditionalReferences.md +36 -0
- package/docs/UpstreamRecordDataQuality.md +42 -0
- package/docs/UpstreamRecordMetadata.md +40 -0
- package/docs/V3DocumentApi.md +361 -0
- package/docs/V3DocumentGet200Response.md +38 -0
- package/docs/V3DocumentGet200ResponseDataInner.md +50 -0
- package/docs/V3DocumentGet200ResponseDataInnerDocumentType.md +36 -0
- package/docs/V3DocumentPost202Response.md +46 -0
- package/docs/V3DocumentPost400Response.md +32 -0
- package/docs/V3DownstreamApi.md +158 -0
- package/docs/V3DownstreamPost202Response.md +36 -0
- package/docs/V3DownstreamPost202ResponseTradeflowsInner.md +36 -0
- package/docs/V3UpstreamApi.md +109 -0
- package/docs/V3UpstreamGet200Response.md +36 -0
- package/docs/V3UpstreamGet400Response.md +32 -0
- package/docs/WidgetApi.md +81 -0
- package/docs/WidgetContainer.md +42 -0
- package/docs/WidgetCountry.md +36 -0
- package/docs/WidgetLeg.md +40 -0
- package/docs/WidgetLocation.md +42 -0
- package/docs/WidgetMilestone.md +40 -0
- package/docs/WidgetPoint.md +36 -0
- package/docs/WidgetSearchResult.md +50 -0
- package/docs/WidgetTrack.md +36 -0
- package/docs/WidgetTrackReading.md +38 -0
- package/package.json +20 -4
- package/src/apis/V3DocumentApi.ts +357 -0
- package/src/apis/V3DownstreamApi.ts +174 -0
- package/src/apis/V3UpstreamApi.ts +185 -0
- package/src/apis/WidgetApi.ts +97 -0
- package/src/apis/index.ts +6 -0
- package/src/index.ts +5 -0
- package/src/models/ContainerReference.ts +70 -0
- package/src/models/DocumentUpdate.ts +75 -0
- package/src/models/DocumentUpload.ts +119 -0
- package/src/models/DownstreamTradeflow.ts +289 -0
- package/src/models/DownstreamTradeflowBillOfLadingReference.ts +46 -0
- package/src/models/DownstreamTradeflowBookingReference.ts +46 -0
- package/src/models/DownstreamTradeflowEventsInner.ts +89 -0
- package/src/models/DownstreamTradeflowFreeTimeOverridesInner.ts +96 -0
- package/src/models/DownstreamTradeflowMockTracking.ts +63 -0
- package/src/models/DownstreamTradeflowPartnersInner.ts +82 -0
- package/src/models/DownstreamTradeflowReferences.ts +75 -0
- package/src/models/InlineObject.ts +71 -0
- package/src/models/ListDocumentTypes200ResponseInner.ts +71 -0
- package/src/models/UpstreamRecord.ts +158 -0
- package/src/models/UpstreamRecordAdditionalReferences.ts +69 -0
- package/src/models/UpstreamRecordDataQuality.ts +87 -0
- package/src/models/UpstreamRecordMetadata.ts +81 -0
- package/src/models/V3DocumentGet200Response.ts +86 -0
- package/src/models/V3DocumentGet200ResponseDataInner.ts +128 -0
- package/src/models/V3DocumentGet200ResponseDataInnerDocumentType.ts +71 -0
- package/src/models/V3DocumentPost202Response.ts +106 -0
- package/src/models/V3DocumentPost400Response.ts +46 -0
- package/src/models/V3DownstreamPost202Response.ts +91 -0
- package/src/models/V3DownstreamPost202ResponseTradeflowsInner.ts +71 -0
- package/src/models/V3UpstreamGet200Response.ts +79 -0
- package/src/models/V3UpstreamGet400Response.ts +46 -0
- package/src/models/WidgetContainer.ts +100 -0
- package/src/models/WidgetCountry.ts +71 -0
- package/src/models/WidgetLeg.ts +93 -0
- package/src/models/WidgetLocation.ts +107 -0
- package/src/models/WidgetMilestone.ts +93 -0
- package/src/models/WidgetPoint.ts +71 -0
- package/src/models/WidgetSearchResult.ts +142 -0
- package/src/models/WidgetTrack.ts +79 -0
- package/src/models/WidgetTrackReading.ts +78 -0
- package/src/models/index.ts +37 -0
- package/src/runtime.ts +572 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
.npmignore
|
|
3
|
+
.openapi-generator-ignore
|
|
4
|
+
README.md
|
|
5
|
+
docs/ContainerReference.md
|
|
6
|
+
docs/DocumentUpdate.md
|
|
7
|
+
docs/DocumentUpload.md
|
|
8
|
+
docs/DownstreamTradeflow.md
|
|
9
|
+
docs/DownstreamTradeflowBillOfLadingReference.md
|
|
10
|
+
docs/DownstreamTradeflowBookingReference.md
|
|
11
|
+
docs/DownstreamTradeflowEventsInner.md
|
|
12
|
+
docs/DownstreamTradeflowFreeTimeOverridesInner.md
|
|
13
|
+
docs/DownstreamTradeflowMockTracking.md
|
|
14
|
+
docs/DownstreamTradeflowPartnersInner.md
|
|
15
|
+
docs/DownstreamTradeflowReferences.md
|
|
16
|
+
docs/InlineObject.md
|
|
17
|
+
docs/ListDocumentTypes200ResponseInner.md
|
|
18
|
+
docs/UpstreamRecord.md
|
|
19
|
+
docs/UpstreamRecordAdditionalReferences.md
|
|
20
|
+
docs/UpstreamRecordDataQuality.md
|
|
21
|
+
docs/UpstreamRecordMetadata.md
|
|
22
|
+
docs/V3DocumentApi.md
|
|
23
|
+
docs/V3DocumentGet200Response.md
|
|
24
|
+
docs/V3DocumentGet200ResponseDataInner.md
|
|
25
|
+
docs/V3DocumentGet200ResponseDataInnerDocumentType.md
|
|
26
|
+
docs/V3DocumentPost202Response.md
|
|
27
|
+
docs/V3DocumentPost400Response.md
|
|
28
|
+
docs/V3DownstreamApi.md
|
|
29
|
+
docs/V3DownstreamPost202Response.md
|
|
30
|
+
docs/V3DownstreamPost202ResponseTradeflowsInner.md
|
|
31
|
+
docs/V3UpstreamApi.md
|
|
32
|
+
docs/V3UpstreamGet200Response.md
|
|
33
|
+
docs/V3UpstreamGet400Response.md
|
|
34
|
+
docs/WidgetApi.md
|
|
35
|
+
docs/WidgetContainer.md
|
|
36
|
+
docs/WidgetCountry.md
|
|
37
|
+
docs/WidgetLeg.md
|
|
38
|
+
docs/WidgetLocation.md
|
|
39
|
+
docs/WidgetMilestone.md
|
|
40
|
+
docs/WidgetPoint.md
|
|
41
|
+
docs/WidgetSearchResult.md
|
|
42
|
+
docs/WidgetTrack.md
|
|
43
|
+
docs/WidgetTrackReading.md
|
|
44
|
+
package.json
|
|
45
|
+
src/apis/V3DocumentApi.ts
|
|
46
|
+
src/apis/V3DownstreamApi.ts
|
|
47
|
+
src/apis/V3UpstreamApi.ts
|
|
48
|
+
src/apis/WidgetApi.ts
|
|
49
|
+
src/apis/index.ts
|
|
50
|
+
src/index.ts
|
|
51
|
+
src/models/ContainerReference.ts
|
|
52
|
+
src/models/DocumentUpdate.ts
|
|
53
|
+
src/models/DocumentUpload.ts
|
|
54
|
+
src/models/DownstreamTradeflow.ts
|
|
55
|
+
src/models/DownstreamTradeflowBillOfLadingReference.ts
|
|
56
|
+
src/models/DownstreamTradeflowBookingReference.ts
|
|
57
|
+
src/models/DownstreamTradeflowEventsInner.ts
|
|
58
|
+
src/models/DownstreamTradeflowFreeTimeOverridesInner.ts
|
|
59
|
+
src/models/DownstreamTradeflowMockTracking.ts
|
|
60
|
+
src/models/DownstreamTradeflowPartnersInner.ts
|
|
61
|
+
src/models/DownstreamTradeflowReferences.ts
|
|
62
|
+
src/models/InlineObject.ts
|
|
63
|
+
src/models/ListDocumentTypes200ResponseInner.ts
|
|
64
|
+
src/models/UpstreamRecord.ts
|
|
65
|
+
src/models/UpstreamRecordAdditionalReferences.ts
|
|
66
|
+
src/models/UpstreamRecordDataQuality.ts
|
|
67
|
+
src/models/UpstreamRecordMetadata.ts
|
|
68
|
+
src/models/V3DocumentGet200Response.ts
|
|
69
|
+
src/models/V3DocumentGet200ResponseDataInner.ts
|
|
70
|
+
src/models/V3DocumentGet200ResponseDataInnerDocumentType.ts
|
|
71
|
+
src/models/V3DocumentPost202Response.ts
|
|
72
|
+
src/models/V3DocumentPost400Response.ts
|
|
73
|
+
src/models/V3DownstreamPost202Response.ts
|
|
74
|
+
src/models/V3DownstreamPost202ResponseTradeflowsInner.ts
|
|
75
|
+
src/models/V3UpstreamGet200Response.ts
|
|
76
|
+
src/models/V3UpstreamGet400Response.ts
|
|
77
|
+
src/models/WidgetContainer.ts
|
|
78
|
+
src/models/WidgetCountry.ts
|
|
79
|
+
src/models/WidgetLeg.ts
|
|
80
|
+
src/models/WidgetLocation.ts
|
|
81
|
+
src/models/WidgetMilestone.ts
|
|
82
|
+
src/models/WidgetPoint.ts
|
|
83
|
+
src/models/WidgetSearchResult.ts
|
|
84
|
+
src/models/WidgetTrack.ts
|
|
85
|
+
src/models/WidgetTrackReading.ts
|
|
86
|
+
src/models/index.ts
|
|
87
|
+
src/runtime.ts
|
|
88
|
+
tsconfig.esm.json
|
|
89
|
+
tsconfig.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
7.27.0
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OpenAPI Generator Ignore
|
|
2
|
+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
+
|
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
+
|
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
+
#ApiClient.cs
|
|
10
|
+
|
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
+
#foo/*/qux
|
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
+
|
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
+
#foo/**/qux
|
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
+
|
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
+
#docs/*.md
|
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
+
#!docs/README.md
|
package/README.md
CHANGED
|
@@ -1,3 +1,158 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @dockflow/sdk@0.2.0
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A TypeScript SDK client for the api.dockflow.com API.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
First, install the SDK from npm.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @dockflow/sdk --save
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Next, try it out.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import {
|
|
18
|
+
Configuration,
|
|
19
|
+
V3DocumentApi,
|
|
20
|
+
} from '@dockflow/sdk';
|
|
21
|
+
import type { ListDocumentTypesRequest } from '@dockflow/sdk';
|
|
22
|
+
|
|
23
|
+
async function example() {
|
|
24
|
+
console.log("🚀 Testing @dockflow/sdk SDK...");
|
|
25
|
+
const config = new Configuration({
|
|
26
|
+
// Configure HTTP bearer authorization: ApiKey
|
|
27
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
28
|
+
});
|
|
29
|
+
const api = new V3DocumentApi(config);
|
|
30
|
+
|
|
31
|
+
try {
|
|
32
|
+
const data = await api.listDocumentTypes();
|
|
33
|
+
console.log(data);
|
|
34
|
+
} catch (error) {
|
|
35
|
+
console.error(error);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// Run the test
|
|
40
|
+
example().catch(console.error);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Documentation
|
|
45
|
+
|
|
46
|
+
### API Endpoints
|
|
47
|
+
|
|
48
|
+
All URIs are relative to *https://api.dockflow.com*
|
|
49
|
+
|
|
50
|
+
| Class | Method | HTTP request | Description
|
|
51
|
+
| ----- | ------ | ------------ | -------------
|
|
52
|
+
*V3DocumentApi* | [**listDocumentTypes**](docs/V3DocumentApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types
|
|
53
|
+
*V3DocumentApi* | [**v3DocumentDelete**](docs/V3DocumentApi.md#v3documentdelete) | **DELETE** /v3/downstream/documents/{reference} | Delete a document
|
|
54
|
+
*V3DocumentApi* | [**v3DocumentGet**](docs/V3DocumentApi.md#v3documentget) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow
|
|
55
|
+
*V3DocumentApi* | [**v3DocumentPatch**](docs/V3DocumentApi.md#v3documentpatch) | **PATCH** /v3/downstream/documents/{reference} | Update a document
|
|
56
|
+
*V3DocumentApi* | [**v3DocumentPost**](docs/V3DocumentApi.md#v3documentpost) | **POST** /v3/downstream/documents | Upload a document to a tradeflow
|
|
57
|
+
*V3DownstreamApi* | [**v3DownstreamDelete**](docs/V3DownstreamApi.md#v3downstreamdelete) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow
|
|
58
|
+
*V3DownstreamApi* | [**v3DownstreamPost**](docs/V3DownstreamApi.md#v3downstreampost) | **POST** /v3/downstream/tradeflows | Upsert tradeflows
|
|
59
|
+
*V3UpstreamApi* | [**v3UpstreamGet**](docs/V3UpstreamApi.md#v3upstreamget) | **GET** /v3/upstream | Poll upstream events
|
|
60
|
+
*WidgetApi* | [**searchWidget**](docs/WidgetApi.md#searchwidget) | **GET** /v3/widget/search | Search a shipment for the embeddable tracking widget
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Models
|
|
64
|
+
|
|
65
|
+
- [ContainerReference](docs/ContainerReference.md)
|
|
66
|
+
- [DocumentUpdate](docs/DocumentUpdate.md)
|
|
67
|
+
- [DocumentUpload](docs/DocumentUpload.md)
|
|
68
|
+
- [DownstreamTradeflow](docs/DownstreamTradeflow.md)
|
|
69
|
+
- [DownstreamTradeflowBillOfLadingReference](docs/DownstreamTradeflowBillOfLadingReference.md)
|
|
70
|
+
- [DownstreamTradeflowBookingReference](docs/DownstreamTradeflowBookingReference.md)
|
|
71
|
+
- [DownstreamTradeflowEventsInner](docs/DownstreamTradeflowEventsInner.md)
|
|
72
|
+
- [DownstreamTradeflowFreeTimeOverridesInner](docs/DownstreamTradeflowFreeTimeOverridesInner.md)
|
|
73
|
+
- [DownstreamTradeflowMockTracking](docs/DownstreamTradeflowMockTracking.md)
|
|
74
|
+
- [DownstreamTradeflowPartnersInner](docs/DownstreamTradeflowPartnersInner.md)
|
|
75
|
+
- [DownstreamTradeflowReferences](docs/DownstreamTradeflowReferences.md)
|
|
76
|
+
- [InlineObject](docs/InlineObject.md)
|
|
77
|
+
- [ListDocumentTypes200ResponseInner](docs/ListDocumentTypes200ResponseInner.md)
|
|
78
|
+
- [UpstreamRecord](docs/UpstreamRecord.md)
|
|
79
|
+
- [UpstreamRecordAdditionalReferences](docs/UpstreamRecordAdditionalReferences.md)
|
|
80
|
+
- [UpstreamRecordDataQuality](docs/UpstreamRecordDataQuality.md)
|
|
81
|
+
- [UpstreamRecordMetadata](docs/UpstreamRecordMetadata.md)
|
|
82
|
+
- [V3DocumentGet200Response](docs/V3DocumentGet200Response.md)
|
|
83
|
+
- [V3DocumentGet200ResponseDataInner](docs/V3DocumentGet200ResponseDataInner.md)
|
|
84
|
+
- [V3DocumentGet200ResponseDataInnerDocumentType](docs/V3DocumentGet200ResponseDataInnerDocumentType.md)
|
|
85
|
+
- [V3DocumentPost202Response](docs/V3DocumentPost202Response.md)
|
|
86
|
+
- [V3DocumentPost400Response](docs/V3DocumentPost400Response.md)
|
|
87
|
+
- [V3DownstreamPost202Response](docs/V3DownstreamPost202Response.md)
|
|
88
|
+
- [V3DownstreamPost202ResponseTradeflowsInner](docs/V3DownstreamPost202ResponseTradeflowsInner.md)
|
|
89
|
+
- [V3UpstreamGet200Response](docs/V3UpstreamGet200Response.md)
|
|
90
|
+
- [V3UpstreamGet400Response](docs/V3UpstreamGet400Response.md)
|
|
91
|
+
- [WidgetContainer](docs/WidgetContainer.md)
|
|
92
|
+
- [WidgetCountry](docs/WidgetCountry.md)
|
|
93
|
+
- [WidgetLeg](docs/WidgetLeg.md)
|
|
94
|
+
- [WidgetLocation](docs/WidgetLocation.md)
|
|
95
|
+
- [WidgetMilestone](docs/WidgetMilestone.md)
|
|
96
|
+
- [WidgetPoint](docs/WidgetPoint.md)
|
|
97
|
+
- [WidgetSearchResult](docs/WidgetSearchResult.md)
|
|
98
|
+
- [WidgetTrack](docs/WidgetTrack.md)
|
|
99
|
+
- [WidgetTrackReading](docs/WidgetTrackReading.md)
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
Authentication schemes defined for the API:
|
|
105
|
+
<a id="ApiKey"></a>
|
|
106
|
+
#### ApiKey
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
- **Type**: HTTP Bearer Token authentication
|
|
110
|
+
|
|
111
|
+
## About
|
|
112
|
+
|
|
113
|
+
This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
|
|
114
|
+
and is automatically generated by the
|
|
115
|
+
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
116
|
+
|
|
117
|
+
- API version: `3.0.0`
|
|
118
|
+
- Package version: `0.2.0`
|
|
119
|
+
- Generator version: `7.27.0`
|
|
120
|
+
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
121
|
+
|
|
122
|
+
The generated npm module supports the following:
|
|
123
|
+
|
|
124
|
+
- Environments
|
|
125
|
+
* Node.js
|
|
126
|
+
* Webpack
|
|
127
|
+
* Browserify
|
|
128
|
+
- Language levels
|
|
129
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
130
|
+
* ES6
|
|
131
|
+
- Module systems
|
|
132
|
+
* CommonJS
|
|
133
|
+
* ES6 module system
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
## Development
|
|
137
|
+
|
|
138
|
+
### Building
|
|
139
|
+
|
|
140
|
+
To build the TypeScript source code, you need to have Node.js and npm installed.
|
|
141
|
+
After cloning the repository, navigate to the project directory and run:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
npm install
|
|
145
|
+
npm run build
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Publishing
|
|
149
|
+
|
|
150
|
+
Once you've built the package, you can publish it to npm:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
npm publish
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## License
|
|
157
|
+
|
|
158
|
+
[]()
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dockflow v3 API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type DocumentUpdate } from '../models/DocumentUpdate';
|
|
14
|
+
import { type DocumentUpload } from '../models/DocumentUpload';
|
|
15
|
+
import { type ListDocumentTypes200ResponseInner } from '../models/ListDocumentTypes200ResponseInner';
|
|
16
|
+
import { type V3DocumentGet200Response } from '../models/V3DocumentGet200Response';
|
|
17
|
+
import { type V3DocumentGet200ResponseDataInner } from '../models/V3DocumentGet200ResponseDataInner';
|
|
18
|
+
import { type V3DocumentPost202Response } from '../models/V3DocumentPost202Response';
|
|
19
|
+
export interface V3DocumentDeleteRequest {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
reference: string;
|
|
24
|
+
}
|
|
25
|
+
export interface V3DocumentGetRequest {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
reference: string;
|
|
30
|
+
}
|
|
31
|
+
export interface V3DocumentPatchRequest {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
reference: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
documentUpdate: DocumentUpdate;
|
|
40
|
+
}
|
|
41
|
+
export interface V3DocumentPostRequest {
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
*/
|
|
45
|
+
documentUpload: DocumentUpload;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
*/
|
|
50
|
+
export declare class V3DocumentApi extends runtime.BaseAPI {
|
|
51
|
+
/**
|
|
52
|
+
* Creates request options for listDocumentTypes without sending the request
|
|
53
|
+
*/
|
|
54
|
+
listDocumentTypesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
55
|
+
/**
|
|
56
|
+
* List document types
|
|
57
|
+
*/
|
|
58
|
+
listDocumentTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListDocumentTypes200ResponseInner>>>;
|
|
59
|
+
/**
|
|
60
|
+
* List document types
|
|
61
|
+
*/
|
|
62
|
+
listDocumentTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListDocumentTypes200ResponseInner>>;
|
|
63
|
+
/**
|
|
64
|
+
* Creates request options for v3DocumentDelete without sending the request
|
|
65
|
+
*/
|
|
66
|
+
v3DocumentDeleteRequestOpts(requestParameters: V3DocumentDeleteRequest): Promise<runtime.RequestOpts>;
|
|
67
|
+
/**
|
|
68
|
+
* Delete a document
|
|
69
|
+
*/
|
|
70
|
+
v3DocumentDeleteRaw(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
71
|
+
/**
|
|
72
|
+
* Delete a document
|
|
73
|
+
*/
|
|
74
|
+
v3DocumentDelete(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
75
|
+
/**
|
|
76
|
+
* Creates request options for v3DocumentGet without sending the request
|
|
77
|
+
*/
|
|
78
|
+
v3DocumentGetRequestOpts(requestParameters: V3DocumentGetRequest): Promise<runtime.RequestOpts>;
|
|
79
|
+
/**
|
|
80
|
+
* List the documents of a tradeflow
|
|
81
|
+
*/
|
|
82
|
+
v3DocumentGetRaw(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200Response>>;
|
|
83
|
+
/**
|
|
84
|
+
* List the documents of a tradeflow
|
|
85
|
+
*/
|
|
86
|
+
v3DocumentGet(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200Response>;
|
|
87
|
+
/**
|
|
88
|
+
* Creates request options for v3DocumentPatch without sending the request
|
|
89
|
+
*/
|
|
90
|
+
v3DocumentPatchRequestOpts(requestParameters: V3DocumentPatchRequest): Promise<runtime.RequestOpts>;
|
|
91
|
+
/**
|
|
92
|
+
* Update a document
|
|
93
|
+
*/
|
|
94
|
+
v3DocumentPatchRaw(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200ResponseDataInner>>;
|
|
95
|
+
/**
|
|
96
|
+
* Update a document
|
|
97
|
+
*/
|
|
98
|
+
v3DocumentPatch(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200ResponseDataInner>;
|
|
99
|
+
/**
|
|
100
|
+
* Creates request options for v3DocumentPost without sending the request
|
|
101
|
+
*/
|
|
102
|
+
v3DocumentPostRequestOpts(requestParameters: V3DocumentPostRequest): Promise<runtime.RequestOpts>;
|
|
103
|
+
/**
|
|
104
|
+
* Upload a document to a tradeflow
|
|
105
|
+
*/
|
|
106
|
+
v3DocumentPostRaw(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentPost202Response>>;
|
|
107
|
+
/**
|
|
108
|
+
* Upload a document to a tradeflow
|
|
109
|
+
*/
|
|
110
|
+
v3DocumentPost(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentPost202Response>;
|
|
111
|
+
}
|
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Dockflow v3 API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 3.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.V3DocumentApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const DocumentUpdate_1 = require("../models/DocumentUpdate");
|
|
28
|
+
const DocumentUpload_1 = require("../models/DocumentUpload");
|
|
29
|
+
const ListDocumentTypes200ResponseInner_1 = require("../models/ListDocumentTypes200ResponseInner");
|
|
30
|
+
const V3DocumentGet200Response_1 = require("../models/V3DocumentGet200Response");
|
|
31
|
+
const V3DocumentGet200ResponseDataInner_1 = require("../models/V3DocumentGet200ResponseDataInner");
|
|
32
|
+
const V3DocumentPost202Response_1 = require("../models/V3DocumentPost202Response");
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
class V3DocumentApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for listDocumentTypes without sending the request
|
|
39
|
+
*/
|
|
40
|
+
listDocumentTypesRequestOpts() {
|
|
41
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
const queryParameters = {};
|
|
43
|
+
const headerParameters = {};
|
|
44
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
45
|
+
const token = this.configuration.accessToken;
|
|
46
|
+
const tokenString = yield token("ApiKey", []);
|
|
47
|
+
if (tokenString) {
|
|
48
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
let urlPath = `/v3/downstream/documents/types`;
|
|
52
|
+
return {
|
|
53
|
+
path: urlPath,
|
|
54
|
+
method: 'GET',
|
|
55
|
+
headers: headerParameters,
|
|
56
|
+
query: queryParameters,
|
|
57
|
+
};
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* List document types
|
|
62
|
+
*/
|
|
63
|
+
listDocumentTypesRaw(initOverrides) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
+
const requestOptions = yield this.listDocumentTypesRequestOpts();
|
|
66
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
67
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInner_1.ListDocumentTypes200ResponseInnerFromJSON));
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* List document types
|
|
72
|
+
*/
|
|
73
|
+
listDocumentTypes(initOverrides) {
|
|
74
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
75
|
+
const response = yield this.listDocumentTypesRaw(initOverrides);
|
|
76
|
+
return yield response.value();
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Creates request options for v3DocumentDelete without sending the request
|
|
81
|
+
*/
|
|
82
|
+
v3DocumentDeleteRequestOpts(requestParameters) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
84
|
+
if (requestParameters['reference'] == null) {
|
|
85
|
+
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling v3DocumentDelete().');
|
|
86
|
+
}
|
|
87
|
+
const queryParameters = {};
|
|
88
|
+
const headerParameters = {};
|
|
89
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
90
|
+
const token = this.configuration.accessToken;
|
|
91
|
+
const tokenString = yield token("ApiKey", []);
|
|
92
|
+
if (tokenString) {
|
|
93
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
let urlPath = `/v3/downstream/documents/{reference}`;
|
|
97
|
+
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
98
|
+
return {
|
|
99
|
+
path: urlPath,
|
|
100
|
+
method: 'DELETE',
|
|
101
|
+
headers: headerParameters,
|
|
102
|
+
query: queryParameters,
|
|
103
|
+
};
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Delete a document
|
|
108
|
+
*/
|
|
109
|
+
v3DocumentDeleteRaw(requestParameters, initOverrides) {
|
|
110
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
111
|
+
const requestOptions = yield this.v3DocumentDeleteRequestOpts(requestParameters);
|
|
112
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
113
|
+
return new runtime.VoidApiResponse(response);
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Delete a document
|
|
118
|
+
*/
|
|
119
|
+
v3DocumentDelete(requestParameters, initOverrides) {
|
|
120
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
121
|
+
yield this.v3DocumentDeleteRaw(requestParameters, initOverrides);
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Creates request options for v3DocumentGet without sending the request
|
|
126
|
+
*/
|
|
127
|
+
v3DocumentGetRequestOpts(requestParameters) {
|
|
128
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
129
|
+
if (requestParameters['reference'] == null) {
|
|
130
|
+
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling v3DocumentGet().');
|
|
131
|
+
}
|
|
132
|
+
const queryParameters = {};
|
|
133
|
+
const headerParameters = {};
|
|
134
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
135
|
+
const token = this.configuration.accessToken;
|
|
136
|
+
const tokenString = yield token("ApiKey", []);
|
|
137
|
+
if (tokenString) {
|
|
138
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
let urlPath = `/v3/downstream/documents/{reference}`;
|
|
142
|
+
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
143
|
+
return {
|
|
144
|
+
path: urlPath,
|
|
145
|
+
method: 'GET',
|
|
146
|
+
headers: headerParameters,
|
|
147
|
+
query: queryParameters,
|
|
148
|
+
};
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* List the documents of a tradeflow
|
|
153
|
+
*/
|
|
154
|
+
v3DocumentGetRaw(requestParameters, initOverrides) {
|
|
155
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
156
|
+
const requestOptions = yield this.v3DocumentGetRequestOpts(requestParameters);
|
|
157
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
158
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V3DocumentGet200Response_1.V3DocumentGet200ResponseFromJSON)(jsonValue));
|
|
159
|
+
});
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* List the documents of a tradeflow
|
|
163
|
+
*/
|
|
164
|
+
v3DocumentGet(requestParameters, initOverrides) {
|
|
165
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
166
|
+
const response = yield this.v3DocumentGetRaw(requestParameters, initOverrides);
|
|
167
|
+
return yield response.value();
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Creates request options for v3DocumentPatch without sending the request
|
|
172
|
+
*/
|
|
173
|
+
v3DocumentPatchRequestOpts(requestParameters) {
|
|
174
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
175
|
+
if (requestParameters['reference'] == null) {
|
|
176
|
+
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling v3DocumentPatch().');
|
|
177
|
+
}
|
|
178
|
+
if (requestParameters['documentUpdate'] == null) {
|
|
179
|
+
throw new runtime.RequiredError('documentUpdate', 'Required parameter "documentUpdate" was null or undefined when calling v3DocumentPatch().');
|
|
180
|
+
}
|
|
181
|
+
const queryParameters = {};
|
|
182
|
+
const headerParameters = {};
|
|
183
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
184
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
185
|
+
const token = this.configuration.accessToken;
|
|
186
|
+
const tokenString = yield token("ApiKey", []);
|
|
187
|
+
if (tokenString) {
|
|
188
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
let urlPath = `/v3/downstream/documents/{reference}`;
|
|
192
|
+
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
193
|
+
return {
|
|
194
|
+
path: urlPath,
|
|
195
|
+
method: 'PATCH',
|
|
196
|
+
headers: headerParameters,
|
|
197
|
+
query: queryParameters,
|
|
198
|
+
body: (0, DocumentUpdate_1.DocumentUpdateToJSON)(requestParameters['documentUpdate']),
|
|
199
|
+
};
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Update a document
|
|
204
|
+
*/
|
|
205
|
+
v3DocumentPatchRaw(requestParameters, initOverrides) {
|
|
206
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
207
|
+
const requestOptions = yield this.v3DocumentPatchRequestOpts(requestParameters);
|
|
208
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
209
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V3DocumentGet200ResponseDataInner_1.V3DocumentGet200ResponseDataInnerFromJSON)(jsonValue));
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Update a document
|
|
214
|
+
*/
|
|
215
|
+
v3DocumentPatch(requestParameters, initOverrides) {
|
|
216
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
217
|
+
const response = yield this.v3DocumentPatchRaw(requestParameters, initOverrides);
|
|
218
|
+
return yield response.value();
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Creates request options for v3DocumentPost without sending the request
|
|
223
|
+
*/
|
|
224
|
+
v3DocumentPostRequestOpts(requestParameters) {
|
|
225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
226
|
+
if (requestParameters['documentUpload'] == null) {
|
|
227
|
+
throw new runtime.RequiredError('documentUpload', 'Required parameter "documentUpload" was null or undefined when calling v3DocumentPost().');
|
|
228
|
+
}
|
|
229
|
+
const queryParameters = {};
|
|
230
|
+
const headerParameters = {};
|
|
231
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
232
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
233
|
+
const token = this.configuration.accessToken;
|
|
234
|
+
const tokenString = yield token("ApiKey", []);
|
|
235
|
+
if (tokenString) {
|
|
236
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
let urlPath = `/v3/downstream/documents`;
|
|
240
|
+
return {
|
|
241
|
+
path: urlPath,
|
|
242
|
+
method: 'POST',
|
|
243
|
+
headers: headerParameters,
|
|
244
|
+
query: queryParameters,
|
|
245
|
+
body: (0, DocumentUpload_1.DocumentUploadToJSON)(requestParameters['documentUpload']),
|
|
246
|
+
};
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Upload a document to a tradeflow
|
|
251
|
+
*/
|
|
252
|
+
v3DocumentPostRaw(requestParameters, initOverrides) {
|
|
253
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
254
|
+
const requestOptions = yield this.v3DocumentPostRequestOpts(requestParameters);
|
|
255
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
256
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V3DocumentPost202Response_1.V3DocumentPost202ResponseFromJSON)(jsonValue));
|
|
257
|
+
});
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Upload a document to a tradeflow
|
|
261
|
+
*/
|
|
262
|
+
v3DocumentPost(requestParameters, initOverrides) {
|
|
263
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
264
|
+
const response = yield this.v3DocumentPostRaw(requestParameters, initOverrides);
|
|
265
|
+
return yield response.value();
|
|
266
|
+
});
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
exports.V3DocumentApi = V3DocumentApi;
|