@caraer/client 2.0.437 → 2.0.441

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 (122) hide show
  1. package/.openapi-generator/FILES +87 -2
  2. package/api.ts +1952 -755
  3. package/dist/api.d.ts +2039 -713
  4. package/dist/api.js +471 -465
  5. package/dist/esm/api.d.ts +2039 -713
  6. package/dist/esm/api.js +468 -462
  7. package/docs/AppBarIframeSessionsApi.md +10 -4
  8. package/docs/AppBarsApi.md +11 -4
  9. package/docs/AppInstallationRuntimeApi.md +58 -0
  10. package/docs/ApplicationsApi.md +128 -58
  11. package/docs/AutomationsApi.md +6 -4
  12. package/docs/BillingApi.md +10 -4
  13. package/docs/CRUD.md +24 -0
  14. package/docs/CompanyApi.md +44 -18
  15. package/docs/CreateResponseFeedDTO.md +23 -0
  16. package/docs/CreateResponseMapStringString.md +23 -0
  17. package/docs/DeleteResponseFeedDTO.md +23 -0
  18. package/docs/DeveloperProjectsApi.md +31 -6
  19. package/docs/DeveloperSandboxDTO.md +43 -0
  20. package/docs/DeveloperSandboxesApi.md +12 -2
  21. package/docs/ErrorResponse.md +3 -3
  22. package/docs/ExistingWidgetSummary.md +4 -4
  23. package/docs/FeedsApi.md +11 -6
  24. package/docs/FileManagementApi.md +19 -9
  25. package/docs/FilterApi.md +21 -8
  26. package/docs/FlowPaginationRequest.md +43 -0
  27. package/docs/FormsApi.md +95 -56
  28. package/docs/ModuleApi.md +61 -38
  29. package/docs/NotificationsApi.md +15 -2
  30. package/docs/ObjectsApi.md +80 -39
  31. package/docs/PaginationRequest.md +31 -0
  32. package/docs/PaginationResponseAppDTO.md +31 -0
  33. package/docs/PaginationResponseCaraerObjectDTO.md +31 -0
  34. package/docs/PaginationResponseCompanyDTO.md +31 -0
  35. package/docs/{PaginationResponse.md → PaginationResponseFeedDTO.md} +4 -4
  36. package/docs/PaginationResponseFormDTO.md +31 -0
  37. package/docs/PaginationResponseMapStringObject.md +31 -0
  38. package/docs/PaginationResponseObject.md +31 -0
  39. package/docs/PaginationResponsePageContentDTO.md +31 -0
  40. package/docs/PaginationResponsePropertyCalculationTypeDTO.md +31 -0
  41. package/docs/PaginationResponsePropertyDTO.md +31 -0
  42. package/docs/PaginationResponsePropertyFormat.md +31 -0
  43. package/docs/PaginationResponsePropertyOption.md +31 -0
  44. package/docs/PaginationResponsePublicEnvironmentDTO.md +31 -0
  45. package/docs/PaginationResponsePublicFormDTO.md +31 -0
  46. package/docs/PaginationResponseRelationDTO.md +31 -0
  47. package/docs/PaginationResponseSavedFilterDTO.md +31 -0
  48. package/docs/PaginationResponseServerlessFunctionDTO.md +31 -0
  49. package/docs/PaginationResponseSubscribeWebhookDTO.md +31 -0
  50. package/docs/PaginationResponseSyncDTO.md +31 -0
  51. package/docs/PaginationResponseTraitDTO.md +31 -0
  52. package/docs/PaginationResponseViewDTO.md +31 -0
  53. package/docs/PaginationResponseWebMenuDTO.md +31 -0
  54. package/docs/ProjectBuildDTO.md +55 -0
  55. package/docs/ProjectDeployDTO.md +53 -0
  56. package/docs/PropertyApi.md +84 -47
  57. package/docs/PublicFormDTO.md +55 -0
  58. package/docs/RecordPaginationRequest.md +37 -0
  59. package/docs/RecordsApi.md +141 -60
  60. package/docs/RelationsApi.md +82 -48
  61. package/docs/SearchRequest.md +29 -0
  62. package/docs/ServerlessFunctionsApi.md +42 -16
  63. package/docs/ShowResponse.md +3 -3
  64. package/docs/ShowResponseAnalyticsDashboardConfig.md +23 -0
  65. package/docs/ShowResponseAppBarIframeSessionContextDTO.md +23 -0
  66. package/docs/ShowResponseAppBarIframeSessionTokenDTO.md +23 -0
  67. package/docs/ShowResponseAppDTO.md +23 -0
  68. package/docs/ShowResponseBillingStatusDTO.md +23 -0
  69. package/docs/ShowResponseCaraerObjectDTO.md +23 -0
  70. package/docs/ShowResponseCompanyDTO.md +23 -0
  71. package/docs/ShowResponseDeveloperProjectDTO.md +23 -0
  72. package/docs/ShowResponseDigitalIdentityDTO.md +23 -0
  73. package/docs/ShowResponseFeedDTO.md +23 -0
  74. package/docs/ShowResponseFormDTO.md +23 -0
  75. package/docs/ShowResponseListEnvironmentDTO.md +23 -0
  76. package/docs/ShowResponseListFormObjectSummaryDTO.md +23 -0
  77. package/docs/ShowResponseListInstalledAppBarDTO.md +23 -0
  78. package/docs/ShowResponseListPropertyDTO.md +23 -0
  79. package/docs/ShowResponseListWebpagePickerItemDTO.md +23 -0
  80. package/docs/ShowResponseLoadAppSettingOptionsResponse.md +23 -0
  81. package/docs/ShowResponseMapStringAnalyticsDashboardConfig.md +23 -0
  82. package/docs/ShowResponseMapStringBoolean.md +23 -0
  83. package/docs/ShowResponseMapStringString.md +23 -0
  84. package/docs/ShowResponsePageContentDTO.md +23 -0
  85. package/docs/ShowResponsePreviewDTO.md +23 -0
  86. package/docs/ShowResponsePropertyDTO.md +23 -0
  87. package/docs/ShowResponsePublicFormDTO.md +23 -0
  88. package/docs/ShowResponseRelationDTO.md +23 -0
  89. package/docs/ShowResponseSavedFilterDTO.md +23 -0
  90. package/docs/ShowResponseServerlessFunctionDTO.md +23 -0
  91. package/docs/ShowResponseString.md +23 -0
  92. package/docs/ShowResponseSubscribeWebhookDTO.md +23 -0
  93. package/docs/ShowResponseTemplateWebpageDTO.md +23 -0
  94. package/docs/ShowResponseTraitDTO.md +23 -0
  95. package/docs/ShowResponseViewDTO.md +23 -0
  96. package/docs/ShowResponseWebMenuDTO.md +23 -0
  97. package/docs/ShowResponseWebsiteSettingsDTO.md +23 -0
  98. package/docs/SuccessResponseAggregateResponse.md +23 -0
  99. package/docs/SuccessResponseCollectionRelation.md +23 -0
  100. package/docs/SuccessResponseCompanyDTO.md +23 -0
  101. package/docs/{SuccessResponse.md → SuccessResponseFeedDTO.md} +4 -4
  102. package/docs/SuccessResponseFlow.md +23 -0
  103. package/docs/SuccessResponseListAggregateResponse.md +23 -0
  104. package/docs/SuccessResponseListCaraerObjectDTO.md +23 -0
  105. package/docs/SuccessResponseListDeveloperSandboxDTO.md +23 -0
  106. package/docs/SuccessResponseListMapStringObject.md +23 -0
  107. package/docs/SuccessResponseListProjectBuildDTO.md +23 -0
  108. package/docs/SuccessResponseListProjectDeployDTO.md +23 -0
  109. package/docs/SuccessResponseListPropertyDTO.md +23 -0
  110. package/docs/SuccessResponseListString.md +23 -0
  111. package/docs/SuccessResponseMapStringInteger.md +23 -0
  112. package/docs/SuccessResponseMapStringObject.md +23 -0
  113. package/docs/SuccessResponseObject.md +23 -0
  114. package/docs/SuccessResponseSuggestAnalyticsWidgetsResponse.md +23 -0
  115. package/docs/SuccessResponseTable.md +23 -0
  116. package/docs/SyncApi.md +27 -9
  117. package/docs/TraitsApi.md +41 -23
  118. package/docs/UpdateResponseFeedDTO.md +23 -0
  119. package/docs/ViewsApi.md +44 -26
  120. package/docs/WebMenusApi.md +30 -12
  121. package/docs/WebpagesApi.md +128 -24
  122. package/package.json +1 -1
