@caraer/client 2.0.437 → 2.0.442

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 (123) hide show
  1. package/.openapi-generator/FILES +87 -2
  2. package/api.ts +1952 -755
  3. package/dist/api.d.ts +2040 -714
  4. package/dist/api.js +471 -465
  5. package/dist/esm/api.d.ts +2040 -714
  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 +2 -2
  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/SettingField.md +2 -2
  64. package/docs/ShowResponse.md +3 -3
  65. package/docs/ShowResponseAnalyticsDashboardConfig.md +23 -0
  66. package/docs/ShowResponseAppBarIframeSessionContextDTO.md +23 -0
  67. package/docs/ShowResponseAppBarIframeSessionTokenDTO.md +23 -0
  68. package/docs/ShowResponseAppDTO.md +23 -0
  69. package/docs/ShowResponseBillingStatusDTO.md +23 -0
  70. package/docs/ShowResponseCaraerObjectDTO.md +23 -0
  71. package/docs/ShowResponseCompanyDTO.md +23 -0
  72. package/docs/ShowResponseDeveloperProjectDTO.md +23 -0
  73. package/docs/ShowResponseDigitalIdentityDTO.md +23 -0
  74. package/docs/ShowResponseFeedDTO.md +23 -0
  75. package/docs/ShowResponseFormDTO.md +23 -0
  76. package/docs/ShowResponseListEnvironmentDTO.md +23 -0
  77. package/docs/ShowResponseListFormObjectSummaryDTO.md +23 -0
  78. package/docs/ShowResponseListInstalledAppBarDTO.md +23 -0
  79. package/docs/ShowResponseListPropertyDTO.md +23 -0
  80. package/docs/ShowResponseListWebpagePickerItemDTO.md +23 -0
  81. package/docs/ShowResponseLoadAppSettingOptionsResponse.md +23 -0
  82. package/docs/ShowResponseMapStringAnalyticsDashboardConfig.md +23 -0
  83. package/docs/ShowResponseMapStringBoolean.md +23 -0
  84. package/docs/ShowResponseMapStringString.md +23 -0
  85. package/docs/ShowResponsePageContentDTO.md +23 -0
  86. package/docs/ShowResponsePreviewDTO.md +23 -0
  87. package/docs/ShowResponsePropertyDTO.md +23 -0
  88. package/docs/ShowResponsePublicFormDTO.md +23 -0
  89. package/docs/ShowResponseRelationDTO.md +23 -0
  90. package/docs/ShowResponseSavedFilterDTO.md +23 -0
  91. package/docs/ShowResponseServerlessFunctionDTO.md +23 -0
  92. package/docs/ShowResponseString.md +23 -0
  93. package/docs/ShowResponseSubscribeWebhookDTO.md +23 -0
  94. package/docs/ShowResponseTemplateWebpageDTO.md +23 -0
  95. package/docs/ShowResponseTraitDTO.md +23 -0
  96. package/docs/ShowResponseViewDTO.md +23 -0
  97. package/docs/ShowResponseWebMenuDTO.md +23 -0
  98. package/docs/ShowResponseWebsiteSettingsDTO.md +23 -0
  99. package/docs/SuccessResponseAggregateResponse.md +23 -0
  100. package/docs/SuccessResponseCollectionRelation.md +23 -0
  101. package/docs/SuccessResponseCompanyDTO.md +23 -0
  102. package/docs/{SuccessResponse.md → SuccessResponseFeedDTO.md} +4 -4
  103. package/docs/SuccessResponseFlow.md +23 -0
  104. package/docs/SuccessResponseListAggregateResponse.md +23 -0
  105. package/docs/SuccessResponseListCaraerObjectDTO.md +23 -0
  106. package/docs/SuccessResponseListDeveloperSandboxDTO.md +23 -0
  107. package/docs/SuccessResponseListMapStringObject.md +23 -0
  108. package/docs/SuccessResponseListProjectBuildDTO.md +23 -0
  109. package/docs/SuccessResponseListProjectDeployDTO.md +23 -0
  110. package/docs/SuccessResponseListPropertyDTO.md +23 -0
  111. package/docs/SuccessResponseListString.md +23 -0
  112. package/docs/SuccessResponseMapStringInteger.md +23 -0
  113. package/docs/SuccessResponseMapStringObject.md +23 -0
  114. package/docs/SuccessResponseObject.md +23 -0
  115. package/docs/SuccessResponseSuggestAnalyticsWidgetsResponse.md +23 -0
  116. package/docs/SuccessResponseTable.md +23 -0
  117. package/docs/SyncApi.md +27 -9
  118. package/docs/TraitsApi.md +41 -23
  119. package/docs/UpdateResponseFeedDTO.md +23 -0
  120. package/docs/ViewsApi.md +44 -26
  121. package/docs/WebMenusApi.md +30 -12
  122. package/docs/WebpagesApi.md +128 -24
  123. package/package.json +1 -1
