@dockflow/sdk 0.2.0 → 0.3.1
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 +24 -24
- package/README.md +28 -23
- package/dist/apis/DocumentsApi.d.ts +111 -0
- package/dist/apis/{V3DocumentApi.js → DocumentsApi.js} +61 -61
- package/dist/apis/TradeflowsApi.d.ts +63 -0
- package/dist/apis/{V3DownstreamApi.js → TradeflowsApi.js} +45 -45
- package/dist/apis/{V3UpstreamApi.d.ts → UpstreamApi.d.ts} +14 -14
- package/dist/apis/{V3UpstreamApi.js → UpstreamApi.js} +14 -14
- package/dist/apis/WidgetApi.d.ts +1 -1
- package/dist/apis/WidgetApi.js +1 -1
- package/dist/apis/index.d.ts +3 -3
- package/dist/apis/index.js +3 -3
- package/dist/esm/apis/DocumentsApi.d.ts +111 -0
- package/dist/esm/apis/{V3DocumentApi.js → DocumentsApi.js} +59 -59
- package/dist/esm/apis/TradeflowsApi.d.ts +63 -0
- package/dist/esm/apis/{V3DownstreamApi.js → TradeflowsApi.js} +43 -43
- package/dist/esm/apis/{V3UpstreamApi.d.ts → UpstreamApi.d.ts} +14 -14
- package/dist/esm/apis/{V3UpstreamApi.js → UpstreamApi.js} +12 -12
- package/dist/esm/apis/WidgetApi.d.ts +1 -1
- package/dist/esm/apis/WidgetApi.js +1 -1
- package/dist/esm/apis/index.d.ts +3 -3
- package/dist/esm/apis/index.js +3 -3
- package/dist/esm/models/ContainerReference.d.ts +1 -1
- package/dist/esm/models/ContainerReference.js +1 -1
- package/dist/esm/models/CreateTradeflows202Response.d.ts +42 -0
- package/dist/esm/models/CreateTradeflows202Response.js +56 -0
- package/dist/esm/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
- package/dist/esm/models/{V3DownstreamPost202ResponseTradeflowsInner.js → CreateTradeflows202ResponseTradeflowsInner.js} +9 -9
- package/dist/esm/models/DocumentUpdate.d.ts +1 -1
- package/dist/esm/models/DocumentUpdate.js +1 -1
- package/dist/esm/models/DocumentUpload.d.ts +1 -1
- package/dist/esm/models/DocumentUpload.js +1 -1
- package/dist/esm/models/DownstreamTradeflow.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflow.js +1 -1
- package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowBillOfLadingReference.js +1 -1
- package/dist/esm/models/DownstreamTradeflowBookingReference.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowBookingReference.js +1 -1
- package/dist/esm/models/DownstreamTradeflowEventsInner.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowEventsInner.js +1 -1
- package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowFreeTimeOverridesInner.js +1 -1
- package/dist/esm/models/DownstreamTradeflowMockTracking.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowMockTracking.js +1 -1
- package/dist/esm/models/DownstreamTradeflowPartnersInner.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowPartnersInner.js +1 -1
- package/dist/esm/models/DownstreamTradeflowReferences.d.ts +1 -1
- package/dist/esm/models/DownstreamTradeflowReferences.js +1 -1
- package/dist/esm/models/GetDocument200Response.d.ts +39 -0
- package/dist/esm/models/{V3DocumentGet200Response.js → GetDocument200Response.js} +12 -12
- package/dist/esm/models/GetDocument200ResponseDataInner.d.ts +63 -0
- package/dist/esm/models/{V3DocumentGet200ResponseDataInner.js → GetDocument200ResponseDataInner.js} +12 -12
- package/dist/esm/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
- package/dist/esm/models/{V3DocumentGet200ResponseDataInnerDocumentType.js → GetDocument200ResponseDataInnerDocumentType.js} +9 -9
- package/dist/esm/models/GetUpstream200Response.d.ts +35 -0
- package/dist/esm/models/{V3UpstreamGet200Response.js → GetUpstream200Response.js} +9 -9
- package/dist/esm/models/GetUpstream400Response.d.ts +26 -0
- package/dist/esm/models/GetUpstream400Response.js +31 -0
- package/dist/esm/models/InlineObject.d.ts +1 -1
- package/dist/esm/models/InlineObject.js +1 -1
- package/dist/esm/models/ListDocumentTypes200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListDocumentTypes200ResponseInner.js +1 -1
- package/dist/esm/models/UploadDocument202Response.d.ts +54 -0
- package/dist/esm/models/{V3DocumentPost202Response.js → UploadDocument202Response.js} +9 -9
- package/dist/esm/models/UploadDocument400Response.d.ts +26 -0
- package/dist/esm/models/UploadDocument400Response.js +31 -0
- package/dist/esm/models/UpstreamRecord.d.ts +1 -1
- package/dist/esm/models/UpstreamRecord.js +1 -1
- package/dist/esm/models/UpstreamRecordAdditionalReferences.d.ts +1 -1
- package/dist/esm/models/UpstreamRecordAdditionalReferences.js +1 -1
- package/dist/esm/models/UpstreamRecordDataQuality.d.ts +1 -1
- package/dist/esm/models/UpstreamRecordDataQuality.js +1 -1
- package/dist/esm/models/UpstreamRecordMetadata.d.ts +1 -1
- package/dist/esm/models/UpstreamRecordMetadata.js +1 -1
- package/dist/esm/models/WidgetContainer.d.ts +1 -1
- package/dist/esm/models/WidgetContainer.js +1 -1
- package/dist/esm/models/WidgetCountry.d.ts +1 -1
- package/dist/esm/models/WidgetCountry.js +1 -1
- package/dist/esm/models/WidgetLeg.d.ts +1 -1
- package/dist/esm/models/WidgetLeg.js +1 -1
- package/dist/esm/models/WidgetLocation.d.ts +1 -1
- package/dist/esm/models/WidgetLocation.js +1 -1
- package/dist/esm/models/WidgetMilestone.d.ts +1 -1
- package/dist/esm/models/WidgetMilestone.js +1 -1
- package/dist/esm/models/WidgetPoint.d.ts +1 -1
- package/dist/esm/models/WidgetPoint.js +1 -1
- package/dist/esm/models/WidgetSearchResult.d.ts +1 -1
- package/dist/esm/models/WidgetSearchResult.js +1 -1
- package/dist/esm/models/WidgetTrack.d.ts +1 -1
- package/dist/esm/models/WidgetTrack.js +1 -1
- package/dist/esm/models/WidgetTrackReading.d.ts +1 -1
- package/dist/esm/models/WidgetTrackReading.js +1 -1
- package/dist/esm/models/index.d.ts +9 -9
- package/dist/esm/models/index.js +9 -9
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/ContainerReference.d.ts +1 -1
- package/dist/models/ContainerReference.js +1 -1
- package/dist/models/CreateTradeflows202Response.d.ts +42 -0
- package/dist/models/CreateTradeflows202Response.js +64 -0
- package/dist/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
- package/dist/models/CreateTradeflows202ResponseTradeflowsInner.js +54 -0
- package/dist/models/DocumentUpdate.d.ts +1 -1
- package/dist/models/DocumentUpdate.js +1 -1
- package/dist/models/DocumentUpload.d.ts +1 -1
- package/dist/models/DocumentUpload.js +1 -1
- package/dist/models/DownstreamTradeflow.d.ts +1 -1
- package/dist/models/DownstreamTradeflow.js +1 -1
- package/dist/models/DownstreamTradeflowBillOfLadingReference.d.ts +1 -1
- package/dist/models/DownstreamTradeflowBillOfLadingReference.js +1 -1
- package/dist/models/DownstreamTradeflowBookingReference.d.ts +1 -1
- package/dist/models/DownstreamTradeflowBookingReference.js +1 -1
- package/dist/models/DownstreamTradeflowEventsInner.d.ts +1 -1
- package/dist/models/DownstreamTradeflowEventsInner.js +1 -1
- package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.d.ts +1 -1
- package/dist/models/DownstreamTradeflowFreeTimeOverridesInner.js +1 -1
- package/dist/models/DownstreamTradeflowMockTracking.d.ts +1 -1
- package/dist/models/DownstreamTradeflowMockTracking.js +1 -1
- package/dist/models/DownstreamTradeflowPartnersInner.d.ts +1 -1
- package/dist/models/DownstreamTradeflowPartnersInner.js +1 -1
- package/dist/models/DownstreamTradeflowReferences.d.ts +1 -1
- package/dist/models/DownstreamTradeflowReferences.js +1 -1
- package/dist/models/GetDocument200Response.d.ts +39 -0
- package/dist/models/GetDocument200Response.js +59 -0
- package/dist/models/GetDocument200ResponseDataInner.d.ts +63 -0
- package/dist/models/{V3DocumentGet200ResponseDataInner.js → GetDocument200ResponseDataInner.js} +17 -17
- package/dist/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
- package/dist/models/GetDocument200ResponseDataInnerDocumentType.js +54 -0
- package/dist/models/GetUpstream200Response.d.ts +35 -0
- package/dist/models/{V3UpstreamGet200Response.js → GetUpstream200Response.js} +14 -14
- package/dist/models/GetUpstream400Response.d.ts +26 -0
- package/dist/models/GetUpstream400Response.js +38 -0
- package/dist/models/InlineObject.d.ts +1 -1
- package/dist/models/InlineObject.js +1 -1
- package/dist/models/ListDocumentTypes200ResponseInner.d.ts +1 -1
- package/dist/models/ListDocumentTypes200ResponseInner.js +1 -1
- package/dist/models/UploadDocument202Response.d.ts +54 -0
- package/dist/models/{V3DocumentPost202Response.js → UploadDocument202Response.js} +14 -14
- package/dist/models/UploadDocument400Response.d.ts +26 -0
- package/dist/models/UploadDocument400Response.js +38 -0
- package/dist/models/UpstreamRecord.d.ts +1 -1
- package/dist/models/UpstreamRecord.js +1 -1
- package/dist/models/UpstreamRecordAdditionalReferences.d.ts +1 -1
- package/dist/models/UpstreamRecordAdditionalReferences.js +1 -1
- package/dist/models/UpstreamRecordDataQuality.d.ts +1 -1
- package/dist/models/UpstreamRecordDataQuality.js +1 -1
- package/dist/models/UpstreamRecordMetadata.d.ts +1 -1
- package/dist/models/UpstreamRecordMetadata.js +1 -1
- package/dist/models/WidgetContainer.d.ts +1 -1
- package/dist/models/WidgetContainer.js +1 -1
- package/dist/models/WidgetCountry.d.ts +1 -1
- package/dist/models/WidgetCountry.js +1 -1
- package/dist/models/WidgetLeg.d.ts +1 -1
- package/dist/models/WidgetLeg.js +1 -1
- package/dist/models/WidgetLocation.d.ts +1 -1
- package/dist/models/WidgetLocation.js +1 -1
- package/dist/models/WidgetMilestone.d.ts +1 -1
- package/dist/models/WidgetMilestone.js +1 -1
- package/dist/models/WidgetPoint.d.ts +1 -1
- package/dist/models/WidgetPoint.js +1 -1
- package/dist/models/WidgetSearchResult.d.ts +1 -1
- package/dist/models/WidgetSearchResult.js +1 -1
- package/dist/models/WidgetTrack.d.ts +1 -1
- package/dist/models/WidgetTrack.js +1 -1
- package/dist/models/WidgetTrackReading.d.ts +1 -1
- package/dist/models/WidgetTrackReading.js +1 -1
- package/dist/models/index.d.ts +9 -9
- package/dist/models/index.js +9 -9
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/{V3DownstreamPost202Response.md → CreateTradeflows202Response.md} +5 -5
- package/docs/{V3DownstreamPost202ResponseTradeflowsInner.md → CreateTradeflows202ResponseTradeflowsInner.md} +4 -4
- package/docs/{V3DocumentApi.md → DocumentsApi.md} +63 -63
- package/docs/{V3DocumentGet200Response.md → GetDocument200Response.md} +5 -5
- package/docs/{V3DocumentGet200ResponseDataInner.md → GetDocument200ResponseDataInner.md} +5 -5
- package/docs/{V3DocumentGet200ResponseDataInnerDocumentType.md → GetDocument200ResponseDataInnerDocumentType.md} +4 -4
- package/docs/{V3UpstreamGet200Response.md → GetUpstream200Response.md} +4 -4
- package/docs/{V3UpstreamGet400Response.md → GetUpstream400Response.md} +4 -4
- package/docs/{V3DownstreamApi.md → TradeflowsApi.md} +39 -39
- package/docs/{V3DocumentPost202Response.md → UploadDocument202Response.md} +4 -4
- package/docs/{V3DocumentPost400Response.md → UploadDocument400Response.md} +4 -4
- package/docs/{V3UpstreamApi.md → UpstreamApi.md} +10 -10
- package/package.json +1 -1
- package/src/apis/{V3DocumentApi.ts → DocumentsApi.ts} +82 -82
- package/src/apis/{V3DownstreamApi.ts → TradeflowsApi.ts} +59 -59
- package/src/apis/{V3UpstreamApi.ts → UpstreamApi.ts} +24 -24
- package/src/apis/WidgetApi.ts +1 -1
- package/src/apis/index.ts +3 -3
- package/src/models/ContainerReference.ts +1 -1
- package/src/models/CreateTradeflows202Response.ts +91 -0
- package/src/models/{V3DownstreamPost202ResponseTradeflowsInner.ts → CreateTradeflows202ResponseTradeflowsInner.ts} +11 -11
- package/src/models/DocumentUpdate.ts +1 -1
- package/src/models/DocumentUpload.ts +1 -1
- package/src/models/DownstreamTradeflow.ts +1 -1
- package/src/models/DownstreamTradeflowBillOfLadingReference.ts +1 -1
- package/src/models/DownstreamTradeflowBookingReference.ts +1 -1
- package/src/models/DownstreamTradeflowEventsInner.ts +1 -1
- package/src/models/DownstreamTradeflowFreeTimeOverridesInner.ts +1 -1
- package/src/models/DownstreamTradeflowMockTracking.ts +1 -1
- package/src/models/DownstreamTradeflowPartnersInner.ts +1 -1
- package/src/models/DownstreamTradeflowReferences.ts +1 -1
- package/src/models/GetDocument200Response.ts +86 -0
- package/src/models/{V3DocumentGet200ResponseDataInner.ts → GetDocument200ResponseDataInner.ts} +20 -20
- package/src/models/GetDocument200ResponseDataInnerDocumentType.ts +71 -0
- package/src/models/{V3UpstreamGet200Response.ts → GetUpstream200Response.ts} +11 -11
- package/src/models/GetUpstream400Response.ts +46 -0
- package/src/models/InlineObject.ts +1 -1
- package/src/models/ListDocumentTypes200ResponseInner.ts +1 -1
- package/src/models/{V3DocumentPost202Response.ts → UploadDocument202Response.ts} +11 -11
- package/src/models/UploadDocument400Response.ts +46 -0
- package/src/models/UpstreamRecord.ts +1 -1
- package/src/models/UpstreamRecordAdditionalReferences.ts +1 -1
- package/src/models/UpstreamRecordDataQuality.ts +1 -1
- package/src/models/UpstreamRecordMetadata.ts +1 -1
- package/src/models/WidgetContainer.ts +1 -1
- package/src/models/WidgetCountry.ts +1 -1
- package/src/models/WidgetLeg.ts +1 -1
- package/src/models/WidgetLocation.ts +1 -1
- package/src/models/WidgetMilestone.ts +1 -1
- package/src/models/WidgetPoint.ts +1 -1
- package/src/models/WidgetSearchResult.ts +1 -1
- package/src/models/WidgetTrack.ts +1 -1
- package/src/models/WidgetTrackReading.ts +1 -1
- package/src/models/index.ts +9 -9
- package/src/runtime.ts +1 -1
- package/dist/apis/V3DocumentApi.d.ts +0 -111
- package/dist/apis/V3DownstreamApi.d.ts +0 -63
- package/dist/esm/apis/V3DocumentApi.d.ts +0 -111
- package/dist/esm/apis/V3DownstreamApi.d.ts +0 -63
- package/dist/esm/models/V3DocumentGet200Response.d.ts +0 -39
- package/dist/esm/models/V3DocumentGet200ResponseDataInner.d.ts +0 -63
- package/dist/esm/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +0 -34
- package/dist/esm/models/V3DocumentPost202Response.d.ts +0 -54
- package/dist/esm/models/V3DocumentPost400Response.d.ts +0 -26
- package/dist/esm/models/V3DocumentPost400Response.js +0 -31
- package/dist/esm/models/V3DownstreamPost202Response.d.ts +0 -42
- package/dist/esm/models/V3DownstreamPost202Response.js +0 -56
- package/dist/esm/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +0 -34
- package/dist/esm/models/V3UpstreamGet200Response.d.ts +0 -35
- package/dist/esm/models/V3UpstreamGet400Response.d.ts +0 -26
- package/dist/esm/models/V3UpstreamGet400Response.js +0 -31
- package/dist/models/V3DocumentGet200Response.d.ts +0 -39
- package/dist/models/V3DocumentGet200Response.js +0 -59
- package/dist/models/V3DocumentGet200ResponseDataInner.d.ts +0 -63
- package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +0 -34
- package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.js +0 -54
- package/dist/models/V3DocumentPost202Response.d.ts +0 -54
- package/dist/models/V3DocumentPost400Response.d.ts +0 -26
- package/dist/models/V3DocumentPost400Response.js +0 -38
- package/dist/models/V3DownstreamPost202Response.d.ts +0 -42
- package/dist/models/V3DownstreamPost202Response.js +0 -64
- package/dist/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +0 -34
- package/dist/models/V3DownstreamPost202ResponseTradeflowsInner.js +0 -54
- package/dist/models/V3UpstreamGet200Response.d.ts +0 -35
- package/dist/models/V3UpstreamGet400Response.d.ts +0 -26
- package/dist/models/V3UpstreamGet400Response.js +0 -38
- package/src/models/V3DocumentGet200Response.ts +0 -86
- package/src/models/V3DocumentGet200ResponseDataInnerDocumentType.ts +0 -71
- package/src/models/V3DocumentPost400Response.ts +0 -46
- package/src/models/V3DownstreamPost202Response.ts +0 -91
- package/src/models/V3UpstreamGet400Response.ts +0 -46
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Dockflow v3 API
|
|
5
|
-
*
|
|
5
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
*
|
|
@@ -23,19 +23,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
24
|
import { DocumentUpdateToJSON, } from '../models/DocumentUpdate';
|
|
25
25
|
import { DocumentUploadToJSON, } from '../models/DocumentUpload';
|
|
26
|
+
import { GetDocument200ResponseFromJSON, } from '../models/GetDocument200Response';
|
|
27
|
+
import { GetDocument200ResponseDataInnerFromJSON, } from '../models/GetDocument200ResponseDataInner';
|
|
26
28
|
import { ListDocumentTypes200ResponseInnerFromJSON, } from '../models/ListDocumentTypes200ResponseInner';
|
|
27
|
-
import {
|
|
28
|
-
import { V3DocumentGet200ResponseDataInnerFromJSON, } from '../models/V3DocumentGet200ResponseDataInner';
|
|
29
|
-
import { V3DocumentPost202ResponseFromJSON, } from '../models/V3DocumentPost202Response';
|
|
29
|
+
import { UploadDocument202ResponseFromJSON, } from '../models/UploadDocument202Response';
|
|
30
30
|
/**
|
|
31
31
|
*
|
|
32
32
|
*/
|
|
33
|
-
export class
|
|
33
|
+
export class DocumentsApi extends runtime.BaseAPI {
|
|
34
34
|
/**
|
|
35
|
-
* Creates request options for
|
|
35
|
+
* Creates request options for deleteDocument without sending the request
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
deleteDocumentRequestOpts(requestParameters) {
|
|
38
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
|
+
}
|
|
39
42
|
const queryParameters = {};
|
|
40
43
|
const headerParameters = {};
|
|
41
44
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -45,41 +48,41 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
45
48
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
46
49
|
}
|
|
47
50
|
}
|
|
48
|
-
let urlPath = `/v3/downstream/documents/
|
|
51
|
+
let urlPath = `/v3/downstream/documents/{reference}`;
|
|
52
|
+
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
49
53
|
return {
|
|
50
54
|
path: urlPath,
|
|
51
|
-
method: '
|
|
55
|
+
method: 'DELETE',
|
|
52
56
|
headers: headerParameters,
|
|
53
57
|
query: queryParameters,
|
|
54
58
|
};
|
|
55
59
|
});
|
|
56
60
|
}
|
|
57
61
|
/**
|
|
58
|
-
*
|
|
62
|
+
* Delete a document
|
|
59
63
|
*/
|
|
60
|
-
|
|
64
|
+
deleteDocumentRaw(requestParameters, initOverrides) {
|
|
61
65
|
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
-
const requestOptions = yield this.
|
|
66
|
+
const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
|
|
63
67
|
const response = yield this.request(requestOptions, initOverrides);
|
|
64
|
-
return new runtime.
|
|
68
|
+
return new runtime.VoidApiResponse(response);
|
|
65
69
|
});
|
|
66
70
|
}
|
|
67
71
|
/**
|
|
68
|
-
*
|
|
72
|
+
* Delete a document
|
|
69
73
|
*/
|
|
70
|
-
|
|
74
|
+
deleteDocument(requestParameters, initOverrides) {
|
|
71
75
|
return __awaiter(this, void 0, void 0, function* () {
|
|
72
|
-
|
|
73
|
-
return yield response.value();
|
|
76
|
+
yield this.deleteDocumentRaw(requestParameters, initOverrides);
|
|
74
77
|
});
|
|
75
78
|
}
|
|
76
79
|
/**
|
|
77
|
-
* Creates request options for
|
|
80
|
+
* Creates request options for getDocument without sending the request
|
|
78
81
|
*/
|
|
79
|
-
|
|
82
|
+
getDocumentRequestOpts(requestParameters) {
|
|
80
83
|
return __awaiter(this, void 0, void 0, function* () {
|
|
81
84
|
if (requestParameters['reference'] == null) {
|
|
82
|
-
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling
|
|
85
|
+
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling getDocument().');
|
|
83
86
|
}
|
|
84
87
|
const queryParameters = {};
|
|
85
88
|
const headerParameters = {};
|
|
@@ -94,38 +97,36 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
94
97
|
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
95
98
|
return {
|
|
96
99
|
path: urlPath,
|
|
97
|
-
method: '
|
|
100
|
+
method: 'GET',
|
|
98
101
|
headers: headerParameters,
|
|
99
102
|
query: queryParameters,
|
|
100
103
|
};
|
|
101
104
|
});
|
|
102
105
|
}
|
|
103
106
|
/**
|
|
104
|
-
*
|
|
107
|
+
* List the documents of a tradeflow
|
|
105
108
|
*/
|
|
106
|
-
|
|
109
|
+
getDocumentRaw(requestParameters, initOverrides) {
|
|
107
110
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108
|
-
const requestOptions = yield this.
|
|
111
|
+
const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
|
|
109
112
|
const response = yield this.request(requestOptions, initOverrides);
|
|
110
|
-
return new runtime.
|
|
113
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseFromJSON(jsonValue));
|
|
111
114
|
});
|
|
112
115
|
}
|
|
113
116
|
/**
|
|
114
|
-
*
|
|
117
|
+
* List the documents of a tradeflow
|
|
115
118
|
*/
|
|
116
|
-
|
|
119
|
+
getDocument(requestParameters, initOverrides) {
|
|
117
120
|
return __awaiter(this, void 0, void 0, function* () {
|
|
118
|
-
yield this.
|
|
121
|
+
const response = yield this.getDocumentRaw(requestParameters, initOverrides);
|
|
122
|
+
return yield response.value();
|
|
119
123
|
});
|
|
120
124
|
}
|
|
121
125
|
/**
|
|
122
|
-
* Creates request options for
|
|
126
|
+
* Creates request options for listDocumentTypes without sending the request
|
|
123
127
|
*/
|
|
124
|
-
|
|
128
|
+
listDocumentTypesRequestOpts() {
|
|
125
129
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
|
-
if (requestParameters['reference'] == null) {
|
|
127
|
-
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling v3DocumentGet().');
|
|
128
|
-
}
|
|
129
130
|
const queryParameters = {};
|
|
130
131
|
const headerParameters = {};
|
|
131
132
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -135,8 +136,7 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
135
136
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
136
137
|
}
|
|
137
138
|
}
|
|
138
|
-
let urlPath = `/v3/downstream/documents/
|
|
139
|
-
urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
|
|
139
|
+
let urlPath = `/v3/downstream/documents/types`;
|
|
140
140
|
return {
|
|
141
141
|
path: urlPath,
|
|
142
142
|
method: 'GET',
|
|
@@ -146,34 +146,34 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
146
146
|
});
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* List
|
|
149
|
+
* List document types
|
|
150
150
|
*/
|
|
151
|
-
|
|
151
|
+
listDocumentTypesRaw(initOverrides) {
|
|
152
152
|
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
-
const requestOptions = yield this.
|
|
153
|
+
const requestOptions = yield this.listDocumentTypesRequestOpts();
|
|
154
154
|
const response = yield this.request(requestOptions, initOverrides);
|
|
155
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
155
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInnerFromJSON));
|
|
156
156
|
});
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
|
-
* List
|
|
159
|
+
* List document types
|
|
160
160
|
*/
|
|
161
|
-
|
|
161
|
+
listDocumentTypes(initOverrides) {
|
|
162
162
|
return __awaiter(this, void 0, void 0, function* () {
|
|
163
|
-
const response = yield this.
|
|
163
|
+
const response = yield this.listDocumentTypesRaw(initOverrides);
|
|
164
164
|
return yield response.value();
|
|
165
165
|
});
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* Creates request options for
|
|
168
|
+
* Creates request options for updateDocument without sending the request
|
|
169
169
|
*/
|
|
170
|
-
|
|
170
|
+
updateDocumentRequestOpts(requestParameters) {
|
|
171
171
|
return __awaiter(this, void 0, void 0, function* () {
|
|
172
172
|
if (requestParameters['reference'] == null) {
|
|
173
|
-
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling
|
|
173
|
+
throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling updateDocument().');
|
|
174
174
|
}
|
|
175
175
|
if (requestParameters['documentUpdate'] == null) {
|
|
176
|
-
throw new runtime.RequiredError('documentUpdate', 'Required parameter "documentUpdate" was null or undefined when calling
|
|
176
|
+
throw new runtime.RequiredError('documentUpdate', 'Required parameter "documentUpdate" was null or undefined when calling updateDocument().');
|
|
177
177
|
}
|
|
178
178
|
const queryParameters = {};
|
|
179
179
|
const headerParameters = {};
|
|
@@ -199,29 +199,29 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
199
199
|
/**
|
|
200
200
|
* Update a document
|
|
201
201
|
*/
|
|
202
|
-
|
|
202
|
+
updateDocumentRaw(requestParameters, initOverrides) {
|
|
203
203
|
return __awaiter(this, void 0, void 0, function* () {
|
|
204
|
-
const requestOptions = yield this.
|
|
204
|
+
const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
|
|
205
205
|
const response = yield this.request(requestOptions, initOverrides);
|
|
206
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
206
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseDataInnerFromJSON(jsonValue));
|
|
207
207
|
});
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
210
|
* Update a document
|
|
211
211
|
*/
|
|
212
|
-
|
|
212
|
+
updateDocument(requestParameters, initOverrides) {
|
|
213
213
|
return __awaiter(this, void 0, void 0, function* () {
|
|
214
|
-
const response = yield this.
|
|
214
|
+
const response = yield this.updateDocumentRaw(requestParameters, initOverrides);
|
|
215
215
|
return yield response.value();
|
|
216
216
|
});
|
|
217
217
|
}
|
|
218
218
|
/**
|
|
219
|
-
* Creates request options for
|
|
219
|
+
* Creates request options for uploadDocument without sending the request
|
|
220
220
|
*/
|
|
221
|
-
|
|
221
|
+
uploadDocumentRequestOpts(requestParameters) {
|
|
222
222
|
return __awaiter(this, void 0, void 0, function* () {
|
|
223
223
|
if (requestParameters['documentUpload'] == null) {
|
|
224
|
-
throw new runtime.RequiredError('documentUpload', 'Required parameter "documentUpload" was null or undefined when calling
|
|
224
|
+
throw new runtime.RequiredError('documentUpload', 'Required parameter "documentUpload" was null or undefined when calling uploadDocument().');
|
|
225
225
|
}
|
|
226
226
|
const queryParameters = {};
|
|
227
227
|
const headerParameters = {};
|
|
@@ -246,19 +246,19 @@ export class V3DocumentApi extends runtime.BaseAPI {
|
|
|
246
246
|
/**
|
|
247
247
|
* Upload a document to a tradeflow
|
|
248
248
|
*/
|
|
249
|
-
|
|
249
|
+
uploadDocumentRaw(requestParameters, initOverrides) {
|
|
250
250
|
return __awaiter(this, void 0, void 0, function* () {
|
|
251
|
-
const requestOptions = yield this.
|
|
251
|
+
const requestOptions = yield this.uploadDocumentRequestOpts(requestParameters);
|
|
252
252
|
const response = yield this.request(requestOptions, initOverrides);
|
|
253
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
253
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => UploadDocument202ResponseFromJSON(jsonValue));
|
|
254
254
|
});
|
|
255
255
|
}
|
|
256
256
|
/**
|
|
257
257
|
* Upload a document to a tradeflow
|
|
258
258
|
*/
|
|
259
|
-
|
|
259
|
+
uploadDocument(requestParameters, initOverrides) {
|
|
260
260
|
return __awaiter(this, void 0, void 0, function* () {
|
|
261
|
-
const response = yield this.
|
|
261
|
+
const response = yield this.uploadDocumentRaw(requestParameters, initOverrides);
|
|
262
262
|
return yield response.value();
|
|
263
263
|
});
|
|
264
264
|
}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dockflow v3 API
|
|
3
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
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
|
+
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Dockflow v3 API
|
|
5
|
-
*
|
|
5
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
*
|
|
@@ -21,28 +21,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
+
import { CreateTradeflows202ResponseFromJSON, } from '../models/CreateTradeflows202Response';
|
|
24
25
|
import { DownstreamTradeflowToJSON, } from '../models/DownstreamTradeflow';
|
|
25
|
-
import { V3DownstreamPost202ResponseFromJSON, } from '../models/V3DownstreamPost202Response';
|
|
26
26
|
/**
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
|
-
export class
|
|
29
|
+
export class TradeflowsApi extends runtime.BaseAPI {
|
|
30
30
|
/**
|
|
31
|
-
* Creates request options for
|
|
31
|
+
* Creates request options for createTradeflows without sending the request
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
createTradeflowsRequestOpts(requestParameters) {
|
|
34
34
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35
|
-
if (requestParameters['
|
|
36
|
-
throw new runtime.RequiredError('
|
|
35
|
+
if (requestParameters['downstreamTradeflow'] == null) {
|
|
36
|
+
throw new runtime.RequiredError('downstreamTradeflow', 'Required parameter "downstreamTradeflow" was null or undefined when calling createTradeflows().');
|
|
37
37
|
}
|
|
38
38
|
const queryParameters = {};
|
|
39
|
-
if (requestParameters['confirm'] != null) {
|
|
40
|
-
queryParameters['confirm'] = requestParameters['confirm'];
|
|
41
|
-
}
|
|
42
|
-
if (requestParameters['hard'] != null) {
|
|
43
|
-
queryParameters['hard'] = requestParameters['hard'];
|
|
44
|
-
}
|
|
45
39
|
const headerParameters = {};
|
|
40
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
46
41
|
if (this.configuration && this.configuration.accessToken) {
|
|
47
42
|
const token = this.configuration.accessToken;
|
|
48
43
|
const tokenString = yield token("ApiKey", []);
|
|
@@ -50,51 +45,51 @@ export class V3DownstreamApi extends runtime.BaseAPI {
|
|
|
50
45
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
51
46
|
}
|
|
52
47
|
}
|
|
53
|
-
let urlPath = `/v3/downstream/tradeflows
|
|
54
|
-
urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
|
|
48
|
+
let urlPath = `/v3/downstream/tradeflows`;
|
|
55
49
|
return {
|
|
56
50
|
path: urlPath,
|
|
57
|
-
method: '
|
|
51
|
+
method: 'POST',
|
|
58
52
|
headers: headerParameters,
|
|
59
53
|
query: queryParameters,
|
|
54
|
+
body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflowToJSON),
|
|
60
55
|
};
|
|
61
56
|
});
|
|
62
57
|
}
|
|
63
58
|
/**
|
|
64
|
-
*
|
|
59
|
+
* Upsert tradeflows
|
|
65
60
|
*/
|
|
66
|
-
|
|
61
|
+
createTradeflowsRaw(requestParameters, initOverrides) {
|
|
67
62
|
return __awaiter(this, void 0, void 0, function* () {
|
|
68
|
-
const requestOptions = yield this.
|
|
63
|
+
const requestOptions = yield this.createTradeflowsRequestOpts(requestParameters);
|
|
69
64
|
const response = yield this.request(requestOptions, initOverrides);
|
|
70
|
-
|
|
71
|
-
return new runtime.JSONApiResponse(response);
|
|
72
|
-
}
|
|
73
|
-
else {
|
|
74
|
-
return new runtime.TextApiResponse(response);
|
|
75
|
-
}
|
|
65
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateTradeflows202ResponseFromJSON(jsonValue));
|
|
76
66
|
});
|
|
77
67
|
}
|
|
78
68
|
/**
|
|
79
|
-
*
|
|
69
|
+
* Upsert tradeflows
|
|
80
70
|
*/
|
|
81
|
-
|
|
71
|
+
createTradeflows(requestParameters, initOverrides) {
|
|
82
72
|
return __awaiter(this, void 0, void 0, function* () {
|
|
83
|
-
const response = yield this.
|
|
73
|
+
const response = yield this.createTradeflowsRaw(requestParameters, initOverrides);
|
|
84
74
|
return yield response.value();
|
|
85
75
|
});
|
|
86
76
|
}
|
|
87
77
|
/**
|
|
88
|
-
* Creates request options for
|
|
78
|
+
* Creates request options for deleteTradeflow without sending the request
|
|
89
79
|
*/
|
|
90
|
-
|
|
80
|
+
deleteTradeflowRequestOpts(requestParameters) {
|
|
91
81
|
return __awaiter(this, void 0, void 0, function* () {
|
|
92
|
-
if (requestParameters['
|
|
93
|
-
throw new runtime.RequiredError('
|
|
82
|
+
if (requestParameters['tradeflowReference'] == null) {
|
|
83
|
+
throw new runtime.RequiredError('tradeflowReference', 'Required parameter "tradeflowReference" was null or undefined when calling deleteTradeflow().');
|
|
94
84
|
}
|
|
95
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
|
+
}
|
|
96
92
|
const headerParameters = {};
|
|
97
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
98
93
|
if (this.configuration && this.configuration.accessToken) {
|
|
99
94
|
const token = this.configuration.accessToken;
|
|
100
95
|
const tokenString = yield token("ApiKey", []);
|
|
@@ -102,32 +97,37 @@ export class V3DownstreamApi extends runtime.BaseAPI {
|
|
|
102
97
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
103
98
|
}
|
|
104
99
|
}
|
|
105
|
-
let urlPath = `/v3/downstream/tradeflows`;
|
|
100
|
+
let urlPath = `/v3/downstream/tradeflows/{tradeflow_reference}`;
|
|
101
|
+
urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
|
|
106
102
|
return {
|
|
107
103
|
path: urlPath,
|
|
108
|
-
method: '
|
|
104
|
+
method: 'DELETE',
|
|
109
105
|
headers: headerParameters,
|
|
110
106
|
query: queryParameters,
|
|
111
|
-
body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflowToJSON),
|
|
112
107
|
};
|
|
113
108
|
});
|
|
114
109
|
}
|
|
115
110
|
/**
|
|
116
|
-
*
|
|
111
|
+
* Delete a tradeflow
|
|
117
112
|
*/
|
|
118
|
-
|
|
113
|
+
deleteTradeflowRaw(requestParameters, initOverrides) {
|
|
119
114
|
return __awaiter(this, void 0, void 0, function* () {
|
|
120
|
-
const requestOptions = yield this.
|
|
115
|
+
const requestOptions = yield this.deleteTradeflowRequestOpts(requestParameters);
|
|
121
116
|
const response = yield this.request(requestOptions, initOverrides);
|
|
122
|
-
|
|
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
123
|
});
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
126
|
+
* Delete a tradeflow
|
|
127
127
|
*/
|
|
128
|
-
|
|
128
|
+
deleteTradeflow(requestParameters, initOverrides) {
|
|
129
129
|
return __awaiter(this, void 0, void 0, function* () {
|
|
130
|
-
const response = yield this.
|
|
130
|
+
const response = yield this.deleteTradeflowRaw(requestParameters, initOverrides);
|
|
131
131
|
return yield response.value();
|
|
132
132
|
});
|
|
133
133
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Dockflow v3 API
|
|
3
|
-
*
|
|
3
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 3.0.0
|
|
6
6
|
*
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { type
|
|
14
|
-
export interface
|
|
13
|
+
import { type GetUpstream200Response } from '../models/GetUpstream200Response';
|
|
14
|
+
export interface GetUpstreamRequest {
|
|
15
15
|
/**
|
|
16
16
|
* Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
|
|
17
17
|
*/
|
|
@@ -47,7 +47,7 @@ export interface V3UpstreamGetRequest {
|
|
|
47
47
|
/**
|
|
48
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
49
|
*/
|
|
50
|
-
format?:
|
|
50
|
+
format?: GetUpstreamFormatEnum;
|
|
51
51
|
/**
|
|
52
52
|
* Tradeflows per page, 1 to 1000. Default 50.
|
|
53
53
|
*/
|
|
@@ -55,38 +55,38 @@ export interface V3UpstreamGetRequest {
|
|
|
55
55
|
/**
|
|
56
56
|
* Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
|
|
57
57
|
*/
|
|
58
|
-
failsafe?:
|
|
58
|
+
failsafe?: GetUpstreamFailsafeEnum;
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
*
|
|
62
62
|
*/
|
|
63
|
-
export declare class
|
|
63
|
+
export declare class UpstreamApi extends runtime.BaseAPI {
|
|
64
64
|
/**
|
|
65
|
-
* Creates request options for
|
|
65
|
+
* Creates request options for getUpstream without sending the request
|
|
66
66
|
*/
|
|
67
|
-
|
|
67
|
+
getUpstreamRequestOpts(requestParameters: GetUpstreamRequest): Promise<runtime.RequestOpts>;
|
|
68
68
|
/**
|
|
69
69
|
* Poll upstream events
|
|
70
70
|
*/
|
|
71
|
-
|
|
71
|
+
getUpstreamRaw(requestParameters: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUpstream200Response>>;
|
|
72
72
|
/**
|
|
73
73
|
* Poll upstream events
|
|
74
74
|
*/
|
|
75
|
-
|
|
75
|
+
getUpstream(requestParameters?: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUpstream200Response>;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
78
|
* @export
|
|
79
79
|
*/
|
|
80
|
-
export declare const
|
|
80
|
+
export declare const GetUpstreamFormatEnum: {
|
|
81
81
|
readonly V3: "v3";
|
|
82
82
|
readonly DcsaTnt22: "dcsa-tnt-2.2";
|
|
83
83
|
};
|
|
84
|
-
export type
|
|
84
|
+
export type GetUpstreamFormatEnum = typeof GetUpstreamFormatEnum[keyof typeof GetUpstreamFormatEnum];
|
|
85
85
|
/**
|
|
86
86
|
* @export
|
|
87
87
|
*/
|
|
88
|
-
export declare const
|
|
88
|
+
export declare const GetUpstreamFailsafeEnum: {
|
|
89
89
|
readonly _0: "0";
|
|
90
90
|
readonly _1: "1";
|
|
91
91
|
};
|
|
92
|
-
export type
|
|
92
|
+
export type GetUpstreamFailsafeEnum = typeof GetUpstreamFailsafeEnum[keyof typeof GetUpstreamFailsafeEnum];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Dockflow v3 API
|
|
5
|
-
*
|
|
5
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
*
|
|
@@ -21,15 +21,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import {
|
|
24
|
+
import { GetUpstream200ResponseFromJSON, } from '../models/GetUpstream200Response';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
|
-
export class
|
|
28
|
+
export class UpstreamApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Creates request options for
|
|
30
|
+
* Creates request options for getUpstream without sending the request
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
getUpstreamRequestOpts(requestParameters) {
|
|
33
33
|
return __awaiter(this, void 0, void 0, function* () {
|
|
34
34
|
const queryParameters = {};
|
|
35
35
|
if (requestParameters['since'] != null) {
|
|
@@ -85,19 +85,19 @@ export class V3UpstreamApi extends runtime.BaseAPI {
|
|
|
85
85
|
/**
|
|
86
86
|
* Poll upstream events
|
|
87
87
|
*/
|
|
88
|
-
|
|
88
|
+
getUpstreamRaw(requestParameters, initOverrides) {
|
|
89
89
|
return __awaiter(this, void 0, void 0, function* () {
|
|
90
|
-
const requestOptions = yield this.
|
|
90
|
+
const requestOptions = yield this.getUpstreamRequestOpts(requestParameters);
|
|
91
91
|
const response = yield this.request(requestOptions, initOverrides);
|
|
92
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
92
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetUpstream200ResponseFromJSON(jsonValue));
|
|
93
93
|
});
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
96
|
* Poll upstream events
|
|
97
97
|
*/
|
|
98
|
-
|
|
98
|
+
getUpstream() {
|
|
99
99
|
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
100
|
-
const response = yield this.
|
|
100
|
+
const response = yield this.getUpstreamRaw(requestParameters, initOverrides);
|
|
101
101
|
return yield response.value();
|
|
102
102
|
});
|
|
103
103
|
}
|
|
@@ -105,14 +105,14 @@ export class V3UpstreamApi extends runtime.BaseAPI {
|
|
|
105
105
|
/**
|
|
106
106
|
* @export
|
|
107
107
|
*/
|
|
108
|
-
export const
|
|
108
|
+
export const GetUpstreamFormatEnum = {
|
|
109
109
|
V3: 'v3',
|
|
110
110
|
DcsaTnt22: 'dcsa-tnt-2.2',
|
|
111
111
|
};
|
|
112
112
|
/**
|
|
113
113
|
* @export
|
|
114
114
|
*/
|
|
115
|
-
export const
|
|
115
|
+
export const GetUpstreamFailsafeEnum = {
|
|
116
116
|
_0: '0',
|
|
117
117
|
_1: '1',
|
|
118
118
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Dockflow v3 API
|
|
3
|
-
*
|
|
3
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 3.0.0
|
|
6
6
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Dockflow v3 API
|
|
5
|
-
*
|
|
5
|
+
* Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
*
|