tuix-pdf-service-client 0.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.
Files changed (82) hide show
  1. package/.openapi-generator/FILES +37 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +48 -0
  5. package/apis/ClientApi.js +571 -0
  6. package/apis/ClientApi.js.map +1 -0
  7. package/apis/ClientApi.ts +858 -0
  8. package/apis/index.js +20 -0
  9. package/apis/index.js.map +1 -0
  10. package/apis/index.ts +3 -0
  11. package/docs/APIKeyDTO.md +40 -0
  12. package/docs/AccountDTO.md +34 -0
  13. package/docs/ApplicationDTO.md +42 -0
  14. package/docs/ApplicationWithApplicationCountDTO.md +44 -0
  15. package/docs/ClientApi.md +1115 -0
  16. package/docs/CreateAPIKeyRequestDTO.md +34 -0
  17. package/docs/CreateAPIKeyResponseDTO.md +42 -0
  18. package/docs/CreateAccountDTO.md +36 -0
  19. package/docs/CreateApplicationDTO.md +36 -0
  20. package/docs/CreatePdfRequestDTO.md +34 -0
  21. package/docs/ErrorDTO.md +34 -0
  22. package/docs/GetAPIKeysResponseDTO.md +42 -0
  23. package/docs/PaginatedApplicationsDTO.md +42 -0
  24. package/docs/PdfCreatedRequestItemsDTO.md +40 -0
  25. package/docs/PdfTemplateDTO.md +36 -0
  26. package/docs/UpdateApplicationDTO.md +36 -0
  27. package/index.js +22 -0
  28. package/index.js.map +1 -0
  29. package/index.ts +5 -0
  30. package/models/APIKeyDTO.js +55 -0
  31. package/models/APIKeyDTO.js.map +1 -0
  32. package/models/APIKeyDTO.ts +89 -0
  33. package/models/AccountDTO.js +49 -0
  34. package/models/AccountDTO.js.map +1 -0
  35. package/models/AccountDTO.ts +65 -0
  36. package/models/ApplicationDTO.js +57 -0
  37. package/models/ApplicationDTO.js.map +1 -0
  38. package/models/ApplicationDTO.ts +97 -0
  39. package/models/ApplicationWithApplicationCountDTO.js +59 -0
  40. package/models/ApplicationWithApplicationCountDTO.js.map +1 -0
  41. package/models/ApplicationWithApplicationCountDTO.ts +105 -0
  42. package/models/CreateAPIKeyRequestDTO.js +51 -0
  43. package/models/CreateAPIKeyRequestDTO.js.map +1 -0
  44. package/models/CreateAPIKeyRequestDTO.ts +66 -0
  45. package/models/CreateAPIKeyResponseDTO.js +57 -0
  46. package/models/CreateAPIKeyResponseDTO.js.map +1 -0
  47. package/models/CreateAPIKeyResponseDTO.ts +97 -0
  48. package/models/CreateAccountDTO.js +55 -0
  49. package/models/CreateAccountDTO.js.map +1 -0
  50. package/models/CreateAccountDTO.ts +75 -0
  51. package/models/CreateApplicationDTO.js +55 -0
  52. package/models/CreateApplicationDTO.js.map +1 -0
  53. package/models/CreateApplicationDTO.ts +75 -0
  54. package/models/CreatePdfRequestDTO.js +52 -0
  55. package/models/CreatePdfRequestDTO.js.map +1 -0
  56. package/models/CreatePdfRequestDTO.ts +74 -0
  57. package/models/ErrorDTO.js +49 -0
  58. package/models/ErrorDTO.js.map +1 -0
  59. package/models/ErrorDTO.ts +65 -0
  60. package/models/GetAPIKeysResponseDTO.js +58 -0
  61. package/models/GetAPIKeysResponseDTO.js.map +1 -0
  62. package/models/GetAPIKeysResponseDTO.ts +105 -0
  63. package/models/PaginatedApplicationsDTO.js +68 -0
  64. package/models/PaginatedApplicationsDTO.js.map +1 -0
  65. package/models/PaginatedApplicationsDTO.ts +110 -0
  66. package/models/PdfCreatedRequestItemsDTO.js +63 -0
  67. package/models/PdfCreatedRequestItemsDTO.js.map +1 -0
  68. package/models/PdfCreatedRequestItemsDTO.ts +93 -0
  69. package/models/PdfTemplateDTO.js +53 -0
  70. package/models/PdfTemplateDTO.js.map +1 -0
  71. package/models/PdfTemplateDTO.ts +74 -0
  72. package/models/UpdateApplicationDTO.js +51 -0
  73. package/models/UpdateApplicationDTO.js.map +1 -0
  74. package/models/UpdateApplicationDTO.ts +73 -0
  75. package/models/index.js +34 -0
  76. package/models/index.js.map +1 -0
  77. package/models/index.ts +17 -0
  78. package/package.json +17 -0
  79. package/runtime.js +330 -0
  80. package/runtime.js.map +1 -0
  81. package/runtime.ts +432 -0
  82. package/tsconfig.build.tsbuildinfo +1 -0
