@dockflow/sdk 0.2.0 → 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 (115) hide show
  1. package/.openapi-generator/FILES +24 -24
  2. package/README.md +28 -23
  3. package/dist/apis/DocumentsApi.d.ts +111 -0
  4. package/dist/apis/{V3DocumentApi.js → DocumentsApi.js} +60 -60
  5. package/dist/apis/TradeflowsApi.d.ts +63 -0
  6. package/dist/apis/{V3DownstreamApi.js → TradeflowsApi.js} +44 -44
  7. package/dist/apis/{V3UpstreamApi.d.ts → UpstreamApi.d.ts} +13 -13
  8. package/dist/apis/{V3UpstreamApi.js → UpstreamApi.js} +13 -13
  9. package/dist/apis/index.d.ts +3 -3
  10. package/dist/apis/index.js +3 -3
  11. package/dist/esm/apis/DocumentsApi.d.ts +111 -0
  12. package/dist/esm/apis/{V3DocumentApi.js → DocumentsApi.js} +58 -58
  13. package/dist/esm/apis/TradeflowsApi.d.ts +63 -0
  14. package/dist/esm/apis/{V3DownstreamApi.js → TradeflowsApi.js} +42 -42
  15. package/dist/esm/apis/{V3UpstreamApi.d.ts → UpstreamApi.d.ts} +13 -13
  16. package/dist/esm/apis/{V3UpstreamApi.js → UpstreamApi.js} +11 -11
  17. package/dist/esm/apis/index.d.ts +3 -3
  18. package/dist/esm/apis/index.js +3 -3
  19. package/dist/esm/models/CreateTradeflows202Response.d.ts +42 -0
  20. package/dist/esm/models/{V3DownstreamPost202Response.js → CreateTradeflows202Response.js} +12 -12
  21. package/dist/esm/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
  22. package/dist/esm/models/{V3DownstreamPost202ResponseTradeflowsInner.js → CreateTradeflows202ResponseTradeflowsInner.js} +8 -8
  23. package/dist/esm/models/GetDocument200Response.d.ts +39 -0
  24. package/dist/esm/models/{V3DocumentGet200Response.js → GetDocument200Response.js} +11 -11
  25. package/dist/esm/models/GetDocument200ResponseDataInner.d.ts +63 -0
  26. package/dist/esm/models/{V3DocumentGet200ResponseDataInner.js → GetDocument200ResponseDataInner.js} +11 -11
  27. package/dist/esm/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
  28. package/dist/esm/models/{V3DocumentGet200ResponseDataInnerDocumentType.js → GetDocument200ResponseDataInnerDocumentType.js} +8 -8
  29. package/dist/esm/models/GetUpstream200Response.d.ts +35 -0
  30. package/dist/esm/models/{V3UpstreamGet200Response.js → GetUpstream200Response.js} +8 -8
  31. package/dist/esm/models/GetUpstream400Response.d.ts +26 -0
  32. package/dist/esm/models/GetUpstream400Response.js +31 -0
  33. package/dist/{models/V3DocumentPost202Response.d.ts → esm/models/UploadDocument202Response.d.ts} +8 -8
  34. package/dist/esm/models/{V3DocumentPost202Response.js → UploadDocument202Response.js} +8 -8
  35. package/dist/esm/models/UploadDocument400Response.d.ts +26 -0
  36. package/dist/esm/models/{V3DocumentPost400Response.js → UploadDocument400Response.js} +8 -8
  37. package/dist/esm/models/index.d.ts +9 -9
  38. package/dist/esm/models/index.js +9 -9
  39. package/dist/models/CreateTradeflows202Response.d.ts +42 -0
  40. package/dist/models/CreateTradeflows202Response.js +64 -0
  41. package/dist/models/CreateTradeflows202ResponseTradeflowsInner.d.ts +34 -0
  42. package/dist/models/{V3DownstreamPost202ResponseTradeflowsInner.js → CreateTradeflows202ResponseTradeflowsInner.js} +13 -13
  43. package/dist/models/GetDocument200Response.d.ts +39 -0
  44. package/dist/models/GetDocument200Response.js +59 -0
  45. package/dist/models/GetDocument200ResponseDataInner.d.ts +63 -0
  46. package/dist/models/{V3DocumentGet200ResponseDataInner.js → GetDocument200ResponseDataInner.js} +16 -16
  47. package/dist/models/GetDocument200ResponseDataInnerDocumentType.d.ts +34 -0
  48. package/dist/models/GetDocument200ResponseDataInnerDocumentType.js +54 -0
  49. package/dist/models/GetUpstream200Response.d.ts +35 -0
  50. package/dist/models/{V3UpstreamGet200Response.js → GetUpstream200Response.js} +13 -13
  51. package/dist/models/GetUpstream400Response.d.ts +26 -0
  52. package/dist/models/GetUpstream400Response.js +38 -0
  53. package/dist/{esm/models/V3DocumentPost202Response.d.ts → models/UploadDocument202Response.d.ts} +8 -8
  54. package/dist/models/{V3DocumentPost202Response.js → UploadDocument202Response.js} +13 -13
  55. package/dist/models/UploadDocument400Response.d.ts +26 -0
  56. package/dist/models/UploadDocument400Response.js +38 -0
  57. package/dist/models/index.d.ts +9 -9
  58. package/dist/models/index.js +9 -9
  59. package/docs/{V3DownstreamPost202Response.md → CreateTradeflows202Response.md} +5 -5
  60. package/docs/{V3DownstreamPost202ResponseTradeflowsInner.md → CreateTradeflows202ResponseTradeflowsInner.md} +4 -4
  61. package/docs/{V3DocumentApi.md → DocumentsApi.md} +63 -63
  62. package/docs/{V3DocumentGet200Response.md → GetDocument200Response.md} +5 -5
  63. package/docs/{V3DocumentGet200ResponseDataInner.md → GetDocument200ResponseDataInner.md} +5 -5
  64. package/docs/{V3DocumentGet200ResponseDataInnerDocumentType.md → GetDocument200ResponseDataInnerDocumentType.md} +4 -4
  65. package/docs/{V3UpstreamGet200Response.md → GetUpstream200Response.md} +4 -4
  66. package/docs/{V3UpstreamGet400Response.md → GetUpstream400Response.md} +4 -4
  67. package/docs/{V3DownstreamApi.md → TradeflowsApi.md} +39 -39
  68. package/docs/{V3DocumentPost202Response.md → UploadDocument202Response.md} +4 -4
  69. package/docs/{V3DocumentPost400Response.md → UploadDocument400Response.md} +4 -4
  70. package/docs/{V3UpstreamApi.md → UpstreamApi.md} +10 -10
  71. package/package.json +1 -1
  72. package/src/apis/{V3DocumentApi.ts → DocumentsApi.ts} +81 -81
  73. package/src/apis/{V3DownstreamApi.ts → TradeflowsApi.ts} +58 -58
  74. package/src/apis/{V3UpstreamApi.ts → UpstreamApi.ts} +23 -23
  75. package/src/apis/index.ts +3 -3
  76. package/src/models/CreateTradeflows202Response.ts +91 -0
  77. package/src/models/{V3DownstreamPost202ResponseTradeflowsInner.ts → CreateTradeflows202ResponseTradeflowsInner.ts} +10 -10
  78. package/src/models/{V3DocumentGet200Response.ts → GetDocument200Response.ts} +19 -19
  79. package/src/models/{V3DocumentGet200ResponseDataInner.ts → GetDocument200ResponseDataInner.ts} +19 -19
  80. package/src/models/GetDocument200ResponseDataInnerDocumentType.ts +71 -0
  81. package/src/models/{V3UpstreamGet200Response.ts → GetUpstream200Response.ts} +10 -10
  82. package/src/models/GetUpstream400Response.ts +46 -0
  83. package/src/models/{V3DocumentPost202Response.ts → UploadDocument202Response.ts} +10 -10
  84. package/src/models/UploadDocument400Response.ts +46 -0
  85. package/src/models/index.ts +9 -9
  86. package/dist/apis/V3DocumentApi.d.ts +0 -111
  87. package/dist/apis/V3DownstreamApi.d.ts +0 -63
  88. package/dist/esm/apis/V3DocumentApi.d.ts +0 -111
  89. package/dist/esm/apis/V3DownstreamApi.d.ts +0 -63
  90. package/dist/esm/models/V3DocumentGet200Response.d.ts +0 -39
  91. package/dist/esm/models/V3DocumentGet200ResponseDataInner.d.ts +0 -63
  92. package/dist/esm/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +0 -34
  93. package/dist/esm/models/V3DocumentPost400Response.d.ts +0 -26
  94. package/dist/esm/models/V3DownstreamPost202Response.d.ts +0 -42
  95. package/dist/esm/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +0 -34
  96. package/dist/esm/models/V3UpstreamGet200Response.d.ts +0 -35
  97. package/dist/esm/models/V3UpstreamGet400Response.d.ts +0 -26
  98. package/dist/esm/models/V3UpstreamGet400Response.js +0 -31
  99. package/dist/models/V3DocumentGet200Response.d.ts +0 -39
  100. package/dist/models/V3DocumentGet200Response.js +0 -59
  101. package/dist/models/V3DocumentGet200ResponseDataInner.d.ts +0 -63
  102. package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.d.ts +0 -34
  103. package/dist/models/V3DocumentGet200ResponseDataInnerDocumentType.js +0 -54
  104. package/dist/models/V3DocumentPost400Response.d.ts +0 -26
  105. package/dist/models/V3DocumentPost400Response.js +0 -38
  106. package/dist/models/V3DownstreamPost202Response.d.ts +0 -42
  107. package/dist/models/V3DownstreamPost202Response.js +0 -64
  108. package/dist/models/V3DownstreamPost202ResponseTradeflowsInner.d.ts +0 -34
  109. package/dist/models/V3UpstreamGet200Response.d.ts +0 -35
  110. package/dist/models/V3UpstreamGet400Response.d.ts +0 -26
  111. package/dist/models/V3UpstreamGet400Response.js +0 -38
  112. package/src/models/V3DocumentGet200ResponseDataInnerDocumentType.ts +0 -71
  113. package/src/models/V3DocumentPost400Response.ts +0 -46
  114. package/src/models/V3DownstreamPost202Response.ts +0 -91
  115. package/src/models/V3UpstreamGet400Response.ts +0 -46
