@caraer/client 2.0.504 → 2.0.506
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 +32 -0
- package/api.ts +4951 -147
- package/dist/api.d.ts +2747 -126
- package/dist/api.js +4048 -72
- package/dist/esm/api.d.ts +2747 -126
- package/dist/esm/api.js +4024 -69
- package/docs/AppSettingFieldSchema.md +10 -0
- package/docs/CMSModulesApi.md +181 -0
- package/docs/CMSV2EnvironmentsApi.md +396 -0
- package/docs/CMSV2PagesApi.md +1058 -0
- package/docs/CMSV2PublicApi.md +739 -0
- package/docs/CMSV2TransferApi.md +230 -0
- package/docs/CalendarsApi.md +8 -8
- package/docs/CmsEnvironmentDTO.md +36 -0
- package/docs/CmsModuleDTO.md +52 -0
- package/docs/CmsPageDTO.md +44 -0
- package/docs/CmsPageDocument.md +38 -0
- package/docs/CmsPageModuleInstance.md +26 -0
- package/docs/CmsPagePatch.md +40 -0
- package/docs/CmsPagePatchRequest.md +24 -0
- package/docs/CmsPublicMenuDTO.md +24 -0
- package/docs/CompanyDTO.md +8 -0
- package/docs/DeveloperSandboxesApi.md +4 -4
- package/docs/DigitalIdentityDTO.md +104 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/FileListItemDTO.md +28 -0
- package/docs/FileManagementApi.md +55 -0
- package/docs/Location.md +18 -0
- package/docs/MapLocationDTO.md +65 -0
- package/docs/MapMarkerPreviewRequest.md +24 -0
- package/docs/MultiFile.md +18 -0
- package/docs/PageContentSettingsDTO.md +10 -0
- package/docs/RecordSummary.md +26 -0
- package/docs/ServerlessFunctionsApi.md +12 -12
- package/docs/SettingOption.md +2 -0
- package/docs/ShowResponseCmsEnvironmentDTO.md +23 -0
- package/docs/ShowResponseCmsPageDTO.md +23 -0
- package/docs/ShowResponseCmsPageDocument.md +23 -0
- package/docs/ShowResponseCompanyDTO.md +3 -3
- package/docs/ShowResponseListCmsEnvironmentDTO.md +23 -0
- package/docs/ShowResponseListCmsModuleDTO.md +23 -0
- package/docs/ShowResponseListCmsPageDTO.md +23 -0
- package/docs/ShowResponseListCmsPublicMenuDTO.md +23 -0
- package/docs/ShowResponseListMapStringObject.md +23 -0
- package/docs/ShowResponseListWebpageAccessGrantDTO.md +23 -0
- package/docs/ShowResponsePreviewDTO.md +3 -3
- package/docs/ShowResponseSignedUrlResultDTO.md +23 -0
- package/docs/ShowResponseWebpageMapLocationsDTO.md +23 -0
- package/docs/SuccessResponseListFileListItemDTO.md +23 -0
- package/docs/TemplateWebpageDTO.md +2 -0
- package/docs/WebpageDTO.md +4 -0
- package/docs/WebpageMapLocationsDTO.md +21 -0
- package/docs/WebpagesApi.md +168 -0
- package/docs/WebsiteSettingsDTO.md +10 -0
- package/package.json +1 -1
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListCmsPageDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<CmsPageDTO>**](CmsPageDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListCmsPageDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListCmsPageDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListCmsPublicMenuDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<CmsPublicMenuDTO>**](CmsPublicMenuDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListCmsPublicMenuDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListCmsPublicMenuDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListMapStringObject
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | **Array<{ [key: string]: any | null; }>** | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListMapStringObject } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListMapStringObject = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListWebpageAccessGrantDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<WebpageAccessGrantDTO>**](WebpageAccessGrantDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListWebpageAccessGrantDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListWebpageAccessGrantDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# ShowResponsePreviewDTO
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** |
|
|
10
|
-
**data** | **
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**PreviewDTO**](PreviewDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseSignedUrlResultDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**SignedUrlResultDTO**](SignedUrlResultDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseSignedUrlResultDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseSignedUrlResultDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseWebpageMapLocationsDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**WebpageMapLocationsDTO**](WebpageMapLocationsDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseWebpageMapLocationsDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseWebpageMapLocationsDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SuccessResponseListFileListItemDTO
|
|
2
|
+
|
|
3
|
+
Represents a standard successful response with a message and optional data.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<FileListItemDTO>**](FileListItemDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuccessResponseListFileListItemDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuccessResponseListFileListItemDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**sidebar** | [**PreviewDTO**](PreviewDTO.md) | Preview of the sidebar | [optional] [default to undefined]
|
|
29
29
|
**sidebarRelation** | [**RelationDTO**](RelationDTO.md) | Relation of the sidebar | [optional] [default to undefined]
|
|
30
30
|
**sidebarObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Object of the sidebar | [optional] [default to undefined]
|
|
31
|
+
**floatingActionBarModuleUuid** | **string** | UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar. | [optional] [default to undefined]
|
|
31
32
|
**_options** | [**WebpageOptionsDTO**](WebpageOptionsDTO.md) | Custom options and configurations specific to the webpage. | [optional] [default to undefined]
|
|
32
33
|
**metaData** | **{ [key: string]: any | null; }** | Map of additional metadata and attributes for the webpage. | [optional] [default to undefined]
|
|
33
34
|
**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Represents the associated Caraer object | [optional] [default to undefined]
|
|
@@ -60,6 +61,7 @@ const instance: TemplateWebpageDTO = {
|
|
|
60
61
|
sidebar,
|
|
61
62
|
sidebarRelation,
|
|
62
63
|
sidebarObject,
|
|
64
|
+
floatingActionBarModuleUuid,
|
|
63
65
|
_options,
|
|
64
66
|
metaData,
|
|
65
67
|
object,
|
package/docs/WebpageDTO.md
CHANGED
|
@@ -19,6 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**sidebar** | [**PreviewDTO**](PreviewDTO.md) | Preview of the sidebar | [optional] [default to undefined]
|
|
20
20
|
**sidebarRelation** | [**RelationDTO**](RelationDTO.md) | Relation of the sidebar | [optional] [default to undefined]
|
|
21
21
|
**sidebarObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Object of the sidebar | [optional] [default to undefined]
|
|
22
|
+
**floatingActionBarModuleUuid** | **string** | UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar. | [optional] [default to undefined]
|
|
23
|
+
**floatingActionBar** | [**PageContentDTO**](PageContentDTO.md) | Hydrated module tree for the floating action bar. Set only on public page responses. | [optional] [default to undefined]
|
|
22
24
|
**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The Object object associated with the webpage, representing application data. | [optional] [default to undefined]
|
|
23
25
|
**record** | [**WebpagePublicRecordDTO**](WebpagePublicRecordDTO.md) | Webpage-public backing record values (internal + parsed). Set only on public page responses. | [optional] [default to undefined]
|
|
24
26
|
**_options** | [**WebpageOptionsDTO**](WebpageOptionsDTO.md) | Custom options and configurations specific to the webpage. | [optional] [default to undefined]
|
|
@@ -51,6 +53,8 @@ const instance: WebpageDTO = {
|
|
|
51
53
|
sidebar,
|
|
52
54
|
sidebarRelation,
|
|
53
55
|
sidebarObject,
|
|
56
|
+
floatingActionBarModuleUuid,
|
|
57
|
+
floatingActionBar,
|
|
54
58
|
object,
|
|
55
59
|
record,
|
|
56
60
|
_options,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# WebpageMapLocationsDTO
|
|
2
|
+
|
|
3
|
+
Resolved public map markers for a webpage map block
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**mapLocations** | [**Array<MapLocationDTO>**](MapLocationDTO.md) | Concrete markers after applying public filters | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { WebpageMapLocationsDTO } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: WebpageMapLocationsDTO = {
|
|
17
|
+
mapLocations,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/WebpagesApi.md
CHANGED
|
@@ -18,6 +18,8 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
18
18
|
|[**getCompanySettings**](#getcompanysettings) | **GET** /api/v2/webpages/public/companySettings | Fetch public company settings|
|
|
19
19
|
|[**getEnvironments**](#getenvironments) | **GET** /api/v2/webpages/environments | Get all environments|
|
|
20
20
|
|[**getMenus**](#getmenus) | **GET** /api/v2/webpages/public/getMenus | Fetch public web menus|
|
|
21
|
+
|[**getPublicMapLocations**](#getpublicmaplocations) | **POST** /api/v2/webpages/public/maps/{pageUuid}/{componentUuid} | Get filtered map markers for a public webpage|
|
|
22
|
+
|[**getPublicMapMarkerPreview**](#getpublicmapmarkerpreview) | **POST** /api/v2/webpages/public/maps/{pageUuid}/{componentUuid}/marker-preview | Get a hydrated preview for one public map marker|
|
|
21
23
|
|[**getPublicPreviews**](#getpublicpreviews) | **POST** /api/v2/webpages/public/previews/{pageUuid}/{componentUuid}/{layout} | Get previews for a public webpage|
|
|
22
24
|
|[**getPublicWebpage**](#getpublicwebpage) | **GET** /api/v2/webpages/public/{rootSlug}/{slug} | Get a public webpage by slug|
|
|
23
25
|
|[**getPublicWebpageByUuid**](#getpublicwebpagebyuuid) | **GET** /api/v2/webpages/public/uuid/{uuid} | Get a public webpage by UUID|
|
|
@@ -860,6 +862,172 @@ const { status, data } = await apiInstance.getMenus(
|
|
|
860
862
|
|
|
861
863
|
[[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)
|
|
862
864
|
|
|
865
|
+
# **getPublicMapLocations**
|
|
866
|
+
> ShowResponseWebpageMapLocationsDTO getPublicMapLocations(recordPaginationRequest)
|
|
867
|
+
|
|
868
|
+
Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
869
|
+
|
|
870
|
+
### Example
|
|
871
|
+
|
|
872
|
+
```typescript
|
|
873
|
+
import {
|
|
874
|
+
WebpagesApi,
|
|
875
|
+
Configuration,
|
|
876
|
+
RecordPaginationRequest
|
|
877
|
+
} from '@caraer/client';
|
|
878
|
+
|
|
879
|
+
const configuration = new Configuration();
|
|
880
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
881
|
+
|
|
882
|
+
let xCaraerSubdomain: string; // (default to undefined)
|
|
883
|
+
let pageUuid: string; // (default to undefined)
|
|
884
|
+
let componentUuid: string; // (default to undefined)
|
|
885
|
+
let recordPaginationRequest: RecordPaginationRequest; //
|
|
886
|
+
let xCaraerEnvironment: string; // (optional) (default to 'production')
|
|
887
|
+
let xCaraerPrimaryEnvironment: string; // (optional) (default to 'production')
|
|
888
|
+
let authorization: string; // (optional) (default to undefined)
|
|
889
|
+
let xCaraerWebpageAccess: string; // (optional) (default to undefined)
|
|
890
|
+
let access: string; // (optional) (default to undefined)
|
|
891
|
+
let token: string; // (optional) (default to undefined)
|
|
892
|
+
|
|
893
|
+
const { status, data } = await apiInstance.getPublicMapLocations(
|
|
894
|
+
xCaraerSubdomain,
|
|
895
|
+
pageUuid,
|
|
896
|
+
componentUuid,
|
|
897
|
+
recordPaginationRequest,
|
|
898
|
+
xCaraerEnvironment,
|
|
899
|
+
xCaraerPrimaryEnvironment,
|
|
900
|
+
authorization,
|
|
901
|
+
xCaraerWebpageAccess,
|
|
902
|
+
access,
|
|
903
|
+
token
|
|
904
|
+
);
|
|
905
|
+
```
|
|
906
|
+
|
|
907
|
+
### Parameters
|
|
908
|
+
|
|
909
|
+
|Name | Type | Description | Notes|
|
|
910
|
+
|------------- | ------------- | ------------- | -------------|
|
|
911
|
+
| **recordPaginationRequest** | **RecordPaginationRequest**| | |
|
|
912
|
+
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
913
|
+
| **pageUuid** | [**string**] | | defaults to undefined|
|
|
914
|
+
| **componentUuid** | [**string**] | | defaults to undefined|
|
|
915
|
+
| **xCaraerEnvironment** | [**string**] | | (optional) defaults to 'production'|
|
|
916
|
+
| **xCaraerPrimaryEnvironment** | [**string**] | | (optional) defaults to 'production'|
|
|
917
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
918
|
+
| **xCaraerWebpageAccess** | [**string**] | | (optional) defaults to undefined|
|
|
919
|
+
| **access** | [**string**] | | (optional) defaults to undefined|
|
|
920
|
+
| **token** | [**string**] | | (optional) defaults to undefined|
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
### Return type
|
|
924
|
+
|
|
925
|
+
**ShowResponseWebpageMapLocationsDTO**
|
|
926
|
+
|
|
927
|
+
### Authorization
|
|
928
|
+
|
|
929
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
930
|
+
|
|
931
|
+
### HTTP request headers
|
|
932
|
+
|
|
933
|
+
- **Content-Type**: application/json
|
|
934
|
+
- **Accept**: application/json
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
### HTTP response details
|
|
938
|
+
| Status code | Description | Response headers |
|
|
939
|
+
|-------------|-------------|------------------|
|
|
940
|
+
|**200** | OK | - |
|
|
941
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
942
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
943
|
+
|**404** | The requested resource was not found. | - |
|
|
944
|
+
|**500** | An internal server error occurred. | - |
|
|
945
|
+
|
|
946
|
+
[[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)
|
|
947
|
+
|
|
948
|
+
# **getPublicMapMarkerPreview**
|
|
949
|
+
> ShowResponsePreviewDTO getPublicMapMarkerPreview(mapMarkerPreviewRequest)
|
|
950
|
+
|
|
951
|
+
Hydrates the hover preview selected on a bound map location for a published record.
|
|
952
|
+
|
|
953
|
+
### Example
|
|
954
|
+
|
|
955
|
+
```typescript
|
|
956
|
+
import {
|
|
957
|
+
WebpagesApi,
|
|
958
|
+
Configuration,
|
|
959
|
+
MapMarkerPreviewRequest
|
|
960
|
+
} from '@caraer/client';
|
|
961
|
+
|
|
962
|
+
const configuration = new Configuration();
|
|
963
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
964
|
+
|
|
965
|
+
let xCaraerSubdomain: string; // (default to undefined)
|
|
966
|
+
let pageUuid: string; // (default to undefined)
|
|
967
|
+
let componentUuid: string; // (default to undefined)
|
|
968
|
+
let mapMarkerPreviewRequest: MapMarkerPreviewRequest; //
|
|
969
|
+
let xCaraerEnvironment: string; // (optional) (default to 'production')
|
|
970
|
+
let xCaraerPrimaryEnvironment: string; // (optional) (default to 'production')
|
|
971
|
+
let authorization: string; // (optional) (default to undefined)
|
|
972
|
+
let xCaraerWebpageAccess: string; // (optional) (default to undefined)
|
|
973
|
+
let access: string; // (optional) (default to undefined)
|
|
974
|
+
let token: string; // (optional) (default to undefined)
|
|
975
|
+
|
|
976
|
+
const { status, data } = await apiInstance.getPublicMapMarkerPreview(
|
|
977
|
+
xCaraerSubdomain,
|
|
978
|
+
pageUuid,
|
|
979
|
+
componentUuid,
|
|
980
|
+
mapMarkerPreviewRequest,
|
|
981
|
+
xCaraerEnvironment,
|
|
982
|
+
xCaraerPrimaryEnvironment,
|
|
983
|
+
authorization,
|
|
984
|
+
xCaraerWebpageAccess,
|
|
985
|
+
access,
|
|
986
|
+
token
|
|
987
|
+
);
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
### Parameters
|
|
991
|
+
|
|
992
|
+
|Name | Type | Description | Notes|
|
|
993
|
+
|------------- | ------------- | ------------- | -------------|
|
|
994
|
+
| **mapMarkerPreviewRequest** | **MapMarkerPreviewRequest**| | |
|
|
995
|
+
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
996
|
+
| **pageUuid** | [**string**] | | defaults to undefined|
|
|
997
|
+
| **componentUuid** | [**string**] | | defaults to undefined|
|
|
998
|
+
| **xCaraerEnvironment** | [**string**] | | (optional) defaults to 'production'|
|
|
999
|
+
| **xCaraerPrimaryEnvironment** | [**string**] | | (optional) defaults to 'production'|
|
|
1000
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
1001
|
+
| **xCaraerWebpageAccess** | [**string**] | | (optional) defaults to undefined|
|
|
1002
|
+
| **access** | [**string**] | | (optional) defaults to undefined|
|
|
1003
|
+
| **token** | [**string**] | | (optional) defaults to undefined|
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
### Return type
|
|
1007
|
+
|
|
1008
|
+
**ShowResponsePreviewDTO**
|
|
1009
|
+
|
|
1010
|
+
### Authorization
|
|
1011
|
+
|
|
1012
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1013
|
+
|
|
1014
|
+
### HTTP request headers
|
|
1015
|
+
|
|
1016
|
+
- **Content-Type**: application/json
|
|
1017
|
+
- **Accept**: application/json
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
### HTTP response details
|
|
1021
|
+
| Status code | Description | Response headers |
|
|
1022
|
+
|-------------|-------------|------------------|
|
|
1023
|
+
|**200** | OK | - |
|
|
1024
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1025
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1026
|
+
|**404** | The requested resource was not found. | - |
|
|
1027
|
+
|**500** | An internal server error occurred. | - |
|
|
1028
|
+
|
|
1029
|
+
[[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)
|
|
1030
|
+
|
|
863
1031
|
# **getPublicPreviews**
|
|
864
1032
|
> PaginationResponsePreviewDTO getPublicPreviews()
|
|
865
1033
|
|
|
@@ -112,6 +112,10 @@ Name | Type | Description | Notes
|
|
|
112
112
|
**footerCompanyText** | **string** | | [optional] [default to undefined]
|
|
113
113
|
**customFooterEnabled** | **boolean** | | [optional] [default to undefined]
|
|
114
114
|
**customFooterModuleUuid** | **string** | | [optional] [default to undefined]
|
|
115
|
+
**cmsHeaderModule** | **string** | | [optional] [default to undefined]
|
|
116
|
+
**cmsFooterModule** | **string** | | [optional] [default to undefined]
|
|
117
|
+
**cmsCookieBannerModule** | **string** | | [optional] [default to undefined]
|
|
118
|
+
**cmsModuleDefaults** | **string** | | [optional] [default to undefined]
|
|
115
119
|
**footerBackgroundColor** | **string** | | [optional] [default to undefined]
|
|
116
120
|
**footerForegroundColor** | **string** | | [optional] [default to undefined]
|
|
117
121
|
**footerShowSocialButtons** | **boolean** | | [optional] [default to undefined]
|
|
@@ -142,6 +146,7 @@ Name | Type | Description | Notes
|
|
|
142
146
|
**tertiaryButtonStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
143
147
|
**imageStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
144
148
|
**videoStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
149
|
+
**mapStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
145
150
|
**formStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
146
151
|
**sliderStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
147
152
|
**accordionStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | | [optional] [default to undefined]
|
|
@@ -272,6 +277,10 @@ const instance: WebsiteSettingsDTO = {
|
|
|
272
277
|
footerCompanyText,
|
|
273
278
|
customFooterEnabled,
|
|
274
279
|
customFooterModuleUuid,
|
|
280
|
+
cmsHeaderModule,
|
|
281
|
+
cmsFooterModule,
|
|
282
|
+
cmsCookieBannerModule,
|
|
283
|
+
cmsModuleDefaults,
|
|
275
284
|
footerBackgroundColor,
|
|
276
285
|
footerForegroundColor,
|
|
277
286
|
footerShowSocialButtons,
|
|
@@ -302,6 +311,7 @@ const instance: WebsiteSettingsDTO = {
|
|
|
302
311
|
tertiaryButtonStyling,
|
|
303
312
|
imageStyling,
|
|
304
313
|
videoStyling,
|
|
314
|
+
mapStyling,
|
|
305
315
|
formStyling,
|
|
306
316
|
sliderStyling,
|
|
307
317
|
accordionStyling,
|