@@ -0,0 +1,1115 @@
1
+ # ClientApi
2
+
3
+ All URIs are relative to *http://localhost:3000*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**apiKeysGet**](ClientApi.md#apikeysget) | **GET** /api-keys | Get all API keys for the authenticated user |
8
+ | [**apiKeysIdDelete**](ClientApi.md#apikeysiddelete) | **DELETE** /api-keys/{id} | Delete an API key |
9
+ | [**apiKeysPost**](ClientApi.md#apikeyspost) | **POST** /api-keys | Create a new API key |
10
+ | [**createAccount**](ClientApi.md#createaccount) | **POST** /accounts | Creates a new account |
11
+ | [**createApplication**](ClientApi.md#createapplication) | **POST** /applications | Create a new application |
12
+ | [**createPdfByTermplate**](ClientApi.md#createpdfbytermplate) | **POST** /api/applications/{applicationId}/create-pdf | Create PDF by template |
13
+ | [**deleteApplication**](ClientApi.md#deleteapplication) | **DELETE** /applications/{applicationId} | Delete an application |
14
+ | [**deletePDFTemplate**](ClientApi.md#deletepdftemplate) | **DELETE** /applications/{applicationId}/pdf-templates/{id} | Delete a pdf template |
15
+ | [**getApplicationByID**](ClientApi.md#getapplicationbyid) | **GET** /applications/{applicationId} | Get an application by applicationId |
16
+ | [**getApplications**](ClientApi.md#getapplications) | **GET** /applications | Get all applications for the account |
17
+ | [**getPdfTemplate**](ClientApi.md#getpdftemplate) | **GET** /applications/{applicationId}/pdf-templates/{id} | Get template by id |
18
+ | [**getPdfTemplates**](ClientApi.md#getpdftemplates) | **GET** /applications/{applicationId}/pdf-templates | Get all templates |
19
+ | [**updateApplication**](ClientApi.md#updateapplication) | **PATCH** /applications/{applicationId} | Update an application |
20
+ | [**updatePdfTemplate**](ClientApi.md#updatepdftemplate) | **PATCH** /applications/{applicationId}/pdf-templates/{id} | Update template |
21
+ | [**uploadPdfTemplate**](ClientApi.md#uploadpdftemplate) | **POST** /applications/{applicationId}/pdf-templates | Upload template |
22
+
23
+
24
+
25
+ ## apiKeysGet
26
+
27
+ > GetAPIKeysResponseDTO apiKeysGet(page, pageSize)
28
+
29
+ Get all API keys for the authenticated user
30
+
31
+ Retrieve all API keys associated with the authenticated user\'s account with pagination.
32
+
33
+ ### Example
34
+
35
+ ```ts
36
+ import {
37
+ Configuration,
38
+ ClientApi,
39
+ } from '';
40
+ import type { ApiKeysGetRequest } from '';
41
+
42
+ async function example() {
43
+ console.log("🚀 Testing SDK...");
44
+ const api = new ClientApi();
45
+
46
+ const body = {
47
+ // number | Page number for pagination(default: 1) (optional)
48
+ page: 56,
49
+ // number | Limit number of items per page (default: 10) (optional)
50
+ pageSize: 56,
51
+ } satisfies ApiKeysGetRequest;
52
+
53
+ try {
54
+ const data = await api.apiKeysGet(body);
55
+ console.log(data);
56
+ } catch (error) {
57
+ console.error(error);
58
+ }
59
+ }
60
+
61
+ // Run the test
62
+ example().catch(console.error);
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+
68
+ | Name | Type | Description | Notes |
69
+ |------------- | ------------- | ------------- | -------------|
70
+ | **page** | `number` | Page number for pagination(default: 1) | [Optional] [Defaults to `1`] |
71
+ | **pageSize** | `number` | Limit number of items per page (default: 10) | [Optional] [Defaults to `10`] |
72
+
73
+ ### Return type
74
+
75
+ [**GetAPIKeysResponseDTO**](GetAPIKeysResponseDTO.md)
76
+
77
+ ### Authorization
78
+
79
+ No authorization required
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: `application/json`
85
+
86
+
87
+ ### HTTP response details
88
+ | Status code | Description | Response headers |
89
+ |-------------|-------------|------------------|
90
+ | **200** | Returns a paginated list of API keys | - |
91
+ | **401** | Unauthorized | - |
92
+ | **500** | Internal server error: Failed to retrieve API keys | - |
93
+
94
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
95
+
96
+
97
+ ## apiKeysIdDelete
98
+
99
+ > apiKeysIdDelete(id)
100
+
101
+ Delete an API key
102
+
103
+ Delete a specific API key belonging to the authenticated user.
104
+
105
+ ### Example
106
+
107
+ ```ts
108
+ import {
109
+ Configuration,
110
+ ClientApi,
111
+ } from '';
112
+ import type { ApiKeysIdDeleteRequest } from '';
113
+
114
+ async function example() {
115
+ console.log("🚀 Testing SDK...");
116
+ const api = new ClientApi();
117
+
118
+ const body = {
119
+ // string | API Key ID
120
+ id: id_example,
121
+ } satisfies ApiKeysIdDeleteRequest;
122
+
123
+ try {
124
+ const data = await api.apiKeysIdDelete(body);
125
+ console.log(data);
126
+ } catch (error) {
127
+ console.error(error);
128
+ }
129
+ }
130
+
131
+ // Run the test
132
+ example().catch(console.error);
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+
138
+ | Name | Type | Description | Notes |
139
+ |------------- | ------------- | ------------- | -------------|
140
+ | **id** | `string` | API Key ID | [Defaults to `undefined`] |
141
+
142
+ ### Return type
143
+
144
+ `void` (Empty response body)
145
+
146
+ ### Authorization
147
+
148
+ No authorization required
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: `application/json`
154
+
155
+
156
+ ### HTTP response details
157
+ | Status code | Description | Response headers |
158
+ |-------------|-------------|------------------|
159
+ | **204** | API key deleted successfully | - |
160
+ | **400** | Invalid key ID format | - |
161
+ | **401** | Unauthorized | - |
162
+ | **404** | API key not found | - |
163
+ | **500** | Internal server error: Failed to delete API key | - |
164
+
165
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
166
+
167
+
168
+ ## apiKeysPost
169
+
170
+ > CreateAPIKeyResponseDTO apiKeysPost(createAPIKeyRequestDTO)
171
+
172
+ Create a new API key
173
+
174
+ Create a new API key for accessing the RAG service.
175
+
176
+ ### Example
177
+
178
+ ```ts
179
+ import {
180
+ Configuration,
181
+ ClientApi,
182
+ } from '';
183
+ import type { ApiKeysPostRequest } from '';
184
+
185
+ async function example() {
186
+ console.log("🚀 Testing SDK...");
187
+ const api = new ClientApi();
188
+
189
+ const body = {
190
+ // CreateAPIKeyRequestDTO | Create API Key request
191
+ createAPIKeyRequestDTO: ...,
192
+ } satisfies ApiKeysPostRequest;
193
+
194
+ try {
195
+ const data = await api.apiKeysPost(body);
196
+ console.log(data);
197
+ } catch (error) {
198
+ console.error(error);
199
+ }
200
+ }
201
+
202
+ // Run the test
203
+ example().catch(console.error);
204
+ ```
205
+
206
+ ### Parameters
207
+
208
+
209
+ | Name | Type | Description | Notes |
210
+ |------------- | ------------- | ------------- | -------------|
211
+ | **createAPIKeyRequestDTO** | [CreateAPIKeyRequestDTO](CreateAPIKeyRequestDTO.md) | Create API Key request | |
212
+
213
+ ### Return type
214
+
215
+ [**CreateAPIKeyResponseDTO**](CreateAPIKeyResponseDTO.md)
216
+
217
+ ### Authorization
218
+
219
+ No authorization required
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: `application/json`
224
+ - **Accept**: `application/json`
225
+
226
+
227
+ ### HTTP response details
228
+ | Status code | Description | Response headers |
229
+ |-------------|-------------|------------------|
230
+ | **201** | Create an API key and returns the created key | - |
231
+ | **400** | Invalid request format | - |
232
+ | **401** | Unauthorized | - |
233
+ | **500** | Server Error: Failed to create API key | - |
234
+
235
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
236
+
237
+
238
+ ## createAccount
239
+
240
+ > AccountDTO createAccount(createAccountDTO)
241
+
242
+ Creates a new account
243
+
244
+ Create an account
245
+
246
+ ### Example
247
+
248
+ ```ts
249
+ import {
250
+ Configuration,
251
+ ClientApi,
252
+ } from '';
253
+ import type { CreateAccountRequest } from '';
254
+
255
+ async function example() {
256
+ console.log("🚀 Testing SDK...");
257
+ const api = new ClientApi();
258
+
259
+ const body = {
260
+ // CreateAccountDTO | Account creation data
261
+ createAccountDTO: ...,
262
+ } satisfies CreateAccountRequest;
263
+
264
+ try {
265
+ const data = await api.createAccount(body);
266
+ console.log(data);
267
+ } catch (error) {
268
+ console.error(error);
269
+ }
270
+ }
271
+
272
+ // Run the test
273
+ example().catch(console.error);
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+
279
+ | Name | Type | Description | Notes |
280
+ |------------- | ------------- | ------------- | -------------|
281
+ | **createAccountDTO** | [CreateAccountDTO](CreateAccountDTO.md) | Account creation data | |
282
+
283
+ ### Return type
284
+
285
+ [**AccountDTO**](AccountDTO.md)
286
+
287
+ ### Authorization
288
+
289
+ No authorization required
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: `application/json`
294
+ - **Accept**: `application/json`
295
+
296
+
297
+ ### HTTP response details
298
+ | Status code | Description | Response headers |
299
+ |-------------|-------------|------------------|
300
+ | **201** | Create an account and returns the created account | - |
301
+ | **400** | Return an error if there is a missing or invalid field | - |
302
+ | **401** | Return an error if the user is not authenticated | - |
303
+ | **403** | Return an error if the user does not have the required permissions | - |
304
+ | **500** | Return an error if the server finds an error | - |
305
+
306
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
307
+
308
+
309
+ ## createApplication
310
+
311
+ > ApplicationDTO createApplication(createApplicationDTO)
312
+
313
+ Create a new application
314
+
315
+ Create a new application for the authenticated account
316
+
317
+ ### Example
318
+
319
+ ```ts
320
+ import {
321
+ Configuration,
322
+ ClientApi,
323
+ } from '';
324
+ import type { CreateApplicationRequest } from '';
325
+
326
+ async function example() {
327
+ console.log("🚀 Testing SDK...");
328
+ const api = new ClientApi();
329
+
330
+ const body = {
331
+ // CreateApplicationDTO | Application creation data
332
+ createApplicationDTO: ...,
333
+ } satisfies CreateApplicationRequest;
334
+
335
+ try {
336
+ const data = await api.createApplication(body);
337
+ console.log(data);
338
+ } catch (error) {
339
+ console.error(error);
340
+ }
341
+ }
342
+
343
+ // Run the test
344
+ example().catch(console.error);
345
+ ```
346
+
347
+ ### Parameters
348
+
349
+
350
+ | Name | Type | Description | Notes |
351
+ |------------- | ------------- | ------------- | -------------|
352
+ | **createApplicationDTO** | [CreateApplicationDTO](CreateApplicationDTO.md) | Application creation data | |
353
+
354
+ ### Return type
355
+
356
+ [**ApplicationDTO**](ApplicationDTO.md)
357
+
358
+ ### Authorization
359
+
360
+ No authorization required
361
+
362
+ ### HTTP request headers
363
+
364
+ - **Content-Type**: `application/json`
365
+ - **Accept**: `application/json`
366
+
367
+
368
+ ### HTTP response details
369
+ | Status code | Description | Response headers |
370
+ |-------------|-------------|------------------|
371
+ | **201** | Create a application and returns the created application | - |
372
+ | **400** | Return an error if there is a missing or invalid field | - |
373
+ | **401** | Return an error if the user is not authenticated | - |
374
+ | **403** | Return an error if the user does not have the required permissions | - |
375
+ | **500** | Return an error if the server founds an error | - |
376
+
377
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
378
+
379
+
380
+ ## createPdfByTermplate
381
+
382
+ > PdfTemplateDTO createPdfByTermplate(applicationId, createPdfRequestDTO)
383
+
384
+ Create PDF by template
385
+
386
+ Create PDF by template
387
+
388
+ ### Example
389
+
390
+ ```ts
391
+ import {
392
+ Configuration,
393
+ ClientApi,
394
+ } from '';
395
+ import type { CreatePdfByTermplateRequest } from '';
396
+
397
+ async function example() {
398
+ console.log("🚀 Testing SDK...");
399
+ const api = new ClientApi();
400
+
401
+ const body = {
402
+ // string | Application ID
403
+ applicationId: applicationId_example,
404
+ // CreatePdfRequestDTO | Request body to create PDF
405
+ createPdfRequestDTO: ...,
406
+ } satisfies CreatePdfByTermplateRequest;
407
+
408
+ try {
409
+ const data = await api.createPdfByTermplate(body);
410
+ console.log(data);
411
+ } catch (error) {
412
+ console.error(error);
413
+ }
414
+ }
415
+
416
+ // Run the test
417
+ example().catch(console.error);
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+
423
+ | Name | Type | Description | Notes |
424
+ |------------- | ------------- | ------------- | -------------|
425
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
426
+ | **createPdfRequestDTO** | [CreatePdfRequestDTO](CreatePdfRequestDTO.md) | Request body to create PDF | |
427
+
428
+ ### Return type
429
+
430
+ [**PdfTemplateDTO**](PdfTemplateDTO.md)
431
+
432
+ ### Authorization
433
+
434
+ No authorization required
435
+
436
+ ### HTTP request headers
437
+
438
+ - **Content-Type**: `application/json`
439
+ - **Accept**: `application/json`
440
+
441
+
442
+ ### HTTP response details
443
+ | Status code | Description | Response headers |
444
+ |-------------|-------------|------------------|
445
+ | **201** | Return the uploaded template details | - |
446
+ | **400** | Return an error if the file is not attached or it is invalid | - |
447
+ | **500** | Return an error if there is an internal server error | - |
448
+
449
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
450
+
451
+
452
+ ## deleteApplication
453
+
454
+ > deleteApplication(applicationId)
455
+
456
+ Delete an application
457
+
458
+ Delete an application belonging to the authenticated account
459
+
460
+ ### Example
461
+
462
+ ```ts
463
+ import {
464
+ Configuration,
465
+ ClientApi,
466
+ } from '';
467
+ import type { DeleteApplicationRequest } from '';
468
+
469
+ async function example() {
470
+ console.log("🚀 Testing SDK...");
471
+ const api = new ClientApi();
472
+
473
+ const body = {
474
+ // string | Application ID
475
+ applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
476
+ } satisfies DeleteApplicationRequest;
477
+
478
+ try {
479
+ const data = await api.deleteApplication(body);
480
+ console.log(data);
481
+ } catch (error) {
482
+ console.error(error);
483
+ }
484
+ }
485
+
486
+ // Run the test
487
+ example().catch(console.error);
488
+ ```
489
+
490
+ ### Parameters
491
+
492
+
493
+ | Name | Type | Description | Notes |
494
+ |------------- | ------------- | ------------- | -------------|
495
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
496
+
497
+ ### Return type
498
+
499
+ `void` (Empty response body)
500
+
501
+ ### Authorization
502
+
503
+ No authorization required
504
+
505
+ ### HTTP request headers
506
+
507
+ - **Content-Type**: Not defined
508
+ - **Accept**: `application/json`
509
+
510
+
511
+ ### HTTP response details
512
+ | Status code | Description | Response headers |
513
+ |-------------|-------------|------------------|
514
+ | **204** | Application deleted | - |
515
+ | **400** | Return an error if provided ID is not a valid UUID | - |
516
+ | **401** | Return an error if the user is not authenticated | - |
517
+ | **403** | Return an error if the user does not have the required permissions | - |
518
+ | **500** | Return an error if the server founds an error | - |
519
+
520
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
521
+
522
+
523
+ ## deletePDFTemplate
524
+
525
+ > deletePDFTemplate(id, applicationId)
526
+
527
+ Delete a pdf template
528
+
529
+ Delete a pdf template
530
+
531
+ ### Example
532
+
533
+ ```ts
534
+ import {
535
+ Configuration,
536
+ ClientApi,
537
+ } from '';
538
+ import type { DeletePDFTemplateRequest } from '';
539
+
540
+ async function example() {
541
+ console.log("🚀 Testing SDK...");
542
+ const api = new ClientApi();
543
+
544
+ const body = {
545
+ // string | Template ID
546
+ id: id_example,
547
+ // string | Application ID
548
+ applicationId: applicationId_example,
549
+ } satisfies DeletePDFTemplateRequest;
550
+
551
+ try {
552
+ const data = await api.deletePDFTemplate(body);
553
+ console.log(data);
554
+ } catch (error) {
555
+ console.error(error);
556
+ }
557
+ }
558
+
559
+ // Run the test
560
+ example().catch(console.error);
561
+ ```
562
+
563
+ ### Parameters
564
+
565
+
566
+ | Name | Type | Description | Notes |
567
+ |------------- | ------------- | ------------- | -------------|
568
+ | **id** | `string` | Template ID | [Defaults to `undefined`] |
569
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
570
+
571
+ ### Return type
572
+
573
+ `void` (Empty response body)
574
+
575
+ ### Authorization
576
+
577
+ No authorization required
578
+
579
+ ### HTTP request headers
580
+
581
+ - **Content-Type**: Not defined
582
+ - **Accept**: `application/json`
583
+
584
+
585
+ ### HTTP response details
586
+ | Status code | Description | Response headers |
587
+ |-------------|-------------|------------------|
588
+ | **204** | Template deleted successfully | - |
589
+ | **400** | Return an error if there is a missing or invalid field | - |
590
+ | **401** | Return an error if the user is not authorized | - |
591
+ | **404** | Return an error if pdf template not found | - |
592
+ | **500** | Return an error if an internal error occurs | - |
593
+
594
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
595
+
596
+
597
+ ## getApplicationByID
598
+
599
+ > ApplicationDTO getApplicationByID(applicationId)
600
+
601
+ Get an application by applicationId
602
+
603
+ Get a specific application belonging to the authenticated account
604
+
605
+ ### Example
606
+
607
+ ```ts
608
+ import {
609
+ Configuration,
610
+ ClientApi,
611
+ } from '';
612
+ import type { GetApplicationByIDRequest } from '';
613
+
614
+ async function example() {
615
+ console.log("🚀 Testing SDK...");
616
+ const api = new ClientApi();
617
+
618
+ const body = {
619
+ // string | Application ID
620
+ applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
621
+ } satisfies GetApplicationByIDRequest;
622
+
623
+ try {
624
+ const data = await api.getApplicationByID(body);
625
+ console.log(data);
626
+ } catch (error) {
627
+ console.error(error);
628
+ }
629
+ }
630
+
631
+ // Run the test
632
+ example().catch(console.error);
633
+ ```
634
+
635
+ ### Parameters
636
+
637
+
638
+ | Name | Type | Description | Notes |
639
+ |------------- | ------------- | ------------- | -------------|
640
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
641
+
642
+ ### Return type
643
+
644
+ [**ApplicationDTO**](ApplicationDTO.md)
645
+
646
+ ### Authorization
647
+
648
+ No authorization required
649
+
650
+ ### HTTP request headers
651
+
652
+ - **Content-Type**: Not defined
653
+ - **Accept**: `application/json`
654
+
655
+
656
+ ### HTTP response details
657
+ | Status code | Description | Response headers |
658
+ |-------------|-------------|------------------|
659
+ | **200** | Return an application | - |
660
+ | **400** | Return an error if provided ID is not a valid UUID | - |
661
+ | **401** | Return an error if the user is not authenticated | - |
662
+ | **403** | Return an error if the user does not have the required permissions | - |
663
+ | **404** | Return an error if the application is not found | - |
664
+ | **500** | Return an error if the server founds an error | - |
665
+
666
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
667
+
668
+
669
+ ## getApplications
670
+
671
+ > PaginatedApplicationsDTO getApplications(page, pageSize)
672
+
673
+ Get all applications for the account
674
+
675
+ Get all applications belonging to the authenticated account
676
+
677
+ ### Example
678
+
679
+ ```ts
680
+ import {
681
+ Configuration,
682
+ ClientApi,
683
+ } from '';
684
+ import type { GetApplicationsRequest } from '';
685
+
686
+ async function example() {
687
+ console.log("🚀 Testing SDK...");
688
+ const api = new ClientApi();
689
+
690
+ const body = {
691
+ // number | Page number for pagination (optional)
692
+ page: 56,
693
+ // number | Limit number of items per page (optional)
694
+ pageSize: 56,
695
+ } satisfies GetApplicationsRequest;
696
+
697
+ try {
698
+ const data = await api.getApplications(body);
699
+ console.log(data);
700
+ } catch (error) {
701
+ console.error(error);
702
+ }
703
+ }
704
+
705
+ // Run the test
706
+ example().catch(console.error);
707
+ ```
708
+
709
+ ### Parameters
710
+
711
+
712
+ | Name | Type | Description | Notes |
713
+ |------------- | ------------- | ------------- | -------------|
714
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
715
+ | **pageSize** | `number` | Limit number of items per page | [Optional] [Defaults to `10`] |
716
+
717
+ ### Return type
718
+
719
+ [**PaginatedApplicationsDTO**](PaginatedApplicationsDTO.md)
720
+
721
+ ### Authorization
722
+
723
+ No authorization required
724
+
725
+ ### HTTP request headers
726
+
727
+ - **Content-Type**: Not defined
728
+ - **Accept**: `application/json`
729
+
730
+
731
+ ### HTTP response details
732
+ | Status code | Description | Response headers |
733
+ |-------------|-------------|------------------|
734
+ | **200** | Return a list of applications | - |
735
+ | **401** | Return an error if the user is not authenticated | - |
736
+ | **403** | Return an error if the user does not have the required permissions | - |
737
+ | **500** | Return an error if the server founds an error | - |
738
+
739
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
740
+
741
+
742
+ ## getPdfTemplate
743
+
744
+ > string getPdfTemplate(id, applicationId)
745
+
746
+ Get template by id
747
+
748
+ Get template by id
749
+
750
+ ### Example
751
+
752
+ ```ts
753
+ import {
754
+ Configuration,
755
+ ClientApi,
756
+ } from '';
757
+ import type { GetPdfTemplateRequest } from '';
758
+
759
+ async function example() {
760
+ console.log("🚀 Testing SDK...");
761
+ const api = new ClientApi();
762
+
763
+ const body = {
764
+ // string | Template id
765
+ id: id_example,
766
+ // string | Application ID
767
+ applicationId: applicationId_example,
768
+ } satisfies GetPdfTemplateRequest;
769
+
770
+ try {
771
+ const data = await api.getPdfTemplate(body);
772
+ console.log(data);
773
+ } catch (error) {
774
+ console.error(error);
775
+ }
776
+ }
777
+
778
+ // Run the test
779
+ example().catch(console.error);
780
+ ```
781
+
782
+ ### Parameters
783
+
784
+
785
+ | Name | Type | Description | Notes |
786
+ |------------- | ------------- | ------------- | -------------|
787
+ | **id** | `string` | Template id | [Defaults to `undefined`] |
788
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
789
+
790
+ ### Return type
791
+
792
+ **string**
793
+
794
+ ### Authorization
795
+
796
+ No authorization required
797
+
798
+ ### HTTP request headers
799
+
800
+ - **Content-Type**: Not defined
801
+ - **Accept**: `application/json`
802
+
803
+
804
+ ### HTTP response details
805
+ | Status code | Description | Response headers |
806
+ |-------------|-------------|------------------|
807
+ | **200** | Return html template | - |
808
+ | **400** | Return an error if the template id is invalid | - |
809
+ | **404** | Return an error if the template is not found | - |
810
+ | **500** | Return an error if there is an internal server error | - |
811
+
812
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
813
+
814
+
815
+ ## getPdfTemplates
816
+
817
+ > Array<PdfTemplateDTO> getPdfTemplates(applicationId, page, pageSize)
818
+
819
+ Get all templates
820
+
821
+ Get all templates
822
+
823
+ ### Example
824
+
825
+ ```ts
826
+ import {
827
+ Configuration,
828
+ ClientApi,
829
+ } from '';
830
+ import type { GetPdfTemplatesRequest } from '';
831
+
832
+ async function example() {
833
+ console.log("🚀 Testing SDK...");
834
+ const api = new ClientApi();
835
+
836
+ const body = {
837
+ // string | Application ID
838
+ applicationId: applicationId_example,
839
+ // number | Page number for pagination (optional)
840
+ page: 56,
841
+ // number | Limit number of items per page (optional)
842
+ pageSize: 56,
843
+ } satisfies GetPdfTemplatesRequest;
844
+
845
+ try {
846
+ const data = await api.getPdfTemplates(body);
847
+ console.log(data);
848
+ } catch (error) {
849
+ console.error(error);
850
+ }
851
+ }
852
+
853
+ // Run the test
854
+ example().catch(console.error);
855
+ ```
856
+
857
+ ### Parameters
858
+
859
+
860
+ | Name | Type | Description | Notes |
861
+ |------------- | ------------- | ------------- | -------------|
862
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
863
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `undefined`] |
864
+ | **pageSize** | `number` | Limit number of items per page | [Optional] [Defaults to `undefined`] |
865
+
866
+ ### Return type
867
+
868
+ [**Array<PdfTemplateDTO>**](PdfTemplateDTO.md)
869
+
870
+ ### Authorization
871
+
872
+ No authorization required
873
+
874
+ ### HTTP request headers
875
+
876
+ - **Content-Type**: Not defined
877
+ - **Accept**: `application/json`
878
+
879
+
880
+ ### HTTP response details
881
+ | Status code | Description | Response headers |
882
+ |-------------|-------------|------------------|
883
+ | **200** | Return all templates | - |
884
+ | **500** | Return an error if there is an internal server error | - |
885
+
886
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
887
+
888
+
889
+ ## updateApplication
890
+
891
+ > ApplicationDTO updateApplication(applicationId, updateApplicationDTO)
892
+
893
+ Update an application
894
+
895
+ Update an application belonging to the authenticated account
896
+
897
+ ### Example
898
+
899
+ ```ts
900
+ import {
901
+ Configuration,
902
+ ClientApi,
903
+ } from '';
904
+ import type { UpdateApplicationRequest } from '';
905
+
906
+ async function example() {
907
+ console.log("🚀 Testing SDK...");
908
+ const api = new ClientApi();
909
+
910
+ const body = {
911
+ // string | Application ID
912
+ applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
913
+ // UpdateApplicationDTO | Application update data
914
+ updateApplicationDTO: ...,
915
+ } satisfies UpdateApplicationRequest;
916
+
917
+ try {
918
+ const data = await api.updateApplication(body);
919
+ console.log(data);
920
+ } catch (error) {
921
+ console.error(error);
922
+ }
923
+ }
924
+
925
+ // Run the test
926
+ example().catch(console.error);
927
+ ```
928
+
929
+ ### Parameters
930
+
931
+
932
+ | Name | Type | Description | Notes |
933
+ |------------- | ------------- | ------------- | -------------|
934
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
935
+ | **updateApplicationDTO** | [UpdateApplicationDTO](UpdateApplicationDTO.md) | Application update data | |
936
+
937
+ ### Return type
938
+
939
+ [**ApplicationDTO**](ApplicationDTO.md)
940
+
941
+ ### Authorization
942
+
943
+ No authorization required
944
+
945
+ ### HTTP request headers
946
+
947
+ - **Content-Type**: `application/json`
948
+ - **Accept**: `application/json`
949
+
950
+
951
+ ### HTTP response details
952
+ | Status code | Description | Response headers |
953
+ |-------------|-------------|------------------|
954
+ | **200** | Updates an application and return an updated application if the ID exists | - |
955
+ | **400** | Return an error if provided ID is not a valid UUID | - |
956
+ | **401** | Return an error if the user is not authenticated | - |
957
+ | **403** | Return an error if the user does not have the required permissions | - |
958
+ | **404** | Return an error if the application is not found | - |
959
+ | **500** | Return an error if the server founds an error | - |
960
+
961
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
962
+
963
+
964
+ ## updatePdfTemplate
965
+
966
+ > PdfTemplateDTO updatePdfTemplate(applicationId, id, file, name)
967
+
968
+ Update template
969
+
970
+ Update template
971
+
972
+ ### Example
973
+
974
+ ```ts
975
+ import {
976
+ Configuration,
977
+ ClientApi,
978
+ } from '';
979
+ import type { UpdatePdfTemplateRequest } from '';
980
+
981
+ async function example() {
982
+ console.log("🚀 Testing SDK...");
983
+ const api = new ClientApi();
984
+
985
+ const body = {
986
+ // string | Application ID
987
+ applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
988
+ // string | pdf template ID
989
+ id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
990
+ // Blob | Template file
991
+ file: BINARY_DATA_HERE,
992
+ // string | Template name
993
+ name: name_example,
994
+ } satisfies UpdatePdfTemplateRequest;
995
+
996
+ try {
997
+ const data = await api.updatePdfTemplate(body);
998
+ console.log(data);
999
+ } catch (error) {
1000
+ console.error(error);
1001
+ }
1002
+ }
1003
+
1004
+ // Run the test
1005
+ example().catch(console.error);
1006
+ ```
1007
+
1008
+ ### Parameters
1009
+
1010
+
1011
+ | Name | Type | Description | Notes |
1012
+ |------------- | ------------- | ------------- | -------------|
1013
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
1014
+ | **id** | `string` | pdf template ID | [Defaults to `undefined`] |
1015
+ | **file** | `Blob` | Template file | [Defaults to `undefined`] |
1016
+ | **name** | `string` | Template name | [Defaults to `undefined`] |
1017
+
1018
+ ### Return type
1019
+
1020
+ [**PdfTemplateDTO**](PdfTemplateDTO.md)
1021
+
1022
+ ### Authorization
1023
+
1024
+ No authorization required
1025
+
1026
+ ### HTTP request headers
1027
+
1028
+ - **Content-Type**: `multipart/form-data`
1029
+ - **Accept**: `application/json`
1030
+
1031
+
1032
+ ### HTTP response details
1033
+ | Status code | Description | Response headers |
1034
+ |-------------|-------------|------------------|
1035
+ | **201** | Return the uploaded template details | - |
1036
+ | **400** | Return an error if the file is not attached or it is invalid | - |
1037
+ | **500** | Return an error if there is an internal server error | - |
1038
+
1039
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1040
+
1041
+
1042
+ ## uploadPdfTemplate
1043
+
1044
+ > PdfTemplateDTO uploadPdfTemplate(applicationId, file, name)
1045
+
1046
+ Upload template
1047
+
1048
+ Upload template
1049
+
1050
+ ### Example
1051
+
1052
+ ```ts
1053
+ import {
1054
+ Configuration,
1055
+ ClientApi,
1056
+ } from '';
1057
+ import type { UploadPdfTemplateRequest } from '';
1058
+
1059
+ async function example() {
1060
+ console.log("🚀 Testing SDK...");
1061
+ const api = new ClientApi();
1062
+
1063
+ const body = {
1064
+ // string | Application ID
1065
+ applicationId: applicationId_example,
1066
+ // Blob | Template file
1067
+ file: BINARY_DATA_HERE,
1068
+ // string | Template name
1069
+ name: name_example,
1070
+ } satisfies UploadPdfTemplateRequest;
1071
+
1072
+ try {
1073
+ const data = await api.uploadPdfTemplate(body);
1074
+ console.log(data);
1075
+ } catch (error) {
1076
+ console.error(error);
1077
+ }
1078
+ }
1079
+
1080
+ // Run the test
1081
+ example().catch(console.error);
1082
+ ```
1083
+
1084
+ ### Parameters
1085
+
1086
+
1087
+ | Name | Type | Description | Notes |
1088
+ |------------- | ------------- | ------------- | -------------|
1089
+ | **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
1090
+ | **file** | `Blob` | Template file | [Defaults to `undefined`] |
1091
+ | **name** | `string` | Template name | [Defaults to `undefined`] |
1092
+
1093
+ ### Return type
1094
+
1095
+ [**PdfTemplateDTO**](PdfTemplateDTO.md)
1096
+
1097
+ ### Authorization
1098
+
1099
+ No authorization required
1100
+
1101
+ ### HTTP request headers
1102
+
1103
+ - **Content-Type**: `multipart/form-data`
1104
+ - **Accept**: `application/json`
1105
+
1106
+
1107
+ ### HTTP response details
1108
+ | Status code | Description | Response headers |
1109
+ |-------------|-------------|------------------|
1110
+ | **201** | Return the uploaded template details | - |
1111
+ | **400** | Return an error if the file is not attached or it is invalid | - |
1112
+ | **500** | Return an error if there is an internal server error | - |
1113
+
1114
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1115
+