@openapi-qraft/openapi-typescript-plugin 1.0.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.
@@ -0,0 +1,577 @@
1
+ /**
2
+ * This file was auto-generated by @openapi-qraft/cli.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/entities/{entity_id}/documents": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ get?: never;
15
+ put?: never;
16
+ /**
17
+ * Update entity onboarding documents
18
+ * @description Update the onboarding documents of an entity.
19
+ */
20
+ post: operations["post_entities_id_documents"];
21
+ delete?: never;
22
+ options?: never;
23
+ head?: never;
24
+ patch?: never;
25
+ trace?: never;
26
+ };
27
+ "/approval_policies/{approval_policy_id}": {
28
+ parameters: {
29
+ query?: never;
30
+ header?: never;
31
+ path?: never;
32
+ cookie?: never;
33
+ };
34
+ /**
35
+ * Get an approval policy by ID
36
+ * @description Retrieve a specific approval policy.
37
+ */
38
+ get: operations["get_approval_policies_id"];
39
+ put?: never;
40
+ post?: never;
41
+ /**
42
+ * Delete an approval policy
43
+ * @description Delete an existing approval policy.
44
+ */
45
+ delete: operations["delete_approval_policies_id"];
46
+ options?: never;
47
+ head?: never;
48
+ /**
49
+ * Update an approval policy
50
+ * @description Update an existing approval policy.
51
+ */
52
+ patch: operations["patch_approval_policies_id"];
53
+ trace?: never;
54
+ };
55
+ "/files": {
56
+ parameters: {
57
+ query?: never;
58
+ header?: never;
59
+ path?: never;
60
+ cookie?: never;
61
+ };
62
+ /** Get a files by ID */
63
+ get: operations["get_files"];
64
+ put?: never;
65
+ /** Upload a files by ID */
66
+ post: operations["post_files"];
67
+ delete?: never;
68
+ options?: never;
69
+ head?: never;
70
+ patch?: never;
71
+ trace?: never;
72
+ };
73
+ "/files/list": {
74
+ parameters: {
75
+ query?: never;
76
+ header?: never;
77
+ path?: never;
78
+ cookie?: never;
79
+ };
80
+ /**
81
+ * Get a file list
82
+ * @deprecated
83
+ */
84
+ get: operations["get_file_list"];
85
+ put?: never;
86
+ post?: never;
87
+ delete?: never;
88
+ options?: never;
89
+ head?: never;
90
+ patch?: never;
91
+ trace?: never;
92
+ };
93
+ }
94
+ export type webhooks = Record<string, never>;
95
+ export interface components {
96
+ schemas: {
97
+ EntityOnboardingDocuments: {
98
+ verification_document_front: string;
99
+ verification_document_back?: string;
100
+ };
101
+ ErrorSchema: {
102
+ message: string;
103
+ };
104
+ ErrorSchemaResponse: {
105
+ error: components["schemas"]["ErrorSchema"];
106
+ };
107
+ HTTPValidationError: {
108
+ detail?: components["schemas"]["ValidationError"][];
109
+ };
110
+ ValidationError: {
111
+ loc: (string | number)[];
112
+ msg: string;
113
+ type: string;
114
+ };
115
+ ApprovalPolicyUpdate: {
116
+ /** @description The name of the approval policy. */
117
+ name?: string;
118
+ /** @description A brief description of the approval policy. */
119
+ description?: string;
120
+ /** @description A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object. */
121
+ script?: (boolean | number | string | unknown[] | Record<string, never>)[];
122
+ /**
123
+ * @description A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated.
124
+ * @example {amount >= 1000}
125
+ */
126
+ trigger?: boolean | number | string | unknown[] | Record<string, never>;
127
+ /** @description A string that represents the current status of the approval policy. */
128
+ status?: components["schemas"]["ApprovalPolicyStatus"];
129
+ };
130
+ /**
131
+ * @description An enumeration.
132
+ * @enum {string}
133
+ */
134
+ ApprovalPolicyStatus: "active" | "deleted" | "pending";
135
+ ApprovalPolicyResource: {
136
+ /** @description The name of the approval policy. */
137
+ name: string;
138
+ /** @description A brief description of the approval policy. */
139
+ description: string;
140
+ /** Format: uuid */
141
+ id: string;
142
+ };
143
+ /**
144
+ * @description An enumeration.
145
+ * @enum {string}
146
+ */
147
+ OrderEnum: "asc" | "desc";
148
+ FilesResponse: {
149
+ data: components["schemas"]["FileResponse"][];
150
+ };
151
+ FileResponse: {
152
+ /** Format: uuid */
153
+ id: string;
154
+ file_type: string;
155
+ name: string;
156
+ url: string;
157
+ };
158
+ };
159
+ responses: never;
160
+ parameters: never;
161
+ requestBodies: never;
162
+ headers: never;
163
+ pathItems: never;
164
+ }
165
+ export type $defs = Record<string, never>;
166
+ export interface operations {
167
+ post_entities_id_documents: {
168
+ parameters: {
169
+ query?: {
170
+ /** @description Document referer */
171
+ referer?: string;
172
+ };
173
+ header: {
174
+ /** @example 2023-06-04 */
175
+ "x-monite-version": string;
176
+ };
177
+ path: {
178
+ entity_id: string;
179
+ };
180
+ cookie?: never;
181
+ };
182
+ requestBody?: {
183
+ content: {
184
+ "application/json": components["schemas"]["EntityOnboardingDocuments"];
185
+ };
186
+ };
187
+ responses: {
188
+ /** @description Successful Response */
189
+ 201: {
190
+ headers: {
191
+ [name: string]: unknown;
192
+ };
193
+ content: {
194
+ "application/json": {
195
+ header?: {
196
+ /** Format: date */
197
+ "x-monite-version"?: string;
198
+ };
199
+ path?: {
200
+ /** Format: uuid */
201
+ entity_id?: string;
202
+ };
203
+ query?: {
204
+ /** @description Referer of the document */
205
+ referer?: string;
206
+ };
207
+ body?: {
208
+ verification_document_front?: string;
209
+ verification_document_back?: string;
210
+ };
211
+ };
212
+ };
213
+ };
214
+ /** @description Bad Request */
215
+ 400: {
216
+ headers: {
217
+ [name: string]: unknown;
218
+ };
219
+ content: {
220
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
221
+ };
222
+ };
223
+ /** @description Unauthorized */
224
+ 401: {
225
+ headers: {
226
+ [name: string]: unknown;
227
+ };
228
+ content: {
229
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
230
+ };
231
+ };
232
+ /** @description Validation Error */
233
+ 422: {
234
+ headers: {
235
+ [name: string]: unknown;
236
+ };
237
+ content: {
238
+ "application/json": components["schemas"]["HTTPValidationError"];
239
+ };
240
+ };
241
+ /** @description Unexpected error */
242
+ default: {
243
+ headers: {
244
+ [name: string]: unknown;
245
+ };
246
+ content: {
247
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
248
+ };
249
+ };
250
+ };
251
+ };
252
+ get_approval_policies_id: {
253
+ parameters: {
254
+ query?: {
255
+ /** @description Order by */
256
+ items_order?: components["schemas"]["OrderEnum"][];
257
+ };
258
+ header: {
259
+ /** @example 2023-06-04 */
260
+ "x-monite-version": string;
261
+ };
262
+ path: {
263
+ approval_policy_id: string;
264
+ };
265
+ cookie?: never;
266
+ };
267
+ requestBody?: never;
268
+ responses: {
269
+ /** @description Successful Response */
270
+ 200: {
271
+ headers: {
272
+ [name: string]: unknown;
273
+ };
274
+ content: {
275
+ "application/json": {
276
+ header?: {
277
+ /** Format: date */
278
+ "x-monite-version"?: string;
279
+ };
280
+ path?: {
281
+ /** Format: uuid */
282
+ approval_policy_id?: string;
283
+ };
284
+ query?: {
285
+ /** @description Order by */
286
+ items_order?: components["schemas"]["OrderEnum"][];
287
+ };
288
+ };
289
+ };
290
+ };
291
+ /** @description Unauthorized */
292
+ 401: {
293
+ headers: {
294
+ [name: string]: unknown;
295
+ };
296
+ content: {
297
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
298
+ };
299
+ };
300
+ /** @description Validation Error */
301
+ 422: {
302
+ headers: {
303
+ [name: string]: unknown;
304
+ };
305
+ content: {
306
+ "application/json": components["schemas"]["HTTPValidationError"];
307
+ };
308
+ };
309
+ /** @description Internal Server Error */
310
+ default: {
311
+ headers: {
312
+ [name: string]: unknown;
313
+ };
314
+ content: {
315
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
316
+ };
317
+ };
318
+ };
319
+ };
320
+ delete_approval_policies_id: {
321
+ parameters: {
322
+ query?: {
323
+ /** @description Limit of records to delete */
324
+ limit?: number;
325
+ };
326
+ header: {
327
+ /** @example 2023-06-04 */
328
+ "x-monite-version": string;
329
+ };
330
+ path: {
331
+ approval_policy_id: string;
332
+ };
333
+ cookie?: never;
334
+ };
335
+ requestBody?: never;
336
+ responses: {
337
+ /** @description Successful Response */
338
+ 200: {
339
+ headers: {
340
+ [name: string]: unknown;
341
+ };
342
+ content: {
343
+ "application/json": {
344
+ message: string;
345
+ limit?: number;
346
+ };
347
+ };
348
+ };
349
+ /** @description Unauthorized */
350
+ 401: {
351
+ headers: {
352
+ [name: string]: unknown;
353
+ };
354
+ content: {
355
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
356
+ };
357
+ };
358
+ /** @description Validation Error */
359
+ 422: {
360
+ headers: {
361
+ [name: string]: unknown;
362
+ };
363
+ content: {
364
+ "application/json": components["schemas"]["HTTPValidationError"];
365
+ };
366
+ };
367
+ /** @description Internal Server Error */
368
+ default: {
369
+ headers: {
370
+ [name: string]: unknown;
371
+ };
372
+ content: {
373
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
374
+ };
375
+ };
376
+ };
377
+ };
378
+ patch_approval_policies_id: {
379
+ parameters: {
380
+ query?: {
381
+ /** @description Limit of records to patch */
382
+ limit?: number;
383
+ };
384
+ header: {
385
+ /** @example 2023-06-04 */
386
+ "x-monite-version": string;
387
+ };
388
+ path: {
389
+ approval_policy_id: string;
390
+ };
391
+ cookie?: never;
392
+ };
393
+ requestBody: {
394
+ content: {
395
+ "application/json": components["schemas"]["ApprovalPolicyUpdate"];
396
+ };
397
+ };
398
+ responses: {
399
+ /** @description Successful Response */
400
+ 200: {
401
+ headers: {
402
+ [name: string]: unknown;
403
+ };
404
+ content: {
405
+ "application/json": components["schemas"]["ApprovalPolicyResource"];
406
+ };
407
+ };
408
+ /** @description Unauthorized */
409
+ 401: {
410
+ headers: {
411
+ [name: string]: unknown;
412
+ };
413
+ content: {
414
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
415
+ };
416
+ };
417
+ /** @description Validation Error */
418
+ 422: {
419
+ headers: {
420
+ [name: string]: unknown;
421
+ };
422
+ content: {
423
+ "application/json": components["schemas"]["HTTPValidationError"];
424
+ };
425
+ };
426
+ /** @description Internal Server Error */
427
+ default: {
428
+ headers: {
429
+ [name: string]: unknown;
430
+ };
431
+ content: {
432
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
433
+ };
434
+ };
435
+ };
436
+ };
437
+ get_files: {
438
+ parameters: {
439
+ query: {
440
+ id__in: string[];
441
+ /** @description Page number */
442
+ page?: string;
443
+ };
444
+ header: {
445
+ /** @example 2023-06-04 */
446
+ "x-monite-version": string;
447
+ };
448
+ path?: never;
449
+ cookie?: never;
450
+ };
451
+ requestBody?: never;
452
+ responses: {
453
+ /** @description Successful Response */
454
+ 200: {
455
+ headers: {
456
+ [name: string]: unknown;
457
+ };
458
+ content: {
459
+ "application/json": {
460
+ header?: {
461
+ /** Format: date */
462
+ "x-monite-version"?: string;
463
+ };
464
+ query?: {
465
+ id__in?: string[];
466
+ /** @description Page number */
467
+ page?: string;
468
+ };
469
+ };
470
+ };
471
+ };
472
+ /** @description Method Not Allowed */
473
+ 405: {
474
+ headers: {
475
+ [name: string]: unknown;
476
+ };
477
+ content: {
478
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
479
+ };
480
+ };
481
+ /** @description Validation Error */
482
+ 422: {
483
+ headers: {
484
+ [name: string]: unknown;
485
+ };
486
+ content: {
487
+ "application/json": components["schemas"]["HTTPValidationError"];
488
+ };
489
+ };
490
+ /** @description Internal Server Error */
491
+ default: {
492
+ headers: {
493
+ [name: string]: unknown;
494
+ };
495
+ content: {
496
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
497
+ };
498
+ };
499
+ };
500
+ };
501
+ post_files: {
502
+ parameters: {
503
+ query?: never;
504
+ header?: never;
505
+ path?: never;
506
+ cookie?: never;
507
+ };
508
+ requestBody?: {
509
+ content: {
510
+ "multipart/form-data": {
511
+ /** Format: binary */
512
+ file?: Blob;
513
+ file_description?: string;
514
+ };
515
+ };
516
+ };
517
+ responses: {
518
+ /** @description Successful Response */
519
+ 200: {
520
+ headers: {
521
+ [name: string]: unknown;
522
+ };
523
+ content: {
524
+ "application/json": {
525
+ body?: {
526
+ file?: string;
527
+ file_description?: string;
528
+ };
529
+ };
530
+ };
531
+ };
532
+ /** @description Internal Server Error */
533
+ default: {
534
+ headers: {
535
+ [name: string]: unknown;
536
+ };
537
+ content: {
538
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
539
+ };
540
+ };
541
+ };
542
+ };
543
+ get_file_list: {
544
+ parameters: {
545
+ query?: {
546
+ id__in?: string[];
547
+ };
548
+ header?: {
549
+ /** @example 2023-06-04 */
550
+ "x-monite-version"?: string;
551
+ };
552
+ path?: never;
553
+ cookie?: never;
554
+ };
555
+ requestBody?: never;
556
+ responses: {
557
+ /** @description Successful Response */
558
+ 200: {
559
+ headers: {
560
+ [name: string]: unknown;
561
+ };
562
+ content: {
563
+ "application/json": components["schemas"]["FilesResponse"];
564
+ };
565
+ };
566
+ /** @description Internal Server Error */
567
+ default: {
568
+ headers: {
569
+ [name: string]: unknown;
570
+ };
571
+ content: {
572
+ "application/json": components["schemas"]["ErrorSchemaResponse"];
573
+ };
574
+ };
575
+ };
576
+ };
577
+ }