@@ -89,6 +89,8 @@ const { status, data } = await apiInstance.createAppWebhookForApp(
89
89
  |**400** | Invalid input provided or app not installed | - |
90
90
  |**404** | App not found | - |
91
91
  |**500** | Internal server error | - |
92
+ |**401** | Authentication is required or the token is invalid. | - |
93
+ |**403** | The caller is missing a required role or scope. | - |
92
94
 
93
95
  [[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)
94
96
 
@@ -144,6 +146,8 @@ const { status, data } = await apiInstance.createPrivateApp(
144
146
  |**400** | Invalid request data | - |
145
147
  |**401** | Unauthorized access | - |
146
148
  |**500** | Internal server error | - |
149
+ |**403** | The caller is missing a required role or scope. | - |
150
+ |**404** | The requested resource was not found. | - |
147
151
 
148
152
  [[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)
149
153
 
@@ -199,6 +203,8 @@ const { status, data } = await apiInstance.createPublicApp(
199
203
  |**400** | Invalid request data | - |
200
204
  |**401** | Unauthorized access | - |
201
205
  |**500** | Internal server error | - |
206
+ |**403** | The caller is missing a required role or scope. | - |
207
+ |**404** | The requested resource was not found. | - |
202
208
 
203
209
  [[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)
204
210
 
@@ -255,11 +261,13 @@ const { status, data } = await apiInstance.deleteAppWebhook(
255
261
  |**200** | Webhook deleted successfully | - |
256
262
  |**404** | Webhook not found for the specified app or company | - |
257
263
  |**500** | Internal server error | - |
264
+ |**401** | Authentication is required or the token is invalid. | - |
265
+ |**403** | The caller is missing a required role or scope. | - |
258
266
 
259
267
  [[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)
260
268
 
261
269
  # **getApp**
262
- > ShowResponse getApp()
270
+ > ShowResponseAppDTO getApp()
263
271
 
264
272
  Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
265
273
 
@@ -290,7 +298,7 @@ const { status, data } = await apiInstance.getApp(
290
298
 
291
299
  ### Return type
292
300
 
293
- **ShowResponse**
301
+ **ShowResponseAppDTO**
294
302
 
295
303
  ### Authorization
296
304
 
@@ -308,11 +316,13 @@ const { status, data } = await apiInstance.getApp(
308
316
  |**200** | Successfully retrieved application details | - |
309
317
  |**404** | Application not found | - |
310
318
  |**500** | Internal server error | - |
319
+ |**401** | Authentication is required or the token is invalid. | - |
320
+ |**403** | The caller is missing a required role or scope. | - |
311
321
 
312
322
  [[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)
313
323
 
314
324
  # **getAppWebhook**
315
- > ShowResponse getAppWebhook()
325
+ > ShowResponseSubscribeWebhookDTO getAppWebhook()
316
326
 
317
327
  Fetches a single webhook that belongs to the specified app.
318
328
 
@@ -346,7 +356,7 @@ const { status, data } = await apiInstance.getAppWebhook(
346
356
 
347
357
  ### Return type
348
358
 
349
- **ShowResponse**
359
+ **ShowResponseSubscribeWebhookDTO**
350
360
 
351
361
  ### Authorization
352
362
 
@@ -364,11 +374,13 @@ const { status, data } = await apiInstance.getAppWebhook(
364
374
  |**200** | Webhook retrieved successfully | - |
365
375
  |**404** | Webhook not found for the specified app or company | - |
366
376
  |**500** | Internal server error | - |
377
+ |**401** | Authentication is required or the token is invalid. | - |
378
+ |**403** | The caller is missing a required role or scope. | - |
367
379
 
368
380
  [[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)
369
381
 
370
382
  # **getAppWebhooks**
371
- > PaginationResponse getAppWebhooks(body)
383
+ > PaginationResponseSubscribeWebhookDTO getAppWebhooks(paginationRequest)
372
384
 
373
385
  Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company.
374
386
 
@@ -377,18 +389,19 @@ Fetches a paginated and optionally filtered list of webhooks associated with the
377
389
  ```typescript
378
390
  import {
379
391
  ApplicationsApi,
380
- Configuration
392
+ Configuration,
393
+ PaginationRequest
381
394
  } from '@caraer/client';
382
395
 
383
396
  const configuration = new Configuration();
384
397
  const apiInstance = new ApplicationsApi(configuration);
385
398
 
386
399
  let appUuid: string; //UUID of the application for which to retrieve webhooks (default to undefined)
387
- let body: any; //
400
+ let paginationRequest: PaginationRequest; //
388
401
 
389
402
  const { status, data } = await apiInstance.getAppWebhooks(
390
403
  appUuid,
391
- body
404
+ paginationRequest
392
405
  );
393
406
  ```
394
407
 
@@ -396,13 +409,13 @@ const { status, data } = await apiInstance.getAppWebhooks(
396
409
 
397
410
  |Name | Type | Description | Notes|
398
411
  |------------- | ------------- | ------------- | -------------|
399
- | **body** | **any**| | |
412
+ | **paginationRequest** | **PaginationRequest**| | |
400
413
  | **appUuid** | [**string**] | UUID of the application for which to retrieve webhooks | defaults to undefined|
401
414
 
402
415
 
403
416
  ### Return type
404
417
 
405
- **PaginationResponse**
418
+ **PaginationResponseSubscribeWebhookDTO**
406
419
 
407
420
  ### Authorization
408
421
 
@@ -422,11 +435,12 @@ const { status, data } = await apiInstance.getAppWebhooks(
422
435
  |**401** | Unauthorized access | - |
423
436
  |**404** | Application not found | - |
424
437
  |**500** | Internal server error | - |
438
+ |**403** | The caller is missing a required role or scope. | - |
425
439
 
426
440
  [[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)
427
441
 
428
442
  # **getApps**
429
- > PaginationResponse getApps(body)
443
+ > PaginationResponseAppDTO getApps(paginationRequest)
430
444
 
431
445
  Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
432
446
 
@@ -435,18 +449,19 @@ Fetches a paginated and optionally filtered list of applications. The list is so
435
449
  ```typescript
436
450
  import {
437
451
  ApplicationsApi,
438
- Configuration
452
+ Configuration,
453
+ PaginationRequest
439
454
  } from '@caraer/client';
440
455
 
441
456
  const configuration = new Configuration();
442
457
  const apiInstance = new ApplicationsApi(configuration);
443
458
 
444
- let body: any; //
459
+ let paginationRequest: PaginationRequest; //
445
460
  let type: string; // (optional) (default to '')
446
461
  let installedOnly: boolean; // (optional) (default to false)
447
462
 
448
463
  const { status, data } = await apiInstance.getApps(
449
- body,
464
+ paginationRequest,
450
465
  type,
451
466
  installedOnly
452
467
  );
@@ -456,14 +471,14 @@ const { status, data } = await apiInstance.getApps(
456
471
 
457
472
  |Name | Type | Description | Notes|
458
473
  |------------- | ------------- | ------------- | -------------|
459
- | **body** | **any**| | |
474
+ | **paginationRequest** | **PaginationRequest**| | |
460
475
  | **type** | [**string**] | | (optional) defaults to ''|
461
476
  | **installedOnly** | [**boolean**] | | (optional) defaults to false|
462
477
 
463
478
 
464
479
  ### Return type
465
480
 
466
- **PaginationResponse**
481
+ **PaginationResponseAppDTO**
467
482
 
468
483
  ### Authorization
469
484
 
@@ -482,6 +497,8 @@ const { status, data } = await apiInstance.getApps(
482
497
  |**400** | Invalid request data | - |
483
498
  |**401** | Unauthorized access | - |
484
499
  |**500** | Internal server error | - |
500
+ |**403** | The caller is missing a required role or scope. | - |
501
+ |**404** | The requested resource was not found. | - |
485
502
 
486
503
  [[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)
487
504
 
@@ -534,11 +551,14 @@ const { status, data } = await apiInstance.getCompanyInformation(
534
551
  |-------------|-------------|------------------|
535
552
  |**200** | Successfully retrieved company information | - |
536
553
  |**500** | Internal server error | - |
554
+ |**401** | Authentication is required or the token is invalid. | - |
555
+ |**403** | The caller is missing a required role or scope. | - |
556
+ |**404** | The requested resource was not found. | - |
537
557
 
538
558
  [[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)
539
559
 
540
560
  # **getMyCreatedApps**
541
- > PaginationResponse getMyCreatedApps(body)
561
+ > PaginationResponseAppDTO getMyCreatedApps(paginationRequest)
542
562
 
543
563
  Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects.
544
564
 
@@ -547,16 +567,17 @@ Fetches a paginated and optionally filtered list of apps where the selected comp
547
567
  ```typescript
548
568
  import {
549
569
  ApplicationsApi,
550
- Configuration
570
+ Configuration,
571
+ PaginationRequest
551
572
  } from '@caraer/client';
552
573
 
553
574
  const configuration = new Configuration();
554
575
  const apiInstance = new ApplicationsApi(configuration);
555
576
 
556
- let body: any; //
577
+ let paginationRequest: PaginationRequest; //
557
578
 
558
579
  const { status, data } = await apiInstance.getMyCreatedApps(
559
- body
580
+ paginationRequest
560
581
  );
561
582
  ```
562
583
 
@@ -564,12 +585,12 @@ const { status, data } = await apiInstance.getMyCreatedApps(
564
585
 
565
586
  |Name | Type | Description | Notes|
566
587
  |------------- | ------------- | ------------- | -------------|
567
- | **body** | **any**| | |
588
+ | **paginationRequest** | **PaginationRequest**| | |
568
589
 
569
590
 
570
591
  ### Return type
571
592
 
572
- **PaginationResponse**
593
+ **PaginationResponseAppDTO**
573
594
 
574
595
  ### Authorization
575
596
 
@@ -588,11 +609,13 @@ const { status, data } = await apiInstance.getMyCreatedApps(
588
609
  |**400** | Invalid request data | - |
589
610
  |**401** | Unauthorized access | - |
590
611
  |**500** | Internal server error | - |
612
+ |**403** | The caller is missing a required role or scope. | - |
613
+ |**404** | The requested resource was not found. | - |
591
614
 
592
615
  [[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)
593
616
 
594
617
  # **getPublicApp**
595
- > ShowResponse getPublicApp()
618
+ > ShowResponseAppDTO getPublicApp()
596
619
 
597
620
  Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App.
598
621
 
@@ -623,7 +646,7 @@ const { status, data } = await apiInstance.getPublicApp(
623
646
 
624
647
  ### Return type
625
648
 
626
- **ShowResponse**
649
+ **ShowResponseAppDTO**
627
650
 
628
651
  ### Authorization
629
652
 
@@ -641,11 +664,13 @@ const { status, data } = await apiInstance.getPublicApp(
641
664
  |**200** | Successfully retrieved the public app | - |
642
665
  |**404** | Public app not found | - |
643
666
  |**500** | Internal server error | - |
667
+ |**401** | Authentication is required or the token is invalid. | - |
668
+ |**403** | The caller is missing a required role or scope. | - |
644
669
 
645
670
  [[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)
646
671
 
647
672
  # **getRuntimeLogs**
648
- > SuccessResponse getRuntimeLogs()
673
+ > SuccessResponseMapStringObject getRuntimeLogs()
649
674
 
650
675
  Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function.
651
676
 
@@ -682,7 +707,7 @@ const { status, data } = await apiInstance.getRuntimeLogs(
682
707
 
683
708
  ### Return type
684
709
 
685
- **SuccessResponse**
710
+ **SuccessResponseMapStringObject**
686
711
 
687
712
  ### Authorization
688
713
 
@@ -699,11 +724,14 @@ const { status, data } = await apiInstance.getRuntimeLogs(
699
724
  |-------------|-------------|------------------|
700
725
  |**200** | Successfully retrieved logs (may be empty if logging is unavailable) | - |
701
726
  |**404** | App not found | - |
727
+ |**401** | Authentication is required or the token is invalid. | - |
728
+ |**403** | The caller is missing a required role or scope. | - |
729
+ |**500** | An internal server error occurred. | - |
702
730
 
703
731
  [[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)
704
732
 
705
733
  # **getWebhookEvents**
706
- > getWebhookEvents()
734
+ > Array<{ [key: string]: any | null; }> getWebhookEvents()
707
735
 
708
736
  Returns all supported record webhook events with their details.
709
737
 
@@ -734,7 +762,7 @@ const { status, data } = await apiInstance.getWebhookEvents(
734
762
 
735
763
  ### Return type
736
764
 
737
- void (empty response body)
765
+ **Array<{ [key: string]: any | null; }>**
738
766
 
739
767
  ### Authorization
740
768
 
@@ -750,11 +778,15 @@ void (empty response body)
750
778
  | Status code | Description | Response headers |
751
779
  |-------------|-------------|------------------|
752
780
  |**200** | List of available webhook record events | - |
781
+ |**401** | Authentication is required or the token is invalid. | - |
782
+ |**403** | The caller is missing a required role or scope. | - |
783
+ |**404** | The requested resource was not found. | - |
784
+ |**500** | An internal server error occurred. | - |
753
785
 
754
786
  [[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)
755
787
 
756
788
  # **getWebhookFormats**
757
- > getWebhookFormats()
789
+ > Array<{ [key: string]: any | null; }> getWebhookFormats()
758
790
 
759
791
  Returns all supported webhook payload formats with their details.
760
792
 
@@ -785,7 +817,7 @@ const { status, data } = await apiInstance.getWebhookFormats(
785
817
 
786
818
  ### Return type
787
819
 
788
- void (empty response body)
820
+ **Array<{ [key: string]: any | null; }>**
789
821
 
790
822
  ### Authorization
791
823
 
@@ -801,11 +833,15 @@ void (empty response body)
801
833
  | Status code | Description | Response headers |
802
834
  |-------------|-------------|------------------|
803
835
  |**200** | List of available webhook formats | - |
836
+ |**401** | Authentication is required or the token is invalid. | - |
837
+ |**403** | The caller is missing a required role or scope. | - |
838
+ |**404** | The requested resource was not found. | - |
839
+ |**500** | An internal server error occurred. | - |
804
840
 
805
841
  [[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)
806
842
 
807
843
  # **getWebhookPropertyTopics**
808
- > getWebhookPropertyTopics()
844
+ > Array<{ [key: string]: string; }> getWebhookPropertyTopics()
809
845
 
810
846
  Returns property names on an object that can be used in 4-part property_changed webhook topics.
811
847
 
@@ -839,7 +875,7 @@ const { status, data } = await apiInstance.getWebhookPropertyTopics(
839
875
 
840
876
  ### Return type
841
877
 
842
- void (empty response body)
878
+ **Array<{ [key: string]: string; }>**
843
879
 
844
880
  ### Authorization
845
881
 
@@ -855,11 +891,15 @@ void (empty response body)
855
891
  | Status code | Description | Response headers |
856
892
  |-------------|-------------|------------------|
857
893
  |**200** | List of property names | - |
894
+ |**401** | Authentication is required or the token is invalid. | - |
895
+ |**403** | The caller is missing a required role or scope. | - |
896
+ |**404** | The requested resource was not found. | - |
897
+ |**500** | An internal server error occurred. | - |
858
898
 
859
899
  [[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)
860
900
 
861
901
  # **installApp**
862
- > ShowResponse installApp()
902
+ > ShowResponseAppDTO installApp()
863
903
 
864
904
  Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO.
865
905
 
@@ -894,7 +934,7 @@ const { status, data } = await apiInstance.installApp(
894
934
 
895
935
  ### Return type
896
936
 
897
- **ShowResponse**
937
+ **ShowResponseAppDTO**
898
938
 
899
939
  ### Authorization
900
940
 
@@ -912,11 +952,13 @@ const { status, data } = await apiInstance.installApp(
912
952
  |**200** | Successfully installed the application | - |
913
953
  |**404** | Application not found | - |
914
954
  |**500** | Internal server error | - |
955
+ |**401** | Authentication is required or the token is invalid. | - |
956
+ |**403** | The caller is missing a required role or scope. | - |
915
957
 
916
958
  [[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)
917
959
 
918
960
  # **listAppCategories**
919
- > listAppCategories()
961
+ > Array<{ [key: string]: any; }> listAppCategories()
920
962
 
921
963
  Returns the allowed category keys and labels for public app marketplace listings.
922
964
 
@@ -940,7 +982,7 @@ This endpoint does not have any parameters.
940
982
 
941
983
  ### Return type
942
984
 
943
- void (empty response body)
985
+ **Array<{ [key: string]: any; }>**
944
986
 
945
987
  ### Authorization
946
988
 
@@ -956,11 +998,15 @@ void (empty response body)
956
998
  | Status code | Description | Response headers |
957
999
  |-------------|-------------|------------------|
958
1000
  |**200** | Successfully retrieved app categories | - |
1001
+ |**401** | Authentication is required or the token is invalid. | - |
1002
+ |**403** | The caller is missing a required role or scope. | - |
1003
+ |**404** | The requested resource was not found. | - |
1004
+ |**500** | An internal server error occurred. | - |
959
1005
 
960
1006
  [[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)
961
1007
 
962
1008
  # **loadSettingOptions**
963
- > ShowResponse loadSettingOptions(loadAppSettingOptionsRequest)
1009
+ > ShowResponseLoadAppSettingOptionsResponse loadSettingOptions(loadAppSettingOptionsRequest)
964
1010
 
965
1011
  Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
966
1012
 
@@ -995,7 +1041,7 @@ const { status, data } = await apiInstance.loadSettingOptions(
995
1041
 
996
1042
  ### Return type
997
1043
 
998
- **ShowResponse**
1044
+ **ShowResponseLoadAppSettingOptionsResponse**
999
1045
 
1000
1046
  ### Authorization
1001
1047
 
@@ -1015,11 +1061,13 @@ const { status, data } = await apiInstance.loadSettingOptions(
1015
1061
  |**403** | App not accessible | - |
1016
1062
  |**404** | App, field, or serverless function not found | - |
1017
1063
  |**502** | Serverless function failed or returned invalid response | - |
1064
+ |**401** | Authentication is required or the token is invalid. | - |
1065
+ |**500** | An internal server error occurred. | - |
1018
1066
 
1019
1067
  [[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)
1020
1068
 
1021
1069
  # **migrateToV2**
1022
- > SuccessResponse migrateToV2()
1070
+ > SuccessResponseMapStringObject migrateToV2()
1023
1071
 
1024
1072
  Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY.
1025
1073
 
@@ -1054,7 +1102,7 @@ const { status, data } = await apiInstance.migrateToV2(
1054
1102
 
1055
1103
  ### Return type
1056
1104
 
1057
- **SuccessResponse**
1105
+ **SuccessResponseMapStringObject**
1058
1106
 
1059
1107
  ### Authorization
1060
1108
 
@@ -1073,11 +1121,13 @@ const { status, data } = await apiInstance.migrateToV2(
1073
1121
  |**400** | Mixed/missing runtimes or invalid request | - |
1074
1122
  |**403** | Not allowed to migrate this app | - |
1075
1123
  |**404** | App not found | - |
1124
+ |**401** | Authentication is required or the token is invalid. | - |
1125
+ |**500** | An internal server error occurred. | - |
1076
1126
 
1077
1127
  [[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)
1078
1128
 
1079
1129
  # **reviewPublicApp**
1080
- > ShowResponse reviewPublicApp(reviewRequest)
1130
+ > ShowResponseAppDTO reviewPublicApp(reviewRequest)
1081
1131
 
1082
1132
  Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO.
1083
1133
 
@@ -1112,7 +1162,7 @@ const { status, data } = await apiInstance.reviewPublicApp(
1112
1162
 
1113
1163
  ### Return type
1114
1164
 
1115
- **ShowResponse**
1165
+ **ShowResponseAppDTO**
1116
1166
 
1117
1167
  ### Authorization
1118
1168
 
@@ -1130,11 +1180,13 @@ const { status, data } = await apiInstance.reviewPublicApp(
1130
1180
  |**200** | Successfully reviewed the public app | - |
1131
1181
  |**404** | Public app not found | - |
1132
1182
  |**500** | Internal server error | - |
1183
+ |**401** | Authentication is required or the token is invalid. | - |
1184
+ |**403** | The caller is missing a required role or scope. | - |
1133
1185
 
1134
1186
  [[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)
1135
1187
 
1136
1188
  # **rotateApp**
1137
- > ShowResponse rotateApp()
1189
+ > ShowResponseAppDTO rotateApp()
1138
1190
 
1139
1191
  Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO.
1140
1192
 
@@ -1165,7 +1217,7 @@ const { status, data } = await apiInstance.rotateApp(
1165
1217
 
1166
1218
  ### Return type
1167
1219
 
1168
- **ShowResponse**
1220
+ **ShowResponseAppDTO**
1169
1221
 
1170
1222
  ### Authorization
1171
1223
 
@@ -1183,6 +1235,8 @@ const { status, data } = await apiInstance.rotateApp(
1183
1235
  |**200** | Successfully rotated application configurations | - |
1184
1236
  |**404** | Application not found | - |
1185
1237
  |**500** | Internal server error | - |
1238
+ |**401** | Authentication is required or the token is invalid. | - |
1239
+ |**403** | The caller is missing a required role or scope. | - |
1186
1240
 
1187
1241
  [[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)
1188
1242
 
@@ -1227,19 +1281,22 @@ const { status, data } = await apiInstance.streamRuntimeLogs(
1227
1281
  ### HTTP request headers
1228
1282
 
1229
1283
  - **Content-Type**: Not defined
1230
- - **Accept**: text/event-stream
1284
+ - **Accept**: text/event-stream, application/json
1231
1285
 
1232
1286
 
1233
1287
  ### HTTP response details
1234
1288
  | Status code | Description | Response headers |
1235
1289
  |-------------|-------------|------------------|
1236
1290
  |**200** | SSE stream of log entries | - |
1237
- |**404** | App not found | - |
1291
+ |**404** | The requested resource was not found. | - |
1292
+ |**401** | Authentication is required or the token is invalid. | - |
1293
+ |**403** | The caller is missing a required role or scope. | - |
1294
+ |**500** | An internal server error occurred. | - |
1238
1295
 
1239
1296
  [[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)
1240
1297
 
1241
1298
  # **submitPublicApp**
1242
- > ShowResponse submitPublicApp()
1299
+ > ShowResponseAppDTO submitPublicApp()
1243
1300
 
1244
1301
  Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO.
1245
1302
 
@@ -1270,7 +1327,7 @@ const { status, data } = await apiInstance.submitPublicApp(
1270
1327
 
1271
1328
  ### Return type
1272
1329
 
1273
- **ShowResponse**
1330
+ **ShowResponseAppDTO**
1274
1331
 
1275
1332
  ### Authorization
1276
1333
 
@@ -1288,11 +1345,13 @@ const { status, data } = await apiInstance.submitPublicApp(
1288
1345
  |**200** | Successfully submitted the public app for review | - |
1289
1346
  |**404** | Public app not found | - |
1290
1347
  |**500** | Internal server error | - |
1348
+ |**401** | Authentication is required or the token is invalid. | - |
1349
+ |**403** | The caller is missing a required role or scope. | - |
1291
1350
 
1292
1351
  [[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)
1293
1352
 
1294
1353
  # **testAppWebhook**
1295
- > testAppWebhook()
1354
+ > string testAppWebhook()
1296
1355
 
1297
1356
  Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery.
1298
1357
 
@@ -1335,7 +1394,7 @@ const { status, data } = await apiInstance.testAppWebhook(
1335
1394
 
1336
1395
  ### Return type
1337
1396
 
1338
- void (empty response body)
1397
+ **string**
1339
1398
 
1340
1399
  ### Authorization
1341
1400
 
@@ -1354,11 +1413,13 @@ void (empty response body)
1354
1413
  |**400** | Invalid event type or app not installed | - |
1355
1414
  |**404** | Webhook not found for the specified app or company | - |
1356
1415
  |**500** | Internal server error | - |
1416
+ |**401** | Authentication is required or the token is invalid. | - |
1417
+ |**403** | The caller is missing a required role or scope. | - |
1357
1418
 
1358
1419
  [[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)
1359
1420
 
1360
1421
  # **testAppWebhookAuto**
1361
- > testAppWebhookAuto()
1422
+ > string testAppWebhookAuto()
1362
1423
 
1363
1424
  Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all).
1364
1425
 
@@ -1392,7 +1453,7 @@ const { status, data } = await apiInstance.testAppWebhookAuto(
1392
1453
 
1393
1454
  ### Return type
1394
1455
 
1395
- void (empty response body)
1456
+ **string**
1396
1457
 
1397
1458
  ### Authorization
1398
1459
 
@@ -1411,11 +1472,13 @@ void (empty response body)
1411
1472
  |**400** | Webhook topic cannot be used for record testing | - |
1412
1473
  |**404** | Webhook not found | - |
1413
1474
  |**500** | Internal server error | - |
1475
+ |**401** | Authentication is required or the token is invalid. | - |
1476
+ |**403** | The caller is missing a required role or scope. | - |
1414
1477
 
1415
1478
  [[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)
1416
1479
 
1417
1480
  # **testAppWebhookUnsaved**
1418
- > testAppWebhookUnsaved(testWebhookRequest)
1481
+ > string testAppWebhookUnsaved(testWebhookRequest)
1419
1482
 
1420
1483
  Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations.
1421
1484
 
@@ -1450,7 +1513,7 @@ const { status, data } = await apiInstance.testAppWebhookUnsaved(
1450
1513
 
1451
1514
  ### Return type
1452
1515
 
1453
- void (empty response body)
1516
+ **string**
1454
1517
 
1455
1518
  ### Authorization
1456
1519
 
@@ -1469,11 +1532,13 @@ void (empty response body)
1469
1532
  |**400** | Invalid webhook configuration or event parameters | - |
1470
1533
  |**404** | App not found | - |
1471
1534
  |**500** | Internal server error | - |
1535
+ |**401** | Authentication is required or the token is invalid. | - |
1536
+ |**403** | The caller is missing a required role or scope. | - |
1472
1537
 
1473
1538
  [[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)
1474
1539
 
1475
1540
  # **uninstallApp**
1476
- > ShowResponse uninstallApp(appRequest)
1541
+ > ShowResponseAppDTO uninstallApp(appRequest)
1477
1542
 
1478
1543
  Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO.
1479
1544
 
@@ -1508,7 +1573,7 @@ const { status, data } = await apiInstance.uninstallApp(
1508
1573
 
1509
1574
  ### Return type
1510
1575
 
1511
- **ShowResponse**
1576
+ **ShowResponseAppDTO**
1512
1577
 
1513
1578
  ### Authorization
1514
1579
 
@@ -1526,6 +1591,8 @@ const { status, data } = await apiInstance.uninstallApp(
1526
1591
  |**200** | Successfully uninstalled the application | - |
1527
1592
  |**404** | Application not found | - |
1528
1593
  |**500** | Internal server error | - |
1594
+ |**401** | Authentication is required or the token is invalid. | - |
1595
+ |**403** | The caller is missing a required role or scope. | - |
1529
1596
 
1530
1597
  [[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)
1531
1598
 
@@ -1587,11 +1654,13 @@ const { status, data } = await apiInstance.updateAppWebhookForApp(
1587
1654
  |**400** | Invalid input provided or app not installed | - |
1588
1655
  |**404** | Webhook not found for the specified app or company | - |
1589
1656
  |**500** | Internal server error | - |
1657
+ |**401** | Authentication is required or the token is invalid. | - |
1658
+ |**403** | The caller is missing a required role or scope. | - |
1590
1659
 
1591
1660
  [[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)
1592
1661
 
1593
1662
  # **updatePublicApp**
1594
- > ShowResponse updatePublicApp(appDTO)
1663
+ > ShowResponseAppDTO updatePublicApp(appDTO)
1595
1664
 
1596
1665
  Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO.
1597
1666
 
@@ -1626,7 +1695,7 @@ const { status, data } = await apiInstance.updatePublicApp(
1626
1695
 
1627
1696
  ### Return type
1628
1697
 
1629
- **ShowResponse**
1698
+ **ShowResponseAppDTO**
1630
1699
 
1631
1700
  ### Authorization
1632
1701
 
@@ -1645,6 +1714,7 @@ const { status, data } = await apiInstance.updatePublicApp(
1645
1714
  |**404** | Public app not found | - |
1646
1715
  |**403** | You are not allowed to update this app | - |
1647
1716
  |**500** | Internal server error | - |
1717
+ |**401** | Authentication is required or the token is invalid. | - |
1648
1718
 
1649
1719
  [[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)
1650
1720