@dockflow/sdk 0.0.0-stage → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (261) hide show
  1. package/.openapi-generator/FILES +89 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +162 -2
  5. package/dist/apis/DocumentsApi.d.ts +111 -0
  6. package/dist/apis/DocumentsApi.js +269 -0
  7. package/dist/apis/TradeflowsApi.d.ts +63 -0
  8. package/dist/apis/TradeflowsApi.js +138 -0
  9. package/dist/apis/UpstreamApi.d.ts +92 -0
  10. package/dist/apis/UpstreamApi.js +122 -0
  11. package/dist/apis/WidgetApi.d.ts +38 -0
  12. package/dist/apis/WidgetApi.js +83 -0
  13. package/dist/apis/index.d.ts +4 -0
  14. package/dist/apis/index.js +22 -0
  15. package/dist/esm/apis/DocumentsApi.d.ts +111 -0
  16. package/dist/esm/apis/DocumentsApi.js +265 -0
  17. package/dist/esm/apis/TradeflowsApi.d.ts +63 -0
  18. package/dist/esm/apis/TradeflowsApi.js +134 -0
  19. package/dist/esm/apis/UpstreamApi.d.ts +92 -0
  20. package/dist/esm/apis/UpstreamApi.js +118 -0
  21. package/dist/esm/apis/WidgetApi.d.ts +38 -0
  22. package/dist/esm/apis/WidgetApi.js +79 -0
  23. package/dist/esm/apis/index.d.ts +4 -0
  24. package/dist/esm/apis/index.js +6 -0
  25. package/dist/esm/index.d.ts +3 -0
  26. package/dist/esm/index.js +5 -0
  27. package/dist/esm/models/ContainerReference.d.ts +34 -0
  28. package/dist/esm/models/ContainerReference.js +45 -0
  29. package/dist/esm/models/CreateTradeflows202Response.d.ts +42 -0
  30. package/dist/esm/models/CreateTradeflows202Response.js +56 -0
  31. package/dist/esm/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
  32. package/dist/esm/models/CreateTradeflows202ResponseTradeflowsInner.js +47 -0
  33. package/dist/esm/models/DocumentUpdate.d.ts +38 -0
  34. package/dist/esm/models/DocumentUpdate.js +45 -0
  35. package/dist/esm/models/DocumentUpload.d.ts +70 -0
  36. package/dist/esm/models/DocumentUpload.js +76 -0
  37. package/dist/esm/models/DownstreamTradeflow.d.ts +150 -0
  38. package/dist/esm/models/DownstreamTradeflow.js +108 -0
  39. package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.d.ts +26 -0
  40. package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.js +31 -0
  41. package/dist/esm/models/DownstreamTradeflowBookingReference.d.ts +26 -0
  42. package/dist/esm/models/DownstreamTradeflowBookingReference.js +31 -0
  43. package/dist/esm/models/DownstreamTradeflowEventsInner.d.ts +46 -0
  44. package/dist/esm/models/DownstreamTradeflowEventsInner.js +54 -0
  45. package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +53 -0
  46. package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.js +59 -0
  47. package/dist/esm/models/DownstreamTradeflowMockTracking.d.ts +30 -0
  48. package/dist/esm/models/DownstreamTradeflowMockTracking.js +41 -0
  49. package/dist/esm/models/DownstreamTradeflowPartnersInner.d.ts +42 -0
  50. package/dist/esm/models/DownstreamTradeflowPartnersInner.js +49 -0
  51. package/dist/esm/models/DownstreamTradeflowReferences.d.ts +38 -0
  52. package/dist/esm/models/DownstreamTradeflowReferences.js +45 -0
  53. package/dist/esm/models/GetDocument200Response.d.ts +39 -0
  54. package/dist/esm/models/GetDocument200Response.js +52 -0
  55. package/dist/esm/models/GetDocument200ResponseDataInner.d.ts +63 -0
  56. package/dist/esm/models/GetDocument200ResponseDataInner.js +76 -0
  57. package/dist/esm/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
  58. package/dist/esm/models/GetDocument200ResponseDataInnerDocumentType.js +47 -0
  59. package/dist/esm/models/GetUpstream200Response.d.ts +35 -0
  60. package/dist/esm/models/GetUpstream200Response.js +48 -0
  61. package/dist/esm/models/GetUpstream400Response.d.ts +26 -0
  62. package/dist/esm/models/GetUpstream400Response.js +31 -0
  63. package/dist/esm/models/InlineObject.d.ts +36 -0
  64. package/dist/esm/models/InlineObject.js +47 -0
  65. package/dist/esm/models/ListDocumentTypes200ResponseInner.d.ts +34 -0
  66. package/dist/esm/models/ListDocumentTypes200ResponseInner.js +47 -0
  67. package/dist/esm/models/UploadDocument202Response.d.ts +54 -0
  68. package/dist/esm/models/UploadDocument202Response.js +67 -0
  69. package/dist/esm/models/UploadDocument400Response.d.ts +26 -0
  70. package/dist/esm/models/UploadDocument400Response.js +31 -0
  71. package/dist/esm/models/UpstreamRecord.d.ts +77 -0
  72. package/dist/esm/models/UpstreamRecord.js +80 -0
  73. package/dist/esm/models/UpstreamRecordAdditionalReferences.d.ts +34 -0
  74. package/dist/esm/models/UpstreamRecordAdditionalReferences.js +43 -0
  75. package/dist/esm/models/UpstreamRecordDataQuality.d.ts +46 -0
  76. package/dist/esm/models/UpstreamRecordDataQuality.js +49 -0
  77. package/dist/esm/models/UpstreamRecordMetadata.d.ts +42 -0
  78. package/dist/esm/models/UpstreamRecordMetadata.js +48 -0
  79. package/dist/esm/models/WidgetContainer.d.ts +47 -0
  80. package/dist/esm/models/WidgetContainer.js +60 -0
  81. package/dist/esm/models/WidgetCountry.d.ts +34 -0
  82. package/dist/esm/models/WidgetCountry.js +47 -0
  83. package/dist/esm/models/WidgetLeg.d.ts +43 -0
  84. package/dist/esm/models/WidgetLeg.js +56 -0
  85. package/dist/esm/models/WidgetLocation.d.ts +48 -0
  86. package/dist/esm/models/WidgetLocation.js +61 -0
  87. package/dist/esm/models/WidgetMilestone.d.ts +43 -0
  88. package/dist/esm/models/WidgetMilestone.js +56 -0
  89. package/dist/esm/models/WidgetPoint.d.ts +34 -0
  90. package/dist/esm/models/WidgetPoint.js +47 -0
  91. package/dist/esm/models/WidgetSearchResult.d.ts +65 -0
  92. package/dist/esm/models/WidgetSearchResult.js +78 -0
  93. package/dist/esm/models/WidgetTrack.d.ts +35 -0
  94. package/dist/esm/models/WidgetTrack.js +48 -0
  95. package/dist/esm/models/WidgetTrackReading.d.ts +38 -0
  96. package/dist/esm/models/WidgetTrackReading.js +51 -0
  97. package/dist/esm/models/index.d.ts +35 -0
  98. package/dist/esm/models/index.js +37 -0
  99. package/dist/esm/runtime.d.ts +217 -0
  100. package/dist/esm/runtime.js +460 -0
  101. package/dist/index.d.ts +3 -0
  102. package/dist/index.js +21 -0
  103. package/dist/models/ContainerReference.d.ts +34 -0
  104. package/dist/models/ContainerReference.js +52 -0
  105. package/dist/models/CreateTradeflows202Response.d.ts +42 -0
  106. package/dist/models/CreateTradeflows202Response.js +64 -0
  107. package/dist/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
  108. package/dist/models/CreateTradeflows202ResponseTradeflowsInner.js +54 -0
  109. package/dist/models/DocumentUpdate.d.ts +38 -0
  110. package/dist/models/DocumentUpdate.js +52 -0
  111. package/dist/models/DocumentUpload.d.ts +70 -0
  112. package/dist/models/DocumentUpload.js +84 -0
  113. package/dist/models/DownstreamTradeflow.d.ts +150 -0
  114. package/dist/models/DownstreamTradeflow.js +115 -0
  115. package/dist/models/DownstreamTradeflowBillOfLadingReference.d.ts +26 -0
  116. package/dist/models/DownstreamTradeflowBillOfLadingReference.js +38 -0
  117. package/dist/models/DownstreamTradeflowBookingReference.d.ts +26 -0
  118. package/dist/models/DownstreamTradeflowBookingReference.js +38 -0
  119. package/dist/models/DownstreamTradeflowEventsInner.d.ts +46 -0
  120. package/dist/models/DownstreamTradeflowEventsInner.js +61 -0
  121. package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +53 -0
  122. package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.js +67 -0
  123. package/dist/models/DownstreamTradeflowMockTracking.d.ts +30 -0
  124. package/dist/models/DownstreamTradeflowMockTracking.js +48 -0
  125. package/dist/models/DownstreamTradeflowPartnersInner.d.ts +42 -0
  126. package/dist/models/DownstreamTradeflowPartnersInner.js +56 -0
  127. package/dist/models/DownstreamTradeflowReferences.d.ts +38 -0
  128. package/dist/models/DownstreamTradeflowReferences.js +52 -0
  129. package/dist/models/GetDocument200Response.d.ts +39 -0
  130. package/dist/models/GetDocument200Response.js +59 -0
  131. package/dist/models/GetDocument200ResponseDataInner.d.ts +63 -0
  132. package/dist/models/GetDocument200ResponseDataInner.js +83 -0
  133. package/dist/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
  134. package/dist/models/GetDocument200ResponseDataInnerDocumentType.js +54 -0
  135. package/dist/models/GetUpstream200Response.d.ts +35 -0
  136. package/dist/models/GetUpstream200Response.js +55 -0
  137. package/dist/models/GetUpstream400Response.d.ts +26 -0
  138. package/dist/models/GetUpstream400Response.js +38 -0
  139. package/dist/models/InlineObject.d.ts +36 -0
  140. package/dist/models/InlineObject.js +54 -0
  141. package/dist/models/ListDocumentTypes200ResponseInner.d.ts +34 -0
  142. package/dist/models/ListDocumentTypes200ResponseInner.js +54 -0
  143. package/dist/models/UploadDocument202Response.d.ts +54 -0
  144. package/dist/models/UploadDocument202Response.js +74 -0
  145. package/dist/models/UploadDocument400Response.d.ts +26 -0
  146. package/dist/models/UploadDocument400Response.js +38 -0
  147. package/dist/models/UpstreamRecord.d.ts +77 -0
  148. package/dist/models/UpstreamRecord.js +87 -0
  149. package/dist/models/UpstreamRecordAdditionalReferences.d.ts +34 -0
  150. package/dist/models/UpstreamRecordAdditionalReferences.js +50 -0
  151. package/dist/models/UpstreamRecordDataQuality.d.ts +46 -0
  152. package/dist/models/UpstreamRecordDataQuality.js +56 -0
  153. package/dist/models/UpstreamRecordMetadata.d.ts +42 -0
  154. package/dist/models/UpstreamRecordMetadata.js +55 -0
  155. package/dist/models/WidgetContainer.d.ts +47 -0
  156. package/dist/models/WidgetContainer.js +67 -0
  157. package/dist/models/WidgetCountry.d.ts +34 -0
  158. package/dist/models/WidgetCountry.js +54 -0
  159. package/dist/models/WidgetLeg.d.ts +43 -0
  160. package/dist/models/WidgetLeg.js +63 -0
  161. package/dist/models/WidgetLocation.d.ts +48 -0
  162. package/dist/models/WidgetLocation.js +68 -0
  163. package/dist/models/WidgetMilestone.d.ts +43 -0
  164. package/dist/models/WidgetMilestone.js +63 -0
  165. package/dist/models/WidgetPoint.d.ts +34 -0
  166. package/dist/models/WidgetPoint.js +54 -0
  167. package/dist/models/WidgetSearchResult.d.ts +65 -0
  168. package/dist/models/WidgetSearchResult.js +85 -0
  169. package/dist/models/WidgetTrack.d.ts +35 -0
  170. package/dist/models/WidgetTrack.js +55 -0
  171. package/dist/models/WidgetTrackReading.d.ts +38 -0
  172. package/dist/models/WidgetTrackReading.js +58 -0
  173. package/dist/models/index.d.ts +35 -0
  174. package/dist/models/index.js +53 -0
  175. package/dist/runtime.d.ts +217 -0
  176. package/dist/runtime.js +482 -0
  177. package/docs/ContainerReference.md +36 -0
  178. package/docs/CreateTradeflows202Response.md +36 -0
  179. package/docs/CreateTradeflows202ResponseTradeflowsInner.md +36 -0
  180. package/docs/DocumentUpdate.md +39 -0
  181. package/docs/DocumentUpload.md +44 -0
  182. package/docs/DocumentsApi.md +361 -0
  183. package/docs/DownstreamTradeflow.md +91 -0
  184. package/docs/DownstreamTradeflowBillOfLadingReference.md +33 -0
  185. package/docs/DownstreamTradeflowBookingReference.md +33 -0
  186. package/docs/DownstreamTradeflowEventsInner.md +42 -0
  187. package/docs/DownstreamTradeflowFreeTimeOverridesInner.md +40 -0
  188. package/docs/DownstreamTradeflowMockTracking.md +35 -0
  189. package/docs/DownstreamTradeflowPartnersInner.md +40 -0
  190. package/docs/DownstreamTradeflowReferences.md +38 -0
  191. package/docs/GetDocument200Response.md +38 -0
  192. package/docs/GetDocument200ResponseDataInner.md +50 -0
  193. package/docs/GetDocument200ResponseDataInnerDocumentType.md +36 -0
  194. package/docs/GetUpstream200Response.md +36 -0
  195. package/docs/GetUpstream400Response.md +32 -0
  196. package/docs/InlineObject.md +36 -0
  197. package/docs/ListDocumentTypes200ResponseInner.md +36 -0
  198. package/docs/TradeflowsApi.md +158 -0
  199. package/docs/UploadDocument202Response.md +46 -0
  200. package/docs/UploadDocument400Response.md +32 -0
  201. package/docs/UpstreamApi.md +109 -0
  202. package/docs/UpstreamRecord.md +57 -0
  203. package/docs/UpstreamRecordAdditionalReferences.md +36 -0
  204. package/docs/UpstreamRecordDataQuality.md +42 -0
  205. package/docs/UpstreamRecordMetadata.md +40 -0
  206. package/docs/WidgetApi.md +81 -0
  207. package/docs/WidgetContainer.md +42 -0
  208. package/docs/WidgetCountry.md +36 -0
  209. package/docs/WidgetLeg.md +40 -0
  210. package/docs/WidgetLocation.md +42 -0
  211. package/docs/WidgetMilestone.md +40 -0
  212. package/docs/WidgetPoint.md +36 -0
  213. package/docs/WidgetSearchResult.md +50 -0
  214. package/docs/WidgetTrack.md +36 -0
  215. package/docs/WidgetTrackReading.md +38 -0
  216. package/package.json +20 -4
  217. package/src/apis/DocumentsApi.ts +357 -0
  218. package/src/apis/TradeflowsApi.ts +174 -0
  219. package/src/apis/UpstreamApi.ts +185 -0
  220. package/src/apis/WidgetApi.ts +97 -0
  221. package/src/apis/index.ts +6 -0
  222. package/src/index.ts +5 -0
  223. package/src/models/ContainerReference.ts +70 -0
  224. package/src/models/CreateTradeflows202Response.ts +91 -0
  225. package/src/models/CreateTradeflows202ResponseTradeflowsInner.ts +71 -0
  226. package/src/models/DocumentUpdate.ts +75 -0
  227. package/src/models/DocumentUpload.ts +119 -0
  228. package/src/models/DownstreamTradeflow.ts +289 -0
  229. package/src/models/DownstreamTradeflowBillOfLadingReference.ts +46 -0
  230. package/src/models/DownstreamTradeflowBookingReference.ts +46 -0
  231. package/src/models/DownstreamTradeflowEventsInner.ts +89 -0
  232. package/src/models/DownstreamTradeflowFreeTimeOverridesInner.ts +96 -0
  233. package/src/models/DownstreamTradeflowMockTracking.ts +63 -0
  234. package/src/models/DownstreamTradeflowPartnersInner.ts +82 -0
  235. package/src/models/DownstreamTradeflowReferences.ts +75 -0
  236. package/src/models/GetDocument200Response.ts +86 -0
  237. package/src/models/GetDocument200ResponseDataInner.ts +128 -0
  238. package/src/models/GetDocument200ResponseDataInnerDocumentType.ts +71 -0
  239. package/src/models/GetUpstream200Response.ts +79 -0
  240. package/src/models/GetUpstream400Response.ts +46 -0
  241. package/src/models/InlineObject.ts +71 -0
  242. package/src/models/ListDocumentTypes200ResponseInner.ts +71 -0
  243. package/src/models/UploadDocument202Response.ts +106 -0
  244. package/src/models/UploadDocument400Response.ts +46 -0
  245. package/src/models/UpstreamRecord.ts +158 -0
  246. package/src/models/UpstreamRecordAdditionalReferences.ts +69 -0
  247. package/src/models/UpstreamRecordDataQuality.ts +87 -0
  248. package/src/models/UpstreamRecordMetadata.ts +81 -0
  249. package/src/models/WidgetContainer.ts +100 -0
  250. package/src/models/WidgetCountry.ts +71 -0
  251. package/src/models/WidgetLeg.ts +93 -0
  252. package/src/models/WidgetLocation.ts +107 -0
  253. package/src/models/WidgetMilestone.ts +93 -0
  254. package/src/models/WidgetPoint.ts +71 -0
  255. package/src/models/WidgetSearchResult.ts +142 -0
  256. package/src/models/WidgetTrack.ts +79 -0
  257. package/src/models/WidgetTrackReading.ts +78 -0
  258. package/src/models/index.ts +37 -0
  259. package/src/runtime.ts +572 -0
  260. package/tsconfig.esm.json +7 -0
  261. package/tsconfig.json +16 -0