@@ -7,7 +7,7 @@ All URIs are relative to *https://v2.api.caraer.com*
7
7
  |[**getToken**](#gettoken) | **GET** /api/v2/automations/token | Get Latenode JWT token for current user|
8
8
 
9
9
  # **getToken**
10
- > string getToken()
10
+ > ShowResponseMapStringString getToken()
11
11
 
12
12
  Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
13
13
 
@@ -31,7 +31,7 @@ This endpoint does not have any parameters.
31
31
 
32
32
  ### Return type
33
33
 
34
- **string**
34
+ **ShowResponseMapStringString**
35
35
 
36
36
  ### Authorization
37
37
 
@@ -47,8 +47,10 @@ This endpoint does not have any parameters.
47
47
  | Status code | Description | Response headers |
48
48
  |-------------|-------------|------------------|
49
49
  |**200** | Successfully generated token | - |
50
- |**401** | Unauthorized access | - |
51
- |**500** | Internal server error | - |
50
+ |**401** | Authentication is required or the token is invalid. | - |
51
+ |**403** | The caller is missing a required role or scope. | - |
52
+ |**404** | The requested resource was not found. | - |
53
+ |**500** | An internal server error occurred. | - |
52
54
 
53
55
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
54
56
 
@@ -8,7 +8,7 @@ All URIs are relative to *https://v2.api.caraer.com*
8
8
  |[**sendSetupEmail**](#sendsetupemail) | **POST** /api/v2/billing/setup-email | Send billing setup email|
9
9
 
10
10
  # **getStatus**
11
- > ShowResponse getStatus()
11
+ > ShowResponseBillingStatusDTO getStatus()
12
12
 
13
13
  Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
14
14
 
@@ -32,7 +32,7 @@ This endpoint does not have any parameters.
32
32
 
33
33
  ### Return type
34
34
 
35
- **ShowResponse**
35
+ **ShowResponseBillingStatusDTO**
36
36
 
37
37
  ### Authorization
38
38
 
@@ -49,11 +49,14 @@ This endpoint does not have any parameters.
49
49
  |-------------|-------------|------------------|
50
50
  |**200** | Billing status | - |
51
51
  |**401** | Unauthorized | - |
52
+ |**403** | The caller is missing a required role or scope. | - |
53
+ |**404** | The requested resource was not found. | - |
54
+ |**500** | An internal server error occurred. | - |
52
55
 
53
56
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
54
57
 
55
58
  # **sendSetupEmail**
56
- > ShowResponse sendSetupEmail()
59
+ > ShowResponseMapStringBoolean sendSetupEmail()
57
60
 
58
61
  Triggers Jortt to email the linked customer a direct-debit authorization payment link.
59
62
 
@@ -77,7 +80,7 @@ This endpoint does not have any parameters.
77
80
 
78
81
  ### Return type
79
82
 
80
- **ShowResponse**
83
+ **ShowResponseMapStringBoolean**
81
84
 
82
85
  ### Authorization
83
86
 
@@ -96,6 +99,9 @@ This endpoint does not have any parameters.
96
99
  |**400** | Missing CRM link, Jortt customer id, or already accepted | - |
97
100
  |**401** | Unauthorized | - |
98
101
  |**503** | Jortt or CRM not configured | - |
102
+ |**403** | The caller is missing a required role or scope. | - |
103
+ |**404** | The requested resource was not found. | - |
104
+ |**500** | An internal server error occurred. | - |
99
105
 
100
106
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
101
107
 
package/docs/CRUD.md ADDED
@@ -0,0 +1,24 @@
1
+ # CRUD
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **sessionType** | **string** | | [optional] [default to undefined]
9
+ **httpSessionId** | **string** | | [optional] [default to undefined]
10
+ **turnOffMetaRelationships** | **boolean** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CRUD } from '@caraer/client';
16
+
17
+ const instance: CRUD = {
18
+ sessionType,
19
+ httpSessionId,
20
+ turnOffMetaRelationships,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -19,7 +19,7 @@ All URIs are relative to *https://v2.api.caraer.com*
19
19
  |[**uploadFont**](#uploadfont) | **POST** /api/v2/company/uploadFont | Upload a font file|
20
20
 
21
21
  # **createCompany**
22
- > SuccessResponse createCompany(createCompanyRequest)
22
+ > SuccessResponseCompanyDTO createCompany(createCompanyRequest)
23
23
 
24
24
  Creates a new company based on the provided request data.
25
25
 
@@ -51,7 +51,7 @@ const { status, data } = await apiInstance.createCompany(
51
51
 
52
52
  ### Return type
53
53
 
54
- **SuccessResponse**
54
+ **SuccessResponseCompanyDTO**
55
55
 
56
56
  ### Authorization
57
57
 
@@ -70,11 +70,13 @@ const { status, data } = await apiInstance.createCompany(
70
70
  |**400** | Invalid input | - |
71
71
  |**401** | Unauthorized | - |
72
72
  |**403** | Insufficient scope | - |
73
+ |**404** | The requested resource was not found. | - |
74
+ |**500** | An internal server error occurred. | - |
73
75
 
74
76
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
75
77
 
76
78
  # **getCompany**
77
- > ShowResponse getCompany()
79
+ > ShowResponseCompanyDTO getCompany()
78
80
 
79
81
  Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope.
80
82
 
@@ -98,7 +100,7 @@ This endpoint does not have any parameters.
98
100
 
99
101
  ### Return type
100
102
 
101
- **ShowResponse**
103
+ **ShowResponseCompanyDTO**
102
104
 
103
105
  ### Authorization
104
106
 
@@ -116,11 +118,13 @@ This endpoint does not have any parameters.
116
118
  |**200** | Company returned successfully | - |
117
119
  |**401** | Unauthorized | - |
118
120
  |**403** | Insufficient scope | - |
121
+ |**404** | The requested resource was not found. | - |
122
+ |**500** | An internal server error occurred. | - |
119
123
 
120
124
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
121
125
 
122
126
  # **getCompanyByUuid**
123
- > ShowResponse getCompanyByUuid()
127
+ > ShowResponseCompanyDTO getCompanyByUuid()
124
128
 
125
129
  Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope.
126
130
 
@@ -151,7 +155,7 @@ const { status, data } = await apiInstance.getCompanyByUuid(
151
155
 
152
156
  ### Return type
153
157
 
154
- **ShowResponse**
158
+ **ShowResponseCompanyDTO**
155
159
 
156
160
  ### Authorization
157
161
 
@@ -170,11 +174,12 @@ const { status, data } = await apiInstance.getCompanyByUuid(
170
174
  |**401** | Unauthorized | - |
171
175
  |**403** | Insufficient scope | - |
172
176
  |**404** | Company not found | - |
177
+ |**500** | An internal server error occurred. | - |
173
178
 
174
179
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
175
180
 
176
181
  # **getDigitalIdentity**
177
- > ShowResponse getDigitalIdentity()
182
+ > ShowResponseDigitalIdentityDTO getDigitalIdentity()
178
183
 
179
184
  Returns the digital identity (branding) for the company currently selected by the logged-in user.
180
185
 
@@ -198,7 +203,7 @@ This endpoint does not have any parameters.
198
203
 
199
204
  ### Return type
200
205
 
201
- **ShowResponse**
206
+ **ShowResponseDigitalIdentityDTO**
202
207
 
203
208
  ### Authorization
204
209
 
@@ -216,11 +221,13 @@ This endpoint does not have any parameters.
216
221
  |**200** | Digital identity returned successfully | - |
217
222
  |**401** | Unauthorized | - |
218
223
  |**403** | Insufficient scope | - |
224
+ |**404** | The requested resource was not found. | - |
225
+ |**500** | An internal server error occurred. | - |
219
226
 
220
227
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
221
228
 
222
229
  # **getSuiteDashboard**
223
- > ShowResponse getSuiteDashboard()
230
+ > ShowResponseAnalyticsDashboardConfig getSuiteDashboard()
224
231
 
225
232
  Returns the home analytics dashboard for a suite. Empty dashboard when none is saved.
226
233
 
@@ -251,7 +258,7 @@ const { status, data } = await apiInstance.getSuiteDashboard(
251
258
 
252
259
  ### Return type
253
260
 
254
- **ShowResponse**
261
+ **ShowResponseAnalyticsDashboardConfig**
255
262
 
256
263
  ### Authorization
257
264
 
@@ -268,11 +275,14 @@ const { status, data } = await apiInstance.getSuiteDashboard(
268
275
  |-------------|-------------|------------------|
269
276
  |**200** | Suite dashboard returned | - |
270
277
  |**401** | Unauthorized | - |
278
+ |**403** | The caller is missing a required role or scope. | - |
279
+ |**404** | The requested resource was not found. | - |
280
+ |**500** | An internal server error occurred. | - |
271
281
 
272
282
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
273
283
 
274
284
  # **getSuiteDashboards**
275
- > ShowResponse getSuiteDashboards()
285
+ > ShowResponseMapStringAnalyticsDashboardConfig getSuiteDashboards()
276
286
 
277
287
  Returns all home analytics dashboards keyed by suite name for the selected company.
278
288
 
@@ -296,7 +306,7 @@ This endpoint does not have any parameters.
296
306
 
297
307
  ### Return type
298
308
 
299
- **ShowResponse**
309
+ **ShowResponseMapStringAnalyticsDashboardConfig**
300
310
 
301
311
  ### Authorization
302
312
 
@@ -313,11 +323,14 @@ This endpoint does not have any parameters.
313
323
  |-------------|-------------|------------------|
314
324
  |**200** | Suite dashboards returned | - |
315
325
  |**401** | Unauthorized | - |
326
+ |**403** | The caller is missing a required role or scope. | - |
327
+ |**404** | The requested resource was not found. | - |
328
+ |**500** | An internal server error occurred. | - |
316
329
 
317
330
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
318
331
 
319
332
  # **getWebsiteSettings**
320
- > ShowResponse getWebsiteSettings()
333
+ > ShowResponseWebsiteSettingsDTO getWebsiteSettings()
321
334
 
322
335
  Returns the website settings for the company currently selected by the logged-in user.
323
336
 
@@ -341,7 +354,7 @@ This endpoint does not have any parameters.
341
354
 
342
355
  ### Return type
343
356
 
344
- **ShowResponse**
357
+ **ShowResponseWebsiteSettingsDTO**
345
358
 
346
359
  ### Authorization
347
360
 
@@ -359,11 +372,13 @@ This endpoint does not have any parameters.
359
372
  |**200** | Website settings returned successfully | - |
360
373
  |**401** | Unauthorized | - |
361
374
  |**403** | Insufficient scope | - |
375
+ |**404** | The requested resource was not found. | - |
376
+ |**500** | An internal server error occurred. | - |
362
377
 
363
378
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
364
379
 
365
380
  # **resumeWebhookDispatch**
366
- > SuccessResponse resumeWebhookDispatch()
381
+ > SuccessResponseMapStringObject resumeWebhookDispatch()
367
382
 
368
383
  Clears the per-company webhook circuit breaker so outbound deliveries resume immediately.
369
384
 
@@ -394,7 +409,7 @@ const { status, data } = await apiInstance.resumeWebhookDispatch(
394
409
 
395
410
  ### Return type
396
411
 
397
- **SuccessResponse**
412
+ **SuccessResponseMapStringObject**
398
413
 
399
414
  ### Authorization
400
415
 
@@ -412,6 +427,8 @@ const { status, data } = await apiInstance.resumeWebhookDispatch(
412
427
  |**200** | Circuit breaker cleared | - |
413
428
  |**401** | Unauthorized | - |
414
429
  |**403** | Insufficient scope | - |
430
+ |**404** | The requested resource was not found. | - |
431
+ |**500** | An internal server error occurred. | - |
415
432
 
416
433
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
417
434
 
@@ -470,6 +487,7 @@ const { status, data } = await apiInstance.updateCompany(
470
487
  |**401** | Unauthorized | - |
471
488
  |**403** | Insufficient scope | - |
472
489
  |**404** | Company not found | - |
490
+ |**500** | An internal server error occurred. | - |
473
491
 
474
492
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
475
493
 
@@ -525,6 +543,7 @@ const { status, data } = await apiInstance.updateDigitalIdentity(
525
543
  |**401** | Unauthorized | - |
526
544
  |**403** | Insufficient scope | - |
527
545
  |**404** | Digital identity not found for company | - |
546
+ |**500** | An internal server error occurred. | - |
528
547
 
529
548
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
530
549
 
@@ -582,6 +601,9 @@ const { status, data } = await apiInstance.updateSuiteDashboard(
582
601
  |**200** | Suite dashboard saved | - |
583
602
  |**400** | Invalid dashboard config | - |
584
603
  |**401** | Unauthorized | - |
604
+ |**403** | The caller is missing a required role or scope. | - |
605
+ |**404** | The requested resource was not found. | - |
606
+ |**500** | An internal server error occurred. | - |
585
607
 
586
608
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
587
609
 
@@ -637,11 +659,12 @@ const { status, data } = await apiInstance.updateWebsiteSettings(
637
659
  |**401** | Unauthorized | - |
638
660
  |**403** | Insufficient scope | - |
639
661
  |**404** | Website settings not found for company | - |
662
+ |**500** | An internal server error occurred. | - |
640
663
 
641
664
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
642
665
 
643
666
  # **uploadFont**
644
- > SuccessResponse uploadFont()
667
+ > SuccessResponseString uploadFont()
645
668
 
646
669
  Uploads a font file to S3 storage and returns the public URL.
647
670
 
@@ -672,7 +695,7 @@ const { status, data } = await apiInstance.uploadFont(
672
695
 
673
696
  ### Return type
674
697
 
675
- **SuccessResponse**
698
+ **SuccessResponseString**
676
699
 
677
700
  ### Authorization
678
701
 
@@ -690,6 +713,9 @@ const { status, data } = await apiInstance.uploadFont(
690
713
  |**200** | Font uploaded successfully | - |
691
714
  |**400** | Invalid file provided | - |
692
715
  |**500** | Internal server error | - |
716
+ |**401** | Authentication is required or the token is invalid. | - |
717
+ |**403** | The caller is missing a required role or scope. | - |
718
+ |**404** | The requested resource was not found. | - |
693
719
 
694
720
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
695
721
 
@@ -0,0 +1,23 @@
1
+ # CreateResponseFeedDTO
2
+
3
+ Response for a successful resource creation operation.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
10
+ **data** | [**FeedDTO**](FeedDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateResponseFeedDTO } from '@caraer/client';
16
+
17
+ const instance: CreateResponseFeedDTO = {
18
+ message,
19
+ data,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # CreateResponseMapStringString
2
+
3
+ Success response (CreateResponseMapStringString).
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | | [optional] [default to undefined]
10
+ **data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateResponseMapStringString } from '@caraer/client';
16
+
17
+ const instance: CreateResponseMapStringString = {
18
+ message,
19
+ data,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # DeleteResponseFeedDTO
2
+
3
+ Response class representing the result of a delete operation.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
10
+ **data** | [**FeedDTO**](FeedDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { DeleteResponseFeedDTO } from '@caraer/client';
16
+
17
+ const instance: DeleteResponseFeedDTO = {
18
+ message,
19
+ data,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -63,6 +63,9 @@ const { status, data } = await apiInstance.create2(
63
63
  |**200** | Project created or fetched | - |
64
64
  |**400** | appUuid is required | - |
65
65
  |**403** | Caller is not the app creator | - |
66
+ |**401** | Authentication is required or the token is invalid. | - |
67
+ |**404** | The requested resource was not found. | - |
68
+ |**500** | An internal server error occurred. | - |
66
69
 
67
70
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
68
71
 
@@ -119,6 +122,10 @@ const { status, data } = await apiInstance.createBuild(
119
122
  |-------------|-------------|------------------|
120
123
  |**200** | Build recorded (may still have status FAILED if parsing/upload failed) | - |
121
124
  |**400** | archiveBase64 is required | - |
125
+ |**401** | Authentication is required or the token is invalid. | - |
126
+ |**403** | The caller is missing a required role or scope. | - |
127
+ |**404** | The requested resource was not found. | - |
128
+ |**500** | An internal server error occurred. | - |
122
129
 
123
130
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
124
131
 
@@ -178,6 +185,10 @@ const { status, data } = await apiInstance.deploy(
178
185
  |-------------|-------------|------------------|
179
186
  |**200** | Deploy recorded | - |
180
187
  |**400** | Build is not ready to deploy | - |
188
+ |**401** | Authentication is required or the token is invalid. | - |
189
+ |**403** | The caller is missing a required role or scope. | - |
190
+ |**404** | The requested resource was not found. | - |
191
+ |**500** | An internal server error occurred. | - |
181
192
 
182
193
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
183
194
 
@@ -231,11 +242,14 @@ void (empty response body)
231
242
  | Status code | Description | Response headers |
232
243
  |-------------|-------------|------------------|
233
244
  |**404** | Build not found for this project | - |
245
+ |**401** | Authentication is required or the token is invalid. | - |
246
+ |**403** | The caller is missing a required role or scope. | - |
247
+ |**500** | An internal server error occurred. | - |
234
248
 
235
249
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
236
250
 
237
251
  # **listBuilds**
238
- > any listBuilds()
252
+ > SuccessResponseListProjectBuildDTO listBuilds()
239
253
 
240
254
 
241
255
  ### Example
@@ -265,7 +279,7 @@ const { status, data } = await apiInstance.listBuilds(
265
279
 
266
280
  ### Return type
267
281
 
268
- **any**
282
+ **SuccessResponseListProjectBuildDTO**
269
283
 
270
284
  ### Authorization
271
285
 
@@ -281,11 +295,15 @@ const { status, data } = await apiInstance.listBuilds(
281
295
  | Status code | Description | Response headers |
282
296
  |-------------|-------------|------------------|
283
297
  |**200** | OK | - |
298
+ |**401** | Authentication is required or the token is invalid. | - |
299
+ |**403** | The caller is missing a required role or scope. | - |
300
+ |**404** | The requested resource was not found. | - |
301
+ |**500** | An internal server error occurred. | - |
284
302
 
285
303
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
286
304
 
287
305
  # **listDeploys**
288
- > any listDeploys()
306
+ > SuccessResponseListProjectDeployDTO listDeploys()
289
307
 
290
308
 
291
309
  ### Example
@@ -315,7 +333,7 @@ const { status, data } = await apiInstance.listDeploys(
315
333
 
316
334
  ### Return type
317
335
 
318
- **any**
336
+ **SuccessResponseListProjectDeployDTO**
319
337
 
320
338
  ### Authorization
321
339
 
@@ -331,11 +349,15 @@ const { status, data } = await apiInstance.listDeploys(
331
349
  | Status code | Description | Response headers |
332
350
  |-------------|-------------|------------------|
333
351
  |**200** | OK | - |
352
+ |**401** | Authentication is required or the token is invalid. | - |
353
+ |**403** | The caller is missing a required role or scope. | - |
354
+ |**404** | The requested resource was not found. | - |
355
+ |**500** | An internal server error occurred. | - |
334
356
 
335
357
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
336
358
 
337
359
  # **show3**
338
- > ShowResponse show3()
360
+ > ShowResponseDeveloperProjectDTO show3()
339
361
 
340
362
 
341
363
  ### Example
@@ -365,7 +387,7 @@ const { status, data } = await apiInstance.show3(
365
387
 
366
388
  ### Return type
367
389
 
368
- **ShowResponse**
390
+ **ShowResponseDeveloperProjectDTO**
369
391
 
370
392
  ### Authorization
371
393
 
@@ -382,6 +404,9 @@ const { status, data } = await apiInstance.show3(
382
404
  |-------------|-------------|------------------|
383
405
  |**200** | Project retrieved | - |
384
406
  |**404** | Project not found | - |
407
+ |**401** | Authentication is required or the token is invalid. | - |
408
+ |**403** | The caller is missing a required role or scope. | - |
409
+ |**500** | An internal server error occurred. | - |
385
410
 
386
411
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
387
412
 
@@ -0,0 +1,43 @@
1
+ # DeveloperSandboxDTO
2
+
3
+ Developer sandbox: a Neo4j DB clone of the owning company. Activate via X-Caraer-Sandbox-Uuid; company identity stays the owner.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **uuid** | **string** | Unique identifier for the entity | [default to undefined]
10
+ **name** | **string** | The name of the entity | [default to undefined]
11
+ **label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
12
+ **createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
13
+ **createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
14
+ **updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
15
+ **updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
16
+ **deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
17
+ **deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
18
+ **index** | **number** | Index number for ordering entities | [optional] [default to undefined]
19
+ **ownerCompanyUuid** | **string** | UUID of the owning company — send this as X-Caraer-Company-Uuid | [optional] [default to undefined]
20
+ **databaseId** | **string** | Neo4j database id of the sandbox clone | [optional] [default to undefined]
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import { DeveloperSandboxDTO } from '@caraer/client';
26
+
27
+ const instance: DeveloperSandboxDTO = {
28
+ uuid,
29
+ name,
30
+ label,
31
+ createdAt,
32
+ createdBy,
33
+ updatedAt,
34
+ updatedBy,
35
+ deletedAt,
36
+ deletedBy,
37
+ index,
38
+ ownerCompanyUuid,
39
+ databaseId,
40
+ };
41
+ ```
42
+
43
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -58,11 +58,15 @@ const { status, data } = await apiInstance.create1(
58
58
  |-------------|-------------|------------------|
59
59
  |**200** | Sandbox created | - |
60
60
  |**400** | name is required | - |
61
+ |**401** | Authentication is required or the token is invalid. | - |
62
+ |**403** | The caller is missing a required role or scope. | - |
63
+ |**404** | The requested resource was not found. | - |
64
+ |**500** | An internal server error occurred. | - |
61
65
 
62
66
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
63
67
 
64
68
  # **list**
65
- > any list()
69
+ > SuccessResponseListDeveloperSandboxDTO list()
66
70
 
67
71
  Lists sandboxes owned by the caller\'s selected company.
68
72
 
@@ -86,7 +90,7 @@ This endpoint does not have any parameters.
86
90
 
87
91
  ### Return type
88
92
 
89
- **any**
93
+ **SuccessResponseListDeveloperSandboxDTO**
90
94
 
91
95
  ### Authorization
92
96
 
@@ -102,6 +106,10 @@ This endpoint does not have any parameters.
102
106
  | Status code | Description | Response headers |
103
107
  |-------------|-------------|------------------|
104
108
  |**200** | OK | - |
109
+ |**401** | Authentication is required or the token is invalid. | - |
110
+ |**403** | The caller is missing a required role or scope. | - |
111
+ |**404** | The requested resource was not found. | - |
112
+ |**500** | An internal server error occurred. | - |
105
113
 
106
114
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
107
115
 
@@ -153,6 +161,8 @@ void (empty response body)
153
161
  |-------------|-------------|------------------|
154
162
  |**403** | Caller does not own this sandbox | - |
155
163
  |**404** | Sandbox not found | - |
164
+ |**401** | Authentication is required or the token is invalid. | - |
165
+ |**500** | An internal server error occurred. | - |
156
166
 
157
167
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
158
168
 
@@ -7,11 +7,11 @@ Defines the structure of error responses returned by the API.
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **message** | **string** | The error message providing details about the failure. | [optional] [default to undefined]
10
- **errors** | [**CaraerErrorType**](CaraerErrorType.md) | A list of error types providing further details about the error. | [optional] [default to undefined]
10
+ **errors** | [**Array<CaraerErrorType>**](CaraerErrorType.md) | A list of error types providing further details about the error. | [optional] [default to undefined]
11
11
  **status** | **number** | The HTTP status code associated with the error. | [optional] [default to undefined]
12
12
  **stackTrace** | **string** | | [optional] [default to undefined]
13
- **roles** | **Array<string>** | | [optional] [default to undefined]
14
- **scopes** | **Array<string>** | | [optional] [default to undefined]
13
+ **roles** | **Array<string>** | Roles the caller is missing when the failure is an authorization error. | [optional] [default to undefined]
14
+ **scopes** | **Array<string>** | Scopes the caller is missing when the failure is an authorization error. | [optional] [default to undefined]
15
15
  **requestId** | **string** | Request correlation ID for support and log tracing. | [optional] [default to undefined]
16
16
 
17
17
  ## Example
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **yproperty** | **string** | | [optional] [default to undefined]
9
- **xproperty** | **string** | | [optional] [default to undefined]
10
8
  **ymetric** | **string** | | [optional] [default to undefined]
9
+ **xproperty** | **string** | | [optional] [default to undefined]
10
+ **yproperty** | **string** | | [optional] [default to undefined]
11
11
  **title** | **string** | | [optional] [default to undefined]
12
12
  **chartType** | **string** | | [optional] [default to undefined]
13
13
  **xProperty** | **string** | | [optional] [default to undefined]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
20
20
  import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
- yproperty,
24
- xproperty,
25
23
  ymetric,
24
+ xproperty,
25
+ yproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,