@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.
- package/.openapi-generator/FILES +87 -2
- package/api.ts +1952 -755
- package/dist/api.d.ts +2040 -714
- package/dist/api.js +471 -465
- package/dist/esm/api.d.ts +2040 -714
- package/dist/esm/api.js +468 -462
- package/docs/AppBarIframeSessionsApi.md +10 -4
- package/docs/AppBarsApi.md +11 -4
- package/docs/AppInstallationRuntimeApi.md +58 -0
- package/docs/ApplicationsApi.md +128 -58
- package/docs/AutomationsApi.md +6 -4
- package/docs/BillingApi.md +10 -4
- package/docs/CRUD.md +24 -0
- package/docs/CompanyApi.md +44 -18
- package/docs/CreateResponseFeedDTO.md +23 -0
- package/docs/CreateResponseMapStringString.md +23 -0
- package/docs/DeleteResponseFeedDTO.md +23 -0
- package/docs/DeveloperProjectsApi.md +31 -6
- package/docs/DeveloperSandboxDTO.md +43 -0
- package/docs/DeveloperSandboxesApi.md +12 -2
- package/docs/ErrorResponse.md +3 -3
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/FeedsApi.md +11 -6
- package/docs/FileManagementApi.md +19 -9
- package/docs/FilterApi.md +21 -8
- package/docs/FlowPaginationRequest.md +43 -0
- package/docs/FormsApi.md +95 -56
- package/docs/ModuleApi.md +61 -38
- package/docs/NotificationsApi.md +15 -2
- package/docs/ObjectsApi.md +80 -39
- package/docs/PaginationRequest.md +31 -0
- package/docs/PaginationResponseAppDTO.md +31 -0
- package/docs/PaginationResponseCaraerObjectDTO.md +31 -0
- package/docs/PaginationResponseCompanyDTO.md +31 -0
- package/docs/{PaginationResponse.md → PaginationResponseFeedDTO.md} +4 -4
- package/docs/PaginationResponseFormDTO.md +31 -0
- package/docs/PaginationResponseMapStringObject.md +31 -0
- package/docs/PaginationResponseObject.md +31 -0
- package/docs/PaginationResponsePageContentDTO.md +31 -0
- package/docs/PaginationResponsePropertyCalculationTypeDTO.md +31 -0
- package/docs/PaginationResponsePropertyDTO.md +31 -0
- package/docs/PaginationResponsePropertyFormat.md +31 -0
- package/docs/PaginationResponsePropertyOption.md +31 -0
- package/docs/PaginationResponsePublicEnvironmentDTO.md +31 -0
- package/docs/PaginationResponsePublicFormDTO.md +31 -0
- package/docs/PaginationResponseRelationDTO.md +31 -0
- package/docs/PaginationResponseSavedFilterDTO.md +31 -0
- package/docs/PaginationResponseServerlessFunctionDTO.md +31 -0
- package/docs/PaginationResponseSubscribeWebhookDTO.md +31 -0
- package/docs/PaginationResponseSyncDTO.md +31 -0
- package/docs/PaginationResponseTraitDTO.md +31 -0
- package/docs/PaginationResponseViewDTO.md +31 -0
- package/docs/PaginationResponseWebMenuDTO.md +31 -0
- package/docs/ProjectBuildDTO.md +55 -0
- package/docs/ProjectDeployDTO.md +53 -0
- package/docs/PropertyApi.md +84 -47
- package/docs/PublicFormDTO.md +55 -0
- package/docs/RecordPaginationRequest.md +37 -0
- package/docs/RecordsApi.md +141 -60
- package/docs/RelationsApi.md +82 -48
- package/docs/SearchRequest.md +29 -0
- package/docs/ServerlessFunctionsApi.md +42 -16
- package/docs/SettingField.md +2 -2
- package/docs/ShowResponse.md +3 -3
- package/docs/ShowResponseAnalyticsDashboardConfig.md +23 -0
- package/docs/ShowResponseAppBarIframeSessionContextDTO.md +23 -0
- package/docs/ShowResponseAppBarIframeSessionTokenDTO.md +23 -0
- package/docs/ShowResponseAppDTO.md +23 -0
- package/docs/ShowResponseBillingStatusDTO.md +23 -0
- package/docs/ShowResponseCaraerObjectDTO.md +23 -0
- package/docs/ShowResponseCompanyDTO.md +23 -0
- package/docs/ShowResponseDeveloperProjectDTO.md +23 -0
- package/docs/ShowResponseDigitalIdentityDTO.md +23 -0
- package/docs/ShowResponseFeedDTO.md +23 -0
- package/docs/ShowResponseFormDTO.md +23 -0
- package/docs/ShowResponseListEnvironmentDTO.md +23 -0
- package/docs/ShowResponseListFormObjectSummaryDTO.md +23 -0
- package/docs/ShowResponseListInstalledAppBarDTO.md +23 -0
- package/docs/ShowResponseListPropertyDTO.md +23 -0
- package/docs/ShowResponseListWebpagePickerItemDTO.md +23 -0
- package/docs/ShowResponseLoadAppSettingOptionsResponse.md +23 -0
- package/docs/ShowResponseMapStringAnalyticsDashboardConfig.md +23 -0
- package/docs/ShowResponseMapStringBoolean.md +23 -0
- package/docs/ShowResponseMapStringString.md +23 -0
- package/docs/ShowResponsePageContentDTO.md +23 -0
- package/docs/ShowResponsePreviewDTO.md +23 -0
- package/docs/ShowResponsePropertyDTO.md +23 -0
- package/docs/ShowResponsePublicFormDTO.md +23 -0
- package/docs/ShowResponseRelationDTO.md +23 -0
- package/docs/ShowResponseSavedFilterDTO.md +23 -0
- package/docs/ShowResponseServerlessFunctionDTO.md +23 -0
- package/docs/ShowResponseString.md +23 -0
- package/docs/ShowResponseSubscribeWebhookDTO.md +23 -0
- package/docs/ShowResponseTemplateWebpageDTO.md +23 -0
- package/docs/ShowResponseTraitDTO.md +23 -0
- package/docs/ShowResponseViewDTO.md +23 -0
- package/docs/ShowResponseWebMenuDTO.md +23 -0
- package/docs/ShowResponseWebsiteSettingsDTO.md +23 -0
- package/docs/SuccessResponseAggregateResponse.md +23 -0
- package/docs/SuccessResponseCollectionRelation.md +23 -0
- package/docs/SuccessResponseCompanyDTO.md +23 -0
- package/docs/{SuccessResponse.md → SuccessResponseFeedDTO.md} +4 -4
- package/docs/SuccessResponseFlow.md +23 -0
- package/docs/SuccessResponseListAggregateResponse.md +23 -0
- package/docs/SuccessResponseListCaraerObjectDTO.md +23 -0
- package/docs/SuccessResponseListDeveloperSandboxDTO.md +23 -0
- package/docs/SuccessResponseListMapStringObject.md +23 -0
- package/docs/SuccessResponseListProjectBuildDTO.md +23 -0
- package/docs/SuccessResponseListProjectDeployDTO.md +23 -0
- package/docs/SuccessResponseListPropertyDTO.md +23 -0
- package/docs/SuccessResponseListString.md +23 -0
- package/docs/SuccessResponseMapStringInteger.md +23 -0
- package/docs/SuccessResponseMapStringObject.md +23 -0
- package/docs/SuccessResponseObject.md +23 -0
- package/docs/SuccessResponseSuggestAnalyticsWidgetsResponse.md +23 -0
- package/docs/SuccessResponseTable.md +23 -0
- package/docs/SyncApi.md +27 -9
- package/docs/TraitsApi.md +41 -23
- package/docs/UpdateResponseFeedDTO.md +23 -0
- package/docs/ViewsApi.md +44 -26
- package/docs/WebMenusApi.md +30 -12
- package/docs/WebpagesApi.md +128 -24
- package/package.json +1 -1
package/docs/WebpagesApi.md
CHANGED
|
@@ -91,6 +91,9 @@ const { status, data } = await apiInstance.claimTemplateWebpageEditingSession(
|
|
|
91
91
|
|-------------|-------------|------------------|
|
|
92
92
|
|**200** | Editing session claimed or blocked | - |
|
|
93
93
|
|**404** | Template webpage not found | - |
|
|
94
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
95
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
96
|
+
|**500** | An internal server error occurred. | - |
|
|
94
97
|
|
|
95
98
|
[[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)
|
|
96
99
|
|
|
@@ -147,11 +150,13 @@ const { status, data } = await apiInstance.claimWebpageEditingSession(
|
|
|
147
150
|
|**200** | Editing session claimed | - |
|
|
148
151
|
|**403** | Missing write access on webpage fields for this environment | - |
|
|
149
152
|
|**404** | Webpage not found | - |
|
|
153
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
154
|
+
|**500** | An internal server error occurred. | - |
|
|
150
155
|
|
|
151
156
|
[[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)
|
|
152
157
|
|
|
153
158
|
# **copyPropertyToEnvironments**
|
|
154
|
-
>
|
|
159
|
+
> ShowResponseListPropertyDTO copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest)
|
|
155
160
|
|
|
156
161
|
Copies selected properties for the chosen environments (e.g. production_title → german_production_title).
|
|
157
162
|
|
|
@@ -183,7 +188,7 @@ const { status, data } = await apiInstance.copyPropertyToEnvironments(
|
|
|
183
188
|
|
|
184
189
|
### Return type
|
|
185
190
|
|
|
186
|
-
**
|
|
191
|
+
**ShowResponseListPropertyDTO**
|
|
187
192
|
|
|
188
193
|
### Authorization
|
|
189
194
|
|
|
@@ -201,6 +206,9 @@ const { status, data } = await apiInstance.copyPropertyToEnvironments(
|
|
|
201
206
|
|**200** | Environment properties copied successfully | - |
|
|
202
207
|
|**400** | Invalid input data | - |
|
|
203
208
|
|**404** | Object or property not found | - |
|
|
209
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
210
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
211
|
+
|**500** | An internal server error occurred. | - |
|
|
204
212
|
|
|
205
213
|
[[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)
|
|
206
214
|
|
|
@@ -259,6 +267,9 @@ const { status, data } = await apiInstance.copyTemplateWebpage(
|
|
|
259
267
|
|-------------|-------------|------------------|
|
|
260
268
|
|**201** | Template webpage copied successfully | - |
|
|
261
269
|
|**404** | Template webpage not found | - |
|
|
270
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
271
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
272
|
+
|**500** | An internal server error occurred. | - |
|
|
262
273
|
|
|
263
274
|
[[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)
|
|
264
275
|
|
|
@@ -317,11 +328,14 @@ const { status, data } = await apiInstance.copyWebpage(
|
|
|
317
328
|
|-------------|-------------|------------------|
|
|
318
329
|
|**201** | Webpage copied successfully | - |
|
|
319
330
|
|**404** | Webpage not found | - |
|
|
331
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
332
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
333
|
+
|**500** | An internal server error occurred. | - |
|
|
320
334
|
|
|
321
335
|
[[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)
|
|
322
336
|
|
|
323
337
|
# **createEnvironments**
|
|
324
|
-
>
|
|
338
|
+
> ShowResponseString createEnvironments(createOrUpdateEnvironmentRequest)
|
|
325
339
|
|
|
326
340
|
Creates an environment.
|
|
327
341
|
|
|
@@ -353,7 +367,7 @@ const { status, data } = await apiInstance.createEnvironments(
|
|
|
353
367
|
|
|
354
368
|
### Return type
|
|
355
369
|
|
|
356
|
-
**
|
|
370
|
+
**ShowResponseString**
|
|
357
371
|
|
|
358
372
|
### Authorization
|
|
359
373
|
|
|
@@ -370,6 +384,9 @@ const { status, data } = await apiInstance.createEnvironments(
|
|
|
370
384
|
|-------------|-------------|------------------|
|
|
371
385
|
|**200** | Environments created or updated successfully | - |
|
|
372
386
|
|**500** | Internal server error | - |
|
|
387
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
388
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
389
|
+
|**404** | The requested resource was not found. | - |
|
|
373
390
|
|
|
374
391
|
[[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)
|
|
375
392
|
|
|
@@ -431,6 +448,8 @@ const { status, data } = await apiInstance.createOrUpdateTemplateWebpage(
|
|
|
431
448
|
|**201** | Template webpage created successfully | - |
|
|
432
449
|
|**404** | Template webpage not found | - |
|
|
433
450
|
|**500** | Internal server error | - |
|
|
451
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
452
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
434
453
|
|
|
435
454
|
[[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)
|
|
436
455
|
|
|
@@ -488,6 +507,10 @@ const { status, data } = await apiInstance.createSignedUrl(
|
|
|
488
507
|
| Status code | Description | Response headers |
|
|
489
508
|
|-------------|-------------|------------------|
|
|
490
509
|
|**200** | OK | - |
|
|
510
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
511
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
512
|
+
|**404** | The requested resource was not found. | - |
|
|
513
|
+
|**500** | An internal server error occurred. | - |
|
|
491
514
|
|
|
492
515
|
[[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)
|
|
493
516
|
|
|
@@ -545,11 +568,14 @@ const { status, data } = await apiInstance.createWebpage(
|
|
|
545
568
|
|**201** | Webpage created successfully | - |
|
|
546
569
|
|**400** | Invalid input data | - |
|
|
547
570
|
|**500** | Internal server error | - |
|
|
571
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
572
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
573
|
+
|**404** | The requested resource was not found. | - |
|
|
548
574
|
|
|
549
575
|
[[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)
|
|
550
576
|
|
|
551
577
|
# **deleteEnvironment**
|
|
552
|
-
>
|
|
578
|
+
> ShowResponseString deleteEnvironment()
|
|
553
579
|
|
|
554
580
|
Soft deletes an environment.
|
|
555
581
|
|
|
@@ -580,7 +606,7 @@ const { status, data } = await apiInstance.deleteEnvironment(
|
|
|
580
606
|
|
|
581
607
|
### Return type
|
|
582
608
|
|
|
583
|
-
**
|
|
609
|
+
**ShowResponseString**
|
|
584
610
|
|
|
585
611
|
### Authorization
|
|
586
612
|
|
|
@@ -597,11 +623,14 @@ const { status, data } = await apiInstance.deleteEnvironment(
|
|
|
597
623
|
|-------------|-------------|------------------|
|
|
598
624
|
|**200** | Environment deleted successfully | - |
|
|
599
625
|
|**500** | Internal server error | - |
|
|
626
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
627
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
628
|
+
|**404** | The requested resource was not found. | - |
|
|
600
629
|
|
|
601
630
|
[[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)
|
|
602
631
|
|
|
603
632
|
# **getAllSlugs**
|
|
604
|
-
>
|
|
633
|
+
> PaginationResponsePublicEnvironmentDTO getAllSlugs()
|
|
605
634
|
|
|
606
635
|
Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects.
|
|
607
636
|
|
|
@@ -638,7 +667,7 @@ const { status, data } = await apiInstance.getAllSlugs(
|
|
|
638
667
|
|
|
639
668
|
### Return type
|
|
640
669
|
|
|
641
|
-
**
|
|
670
|
+
**PaginationResponsePublicEnvironmentDTO**
|
|
642
671
|
|
|
643
672
|
### Authorization
|
|
644
673
|
|
|
@@ -655,6 +684,9 @@ const { status, data } = await apiInstance.getAllSlugs(
|
|
|
655
684
|
|-------------|-------------|------------------|
|
|
656
685
|
|**200** | Slugs retrieved successfully | - |
|
|
657
686
|
|**500** | Internal server error | - |
|
|
687
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
688
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
689
|
+
|**404** | The requested resource was not found. | - |
|
|
658
690
|
|
|
659
691
|
[[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)
|
|
660
692
|
|
|
@@ -713,11 +745,14 @@ const { status, data } = await apiInstance.getCompanySettings(
|
|
|
713
745
|
|-------------|-------------|------------------|
|
|
714
746
|
|**200** | Company settings retrieved successfully | - |
|
|
715
747
|
|**500** | Internal server error | - |
|
|
748
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
749
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
750
|
+
|**404** | The requested resource was not found. | - |
|
|
716
751
|
|
|
717
752
|
[[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)
|
|
718
753
|
|
|
719
754
|
# **getEnvironments**
|
|
720
|
-
>
|
|
755
|
+
> ShowResponseListEnvironmentDTO getEnvironments()
|
|
721
756
|
|
|
722
757
|
Retrieves a list of all environments.
|
|
723
758
|
|
|
@@ -741,7 +776,7 @@ This endpoint does not have any parameters.
|
|
|
741
776
|
|
|
742
777
|
### Return type
|
|
743
778
|
|
|
744
|
-
**
|
|
779
|
+
**ShowResponseListEnvironmentDTO**
|
|
745
780
|
|
|
746
781
|
### Authorization
|
|
747
782
|
|
|
@@ -758,11 +793,14 @@ This endpoint does not have any parameters.
|
|
|
758
793
|
|-------------|-------------|------------------|
|
|
759
794
|
|**200** | Environments retrieved successfully | - |
|
|
760
795
|
|**500** | Internal server error | - |
|
|
796
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
797
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
798
|
+
|**404** | The requested resource was not found. | - |
|
|
761
799
|
|
|
762
800
|
[[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
801
|
|
|
764
802
|
# **getMenus**
|
|
765
|
-
>
|
|
803
|
+
> PaginationResponseWebMenuDTO getMenus()
|
|
766
804
|
|
|
767
805
|
Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects.
|
|
768
806
|
|
|
@@ -799,7 +837,7 @@ const { status, data } = await apiInstance.getMenus(
|
|
|
799
837
|
|
|
800
838
|
### Return type
|
|
801
839
|
|
|
802
|
-
**
|
|
840
|
+
**PaginationResponseWebMenuDTO**
|
|
803
841
|
|
|
804
842
|
### Authorization
|
|
805
843
|
|
|
@@ -816,6 +854,9 @@ const { status, data } = await apiInstance.getMenus(
|
|
|
816
854
|
|-------------|-------------|------------------|
|
|
817
855
|
|**200** | Menus retrieved successfully | - |
|
|
818
856
|
|**500** | Internal server error | - |
|
|
857
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
858
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
859
|
+
|**404** | The requested resource was not found. | - |
|
|
819
860
|
|
|
820
861
|
[[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)
|
|
821
862
|
|
|
@@ -894,6 +935,10 @@ const { status, data } = await apiInstance.getPublicPreviews(
|
|
|
894
935
|
| Status code | Description | Response headers |
|
|
895
936
|
|-------------|-------------|------------------|
|
|
896
937
|
|**200** | OK | - |
|
|
938
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
939
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
940
|
+
|**404** | The requested resource was not found. | - |
|
|
941
|
+
|**500** | An internal server error occurred. | - |
|
|
897
942
|
|
|
898
943
|
[[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)
|
|
899
944
|
|
|
@@ -970,6 +1015,9 @@ const { status, data } = await apiInstance.getPublicWebpage(
|
|
|
970
1015
|
|-------------|-------------|------------------|
|
|
971
1016
|
|**200** | Webpage retrieved successfully | - |
|
|
972
1017
|
|**404** | Webpage not found | - |
|
|
1018
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1019
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1020
|
+
|**500** | An internal server error occurred. | - |
|
|
973
1021
|
|
|
974
1022
|
[[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)
|
|
975
1023
|
|
|
@@ -1043,6 +1091,9 @@ const { status, data } = await apiInstance.getPublicWebpageByUuid(
|
|
|
1043
1091
|
|-------------|-------------|------------------|
|
|
1044
1092
|
|**200** | Webpage retrieved successfully | - |
|
|
1045
1093
|
|**404** | Webpage not found | - |
|
|
1094
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1095
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1096
|
+
|**500** | An internal server error occurred. | - |
|
|
1046
1097
|
|
|
1047
1098
|
[[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)
|
|
1048
1099
|
|
|
@@ -1103,6 +1154,10 @@ const { status, data } = await apiInstance.getPublicWebpageProtection(
|
|
|
1103
1154
|
| Status code | Description | Response headers |
|
|
1104
1155
|
|-------------|-------------|------------------|
|
|
1105
1156
|
|**200** | OK | - |
|
|
1157
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1158
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1159
|
+
|**404** | The requested resource was not found. | - |
|
|
1160
|
+
|**500** | An internal server error occurred. | - |
|
|
1106
1161
|
|
|
1107
1162
|
[[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)
|
|
1108
1163
|
|
|
@@ -1158,11 +1213,14 @@ const { status, data } = await apiInstance.getPublicWebsiteModule(
|
|
|
1158
1213
|
|-------------|-------------|------------------|
|
|
1159
1214
|
|**200** | Module retrieved successfully | - |
|
|
1160
1215
|
|**404** | Module not found or not exposed | - |
|
|
1216
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1217
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1218
|
+
|**500** | An internal server error occurred. | - |
|
|
1161
1219
|
|
|
1162
1220
|
[[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)
|
|
1163
1221
|
|
|
1164
1222
|
# **getTemplateWebpage**
|
|
1165
|
-
>
|
|
1223
|
+
> ShowResponseTemplateWebpageDTO getTemplateWebpage()
|
|
1166
1224
|
|
|
1167
1225
|
Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
1168
1226
|
|
|
@@ -1196,7 +1254,7 @@ const { status, data } = await apiInstance.getTemplateWebpage(
|
|
|
1196
1254
|
|
|
1197
1255
|
### Return type
|
|
1198
1256
|
|
|
1199
|
-
**
|
|
1257
|
+
**ShowResponseTemplateWebpageDTO**
|
|
1200
1258
|
|
|
1201
1259
|
### Authorization
|
|
1202
1260
|
|
|
@@ -1213,6 +1271,9 @@ const { status, data } = await apiInstance.getTemplateWebpage(
|
|
|
1213
1271
|
|-------------|-------------|------------------|
|
|
1214
1272
|
|**200** | Template webpage retrieved successfully | - |
|
|
1215
1273
|
|**404** | Template webpage not found | - |
|
|
1274
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1275
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1276
|
+
|**500** | An internal server error occurred. | - |
|
|
1216
1277
|
|
|
1217
1278
|
[[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)
|
|
1218
1279
|
|
|
@@ -1268,6 +1329,9 @@ const { status, data } = await apiInstance.getTemplateWebpageEditingStatus(
|
|
|
1268
1329
|
|-------------|-------------|------------------|
|
|
1269
1330
|
|**200** | Editing status retrieved successfully | - |
|
|
1270
1331
|
|**404** | Template webpage not found | - |
|
|
1332
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1333
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1334
|
+
|**500** | An internal server error occurred. | - |
|
|
1271
1335
|
|
|
1272
1336
|
[[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)
|
|
1273
1337
|
|
|
@@ -1327,6 +1391,8 @@ const { status, data } = await apiInstance.getWebpage(
|
|
|
1327
1391
|
|**200** | Webpage retrieved successfully | - |
|
|
1328
1392
|
|**403** | Missing read access on one or more webpage fields for this environment | - |
|
|
1329
1393
|
|**404** | Webpage not found | - |
|
|
1394
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1395
|
+
|**500** | An internal server error occurred. | - |
|
|
1330
1396
|
|
|
1331
1397
|
[[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)
|
|
1332
1398
|
|
|
@@ -1383,11 +1449,13 @@ const { status, data } = await apiInstance.getWebpageEditingStatus(
|
|
|
1383
1449
|
|**200** | Editing status retrieved successfully | - |
|
|
1384
1450
|
|**403** | Missing read access on webpage fields for this environment | - |
|
|
1385
1451
|
|**404** | Webpage not found | - |
|
|
1452
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1453
|
+
|**500** | An internal server error occurred. | - |
|
|
1386
1454
|
|
|
1387
1455
|
[[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)
|
|
1388
1456
|
|
|
1389
1457
|
# **getWebpagePickerPages**
|
|
1390
|
-
>
|
|
1458
|
+
> ShowResponseListWebpagePickerItemDTO getWebpagePickerPages()
|
|
1391
1459
|
|
|
1392
1460
|
Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages.
|
|
1393
1461
|
|
|
@@ -1424,7 +1492,7 @@ const { status, data } = await apiInstance.getWebpagePickerPages(
|
|
|
1424
1492
|
|
|
1425
1493
|
### Return type
|
|
1426
1494
|
|
|
1427
|
-
**
|
|
1495
|
+
**ShowResponseListWebpagePickerItemDTO**
|
|
1428
1496
|
|
|
1429
1497
|
### Authorization
|
|
1430
1498
|
|
|
@@ -1440,6 +1508,10 @@ const { status, data } = await apiInstance.getWebpagePickerPages(
|
|
|
1440
1508
|
| Status code | Description | Response headers |
|
|
1441
1509
|
|-------------|-------------|------------------|
|
|
1442
1510
|
|**200** | Webpages retrieved successfully | - |
|
|
1511
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1512
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1513
|
+
|**404** | The requested resource was not found. | - |
|
|
1514
|
+
|**500** | An internal server error occurred. | - |
|
|
1443
1515
|
|
|
1444
1516
|
[[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)
|
|
1445
1517
|
|
|
@@ -1493,6 +1565,10 @@ const { status, data } = await apiInstance.listProtectionGrants(
|
|
|
1493
1565
|
| Status code | Description | Response headers |
|
|
1494
1566
|
|-------------|-------------|------------------|
|
|
1495
1567
|
|**200** | OK | - |
|
|
1568
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1569
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1570
|
+
|**404** | The requested resource was not found. | - |
|
|
1571
|
+
|**500** | An internal server error occurred. | - |
|
|
1496
1572
|
|
|
1497
1573
|
[[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)
|
|
1498
1574
|
|
|
@@ -1553,11 +1629,13 @@ const { status, data } = await apiInstance.publishWebpage(
|
|
|
1553
1629
|
|**400** | Webpage failed publish validation | - |
|
|
1554
1630
|
|**403** | Missing read or write access on webpage property fields for this environment | - |
|
|
1555
1631
|
|**404** | Webpage not found | - |
|
|
1632
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1633
|
+
|**500** | An internal server error occurred. | - |
|
|
1556
1634
|
|
|
1557
1635
|
[[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)
|
|
1558
1636
|
|
|
1559
1637
|
# **releaseTemplateWebpageEditingSession**
|
|
1560
|
-
>
|
|
1638
|
+
> ShowResponseString releaseTemplateWebpageEditingSession()
|
|
1561
1639
|
|
|
1562
1640
|
Releases the editing session held by the current user for this template webpage.
|
|
1563
1641
|
|
|
@@ -1591,7 +1669,7 @@ const { status, data } = await apiInstance.releaseTemplateWebpageEditingSession(
|
|
|
1591
1669
|
|
|
1592
1670
|
### Return type
|
|
1593
1671
|
|
|
1594
|
-
**
|
|
1672
|
+
**ShowResponseString**
|
|
1595
1673
|
|
|
1596
1674
|
### Authorization
|
|
1597
1675
|
|
|
@@ -1607,11 +1685,15 @@ const { status, data } = await apiInstance.releaseTemplateWebpageEditingSession(
|
|
|
1607
1685
|
| Status code | Description | Response headers |
|
|
1608
1686
|
|-------------|-------------|------------------|
|
|
1609
1687
|
|**200** | Editing session released | - |
|
|
1688
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1689
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1690
|
+
|**404** | The requested resource was not found. | - |
|
|
1691
|
+
|**500** | An internal server error occurred. | - |
|
|
1610
1692
|
|
|
1611
1693
|
[[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)
|
|
1612
1694
|
|
|
1613
1695
|
# **releaseWebpageEditingSession**
|
|
1614
|
-
>
|
|
1696
|
+
> ShowResponseString releaseWebpageEditingSession()
|
|
1615
1697
|
|
|
1616
1698
|
Releases the editing session held by the current user for this webpage.
|
|
1617
1699
|
|
|
@@ -1642,7 +1724,7 @@ const { status, data } = await apiInstance.releaseWebpageEditingSession(
|
|
|
1642
1724
|
|
|
1643
1725
|
### Return type
|
|
1644
1726
|
|
|
1645
|
-
**
|
|
1727
|
+
**ShowResponseString**
|
|
1646
1728
|
|
|
1647
1729
|
### Authorization
|
|
1648
1730
|
|
|
@@ -1659,6 +1741,9 @@ const { status, data } = await apiInstance.releaseWebpageEditingSession(
|
|
|
1659
1741
|
|-------------|-------------|------------------|
|
|
1660
1742
|
|**200** | Editing session released | - |
|
|
1661
1743
|
|**404** | Webpage not found | - |
|
|
1744
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1745
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1746
|
+
|**500** | An internal server error occurred. | - |
|
|
1662
1747
|
|
|
1663
1748
|
[[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)
|
|
1664
1749
|
|
|
@@ -1715,6 +1800,10 @@ const { status, data } = await apiInstance.revokeProtectionGrant(
|
|
|
1715
1800
|
| Status code | Description | Response headers |
|
|
1716
1801
|
|-------------|-------------|------------------|
|
|
1717
1802
|
|**200** | OK | - |
|
|
1803
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1804
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1805
|
+
|**404** | The requested resource was not found. | - |
|
|
1806
|
+
|**500** | An internal server error occurred. | - |
|
|
1718
1807
|
|
|
1719
1808
|
[[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)
|
|
1720
1809
|
|
|
@@ -1779,6 +1868,10 @@ const { status, data } = await apiInstance.unlockPublicWebpage(
|
|
|
1779
1868
|
| Status code | Description | Response headers |
|
|
1780
1869
|
|-------------|-------------|------------------|
|
|
1781
1870
|
|**200** | OK | - |
|
|
1871
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1872
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1873
|
+
|**404** | The requested resource was not found. | - |
|
|
1874
|
+
|**500** | An internal server error occurred. | - |
|
|
1782
1875
|
|
|
1783
1876
|
[[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)
|
|
1784
1877
|
|
|
@@ -1837,6 +1930,9 @@ const { status, data } = await apiInstance.unpublishWebpage(
|
|
|
1837
1930
|
|-------------|-------------|------------------|
|
|
1838
1931
|
|**200** | Webpage unpublished successfully | - |
|
|
1839
1932
|
|**404** | Webpage not found | - |
|
|
1933
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1934
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1935
|
+
|**500** | An internal server error occurred. | - |
|
|
1840
1936
|
|
|
1841
1937
|
[[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)
|
|
1842
1938
|
|
|
@@ -1898,11 +1994,13 @@ const { status, data } = await apiInstance.updateWebpage(
|
|
|
1898
1994
|
|**400** | Invalid input data | - |
|
|
1899
1995
|
|**403** | Missing write access on one or more webpage fields for this environment | - |
|
|
1900
1996
|
|**404** | Webpage not found | - |
|
|
1997
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1998
|
+
|**500** | An internal server error occurred. | - |
|
|
1901
1999
|
|
|
1902
2000
|
[[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)
|
|
1903
2001
|
|
|
1904
2002
|
# **uploadFile**
|
|
1905
|
-
>
|
|
2003
|
+
> SuccessResponseString uploadFile()
|
|
1906
2004
|
|
|
1907
2005
|
Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse.
|
|
1908
2006
|
|
|
@@ -1933,7 +2031,7 @@ const { status, data } = await apiInstance.uploadFile(
|
|
|
1933
2031
|
|
|
1934
2032
|
### Return type
|
|
1935
2033
|
|
|
1936
|
-
**
|
|
2034
|
+
**SuccessResponseString**
|
|
1937
2035
|
|
|
1938
2036
|
### Authorization
|
|
1939
2037
|
|
|
@@ -1951,11 +2049,14 @@ const { status, data } = await apiInstance.uploadFile(
|
|
|
1951
2049
|
|**200** | File uploaded successfully | - |
|
|
1952
2050
|
|**400** | Invalid file provided | - |
|
|
1953
2051
|
|**500** | Internal server error | - |
|
|
2052
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
2053
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
2054
|
+
|**404** | The requested resource was not found. | - |
|
|
1954
2055
|
|
|
1955
2056
|
[[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)
|
|
1956
2057
|
|
|
1957
2058
|
# **uploadFile1**
|
|
1958
|
-
>
|
|
2059
|
+
> SuccessResponseString uploadFile1()
|
|
1959
2060
|
|
|
1960
2061
|
Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse.
|
|
1961
2062
|
|
|
@@ -1986,7 +2087,7 @@ const { status, data } = await apiInstance.uploadFile1(
|
|
|
1986
2087
|
|
|
1987
2088
|
### Return type
|
|
1988
2089
|
|
|
1989
|
-
**
|
|
2090
|
+
**SuccessResponseString**
|
|
1990
2091
|
|
|
1991
2092
|
### Authorization
|
|
1992
2093
|
|
|
@@ -2004,6 +2105,9 @@ const { status, data } = await apiInstance.uploadFile1(
|
|
|
2004
2105
|
|**200** | File uploaded successfully | - |
|
|
2005
2106
|
|**400** | Invalid file provided | - |
|
|
2006
2107
|
|**500** | Internal server error | - |
|
|
2108
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
2109
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
2110
|
+
|**404** | The requested resource was not found. | - |
|
|
2007
2111
|
|
|
2008
2112
|
[[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)
|
|
2009
2113
|
|