@@ -0,0 +1,265 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Dockflow v3 API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 3.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { DocumentUpdateToJSON, } from '../models/DocumentUpdate';
25
+ import { DocumentUploadToJSON, } from '../models/DocumentUpload';
26
+ import { GetDocument200ResponseFromJSON, } from '../models/GetDocument200Response';
27
+ import { GetDocument200ResponseDataInnerFromJSON, } from '../models/GetDocument200ResponseDataInner';
28
+ import { ListDocumentTypes200ResponseInnerFromJSON, } from '../models/ListDocumentTypes200ResponseInner';
29
+ import { UploadDocument202ResponseFromJSON, } from '../models/UploadDocument202Response';
30
+ /**
31
+ *
32
+ */
33
+ export class DocumentsApi extends runtime.BaseAPI {
34
+ /**
35
+ * Creates request options for deleteDocument without sending the request
36
+ */
37
+ deleteDocumentRequestOpts(requestParameters) {
38
+ return __awaiter(this, void 0, void 0, function* () {
39
+ if (requestParameters['reference'] == null) {
40
+ throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling deleteDocument().');
41
+ }
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/{reference}`;
52
+ urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
53
+ return {
54
+ path: urlPath,
55
+ method: 'DELETE',
56
+ headers: headerParameters,
57
+ query: queryParameters,
58
+ };
59
+ });
60
+ }
61
+ /**
62
+ * Delete a document
63
+ */
64
+ deleteDocumentRaw(requestParameters, initOverrides) {
65
+ return __awaiter(this, void 0, void 0, function* () {
66
+ const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
67
+ const response = yield this.request(requestOptions, initOverrides);
68
+ return new runtime.VoidApiResponse(response);
69
+ });
70
+ }
71
+ /**
72
+ * Delete a document
73
+ */
74
+ deleteDocument(requestParameters, initOverrides) {
75
+ return __awaiter(this, void 0, void 0, function* () {
76
+ yield this.deleteDocumentRaw(requestParameters, initOverrides);
77
+ });
78
+ }
79
+ /**
80
+ * Creates request options for getDocument without sending the request
81
+ */
82
+ getDocumentRequestOpts(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 getDocument().');
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: 'GET',
101
+ headers: headerParameters,
102
+ query: queryParameters,
103
+ };
104
+ });
105
+ }
106
+ /**
107
+ * List the documents of a tradeflow
108
+ */
109
+ getDocumentRaw(requestParameters, initOverrides) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
112
+ const response = yield this.request(requestOptions, initOverrides);
113
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseFromJSON(jsonValue));
114
+ });
115
+ }
116
+ /**
117
+ * List the documents of a tradeflow
118
+ */
119
+ getDocument(requestParameters, initOverrides) {
120
+ return __awaiter(this, void 0, void 0, function* () {
121
+ const response = yield this.getDocumentRaw(requestParameters, initOverrides);
122
+ return yield response.value();
123
+ });
124
+ }
125
+ /**
126
+ * Creates request options for listDocumentTypes without sending the request
127
+ */
128
+ listDocumentTypesRequestOpts() {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const queryParameters = {};
131
+ const headerParameters = {};
132
+ if (this.configuration && this.configuration.accessToken) {
133
+ const token = this.configuration.accessToken;
134
+ const tokenString = yield token("ApiKey", []);
135
+ if (tokenString) {
136
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
137
+ }
138
+ }
139
+ let urlPath = `/v3/downstream/documents/types`;
140
+ return {
141
+ path: urlPath,
142
+ method: 'GET',
143
+ headers: headerParameters,
144
+ query: queryParameters,
145
+ };
146
+ });
147
+ }
148
+ /**
149
+ * List document types
150
+ */
151
+ listDocumentTypesRaw(initOverrides) {
152
+ return __awaiter(this, void 0, void 0, function* () {
153
+ const requestOptions = yield this.listDocumentTypesRequestOpts();
154
+ const response = yield this.request(requestOptions, initOverrides);
155
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInnerFromJSON));
156
+ });
157
+ }
158
+ /**
159
+ * List document types
160
+ */
161
+ listDocumentTypes(initOverrides) {
162
+ return __awaiter(this, void 0, void 0, function* () {
163
+ const response = yield this.listDocumentTypesRaw(initOverrides);
164
+ return yield response.value();
165
+ });
166
+ }
167
+ /**
168
+ * Creates request options for updateDocument without sending the request
169
+ */
170
+ updateDocumentRequestOpts(requestParameters) {
171
+ return __awaiter(this, void 0, void 0, function* () {
172
+ if (requestParameters['reference'] == null) {
173
+ throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling updateDocument().');
174
+ }
175
+ if (requestParameters['documentUpdate'] == null) {
176
+ throw new runtime.RequiredError('documentUpdate', 'Required parameter "documentUpdate" was null or undefined when calling updateDocument().');
177
+ }
178
+ const queryParameters = {};
179
+ const headerParameters = {};
180
+ headerParameters['Content-Type'] = 'application/json';
181
+ if (this.configuration && this.configuration.accessToken) {
182
+ const token = this.configuration.accessToken;
183
+ const tokenString = yield token("ApiKey", []);
184
+ if (tokenString) {
185
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
186
+ }
187
+ }
188
+ let urlPath = `/v3/downstream/documents/{reference}`;
189
+ urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
190
+ return {
191
+ path: urlPath,
192
+ method: 'PATCH',
193
+ headers: headerParameters,
194
+ query: queryParameters,
195
+ body: DocumentUpdateToJSON(requestParameters['documentUpdate']),
196
+ };
197
+ });
198
+ }
199
+ /**
200
+ * Update a document
201
+ */
202
+ updateDocumentRaw(requestParameters, initOverrides) {
203
+ return __awaiter(this, void 0, void 0, function* () {
204
+ const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
205
+ const response = yield this.request(requestOptions, initOverrides);
206
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseDataInnerFromJSON(jsonValue));
207
+ });
208
+ }
209
+ /**
210
+ * Update a document
211
+ */
212
+ updateDocument(requestParameters, initOverrides) {
213
+ return __awaiter(this, void 0, void 0, function* () {
214
+ const response = yield this.updateDocumentRaw(requestParameters, initOverrides);
215
+ return yield response.value();
216
+ });
217
+ }
218
+ /**
219
+ * Creates request options for uploadDocument without sending the request
220
+ */
221
+ uploadDocumentRequestOpts(requestParameters) {
222
+ return __awaiter(this, void 0, void 0, function* () {
223
+ if (requestParameters['documentUpload'] == null) {
224
+ throw new runtime.RequiredError('documentUpload', 'Required parameter "documentUpload" was null or undefined when calling uploadDocument().');
225
+ }
226
+ const queryParameters = {};
227
+ const headerParameters = {};
228
+ headerParameters['Content-Type'] = 'application/json';
229
+ if (this.configuration && this.configuration.accessToken) {
230
+ const token = this.configuration.accessToken;
231
+ const tokenString = yield token("ApiKey", []);
232
+ if (tokenString) {
233
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
234
+ }
235
+ }
236
+ let urlPath = `/v3/downstream/documents`;
237
+ return {
238
+ path: urlPath,
239
+ method: 'POST',
240
+ headers: headerParameters,
241
+ query: queryParameters,
242
+ body: DocumentUploadToJSON(requestParameters['documentUpload']),
243
+ };
244
+ });
245
+ }
246
+ /**
247
+ * Upload a document to a tradeflow
248
+ */
249
+ uploadDocumentRaw(requestParameters, initOverrides) {
250
+ return __awaiter(this, void 0, void 0, function* () {
251
+ const requestOptions = yield this.uploadDocumentRequestOpts(requestParameters);
252
+ const response = yield this.request(requestOptions, initOverrides);
253
+ return new runtime.JSONApiResponse(response, (jsonValue) => UploadDocument202ResponseFromJSON(jsonValue));
254
+ });
255
+ }
256
+ /**
257
+ * Upload a document to a tradeflow
258
+ */
259
+ uploadDocument(requestParameters, initOverrides) {
260
+ return __awaiter(this, void 0, void 0, function* () {
261
+ const response = yield this.uploadDocumentRaw(requestParameters, initOverrides);
262
+ return yield response.value();
263
+ });
264
+ }
265
+ }
@@ -0,0 +1,63 @@
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 CreateTradeflows202Response } from '../models/CreateTradeflows202Response';
14
+ import { type DownstreamTradeflow } from '../models/DownstreamTradeflow';
15
+ export interface CreateTradeflowsRequest {
16
+ /**
17
+ *
18
+ */
19
+ downstreamTradeflow: Array<DownstreamTradeflow>;
20
+ }
21
+ export interface DeleteTradeflowRequest {
22
+ /**
23
+ *
24
+ */
25
+ tradeflowReference: string;
26
+ /**
27
+ *
28
+ */
29
+ confirm?: string;
30
+ /**
31
+ * true deletes the tradeflow permanently. Default: it is deactivated.
32
+ */
33
+ hard?: boolean;
34
+ }
35
+ /**
36
+ *
37
+ */
38
+ export declare class TradeflowsApi extends runtime.BaseAPI {
39
+ /**
40
+ * Creates request options for createTradeflows without sending the request
41
+ */
42
+ createTradeflowsRequestOpts(requestParameters: CreateTradeflowsRequest): Promise<runtime.RequestOpts>;
43
+ /**
44
+ * Upsert tradeflows
45
+ */
46
+ createTradeflowsRaw(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTradeflows202Response>>;
47
+ /**
48
+ * Upsert tradeflows
49
+ */
50
+ createTradeflows(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTradeflows202Response>;
51
+ /**
52
+ * Creates request options for deleteTradeflow without sending the request
53
+ */
54
+ deleteTradeflowRequestOpts(requestParameters: DeleteTradeflowRequest): Promise<runtime.RequestOpts>;
55
+ /**
56
+ * Delete a tradeflow
57
+ */
58
+ deleteTradeflowRaw(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
59
+ /**
60
+ * Delete a tradeflow
61
+ */
62
+ deleteTradeflow(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
63
+ }
@@ -0,0 +1,134 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Dockflow v3 API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 3.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { CreateTradeflows202ResponseFromJSON, } from '../models/CreateTradeflows202Response';
25
+ import { DownstreamTradeflowToJSON, } from '../models/DownstreamTradeflow';
26
+ /**
27
+ *
28
+ */
29
+ export class TradeflowsApi extends runtime.BaseAPI {
30
+ /**
31
+ * Creates request options for createTradeflows without sending the request
32
+ */
33
+ createTradeflowsRequestOpts(requestParameters) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['downstreamTradeflow'] == null) {
36
+ throw new runtime.RequiredError('downstreamTradeflow', 'Required parameter "downstreamTradeflow" was null or undefined when calling createTradeflows().');
37
+ }
38
+ const queryParameters = {};
39
+ const headerParameters = {};
40
+ headerParameters['Content-Type'] = 'application/json';
41
+ if (this.configuration && this.configuration.accessToken) {
42
+ const token = this.configuration.accessToken;
43
+ const tokenString = yield token("ApiKey", []);
44
+ if (tokenString) {
45
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
46
+ }
47
+ }
48
+ let urlPath = `/v3/downstream/tradeflows`;
49
+ return {
50
+ path: urlPath,
51
+ method: 'POST',
52
+ headers: headerParameters,
53
+ query: queryParameters,
54
+ body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflowToJSON),
55
+ };
56
+ });
57
+ }
58
+ /**
59
+ * Upsert tradeflows
60
+ */
61
+ createTradeflowsRaw(requestParameters, initOverrides) {
62
+ return __awaiter(this, void 0, void 0, function* () {
63
+ const requestOptions = yield this.createTradeflowsRequestOpts(requestParameters);
64
+ const response = yield this.request(requestOptions, initOverrides);
65
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateTradeflows202ResponseFromJSON(jsonValue));
66
+ });
67
+ }
68
+ /**
69
+ * Upsert tradeflows
70
+ */
71
+ createTradeflows(requestParameters, initOverrides) {
72
+ return __awaiter(this, void 0, void 0, function* () {
73
+ const response = yield this.createTradeflowsRaw(requestParameters, initOverrides);
74
+ return yield response.value();
75
+ });
76
+ }
77
+ /**
78
+ * Creates request options for deleteTradeflow without sending the request
79
+ */
80
+ deleteTradeflowRequestOpts(requestParameters) {
81
+ return __awaiter(this, void 0, void 0, function* () {
82
+ if (requestParameters['tradeflowReference'] == null) {
83
+ throw new runtime.RequiredError('tradeflowReference', 'Required parameter "tradeflowReference" was null or undefined when calling deleteTradeflow().');
84
+ }
85
+ const queryParameters = {};
86
+ if (requestParameters['confirm'] != null) {
87
+ queryParameters['confirm'] = requestParameters['confirm'];
88
+ }
89
+ if (requestParameters['hard'] != null) {
90
+ queryParameters['hard'] = requestParameters['hard'];
91
+ }
92
+ const headerParameters = {};
93
+ if (this.configuration && this.configuration.accessToken) {
94
+ const token = this.configuration.accessToken;
95
+ const tokenString = yield token("ApiKey", []);
96
+ if (tokenString) {
97
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
98
+ }
99
+ }
100
+ let urlPath = `/v3/downstream/tradeflows/{tradeflow_reference}`;
101
+ urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
102
+ return {
103
+ path: urlPath,
104
+ method: 'DELETE',
105
+ headers: headerParameters,
106
+ query: queryParameters,
107
+ };
108
+ });
109
+ }
110
+ /**
111
+ * Delete a tradeflow
112
+ */
113
+ deleteTradeflowRaw(requestParameters, initOverrides) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ const requestOptions = yield this.deleteTradeflowRequestOpts(requestParameters);
116
+ const response = yield this.request(requestOptions, initOverrides);
117
+ if (this.isJsonMime(response.headers.get('content-type'))) {
118
+ return new runtime.JSONApiResponse(response);
119
+ }
120
+ else {
121
+ return new runtime.TextApiResponse(response);
122
+ }
123
+ });
124
+ }
125
+ /**
126
+ * Delete a tradeflow
127
+ */
128
+ deleteTradeflow(requestParameters, initOverrides) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const response = yield this.deleteTradeflowRaw(requestParameters, initOverrides);
131
+ return yield response.value();
132
+ });
133
+ }
134
+ }
@@ -0,0 +1,92 @@
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 GetUpstream200Response } from '../models/GetUpstream200Response';
14
+ export interface GetUpstreamRequest {
15
+ /**
16
+ * Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
17
+ */
18
+ since?: string;
19
+ /**
20
+ * Your tradeflow reference. Returns that tradeflow regardless of when it changed.
21
+ */
22
+ tradeflow?: string;
23
+ /**
24
+ * A container number. Returns its tradeflows regardless of when they changed.
25
+ */
26
+ container?: string;
27
+ /**
28
+ * Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
29
+ */
30
+ category?: string;
31
+ /**
32
+ * Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.
33
+ */
34
+ code?: string;
35
+ /**
36
+ * next_cursor from the previous page. Keep since identical across the pages of one cycle.
37
+ */
38
+ cursor?: string;
39
+ /**
40
+ * true (active only), false, or both. Default: active plus recently deactivated.
41
+ */
42
+ active?: string;
43
+ /**
44
+ * Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
45
+ */
46
+ fields?: string;
47
+ /**
48
+ * Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
49
+ */
50
+ format?: GetUpstreamFormatEnum;
51
+ /**
52
+ * Tradeflows per page, 1 to 1000. Default 50.
53
+ */
54
+ perPage?: number;
55
+ /**
56
+ * Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
57
+ */
58
+ failsafe?: GetUpstreamFailsafeEnum;
59
+ }
60
+ /**
61
+ *
62
+ */
63
+ export declare class UpstreamApi extends runtime.BaseAPI {
64
+ /**
65
+ * Creates request options for getUpstream without sending the request
66
+ */
67
+ getUpstreamRequestOpts(requestParameters: GetUpstreamRequest): Promise<runtime.RequestOpts>;
68
+ /**
69
+ * Poll upstream events
70
+ */
71
+ getUpstreamRaw(requestParameters: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUpstream200Response>>;
72
+ /**
73
+ * Poll upstream events
74
+ */
75
+ getUpstream(requestParameters?: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUpstream200Response>;
76
+ }
77
+ /**
78
+ * @export
79
+ */
80
+ export declare const GetUpstreamFormatEnum: {
81
+ readonly V3: "v3";
82
+ readonly DcsaTnt22: "dcsa-tnt-2.2";
83
+ };
84
+ export type GetUpstreamFormatEnum = typeof GetUpstreamFormatEnum[keyof typeof GetUpstreamFormatEnum];
85
+ /**
86
+ * @export
87
+ */
88
+ export declare const GetUpstreamFailsafeEnum: {
89
+ readonly _0: "0";
90
+ readonly _1: "1";
91
+ };
92
+ export type GetUpstreamFailsafeEnum = typeof GetUpstreamFailsafeEnum[keyof typeof GetUpstreamFailsafeEnum];
@@ -0,0 +1,118 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Dockflow v3 API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 3.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { GetUpstream200ResponseFromJSON, } from '../models/GetUpstream200Response';
25
+ /**
26
+ *
27
+ */
28
+ export class UpstreamApi extends runtime.BaseAPI {
29
+ /**
30
+ * Creates request options for getUpstream without sending the request
31
+ */
32
+ getUpstreamRequestOpts(requestParameters) {
33
+ return __awaiter(this, void 0, void 0, function* () {
34
+ const queryParameters = {};
35
+ if (requestParameters['since'] != null) {
36
+ queryParameters['since'] = requestParameters['since'];
37
+ }
38
+ if (requestParameters['tradeflow'] != null) {
39
+ queryParameters['tradeflow'] = requestParameters['tradeflow'];
40
+ }
41
+ if (requestParameters['container'] != null) {
42
+ queryParameters['container'] = requestParameters['container'];
43
+ }
44
+ if (requestParameters['category'] != null) {
45
+ queryParameters['category'] = requestParameters['category'];
46
+ }
47
+ if (requestParameters['code'] != null) {
48
+ queryParameters['code'] = requestParameters['code'];
49
+ }
50
+ if (requestParameters['cursor'] != null) {
51
+ queryParameters['cursor'] = requestParameters['cursor'];
52
+ }
53
+ if (requestParameters['active'] != null) {
54
+ queryParameters['active'] = requestParameters['active'];
55
+ }
56
+ if (requestParameters['fields'] != null) {
57
+ queryParameters['fields'] = requestParameters['fields'];
58
+ }
59
+ if (requestParameters['format'] != null) {
60
+ queryParameters['format'] = requestParameters['format'];
61
+ }
62
+ if (requestParameters['perPage'] != null) {
63
+ queryParameters['per_page'] = requestParameters['perPage'];
64
+ }
65
+ if (requestParameters['failsafe'] != null) {
66
+ queryParameters['failsafe'] = requestParameters['failsafe'];
67
+ }
68
+ const headerParameters = {};
69
+ if (this.configuration && this.configuration.accessToken) {
70
+ const token = this.configuration.accessToken;
71
+ const tokenString = yield token("ApiKey", []);
72
+ if (tokenString) {
73
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
74
+ }
75
+ }
76
+ let urlPath = `/v3/upstream`;
77
+ return {
78
+ path: urlPath,
79
+ method: 'GET',
80
+ headers: headerParameters,
81
+ query: queryParameters,
82
+ };
83
+ });
84
+ }
85
+ /**
86
+ * Poll upstream events
87
+ */
88
+ getUpstreamRaw(requestParameters, initOverrides) {
89
+ return __awaiter(this, void 0, void 0, function* () {
90
+ const requestOptions = yield this.getUpstreamRequestOpts(requestParameters);
91
+ const response = yield this.request(requestOptions, initOverrides);
92
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetUpstream200ResponseFromJSON(jsonValue));
93
+ });
94
+ }
95
+ /**
96
+ * Poll upstream events
97
+ */
98
+ getUpstream() {
99
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
100
+ const response = yield this.getUpstreamRaw(requestParameters, initOverrides);
101
+ return yield response.value();
102
+ });
103
+ }
104
+ }
105
+ /**
106
+ * @export
107
+ */
108
+ export const GetUpstreamFormatEnum = {
109
+ V3: 'v3',
110
+ DcsaTnt22: 'dcsa-tnt-2.2',
111
+ };
112
+ /**
113
+ * @export
114
+ */
115
+ export const GetUpstreamFailsafeEnum = {
116
+ _0: '0',
117
+ _1: '1',
118
+ };