@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
package/docs/AppBarIframeSessionsApi.md CHANGED
@@ -8,7 +8,7 @@ All URIs are relative to *https://v2.api.caraer.com*
8
8
  |[**validateIframeSession**](#validateiframesession) | **POST** /api/v2/app-bars/iframe-session/validate | Validate an iframe session token|
9
9
 
10
10
  # **createIframeSession**
11
- > createIframeSession()
11
+ > ShowResponseAppBarIframeSessionTokenDTO createIframeSession()
12
12
 
13
13
  Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context.
14
14
 
@@ -43,7 +43,7 @@ const { status, data } = await apiInstance.createIframeSession(
43
43
 
44
44
  ### Return type
45
45
 
46
- void (empty response body)
46
+ **ShowResponseAppBarIframeSessionTokenDTO**
47
47
 
48
48
  ### Authorization
49
49
 
@@ -61,11 +61,14 @@ void (empty response body)
61
61
  |**200** | Token created | - |
62
62
  |**400** | Invalid request | - |
63
63
  |**404** | App bar not found | - |
64
+ |**401** | Authentication is required or the token is invalid. | - |
65
+ |**403** | The caller is missing a required role or scope. | - |
66
+ |**500** | An internal server error occurred. | - |
64
67
 
65
68
  [[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)
66
69
 
67
70
  # **validateIframeSession**
68
- > validateIframeSession(appBarIframeSessionValidateRequest)
71
+ > ShowResponseAppBarIframeSessionContextDTO validateIframeSession(appBarIframeSessionValidateRequest)
69
72
 
70
73
  Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context.
71
74
 
@@ -97,7 +100,7 @@ const { status, data } = await apiInstance.validateIframeSession(
97
100
 
98
101
  ### Return type
99
102
 
100
- void (empty response body)
103
+ **ShowResponseAppBarIframeSessionContextDTO**
101
104
 
102
105
  ### Authorization
103
106
 
@@ -114,6 +117,9 @@ void (empty response body)
114
117
  |-------------|-------------|------------------|
115
118
  |**200** | Token validated | - |
116
119
  |**401** | Invalid or expired token | - |
120
+ |**403** | The caller is missing a required role or scope. | - |
121
+ |**404** | The requested resource was not found. | - |
122
+ |**500** | An internal server error occurred. | - |
117
123
 
118
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)
119
125
 
package/docs/AppBarsApi.md CHANGED
@@ -8,7 +8,7 @@ All URIs are relative to *https://v2.api.caraer.com*
8
8
  |[**triggerAppBar**](#triggerappbar) | **POST** /api/v2/app-bars/{appBarUuid}/trigger | Trigger an action-based app bar|
9
9
 
10
10
  # **listAppBars**
11
- > listAppBars()
11
+ > ShowResponseListInstalledAppBarDTO listAppBars()
12
12
 
13
13
  Returns all app bars from installed apps for the authenticated user\'s company at the given location.
14
14
 
@@ -51,7 +51,7 @@ const { status, data } = await apiInstance.listAppBars(
51
51
 
52
52
  ### Return type
53
53
 
54
- void (empty response body)
54
+ **ShowResponseListInstalledAppBarDTO**
55
55
 
56
56
  ### Authorization
57
57
 
@@ -68,11 +68,15 @@ void (empty response body)
68
68
  |-------------|-------------|------------------|
69
69
  |**200** | App bars retrieved | - |
70
70
  |**400** | Invalid request | - |
71
+ |**401** | Authentication is required or the token is invalid. | - |
72
+ |**403** | The caller is missing a required role or scope. | - |
73
+ |**404** | The requested resource was not found. | - |
74
+ |**500** | An internal server error occurred. | - |
71
75
 
72
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)
73
77
 
74
78
  # **triggerAppBar**
75
- > triggerAppBar()
79
+ > SuccessResponseString triggerAppBar()
76
80
 
77
81
  Fires the app bar webhook with optional settings values and record/view context.
78
82
 
@@ -107,7 +111,7 @@ const { status, data } = await apiInstance.triggerAppBar(
107
111
 
108
112
  ### Return type
109
113
 
110
- void (empty response body)
114
+ **SuccessResponseString**
111
115
 
112
116
  ### Authorization
113
117
 
@@ -125,6 +129,9 @@ void (empty response body)
125
129
  |**200** | Trigger accepted | - |
126
130
  |**400** | Invalid request | - |
127
131
  |**404** | App bar not found | - |
132
+ |**401** | Authentication is required or the token is invalid. | - |
133
+ |**403** | The caller is missing a required role or scope. | - |
134
+ |**500** | An internal server error occurred. | - |
128
135
 
129
136
  [[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)
130
137
 
package/docs/AppInstallationRuntimeApi.md CHANGED
@@ -70,6 +70,10 @@ const { status, data } = await apiInstance.deleteSecret(
70
70
  | Status code | Description | Response headers |
71
71
  |-------------|-------------|------------------|
72
72
  |**200** | OK | - |
73
+ |**401** | Authentication is required or the token is invalid. | - |
74
+ |**403** | The caller is missing a required role or scope. | - |
75
+ |**404** | The requested resource was not found. | - |
76
+ |**500** | An internal server error occurred. | - |
73
77
 
74
78
  [[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
79
 
@@ -123,6 +127,10 @@ const { status, data } = await apiInstance.deleteStateKey(
123
127
  | Status code | Description | Response headers |
124
128
  |-------------|-------------|------------------|
125
129
  |**200** | OK | - |
130
+ |**401** | Authentication is required or the token is invalid. | - |
131
+ |**403** | The caller is missing a required role or scope. | - |
132
+ |**404** | The requested resource was not found. | - |
133
+ |**500** | An internal server error occurred. | - |
126
134
 
127
135
  [[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)
128
136
 
@@ -176,6 +184,10 @@ const { status, data } = await apiInstance.enqueueJob(
176
184
  | Status code | Description | Response headers |
177
185
  |-------------|-------------|------------------|
178
186
  |**200** | OK | - |
187
+ |**401** | Authentication is required or the token is invalid. | - |
188
+ |**403** | The caller is missing a required role or scope. | - |
189
+ |**404** | The requested resource was not found. | - |
190
+ |**500** | An internal server error occurred. | - |
179
191
 
180
192
  [[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)
181
193
 
@@ -229,6 +241,10 @@ const { status, data } = await apiInstance.getJob(
229
241
  | Status code | Description | Response headers |
230
242
  |-------------|-------------|------------------|
231
243
  |**200** | OK | - |
244
+ |**401** | Authentication is required or the token is invalid. | - |
245
+ |**403** | The caller is missing a required role or scope. | - |
246
+ |**404** | The requested resource was not found. | - |
247
+ |**500** | An internal server error occurred. | - |
232
248
 
233
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)
234
250
 
@@ -280,6 +296,9 @@ const { status, data } = await apiInstance.getState(
280
296
  |-------------|-------------|------------------|
281
297
  |**200** | State map | - |
282
298
  |**403** | Forbidden | - |
299
+ |**401** | Authentication is required or the token is invalid. | - |
300
+ |**404** | The requested resource was not found. | - |
301
+ |**500** | An internal server error occurred. | - |
283
302
 
284
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)
285
304
 
@@ -333,6 +352,10 @@ const { status, data } = await apiInstance.getStateKey(
333
352
  | Status code | Description | Response headers |
334
353
  |-------------|-------------|------------------|
335
354
  |**200** | OK | - |
355
+ |**401** | Authentication is required or the token is invalid. | - |
356
+ |**403** | The caller is missing a required role or scope. | - |
357
+ |**404** | The requested resource was not found. | - |
358
+ |**500** | An internal server error occurred. | - |
336
359
 
337
360
  [[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)
338
361
 
@@ -383,6 +406,10 @@ const { status, data } = await apiInstance.listConnections(
383
406
  | Status code | Description | Response headers |
384
407
  |-------------|-------------|------------------|
385
408
  |**200** | OK | - |
409
+ |**401** | Authentication is required or the token is invalid. | - |
410
+ |**403** | The caller is missing a required role or scope. | - |
411
+ |**404** | The requested resource was not found. | - |
412
+ |**500** | An internal server error occurred. | - |
386
413
 
387
414
  [[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)
388
415
 
@@ -433,6 +460,10 @@ const { status, data } = await apiInstance.listSecrets(
433
460
  | Status code | Description | Response headers |
434
461
  |-------------|-------------|------------------|
435
462
  |**200** | OK | - |
463
+ |**401** | Authentication is required or the token is invalid. | - |
464
+ |**403** | The caller is missing a required role or scope. | - |
465
+ |**404** | The requested resource was not found. | - |
466
+ |**500** | An internal server error occurred. | - |
436
467
 
437
468
  [[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)
438
469
 
@@ -487,6 +518,9 @@ const { status, data } = await apiInstance.mergeCompanySettings(
487
518
  |-------------|-------------|------------------|
488
519
  |**200** | Merged settings map | - |
489
520
  |**403** | Forbidden | - |
521
+ |**401** | Authentication is required or the token is invalid. | - |
522
+ |**404** | The requested resource was not found. | - |
523
+ |**500** | An internal server error occurred. | - |
490
524
 
491
525
  [[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)
492
526
 
@@ -543,6 +577,10 @@ const { status, data } = await apiInstance.putSecret(
543
577
  | Status code | Description | Response headers |
544
578
  |-------------|-------------|------------------|
545
579
  |**200** | OK | - |
580
+ |**401** | Authentication is required or the token is invalid. | - |
581
+ |**403** | The caller is missing a required role or scope. | - |
582
+ |**404** | The requested resource was not found. | - |
583
+ |**500** | An internal server error occurred. | - |
546
584
 
547
585
  [[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)
548
586
 
@@ -596,6 +634,10 @@ const { status, data } = await apiInstance.putState(
596
634
  | Status code | Description | Response headers |
597
635
  |-------------|-------------|------------------|
598
636
  |**200** | OK | - |
637
+ |**401** | Authentication is required or the token is invalid. | - |
638
+ |**403** | The caller is missing a required role or scope. | - |
639
+ |**404** | The requested resource was not found. | - |
640
+ |**500** | An internal server error occurred. | - |
599
641
 
600
642
  [[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)
601
643
 
@@ -652,6 +694,10 @@ const { status, data } = await apiInstance.putStateKey(
652
694
  | Status code | Description | Response headers |
653
695
  |-------------|-------------|------------------|
654
696
  |**200** | OK | - |
697
+ |**401** | Authentication is required or the token is invalid. | - |
698
+ |**403** | The caller is missing a required role or scope. | - |
699
+ |**404** | The requested resource was not found. | - |
700
+ |**500** | An internal server error occurred. | - |
655
701
 
656
702
  [[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)
657
703
 
@@ -705,6 +751,10 @@ const { status, data } = await apiInstance.revokeConnection(
705
751
  | Status code | Description | Response headers |
706
752
  |-------------|-------------|------------------|
707
753
  |**200** | OK | - |
754
+ |**401** | Authentication is required or the token is invalid. | - |
755
+ |**403** | The caller is missing a required role or scope. | - |
756
+ |**404** | The requested resource was not found. | - |
757
+ |**500** | An internal server error occurred. | - |
708
758
 
709
759
  [[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)
710
760
 
@@ -758,6 +808,10 @@ const { status, data } = await apiInstance.saveUserSettings(
758
808
  | Status code | Description | Response headers |
759
809
  |-------------|-------------|------------------|
760
810
  |**200** | OK | - |
811
+ |**401** | Authentication is required or the token is invalid. | - |
812
+ |**403** | The caller is missing a required role or scope. | - |
813
+ |**404** | The requested resource was not found. | - |
814
+ |**500** | An internal server error occurred. | - |
761
815
 
762
816
  [[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)
763
817
 
@@ -814,6 +868,10 @@ const { status, data } = await apiInstance.startOAuth(
814
868
  | Status code | Description | Response headers |
815
869
  |-------------|-------------|------------------|
816
870
  |**200** | OK | - |
871
+ |**401** | Authentication is required or the token is invalid. | - |
872
+ |**403** | The caller is missing a required role or scope. | - |
873
+ |**404** | The requested resource was not found. | - |
874
+ |**500** | An internal server error occurred. | - |
817
875
 
818
876
  [[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)
819
877