@@ -1,31 +1,31 @@
1
- # V3DocumentApi
1
+ # DocumentsApi
2
2
 
3
3
  All URIs are relative to *https://api.dockflow.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
- | [**listDocumentTypes**](V3DocumentApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types |
8
- | [**v3DocumentDelete**](V3DocumentApi.md#v3documentdelete) | **DELETE** /v3/downstream/documents/{reference} | Delete a document |
9
- | [**v3DocumentGet**](V3DocumentApi.md#v3documentget) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow |
10
- | [**v3DocumentPatch**](V3DocumentApi.md#v3documentpatch) | **PATCH** /v3/downstream/documents/{reference} | Update a document |
11
- | [**v3DocumentPost**](V3DocumentApi.md#v3documentpost) | **POST** /v3/downstream/documents | Upload a document to a tradeflow |
7
+ | [**deleteDocument**](DocumentsApi.md#deletedocument) | **DELETE** /v3/downstream/documents/{reference} | Delete a document |
8
+ | [**getDocument**](DocumentsApi.md#getdocument) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow |
9
+ | [**listDocumentTypes**](DocumentsApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types |
10
+ | [**updateDocument**](DocumentsApi.md#updatedocument) | **PATCH** /v3/downstream/documents/{reference} | Update a document |
11
+ | [**uploadDocument**](DocumentsApi.md#uploaddocument) | **POST** /v3/downstream/documents | Upload a document to a tradeflow |
12
12
 
13
13
 
14
14
 
15
- ## listDocumentTypes
15
+ ## deleteDocument
16
16
 
17
- > Array<ListDocumentTypes200ResponseInner> listDocumentTypes()
17
+ > deleteDocument(reference)
18
18
 
19
- List document types
19
+ Delete a document
20
20
 
21
21
  ### Example
22
22
 
23
23
  ```ts
24
24
  import {
25
25
  Configuration,
26
- V3DocumentApi,
26
+ DocumentsApi,
27
27
  } from '@dockflow/sdk';
28
- import type { ListDocumentTypesRequest } from '@dockflow/sdk';
28
+ import type { DeleteDocumentRequest } from '@dockflow/sdk';
29
29
 
30
30
  async function example() {
31
31
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -33,10 +33,15 @@ async function example() {
33
33
  // Configure HTTP bearer authorization: ApiKey
34
34
  accessToken: "YOUR BEARER TOKEN",
35
35
  });
36
- const api = new V3DocumentApi(config);
36
+ const api = new DocumentsApi(config);
37
+
38
+ const body = {
39
+ // string
40
+ reference: reference_example,
41
+ } satisfies DeleteDocumentRequest;
37
42
 
38
43
  try {
39
- const data = await api.listDocumentTypes();
44
+ const data = await api.deleteDocument(body);
40
45
  console.log(data);
41
46
  } catch (error) {
42
47
  console.error(error);
@@ -49,11 +54,14 @@ example().catch(console.error);
49
54
 
50
55
  ### Parameters
51
56
 
52
- This endpoint does not need any parameter.
57
+
58
+ | Name | Type | Description | Notes |
59
+ |------------- | ------------- | ------------- | -------------|
60
+ | **reference** | `string` | | [Defaults to `undefined`] |
53
61
 
54
62
  ### Return type
55
63
 
56
- [**Array<ListDocumentTypes200ResponseInner>**](ListDocumentTypes200ResponseInner.md)
64
+ `void` (Empty response body)
57
65
 
58
66
  ### Authorization
59
67
 
@@ -68,25 +76,27 @@ This endpoint does not need any parameter.
68
76
  ### HTTP response details
69
77
  | Status code | Description | Response headers |
70
78
  |-------------|-------------|------------------|
71
- | **200** | The document types a document can be uploaded as. | - |
79
+ | **500** | | - |
80
+ | **204** | The document was deleted. | - |
81
+ | **404** | No document with this id is visible to the token\'s entity. | - |
72
82
 
73
83
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
74
84
 
75
85
 
76
- ## v3DocumentDelete
86
+ ## getDocument
77
87
 
78
- > v3DocumentDelete(reference)
88
+ > GetDocument200Response getDocument(reference)
79
89
 
80
- Delete a document
90
+ List the documents of a tradeflow
81
91
 
82
92
  ### Example
83
93
 
84
94
  ```ts
85
95
  import {
86
96
  Configuration,
87
- V3DocumentApi,
97
+ DocumentsApi,
88
98
  } from '@dockflow/sdk';
89
- import type { V3DocumentDeleteRequest } from '@dockflow/sdk';
99
+ import type { GetDocumentRequest } from '@dockflow/sdk';
90
100
 
91
101
  async function example() {
92
102
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -94,15 +104,15 @@ async function example() {
94
104
  // Configure HTTP bearer authorization: ApiKey
95
105
  accessToken: "YOUR BEARER TOKEN",
96
106
  });
97
- const api = new V3DocumentApi(config);
107
+ const api = new DocumentsApi(config);
98
108
 
99
109
  const body = {
100
110
  // string
101
111
  reference: reference_example,
102
- } satisfies V3DocumentDeleteRequest;
112
+ } satisfies GetDocumentRequest;
103
113
 
104
114
  try {
105
- const data = await api.v3DocumentDelete(body);
115
+ const data = await api.getDocument(body);
106
116
  console.log(data);
107
117
  } catch (error) {
108
118
  console.error(error);
@@ -122,7 +132,7 @@ example().catch(console.error);
122
132
 
123
133
  ### Return type
124
134
 
125
- `void` (Empty response body)
135
+ [**GetDocument200Response**](GetDocument200Response.md)
126
136
 
127
137
  ### Authorization
128
138
 
@@ -137,27 +147,26 @@ example().catch(console.error);
137
147
  ### HTTP response details
138
148
  | Status code | Description | Response headers |
139
149
  |-------------|-------------|------------------|
140
- | **500** | | - |
141
- | **204** | The document was deleted. | - |
142
- | **404** | No document with this id is visible to the token\'s entity. | - |
150
+ | **200** | The documents attached to the tradeflow. | - |
151
+ | **404** | No tradeflow with this reference belongs to the token\'s entity. | - |
143
152
 
144
153
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
145
154
 
146
155
 
147
- ## v3DocumentGet
156
+ ## listDocumentTypes
148
157
 
149
- > V3DocumentGet200Response v3DocumentGet(reference)
158
+ > Array<ListDocumentTypes200ResponseInner> listDocumentTypes()
150
159
 
151
- List the documents of a tradeflow
160
+ List document types
152
161
 
153
162
  ### Example
154
163
 
155
164
  ```ts
156
165
  import {
157
166
  Configuration,
158
- V3DocumentApi,
167
+ DocumentsApi,
159
168
  } from '@dockflow/sdk';
160
- import type { V3DocumentGetRequest } from '@dockflow/sdk';
169
+ import type { ListDocumentTypesRequest } from '@dockflow/sdk';
161
170
 
162
171
  async function example() {
163
172
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -165,15 +174,10 @@ async function example() {
165
174
  // Configure HTTP bearer authorization: ApiKey
166
175
  accessToken: "YOUR BEARER TOKEN",
167
176
  });
168
- const api = new V3DocumentApi(config);
169
-
170
- const body = {
171
- // string
172
- reference: reference_example,
173
- } satisfies V3DocumentGetRequest;
177
+ const api = new DocumentsApi(config);
174
178
 
175
179
  try {
176
- const data = await api.v3DocumentGet(body);
180
+ const data = await api.listDocumentTypes();
177
181
  console.log(data);
178
182
  } catch (error) {
179
183
  console.error(error);
@@ -186,14 +190,11 @@ example().catch(console.error);
186
190
 
187
191
  ### Parameters
188
192
 
189
-
190
- | Name | Type | Description | Notes |
191
- |------------- | ------------- | ------------- | -------------|
192
- | **reference** | `string` | | [Defaults to `undefined`] |
193
+ This endpoint does not need any parameter.
193
194
 
194
195
  ### Return type
195
196
 
196
- [**V3DocumentGet200Response**](V3DocumentGet200Response.md)
197
+ [**Array<ListDocumentTypes200ResponseInner>**](ListDocumentTypes200ResponseInner.md)
197
198
 
198
199
  ### Authorization
199
200
 
@@ -208,15 +209,14 @@ example().catch(console.error);
208
209
  ### HTTP response details
209
210
  | Status code | Description | Response headers |
210
211
  |-------------|-------------|------------------|
211
- | **200** | The documents attached to the tradeflow. | - |
212
- | **404** | No tradeflow with this reference belongs to the token\'s entity. | - |
212
+ | **200** | The document types a document can be uploaded as. | - |
213
213
 
214
214
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
215
215
 
216
216
 
217
- ## v3DocumentPatch
217
+ ## updateDocument
218
218
 
219
- > V3DocumentGet200ResponseDataInner v3DocumentPatch(reference, documentUpdate)
219
+ > GetDocument200ResponseDataInner updateDocument(reference, documentUpdate)
220
220
 
221
221
  Update a document
222
222
 
@@ -225,9 +225,9 @@ Update a document
225
225
  ```ts
226
226
  import {
227
227
  Configuration,
228
- V3DocumentApi,
228
+ DocumentsApi,
229
229
  } from '@dockflow/sdk';
230
- import type { V3DocumentPatchRequest } from '@dockflow/sdk';
230
+ import type { UpdateDocumentRequest } from '@dockflow/sdk';
231
231
 
232
232
  async function example() {
233
233
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -235,17 +235,17 @@ async function example() {
235
235
  // Configure HTTP bearer authorization: ApiKey
236
236
  accessToken: "YOUR BEARER TOKEN",
237
237
  });
238
- const api = new V3DocumentApi(config);
238
+ const api = new DocumentsApi(config);
239
239
 
240
240
  const body = {
241
241
  // string
242
242
  reference: reference_example,
243
243
  // DocumentUpdate
244
244
  documentUpdate: ...,
245
- } satisfies V3DocumentPatchRequest;
245
+ } satisfies UpdateDocumentRequest;
246
246
 
247
247
  try {
248
- const data = await api.v3DocumentPatch(body);
248
+ const data = await api.updateDocument(body);
249
249
  console.log(data);
250
250
  } catch (error) {
251
251
  console.error(error);
@@ -266,7 +266,7 @@ example().catch(console.error);
266
266
 
267
267
  ### Return type
268
268
 
269
- [**V3DocumentGet200ResponseDataInner**](V3DocumentGet200ResponseDataInner.md)
269
+ [**GetDocument200ResponseDataInner**](GetDocument200ResponseDataInner.md)
270
270
 
271
271
  ### Authorization
272
272
 
@@ -289,9 +289,9 @@ example().catch(console.error);
289
289
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
290
290
 
291
291
 
292
- ## v3DocumentPost
292
+ ## uploadDocument
293
293
 
294
- > V3DocumentPost202Response v3DocumentPost(documentUpload)
294
+ > UploadDocument202Response uploadDocument(documentUpload)
295
295
 
296
296
  Upload a document to a tradeflow
297
297
 
@@ -300,9 +300,9 @@ Upload a document to a tradeflow
300
300
  ```ts
301
301
  import {
302
302
  Configuration,
303
- V3DocumentApi,
303
+ DocumentsApi,
304
304
  } from '@dockflow/sdk';
305
- import type { V3DocumentPostRequest } from '@dockflow/sdk';
305
+ import type { UploadDocumentRequest } from '@dockflow/sdk';
306
306
 
307
307
  async function example() {
308
308
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -310,15 +310,15 @@ async function example() {
310
310
  // Configure HTTP bearer authorization: ApiKey
311
311
  accessToken: "YOUR BEARER TOKEN",
312
312
  });
313
- const api = new V3DocumentApi(config);
313
+ const api = new DocumentsApi(config);
314
314
 
315
315
  const body = {
316
316
  // DocumentUpload
317
317
  documentUpload: ...,
318
- } satisfies V3DocumentPostRequest;
318
+ } satisfies UploadDocumentRequest;
319
319
 
320
320
  try {
321
- const data = await api.v3DocumentPost(body);
321
+ const data = await api.uploadDocument(body);
322
322
  console.log(data);
323
323
  } catch (error) {
324
324
  console.error(error);
@@ -338,7 +338,7 @@ example().catch(console.error);
338
338
 
339
339
  ### Return type
340
340
 
341
- [**V3DocumentPost202Response**](V3DocumentPost202Response.md)
341
+ [**UploadDocument202Response**](UploadDocument202Response.md)
342
342
 
343
343
  ### Authorization
344
344
 
@@ -1,26 +1,26 @@
1
1
 
2
- # V3DocumentGet200Response
2
+ # GetDocument200Response
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<V3DocumentGet200ResponseDataInner>](V3DocumentGet200ResponseDataInner.md)
9
+ `data` | [Array<GetDocument200ResponseDataInner>](GetDocument200ResponseDataInner.md)
10
10
  `tradeflowReference` | string
11
11
  `count` | number
12
12
 
13
13
  ## Example
14
14
 
15
15
  ```typescript
16
- import type { V3DocumentGet200Response } from '@dockflow/sdk'
16
+ import type { GetDocument200Response } from '@dockflow/sdk'
17
17
 
18
18
  // TODO: Update the object below with actual values
19
19
  const example = {
20
20
  "data": null,
21
21
  "tradeflowReference": null,
22
22
  "count": null,
23
- } satisfies V3DocumentGet200Response
23
+ } satisfies GetDocument200Response
24
24
 
25
25
  console.log(example)
26
26
 
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
29
29
  console.log(exampleJSON)
30
30
 
31
31
  // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as V3DocumentGet200Response
32
+ const exampleParsed = JSON.parse(exampleJSON) as GetDocument200Response
33
33
  console.log(exampleParsed)
34
34
  ```
35
35
 
@@ -1,5 +1,5 @@
1
1
 
2
- # V3DocumentGet200ResponseDataInner
2
+ # GetDocument200ResponseDataInner
3
3
 
4
4
 
5
5
  ## Properties
@@ -11,7 +11,7 @@ Name | Type
11
11
  `filetype` | string
12
12
  `inputName` | string
13
13
  `version` | number
14
- `documentType` | [V3DocumentGet200ResponseDataInnerDocumentType](V3DocumentGet200ResponseDataInnerDocumentType.md)
14
+ `documentType` | [GetDocument200ResponseDataInnerDocumentType](GetDocument200ResponseDataInnerDocumentType.md)
15
15
  `metadata` | object
16
16
  `createdAt` | string
17
17
  `updatedAt` | string
@@ -19,7 +19,7 @@ Name | Type
19
19
  ## Example
20
20
 
21
21
  ```typescript
22
- import type { V3DocumentGet200ResponseDataInner } from '@dockflow/sdk'
22
+ import type { GetDocument200ResponseDataInner } from '@dockflow/sdk'
23
23
 
24
24
  // TODO: Update the object below with actual values
25
25
  const example = {
@@ -32,7 +32,7 @@ const example = {
32
32
  "metadata": null,
33
33
  "createdAt": null,
34
34
  "updatedAt": null,
35
- } satisfies V3DocumentGet200ResponseDataInner
35
+ } satisfies GetDocument200ResponseDataInner
36
36
 
37
37
  console.log(example)
38
38
 
@@ -41,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
41
41
  console.log(exampleJSON)
42
42
 
43
43
  // Parse the JSON string back to an object
44
- const exampleParsed = JSON.parse(exampleJSON) as V3DocumentGet200ResponseDataInner
44
+ const exampleParsed = JSON.parse(exampleJSON) as GetDocument200ResponseDataInner
45
45
  console.log(exampleParsed)
46
46
  ```
47
47
 
@@ -1,5 +1,5 @@
1
1
 
2
- # V3DocumentGet200ResponseDataInnerDocumentType
2
+ # GetDocument200ResponseDataInnerDocumentType
3
3
 
4
4
 
5
5
  ## Properties
@@ -12,13 +12,13 @@ Name | Type
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { V3DocumentGet200ResponseDataInnerDocumentType } from '@dockflow/sdk'
15
+ import type { GetDocument200ResponseDataInnerDocumentType } from '@dockflow/sdk'
16
16
 
17
17
  // TODO: Update the object below with actual values
18
18
  const example = {
19
19
  "name": null,
20
20
  "description": null,
21
- } satisfies V3DocumentGet200ResponseDataInnerDocumentType
21
+ } satisfies GetDocument200ResponseDataInnerDocumentType
22
22
 
23
23
  console.log(example)
24
24
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
27
27
  console.log(exampleJSON)
28
28
 
29
29
  // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as V3DocumentGet200ResponseDataInnerDocumentType
30
+ const exampleParsed = JSON.parse(exampleJSON) as GetDocument200ResponseDataInnerDocumentType
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -1,5 +1,5 @@
1
1
 
2
- # V3UpstreamGet200Response
2
+ # GetUpstream200Response
3
3
 
4
4
 
5
5
  ## Properties
@@ -12,13 +12,13 @@ Name | Type
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { V3UpstreamGet200Response } from '@dockflow/sdk'
15
+ import type { GetUpstream200Response } from '@dockflow/sdk'
16
16
 
17
17
  // TODO: Update the object below with actual values
18
18
  const example = {
19
19
  "data": null,
20
20
  "nextCursor": null,
21
- } satisfies V3UpstreamGet200Response
21
+ } satisfies GetUpstream200Response
22
22
 
23
23
  console.log(example)
24
24
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
27
27
  console.log(exampleJSON)
28
28
 
29
29
  // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as V3UpstreamGet200Response
30
+ const exampleParsed = JSON.parse(exampleJSON) as GetUpstream200Response
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -1,5 +1,5 @@
1
1
 
2
- # V3UpstreamGet400Response
2
+ # GetUpstream400Response
3
3
 
4
4
 
5
5
  ## Properties
@@ -10,11 +10,11 @@ Name | Type
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import type { V3UpstreamGet400Response } from '@dockflow/sdk'
13
+ import type { GetUpstream400Response } from '@dockflow/sdk'
14
14
 
15
15
  // TODO: Update the object below with actual values
16
16
  const example = {
17
- } satisfies V3UpstreamGet400Response
17
+ } satisfies GetUpstream400Response
18
18
 
19
19
  console.log(example)
20
20
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
23
23
  console.log(exampleJSON)
24
24
 
25
25
  // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as V3UpstreamGet400Response
26
+ const exampleParsed = JSON.parse(exampleJSON) as GetUpstream400Response
27
27
  console.log(exampleParsed)
28
28
  ```
29
29
 
@@ -1,28 +1,28 @@
1
- # V3DownstreamApi
1
+ # TradeflowsApi
2
2
 
3
3
  All URIs are relative to *https://api.dockflow.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
- | [**v3DownstreamDelete**](V3DownstreamApi.md#v3downstreamdelete) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow |
8
- | [**v3DownstreamPost**](V3DownstreamApi.md#v3downstreampost) | **POST** /v3/downstream/tradeflows | Upsert tradeflows |
7
+ | [**createTradeflows**](TradeflowsApi.md#createtradeflows) | **POST** /v3/downstream/tradeflows | Upsert tradeflows |
8
+ | [**deleteTradeflow**](TradeflowsApi.md#deletetradeflow) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow |
9
9
 
10
10
 
11
11
 
12
- ## v3DownstreamDelete
12
+ ## createTradeflows
13
13
 
14
- > string v3DownstreamDelete(tradeflowReference, confirm, hard)
14
+ > CreateTradeflows202Response createTradeflows(downstreamTradeflow)
15
15
 
16
- Delete a tradeflow
16
+ Upsert tradeflows
17
17
 
18
18
  ### Example
19
19
 
20
20
  ```ts
21
21
  import {
22
22
  Configuration,
23
- V3DownstreamApi,
23
+ TradeflowsApi,
24
24
  } from '@dockflow/sdk';
25
- import type { V3DownstreamDeleteRequest } from '@dockflow/sdk';
25
+ import type { CreateTradeflowsRequest } from '@dockflow/sdk';
26
26
 
27
27
  async function example() {
28
28
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -30,19 +30,15 @@ async function example() {
30
30
  // Configure HTTP bearer authorization: ApiKey
31
31
  accessToken: "YOUR BEARER TOKEN",
32
32
  });
33
- const api = new V3DownstreamApi(config);
33
+ const api = new TradeflowsApi(config);
34
34
 
35
35
  const body = {
36
- // string
37
- tradeflowReference: tradeflowReference_example,
38
- // string (optional)
39
- confirm: confirm_example,
40
- // boolean | true deletes the tradeflow permanently. Default: it is deactivated. (optional)
41
- hard: true,
42
- } satisfies V3DownstreamDeleteRequest;
36
+ // Array<DownstreamTradeflow>
37
+ downstreamTradeflow: ...,
38
+ } satisfies CreateTradeflowsRequest;
43
39
 
44
40
  try {
45
- const data = await api.v3DownstreamDelete(body);
41
+ const data = await api.createTradeflows(body);
46
42
  console.log(data);
47
43
  } catch (error) {
48
44
  console.error(error);
@@ -58,13 +54,11 @@ example().catch(console.error);
58
54
 
59
55
  | Name | Type | Description | Notes |
60
56
  |------------- | ------------- | ------------- | -------------|
61
- | **tradeflowReference** | `string` | | [Defaults to `undefined`] |
62
- | **confirm** | `string` | | [Optional] [Defaults to `undefined`] |
63
- | **hard** | `boolean` | true deletes the tradeflow permanently. Default: it is deactivated. | [Optional] [Defaults to `undefined`] |
57
+ | **downstreamTradeflow** | `Array<DownstreamTradeflow>` | | |
64
58
 
65
59
  ### Return type
66
60
 
67
- **string**
61
+ [**CreateTradeflows202Response**](CreateTradeflows202Response.md)
68
62
 
69
63
  ### Authorization
70
64
 
@@ -72,35 +66,33 @@ example().catch(console.error);
72
66
 
73
67
  ### HTTP request headers
74
68
 
75
- - **Content-Type**: Not defined
69
+ - **Content-Type**: `application/json`
76
70
  - **Accept**: `application/json`
77
71
 
78
72
 
79
73
  ### HTTP response details
80
74
  | Status code | Description | Response headers |
81
75
  |-------------|-------------|------------------|
82
- | **500** | | - |
83
- | **204** | The tradeflow was deactivated, or deleted with &#x60;hard&#x3D;true&#x60;. The reference &#x60;*&#x60; targets every tradeflow and needs &#x60;confirm&#x3D;PRODUCTION&#x60; on production. | - |
84
- | **404** | No tradeflow with this reference belongs to the token\&#39;s entity. | - |
76
+ | **202** | The tradeflows passed validation and are queued for import. | - |
85
77
  | **400** | | - |
86
78
 
87
79
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
88
80
 
89
81
 
90
- ## v3DownstreamPost
82
+ ## deleteTradeflow
91
83
 
92
- > V3DownstreamPost202Response v3DownstreamPost(downstreamTradeflow)
84
+ > string deleteTradeflow(tradeflowReference, confirm, hard)
93
85
 
94
- Upsert tradeflows
86
+ Delete a tradeflow
95
87
 
96
88
  ### Example
97
89
 
98
90
  ```ts
99
91
  import {
100
92
  Configuration,
101
- V3DownstreamApi,
93
+ TradeflowsApi,
102
94
  } from '@dockflow/sdk';
103
- import type { V3DownstreamPostRequest } from '@dockflow/sdk';
95
+ import type { DeleteTradeflowRequest } from '@dockflow/sdk';
104
96
 
105
97
  async function example() {
106
98
  console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -108,15 +100,19 @@ async function example() {
108
100
  // Configure HTTP bearer authorization: ApiKey
109
101
  accessToken: "YOUR BEARER TOKEN",
110
102
  });
111
- const api = new V3DownstreamApi(config);
103
+ const api = new TradeflowsApi(config);
112
104
 
113
105
  const body = {
114
- // Array<DownstreamTradeflow>
115
- downstreamTradeflow: ...,
116
- } satisfies V3DownstreamPostRequest;
106
+ // string
107
+ tradeflowReference: tradeflowReference_example,
108
+ // string (optional)
109
+ confirm: confirm_example,
110
+ // boolean | true deletes the tradeflow permanently. Default: it is deactivated. (optional)
111
+ hard: true,
112
+ } satisfies DeleteTradeflowRequest;
117
113
 
118
114
  try {
119
- const data = await api.v3DownstreamPost(body);
115
+ const data = await api.deleteTradeflow(body);
120
116
  console.log(data);
121
117
  } catch (error) {
122
118
  console.error(error);
@@ -132,11 +128,13 @@ example().catch(console.error);
132
128
 
133
129
  | Name | Type | Description | Notes |
134
130
  |------------- | ------------- | ------------- | -------------|
135
- | **downstreamTradeflow** | `Array<DownstreamTradeflow>` | | |
131
+ | **tradeflowReference** | `string` | | [Defaults to `undefined`] |
132
+ | **confirm** | `string` | | [Optional] [Defaults to `undefined`] |
133
+ | **hard** | `boolean` | true deletes the tradeflow permanently. Default: it is deactivated. | [Optional] [Defaults to `undefined`] |
136
134
 
137
135
  ### Return type
138
136
 
139
- [**V3DownstreamPost202Response**](V3DownstreamPost202Response.md)
137
+ **string**
140
138
 
141
139
  ### Authorization
142
140
 
@@ -144,14 +142,16 @@ example().catch(console.error);
144
142
 
145
143
  ### HTTP request headers
146
144
 
147
- - **Content-Type**: `application/json`
145
+ - **Content-Type**: Not defined
148
146
  - **Accept**: `application/json`
149
147
 
150
148
 
151
149
  ### HTTP response details
152
150
  | Status code | Description | Response headers |
153
151
  |-------------|-------------|------------------|
154
- | **202** | The tradeflows passed validation and are queued for import. | - |
152
+ | **500** | | - |
153
+ | **204** | The tradeflow was deactivated, or deleted with &#x60;hard&#x3D;true&#x60;. The reference &#x60;*&#x60; targets every tradeflow and needs &#x60;confirm&#x3D;PRODUCTION&#x60; on production. | - |
154
+ | **404** | No tradeflow with this reference belongs to the token\&#39;s entity. | - |
155
155
  | **400** | | - |
156
156
 
157
157
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)