@caraer/client 2.0.503 → 2.0.505
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 +4952 -148
- package/dist/api.d.ts +2746 -125
- package/dist/api.js +4048 -72
- package/dist/esm/api.d.ts +2746 -125
- 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 +2 -2
- 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
|
@@ -21,6 +21,32 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**lightSecondaryColor** | **string** | The secondary color of the company in light mode. | [optional] [default to undefined]
|
|
22
22
|
**lightPrimary100Color** | **string** | The primary 100 color of the company in light mode. | [optional] [default to undefined]
|
|
23
23
|
**lightAccentColor** | **string** | The accent color of the company in light mode. | [optional] [default to undefined]
|
|
24
|
+
**lightPrimary50Color** | **string** | The lightPrimary50Color of the company. | [optional] [default to undefined]
|
|
25
|
+
**lightPrimary200Color** | **string** | The lightPrimary200Color of the company. | [optional] [default to undefined]
|
|
26
|
+
**lightPrimary300Color** | **string** | The lightPrimary300Color of the company. | [optional] [default to undefined]
|
|
27
|
+
**lightPrimary400Color** | **string** | The lightPrimary400Color of the company. | [optional] [default to undefined]
|
|
28
|
+
**lightPrimary600Color** | **string** | The lightPrimary600Color of the company. | [optional] [default to undefined]
|
|
29
|
+
**lightPrimary700Color** | **string** | The lightPrimary700Color of the company. | [optional] [default to undefined]
|
|
30
|
+
**lightPrimary800Color** | **string** | The lightPrimary800Color of the company. | [optional] [default to undefined]
|
|
31
|
+
**lightPrimary900Color** | **string** | The lightPrimary900Color of the company. | [optional] [default to undefined]
|
|
32
|
+
**lightSecondary50Color** | **string** | The lightSecondary50Color of the company. | [optional] [default to undefined]
|
|
33
|
+
**lightSecondary100Color** | **string** | The lightSecondary100Color of the company. | [optional] [default to undefined]
|
|
34
|
+
**lightSecondary200Color** | **string** | The lightSecondary200Color of the company. | [optional] [default to undefined]
|
|
35
|
+
**lightSecondary300Color** | **string** | The lightSecondary300Color of the company. | [optional] [default to undefined]
|
|
36
|
+
**lightSecondary400Color** | **string** | The lightSecondary400Color of the company. | [optional] [default to undefined]
|
|
37
|
+
**lightSecondary600Color** | **string** | The lightSecondary600Color of the company. | [optional] [default to undefined]
|
|
38
|
+
**lightSecondary700Color** | **string** | The lightSecondary700Color of the company. | [optional] [default to undefined]
|
|
39
|
+
**lightSecondary800Color** | **string** | The lightSecondary800Color of the company. | [optional] [default to undefined]
|
|
40
|
+
**lightSecondary900Color** | **string** | The lightSecondary900Color of the company. | [optional] [default to undefined]
|
|
41
|
+
**lightAccent50Color** | **string** | The lightAccent50Color of the company. | [optional] [default to undefined]
|
|
42
|
+
**lightAccent100Color** | **string** | The lightAccent100Color of the company. | [optional] [default to undefined]
|
|
43
|
+
**lightAccent200Color** | **string** | The lightAccent200Color of the company. | [optional] [default to undefined]
|
|
44
|
+
**lightAccent300Color** | **string** | The lightAccent300Color of the company. | [optional] [default to undefined]
|
|
45
|
+
**lightAccent400Color** | **string** | The lightAccent400Color of the company. | [optional] [default to undefined]
|
|
46
|
+
**lightAccent600Color** | **string** | The lightAccent600Color of the company. | [optional] [default to undefined]
|
|
47
|
+
**lightAccent700Color** | **string** | The lightAccent700Color of the company. | [optional] [default to undefined]
|
|
48
|
+
**lightAccent800Color** | **string** | The lightAccent800Color of the company. | [optional] [default to undefined]
|
|
49
|
+
**lightAccent900Color** | **string** | The lightAccent900Color of the company. | [optional] [default to undefined]
|
|
24
50
|
**lightBlackColor** | **string** | The black color of the company in light mode. | [optional] [default to undefined]
|
|
25
51
|
**lightGray900Color** | **string** | The gray 900 color of the company in light mode. | [optional] [default to undefined]
|
|
26
52
|
**lightGray800Color** | **string** | The gray 800 color of the company in light mode. | [optional] [default to undefined]
|
|
@@ -40,6 +66,32 @@ Name | Type | Description | Notes
|
|
|
40
66
|
**darkSecondaryColor** | **string** | The secondary color of the company in dark mode. | [optional] [default to undefined]
|
|
41
67
|
**darkPrimary100Color** | **string** | The primary 100 color of the company in dark mode. | [optional] [default to undefined]
|
|
42
68
|
**darkAccentColor** | **string** | The accent color of the company in dark mode. | [optional] [default to undefined]
|
|
69
|
+
**darkPrimary50Color** | **string** | The darkPrimary50Color of the company. | [optional] [default to undefined]
|
|
70
|
+
**darkPrimary200Color** | **string** | The darkPrimary200Color of the company. | [optional] [default to undefined]
|
|
71
|
+
**darkPrimary300Color** | **string** | The darkPrimary300Color of the company. | [optional] [default to undefined]
|
|
72
|
+
**darkPrimary400Color** | **string** | The darkPrimary400Color of the company. | [optional] [default to undefined]
|
|
73
|
+
**darkPrimary600Color** | **string** | The darkPrimary600Color of the company. | [optional] [default to undefined]
|
|
74
|
+
**darkPrimary700Color** | **string** | The darkPrimary700Color of the company. | [optional] [default to undefined]
|
|
75
|
+
**darkPrimary800Color** | **string** | The darkPrimary800Color of the company. | [optional] [default to undefined]
|
|
76
|
+
**darkPrimary900Color** | **string** | The darkPrimary900Color of the company. | [optional] [default to undefined]
|
|
77
|
+
**darkSecondary50Color** | **string** | The darkSecondary50Color of the company. | [optional] [default to undefined]
|
|
78
|
+
**darkSecondary100Color** | **string** | The darkSecondary100Color of the company. | [optional] [default to undefined]
|
|
79
|
+
**darkSecondary200Color** | **string** | The darkSecondary200Color of the company. | [optional] [default to undefined]
|
|
80
|
+
**darkSecondary300Color** | **string** | The darkSecondary300Color of the company. | [optional] [default to undefined]
|
|
81
|
+
**darkSecondary400Color** | **string** | The darkSecondary400Color of the company. | [optional] [default to undefined]
|
|
82
|
+
**darkSecondary600Color** | **string** | The darkSecondary600Color of the company. | [optional] [default to undefined]
|
|
83
|
+
**darkSecondary700Color** | **string** | The darkSecondary700Color of the company. | [optional] [default to undefined]
|
|
84
|
+
**darkSecondary800Color** | **string** | The darkSecondary800Color of the company. | [optional] [default to undefined]
|
|
85
|
+
**darkSecondary900Color** | **string** | The darkSecondary900Color of the company. | [optional] [default to undefined]
|
|
86
|
+
**darkAccent50Color** | **string** | The darkAccent50Color of the company. | [optional] [default to undefined]
|
|
87
|
+
**darkAccent100Color** | **string** | The darkAccent100Color of the company. | [optional] [default to undefined]
|
|
88
|
+
**darkAccent200Color** | **string** | The darkAccent200Color of the company. | [optional] [default to undefined]
|
|
89
|
+
**darkAccent300Color** | **string** | The darkAccent300Color of the company. | [optional] [default to undefined]
|
|
90
|
+
**darkAccent400Color** | **string** | The darkAccent400Color of the company. | [optional] [default to undefined]
|
|
91
|
+
**darkAccent600Color** | **string** | The darkAccent600Color of the company. | [optional] [default to undefined]
|
|
92
|
+
**darkAccent700Color** | **string** | The darkAccent700Color of the company. | [optional] [default to undefined]
|
|
93
|
+
**darkAccent800Color** | **string** | The darkAccent800Color of the company. | [optional] [default to undefined]
|
|
94
|
+
**darkAccent900Color** | **string** | The darkAccent900Color of the company. | [optional] [default to undefined]
|
|
43
95
|
**darkBlackColor** | **string** | The black color of the company in dark mode. | [optional] [default to undefined]
|
|
44
96
|
**darkGray900Color** | **string** | The gray 900 color of the company in dark mode. | [optional] [default to undefined]
|
|
45
97
|
**darkGray800Color** | **string** | The gray 800 color of the company in dark mode. | [optional] [default to undefined]
|
|
@@ -76,6 +128,32 @@ const instance: DigitalIdentityDTO = {
|
|
|
76
128
|
lightSecondaryColor,
|
|
77
129
|
lightPrimary100Color,
|
|
78
130
|
lightAccentColor,
|
|
131
|
+
lightPrimary50Color,
|
|
132
|
+
lightPrimary200Color,
|
|
133
|
+
lightPrimary300Color,
|
|
134
|
+
lightPrimary400Color,
|
|
135
|
+
lightPrimary600Color,
|
|
136
|
+
lightPrimary700Color,
|
|
137
|
+
lightPrimary800Color,
|
|
138
|
+
lightPrimary900Color,
|
|
139
|
+
lightSecondary50Color,
|
|
140
|
+
lightSecondary100Color,
|
|
141
|
+
lightSecondary200Color,
|
|
142
|
+
lightSecondary300Color,
|
|
143
|
+
lightSecondary400Color,
|
|
144
|
+
lightSecondary600Color,
|
|
145
|
+
lightSecondary700Color,
|
|
146
|
+
lightSecondary800Color,
|
|
147
|
+
lightSecondary900Color,
|
|
148
|
+
lightAccent50Color,
|
|
149
|
+
lightAccent100Color,
|
|
150
|
+
lightAccent200Color,
|
|
151
|
+
lightAccent300Color,
|
|
152
|
+
lightAccent400Color,
|
|
153
|
+
lightAccent600Color,
|
|
154
|
+
lightAccent700Color,
|
|
155
|
+
lightAccent800Color,
|
|
156
|
+
lightAccent900Color,
|
|
79
157
|
lightBlackColor,
|
|
80
158
|
lightGray900Color,
|
|
81
159
|
lightGray800Color,
|
|
@@ -95,6 +173,32 @@ const instance: DigitalIdentityDTO = {
|
|
|
95
173
|
darkSecondaryColor,
|
|
96
174
|
darkPrimary100Color,
|
|
97
175
|
darkAccentColor,
|
|
176
|
+
darkPrimary50Color,
|
|
177
|
+
darkPrimary200Color,
|
|
178
|
+
darkPrimary300Color,
|
|
179
|
+
darkPrimary400Color,
|
|
180
|
+
darkPrimary600Color,
|
|
181
|
+
darkPrimary700Color,
|
|
182
|
+
darkPrimary800Color,
|
|
183
|
+
darkPrimary900Color,
|
|
184
|
+
darkSecondary50Color,
|
|
185
|
+
darkSecondary100Color,
|
|
186
|
+
darkSecondary200Color,
|
|
187
|
+
darkSecondary300Color,
|
|
188
|
+
darkSecondary400Color,
|
|
189
|
+
darkSecondary600Color,
|
|
190
|
+
darkSecondary700Color,
|
|
191
|
+
darkSecondary800Color,
|
|
192
|
+
darkSecondary900Color,
|
|
193
|
+
darkAccent50Color,
|
|
194
|
+
darkAccent100Color,
|
|
195
|
+
darkAccent200Color,
|
|
196
|
+
darkAccent300Color,
|
|
197
|
+
darkAccent400Color,
|
|
198
|
+
darkAccent600Color,
|
|
199
|
+
darkAccent700Color,
|
|
200
|
+
darkAccent800Color,
|
|
201
|
+
darkAccent900Color,
|
|
98
202
|
darkBlackColor,
|
|
99
203
|
darkGray900Color,
|
|
100
204
|
darkGray800Color,
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
@@ -20,8 +20,8 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
xproperty,
|
|
24
23
|
ymetric,
|
|
24
|
+
xproperty,
|
|
25
25
|
yproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FileListItemDTO
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**key** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**size** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**lastModified** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**contentType** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { FileListItemDTO } from '@caraer/client';
|
|
18
|
+
|
|
19
|
+
const instance: FileListItemDTO = {
|
|
20
|
+
key,
|
|
21
|
+
name,
|
|
22
|
+
size,
|
|
23
|
+
lastModified,
|
|
24
|
+
contentType,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
7
7
|
|[**deleteFile**](#deletefile) | **DELETE** /api/v2/files/ | Delete file|
|
|
8
8
|
|[**downloadFile**](#downloadfile) | **GET** /api/v2/files/ | Download file|
|
|
9
9
|
|[**listFiles**](#listfiles) | **GET** /api/v2/files/list | List files|
|
|
10
|
+
|[**listLibrary**](#listlibrary) | **GET** /api/v2/files/library | List company files with metadata for the media library|
|
|
10
11
|
|[**uploadFile2**](#uploadfile2) | **POST** /api/v2/files/ | Upload files|
|
|
11
12
|
|
|
12
13
|
# **deleteFile**
|
|
@@ -180,6 +181,60 @@ const { status, data } = await apiInstance.listFiles(
|
|
|
180
181
|
|
|
181
182
|
[[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)
|
|
182
183
|
|
|
184
|
+
# **listLibrary**
|
|
185
|
+
> SuccessResponseListFileListItemDTO listLibrary()
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### Example
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
import {
|
|
192
|
+
FileManagementApi,
|
|
193
|
+
Configuration
|
|
194
|
+
} from '@caraer/client';
|
|
195
|
+
|
|
196
|
+
const configuration = new Configuration();
|
|
197
|
+
const apiInstance = new FileManagementApi(configuration);
|
|
198
|
+
|
|
199
|
+
let recordUuid: string; // (optional) (default to undefined)
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.listLibrary(
|
|
202
|
+
recordUuid
|
|
203
|
+
);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|Name | Type | Description | Notes|
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **recordUuid** | [**string**] | | (optional) defaults to undefined|
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
**SuccessResponseListFileListItemDTO**
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: application/json
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
### HTTP response details
|
|
228
|
+
| Status code | Description | Response headers |
|
|
229
|
+
|-------------|-------------|------------------|
|
|
230
|
+
|**200** | OK | - |
|
|
231
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
232
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
233
|
+
|**404** | The requested resource was not found. | - |
|
|
234
|
+
|**500** | An internal server error occurred. | - |
|
|
235
|
+
|
|
236
|
+
[[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)
|
|
237
|
+
|
|
183
238
|
# **uploadFile2**
|
|
184
239
|
> SuccessResponseListString uploadFile2()
|
|
185
240
|
|
package/docs/Location.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Location
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { Location } from '@caraer/client';
|
|
13
|
+
|
|
14
|
+
const instance: Location = {
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[[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,65 @@
|
|
|
1
|
+
# MapLocationDTO
|
|
2
|
+
|
|
3
|
+
A map marker from one source: custom lat/lng, a page location property, or an object
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**latitude** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**longitude** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**propertyUuid** | **string** | UUID of a location property | [optional] [default to undefined]
|
|
12
|
+
**propertyName** | **string** | Name of a location property (fallback if uuid missing) | [optional] [default to undefined]
|
|
13
|
+
**objectUuid** | **string** | When set, resolve markers from published records of this object. Exclusive with propertyUuid and custom lat/lng. | [optional] [default to undefined]
|
|
14
|
+
**objectName** | **string** | Object name fallback when uuid is missing | [optional] [default to undefined]
|
|
15
|
+
**icon** | **string** | FontAwesome icon key for the marker | [optional] [default to undefined]
|
|
16
|
+
**iconColor** | **string** | Marker icon color (hex or rgba) | [optional] [default to undefined]
|
|
17
|
+
**iconBackgroundColor** | **string** | Marker pin background fill color (hex or rgba) | [optional] [default to undefined]
|
|
18
|
+
**markerSize** | **number** | Marker pin size in CSS pixels | [optional] [default to undefined]
|
|
19
|
+
**iconSize** | **number** | Marker glyph size in CSS pixels | [optional] [default to undefined]
|
|
20
|
+
**label** | **string** | Text shown when hovering the marker (supports smart content) | [optional] [default to undefined]
|
|
21
|
+
**labelPropertyUuid** | **string** | UUID of a property whose value is shown as hover text | [optional] [default to undefined]
|
|
22
|
+
**labelPropertyName** | **string** | Name of a property whose value is shown as hover text | [optional] [default to undefined]
|
|
23
|
+
**hoverPreviewUuid** | **string** | UUID of the preview shown when hovering a bound marker | [optional] [default to undefined]
|
|
24
|
+
**hoverPreviewName** | **string** | Name of the preview shown when hovering a bound marker | [optional] [default to undefined]
|
|
25
|
+
**recordUuid** | **string** | Record this concrete public marker was resolved from | [optional] [default to undefined]
|
|
26
|
+
**clickLinkType** | **string** | Marker click target: liveUrl, custom, or unset | [optional] [default to undefined]
|
|
27
|
+
**clickLinkUrl** | **string** | Custom URL used when clickLinkType is custom | [optional] [default to undefined]
|
|
28
|
+
**clickLinkOpenInNewWindow** | **boolean** | Open the marker link in a new tab | [optional] [default to undefined]
|
|
29
|
+
**href** | **string** | Resolved public URL for this concrete marker | [optional] [default to undefined]
|
|
30
|
+
**filterProperties** | [**Array<PropertyDTO>**](PropertyDTO.md) | Properties exposed as public filters for object-bound markers | [optional] [default to undefined]
|
|
31
|
+
**filterValues** | **{ [key: string]: any | null; }** | Resolved property values used to filter this concrete marker | [optional] [default to undefined]
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { MapLocationDTO } from '@caraer/client';
|
|
37
|
+
|
|
38
|
+
const instance: MapLocationDTO = {
|
|
39
|
+
latitude,
|
|
40
|
+
longitude,
|
|
41
|
+
propertyUuid,
|
|
42
|
+
propertyName,
|
|
43
|
+
objectUuid,
|
|
44
|
+
objectName,
|
|
45
|
+
icon,
|
|
46
|
+
iconColor,
|
|
47
|
+
iconBackgroundColor,
|
|
48
|
+
markerSize,
|
|
49
|
+
iconSize,
|
|
50
|
+
label,
|
|
51
|
+
labelPropertyUuid,
|
|
52
|
+
labelPropertyName,
|
|
53
|
+
hoverPreviewUuid,
|
|
54
|
+
hoverPreviewName,
|
|
55
|
+
recordUuid,
|
|
56
|
+
clickLinkType,
|
|
57
|
+
clickLinkUrl,
|
|
58
|
+
clickLinkOpenInNewWindow,
|
|
59
|
+
href,
|
|
60
|
+
filterProperties,
|
|
61
|
+
filterValues,
|
|
62
|
+
};
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
[[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,24 @@
|
|
|
1
|
+
# MapMarkerPreviewRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**recordUuid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**previewUuid** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**previewName** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MapMarkerPreviewRequest } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: MapMarkerPreviewRequest = {
|
|
18
|
+
recordUuid,
|
|
19
|
+
previewUuid,
|
|
20
|
+
previewName,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MultiFile
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { MultiFile } from '@caraer/client';
|
|
13
|
+
|
|
14
|
+
const instance: MultiFile = {
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -52,6 +52,11 @@ Name | Type | Description | Notes
|
|
|
52
52
|
**ctaButtonText** | **string** | The button text of the CTA | [optional] [default to undefined]
|
|
53
53
|
**ctaButtonLink** | **string** | The button link of the CTA | [optional] [default to undefined]
|
|
54
54
|
**platforms** | **Array<string>** | The platforms shown in the share component | [optional] [default to undefined]
|
|
55
|
+
**mapLatitude** | **number** | Latitude for the map component | [optional] [default to undefined]
|
|
56
|
+
**mapLongitude** | **number** | Longitude for the map component | [optional] [default to undefined]
|
|
57
|
+
**mapLocations** | [**Array<MapLocationDTO>**](MapLocationDTO.md) | Multiple map markers | [optional] [default to undefined]
|
|
58
|
+
**distanceFilterEnabled** | **boolean** | Show a public distance-from-location filter on this map | [optional] [default to undefined]
|
|
59
|
+
**locationContainsFilterEnabled** | **boolean** | Show a public contains filter for city, street, or postcode on this map | [optional] [default to undefined]
|
|
55
60
|
|
|
56
61
|
## Example
|
|
57
62
|
|
|
@@ -105,6 +110,11 @@ const instance: PageContentSettingsDTO = {
|
|
|
105
110
|
ctaButtonText,
|
|
106
111
|
ctaButtonLink,
|
|
107
112
|
platforms,
|
|
113
|
+
mapLatitude,
|
|
114
|
+
mapLongitude,
|
|
115
|
+
mapLocations,
|
|
116
|
+
distanceFilterEnabled,
|
|
117
|
+
locationContainsFilterEnabled,
|
|
108
118
|
};
|
|
109
119
|
```
|
|
110
120
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RecordSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uuid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**object** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**properties** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
11
|
+
**parsedProperties** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RecordSummary } from '@caraer/client';
|
|
17
|
+
|
|
18
|
+
const instance: RecordSummary = {
|
|
19
|
+
uuid,
|
|
20
|
+
object,
|
|
21
|
+
properties,
|
|
22
|
+
parsedProperties,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
7
|
+
|[**create5**](#create5) | **POST** /api/v2/apps/{appUuid}/serverless-functions | Create a serverless function|
|
|
8
|
+
|[**delete2**](#delete2) | **DELETE** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Delete a serverless function|
|
|
9
9
|
|[**index2**](#index2) | **POST** /api/v2/apps/{appUuid}/serverless-functions/index | List serverless functions for an app|
|
|
10
10
|
|[**logs**](#logs) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/logs | Get serverless function logs|
|
|
11
11
|
|[**samplePayload**](#samplepayload) | **POST** /api/v2/apps/{appUuid}/serverless-functions/sample-payload | Generate a sample webhook payload|
|
|
12
12
|
|[**show1**](#show1) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Get a serverless function|
|
|
13
13
|
|[**testServerlessFunction**](#testserverlessfunction) | **POST** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/test | Test a serverless function|
|
|
14
|
-
|[**
|
|
14
|
+
|[**update2**](#update2) | **PUT** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Update a serverless function|
|
|
15
15
|
|
|
16
|
-
# **
|
|
17
|
-
> CreateResponse
|
|
16
|
+
# **create5**
|
|
17
|
+
> CreateResponse create5(serverlessFunctionDTO)
|
|
18
18
|
|
|
19
19
|
Creates a new serverless function attached to the specified app.
|
|
20
20
|
|
|
@@ -33,7 +33,7 @@ const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
|
33
33
|
let appUuid: string; //UUID of the app to attach the serverless function to (default to undefined)
|
|
34
34
|
let serverlessFunctionDTO: ServerlessFunctionDTO; //Serverless function payload (runtime and code)
|
|
35
35
|
|
|
36
|
-
const { status, data } = await apiInstance.
|
|
36
|
+
const { status, data } = await apiInstance.create5(
|
|
37
37
|
appUuid,
|
|
38
38
|
serverlessFunctionDTO
|
|
39
39
|
);
|
|
@@ -73,8 +73,8 @@ const { status, data } = await apiInstance.create4(
|
|
|
73
73
|
|
|
74
74
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
75
75
|
|
|
76
|
-
# **
|
|
77
|
-
> DeleteResponse
|
|
76
|
+
# **delete2**
|
|
77
|
+
> DeleteResponse delete2()
|
|
78
78
|
|
|
79
79
|
Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
80
80
|
|
|
@@ -92,7 +92,7 @@ const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
|
92
92
|
let appUuid: string; //UUID of the app (default to undefined)
|
|
93
93
|
let uuid: string; //UUID of the serverless function to delete (default to undefined)
|
|
94
94
|
|
|
95
|
-
const { status, data } = await apiInstance.
|
|
95
|
+
const { status, data } = await apiInstance.delete2(
|
|
96
96
|
appUuid,
|
|
97
97
|
uuid
|
|
98
98
|
);
|
|
@@ -436,8 +436,8 @@ const { status, data } = await apiInstance.testServerlessFunction(
|
|
|
436
436
|
|
|
437
437
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
438
438
|
|
|
439
|
-
# **
|
|
440
|
-
> ShowResponseServerlessFunctionDTO
|
|
439
|
+
# **update2**
|
|
440
|
+
> ShowResponseServerlessFunctionDTO update2(serverlessFunctionDTO)
|
|
441
441
|
|
|
442
442
|
Updates an existing serverless function\'s runtime and code, keeping it attached to the same app.
|
|
443
443
|
|
|
@@ -457,7 +457,7 @@ let appUuid: string; //UUID of the app (default to undefined)
|
|
|
457
457
|
let uuid: string; //UUID of the serverless function to update (default to undefined)
|
|
458
458
|
let serverlessFunctionDTO: ServerlessFunctionDTO; //Updated serverless function payload (runtime and code)
|
|
459
459
|
|
|
460
|
-
const { status, data } = await apiInstance.
|
|
460
|
+
const { status, data } = await apiInstance.update2(
|
|
461
461
|
appUuid,
|
|
462
462
|
uuid,
|
|
463
463
|
serverlessFunctionDTO
|
package/docs/SettingOption.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**label** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**helpText** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**preview** | **string** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: SettingOption = {
|
|
|
18
19
|
name,
|
|
19
20
|
label,
|
|
20
21
|
helpText,
|
|
22
|
+
preview,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseCmsEnvironmentDTO
|
|
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** | [**CmsEnvironmentDTO**](CmsEnvironmentDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseCmsEnvironmentDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseCmsEnvironmentDTO = {
|
|
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
|
+
# ShowResponseCmsPageDTO
|
|
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** | [**CmsPageDTO**](CmsPageDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseCmsPageDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseCmsPageDTO = {
|
|
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
|
+
# ShowResponseCmsPageDocument
|
|
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** | [**CmsPageDocument**](CmsPageDocument.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseCmsPageDocument } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseCmsPageDocument = {
|
|
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
|
# ShowResponseCompanyDTO
|
|
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** | [**CompanyDTO**](CompanyDTO.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
|
+
# ShowResponseListCmsEnvironmentDTO
|
|
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<CmsEnvironmentDTO>**](CmsEnvironmentDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListCmsEnvironmentDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListCmsEnvironmentDTO = {
|
|
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
|
+
# ShowResponseListCmsModuleDTO
|
|
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<CmsModuleDTO>**](CmsModuleDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListCmsModuleDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListCmsModuleDTO = {
|
|
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)
|