@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
package/dist/api.d.ts
CHANGED
|
@@ -966,8 +966,13 @@ export interface AppSettingFieldSchema {
|
|
|
966
966
|
'actionSource'?: AppSettingActionSource;
|
|
967
967
|
'defaultValue'?: any;
|
|
968
968
|
'hidden'?: boolean;
|
|
969
|
+
'advanced'?: boolean;
|
|
969
970
|
'filterTraits'?: Array<string>;
|
|
970
971
|
'visibleWhen'?: Array<AppSettingCondition>;
|
|
972
|
+
'itemFields'?: Array<AppSettingFieldSchema>;
|
|
973
|
+
'min'?: number;
|
|
974
|
+
'max'?: number;
|
|
975
|
+
'itemLabel'?: string;
|
|
971
976
|
'value'?: any;
|
|
972
977
|
'hasValue'?: boolean;
|
|
973
978
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
@@ -1362,6 +1367,104 @@ export interface CaraerObjectDTO {
|
|
|
1362
1367
|
*/
|
|
1363
1368
|
'editable'?: boolean;
|
|
1364
1369
|
}
|
|
1370
|
+
export interface CmsEnvironmentDTO {
|
|
1371
|
+
'uuid'?: string;
|
|
1372
|
+
'key'?: string;
|
|
1373
|
+
'label'?: string;
|
|
1374
|
+
'routing'?: string;
|
|
1375
|
+
'slugPrefix'?: string;
|
|
1376
|
+
'hostLabel'?: string;
|
|
1377
|
+
'requiresAuth'?: boolean;
|
|
1378
|
+
'htmlLang'?: string;
|
|
1379
|
+
'default'?: boolean;
|
|
1380
|
+
}
|
|
1381
|
+
export interface CmsModuleDTO {
|
|
1382
|
+
'uuid'?: string;
|
|
1383
|
+
'name'?: string;
|
|
1384
|
+
'label'?: string;
|
|
1385
|
+
'ref'?: string;
|
|
1386
|
+
'kind'?: string;
|
|
1387
|
+
'description'?: string;
|
|
1388
|
+
'category'?: string;
|
|
1389
|
+
'icon'?: string;
|
|
1390
|
+
'preview'?: string;
|
|
1391
|
+
'appUuid'?: string;
|
|
1392
|
+
'appName'?: string;
|
|
1393
|
+
'appLabel'?: string;
|
|
1394
|
+
'packageName'?: string;
|
|
1395
|
+
'version'?: string;
|
|
1396
|
+
'retired'?: boolean;
|
|
1397
|
+
'fields'?: Array<AppSettingFieldSchema>;
|
|
1398
|
+
'frameworks'?: {
|
|
1399
|
+
[key: string]: string;
|
|
1400
|
+
};
|
|
1401
|
+
}
|
|
1402
|
+
export interface CmsPageDTO {
|
|
1403
|
+
'uuid'?: string;
|
|
1404
|
+
'title'?: string;
|
|
1405
|
+
'slug'?: string;
|
|
1406
|
+
'locale'?: string;
|
|
1407
|
+
'environment'?: string;
|
|
1408
|
+
'state'?: string;
|
|
1409
|
+
'published'?: boolean;
|
|
1410
|
+
'document'?: CmsPageDocument;
|
|
1411
|
+
'record'?: RecordSummary;
|
|
1412
|
+
'protection'?: {
|
|
1413
|
+
[key: string]: any | null;
|
|
1414
|
+
};
|
|
1415
|
+
'locales'?: Array<string>;
|
|
1416
|
+
'publishAt'?: number;
|
|
1417
|
+
'unpublishAt'?: number;
|
|
1418
|
+
}
|
|
1419
|
+
export interface CmsPageDocument {
|
|
1420
|
+
'version'?: number;
|
|
1421
|
+
'revision'?: number;
|
|
1422
|
+
'modules'?: Array<CmsPageModuleInstance>;
|
|
1423
|
+
'seo'?: {
|
|
1424
|
+
[key: string]: any | null;
|
|
1425
|
+
};
|
|
1426
|
+
'title'?: string;
|
|
1427
|
+
'slug'?: string;
|
|
1428
|
+
'excerpt'?: string;
|
|
1429
|
+
'css'?: string;
|
|
1430
|
+
'headJs'?: string;
|
|
1431
|
+
'bodyJs'?: string;
|
|
1432
|
+
}
|
|
1433
|
+
export interface CmsPageModuleInstance {
|
|
1434
|
+
'id'?: string;
|
|
1435
|
+
'module'?: string;
|
|
1436
|
+
'fields'?: {
|
|
1437
|
+
[key: string]: any | null;
|
|
1438
|
+
};
|
|
1439
|
+
'hidden'?: boolean;
|
|
1440
|
+
}
|
|
1441
|
+
export interface CmsPagePatch {
|
|
1442
|
+
'op'?: string;
|
|
1443
|
+
'moduleId'?: string;
|
|
1444
|
+
'field'?: string;
|
|
1445
|
+
'value'?: any;
|
|
1446
|
+
'fields'?: {
|
|
1447
|
+
[key: string]: any | null;
|
|
1448
|
+
};
|
|
1449
|
+
'module'?: CmsPageModuleInstance;
|
|
1450
|
+
'index'?: number;
|
|
1451
|
+
'toIndex'?: number;
|
|
1452
|
+
'hidden'?: boolean;
|
|
1453
|
+
'modules'?: Array<CmsPageModuleInstance>;
|
|
1454
|
+
'seo'?: {
|
|
1455
|
+
[key: string]: any | null;
|
|
1456
|
+
};
|
|
1457
|
+
}
|
|
1458
|
+
export interface CmsPagePatchRequest {
|
|
1459
|
+
'locale'?: string;
|
|
1460
|
+
'patches'?: Array<CmsPagePatch>;
|
|
1461
|
+
'expectedRevision'?: number;
|
|
1462
|
+
}
|
|
1463
|
+
export interface CmsPublicMenuDTO {
|
|
1464
|
+
'location'?: string;
|
|
1465
|
+
'title'?: string;
|
|
1466
|
+
'items'?: Array<WebMenuItem>;
|
|
1467
|
+
}
|
|
1365
1468
|
/**
|
|
1366
1469
|
* A DTO representing a company with its various settings and details.
|
|
1367
1470
|
*/
|
|
@@ -1422,6 +1525,16 @@ export interface CompanyDTO {
|
|
|
1422
1525
|
* The billing settings of the company.
|
|
1423
1526
|
*/
|
|
1424
1527
|
'billingSettings'?: BillingSettingsDTO;
|
|
1528
|
+
/**
|
|
1529
|
+
* Which CMS serves this company: 1 = WerkenBij, 2 = caraer-web
|
|
1530
|
+
*/
|
|
1531
|
+
'cmsVersion'?: number;
|
|
1532
|
+
/**
|
|
1533
|
+
* Origin of the v2 sidecar site while the live hostname is still v1
|
|
1534
|
+
*/
|
|
1535
|
+
'cmsV2PreviewOrigin'?: string;
|
|
1536
|
+
'cmsV2ProjectId'?: string;
|
|
1537
|
+
'cmsV1ProjectId'?: string;
|
|
1425
1538
|
}
|
|
1426
1539
|
/**
|
|
1427
1540
|
* A DTO representing the details of a company.
|
|
@@ -2041,6 +2154,110 @@ export interface DigitalIdentityDTO {
|
|
|
2041
2154
|
* The accent color of the company in light mode.
|
|
2042
2155
|
*/
|
|
2043
2156
|
'lightAccentColor'?: string;
|
|
2157
|
+
/**
|
|
2158
|
+
* The lightPrimary50Color of the company.
|
|
2159
|
+
*/
|
|
2160
|
+
'lightPrimary50Color'?: string;
|
|
2161
|
+
/**
|
|
2162
|
+
* The lightPrimary200Color of the company.
|
|
2163
|
+
*/
|
|
2164
|
+
'lightPrimary200Color'?: string;
|
|
2165
|
+
/**
|
|
2166
|
+
* The lightPrimary300Color of the company.
|
|
2167
|
+
*/
|
|
2168
|
+
'lightPrimary300Color'?: string;
|
|
2169
|
+
/**
|
|
2170
|
+
* The lightPrimary400Color of the company.
|
|
2171
|
+
*/
|
|
2172
|
+
'lightPrimary400Color'?: string;
|
|
2173
|
+
/**
|
|
2174
|
+
* The lightPrimary600Color of the company.
|
|
2175
|
+
*/
|
|
2176
|
+
'lightPrimary600Color'?: string;
|
|
2177
|
+
/**
|
|
2178
|
+
* The lightPrimary700Color of the company.
|
|
2179
|
+
*/
|
|
2180
|
+
'lightPrimary700Color'?: string;
|
|
2181
|
+
/**
|
|
2182
|
+
* The lightPrimary800Color of the company.
|
|
2183
|
+
*/
|
|
2184
|
+
'lightPrimary800Color'?: string;
|
|
2185
|
+
/**
|
|
2186
|
+
* The lightPrimary900Color of the company.
|
|
2187
|
+
*/
|
|
2188
|
+
'lightPrimary900Color'?: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* The lightSecondary50Color of the company.
|
|
2191
|
+
*/
|
|
2192
|
+
'lightSecondary50Color'?: string;
|
|
2193
|
+
/**
|
|
2194
|
+
* The lightSecondary100Color of the company.
|
|
2195
|
+
*/
|
|
2196
|
+
'lightSecondary100Color'?: string;
|
|
2197
|
+
/**
|
|
2198
|
+
* The lightSecondary200Color of the company.
|
|
2199
|
+
*/
|
|
2200
|
+
'lightSecondary200Color'?: string;
|
|
2201
|
+
/**
|
|
2202
|
+
* The lightSecondary300Color of the company.
|
|
2203
|
+
*/
|
|
2204
|
+
'lightSecondary300Color'?: string;
|
|
2205
|
+
/**
|
|
2206
|
+
* The lightSecondary400Color of the company.
|
|
2207
|
+
*/
|
|
2208
|
+
'lightSecondary400Color'?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
* The lightSecondary600Color of the company.
|
|
2211
|
+
*/
|
|
2212
|
+
'lightSecondary600Color'?: string;
|
|
2213
|
+
/**
|
|
2214
|
+
* The lightSecondary700Color of the company.
|
|
2215
|
+
*/
|
|
2216
|
+
'lightSecondary700Color'?: string;
|
|
2217
|
+
/**
|
|
2218
|
+
* The lightSecondary800Color of the company.
|
|
2219
|
+
*/
|
|
2220
|
+
'lightSecondary800Color'?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* The lightSecondary900Color of the company.
|
|
2223
|
+
*/
|
|
2224
|
+
'lightSecondary900Color'?: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* The lightAccent50Color of the company.
|
|
2227
|
+
*/
|
|
2228
|
+
'lightAccent50Color'?: string;
|
|
2229
|
+
/**
|
|
2230
|
+
* The lightAccent100Color of the company.
|
|
2231
|
+
*/
|
|
2232
|
+
'lightAccent100Color'?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* The lightAccent200Color of the company.
|
|
2235
|
+
*/
|
|
2236
|
+
'lightAccent200Color'?: string;
|
|
2237
|
+
/**
|
|
2238
|
+
* The lightAccent300Color of the company.
|
|
2239
|
+
*/
|
|
2240
|
+
'lightAccent300Color'?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* The lightAccent400Color of the company.
|
|
2243
|
+
*/
|
|
2244
|
+
'lightAccent400Color'?: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* The lightAccent600Color of the company.
|
|
2247
|
+
*/
|
|
2248
|
+
'lightAccent600Color'?: string;
|
|
2249
|
+
/**
|
|
2250
|
+
* The lightAccent700Color of the company.
|
|
2251
|
+
*/
|
|
2252
|
+
'lightAccent700Color'?: string;
|
|
2253
|
+
/**
|
|
2254
|
+
* The lightAccent800Color of the company.
|
|
2255
|
+
*/
|
|
2256
|
+
'lightAccent800Color'?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
* The lightAccent900Color of the company.
|
|
2259
|
+
*/
|
|
2260
|
+
'lightAccent900Color'?: string;
|
|
2044
2261
|
/**
|
|
2045
2262
|
* The black color of the company in light mode.
|
|
2046
2263
|
*/
|
|
@@ -2117,6 +2334,110 @@ export interface DigitalIdentityDTO {
|
|
|
2117
2334
|
* The accent color of the company in dark mode.
|
|
2118
2335
|
*/
|
|
2119
2336
|
'darkAccentColor'?: string;
|
|
2337
|
+
/**
|
|
2338
|
+
* The darkPrimary50Color of the company.
|
|
2339
|
+
*/
|
|
2340
|
+
'darkPrimary50Color'?: string;
|
|
2341
|
+
/**
|
|
2342
|
+
* The darkPrimary200Color of the company.
|
|
2343
|
+
*/
|
|
2344
|
+
'darkPrimary200Color'?: string;
|
|
2345
|
+
/**
|
|
2346
|
+
* The darkPrimary300Color of the company.
|
|
2347
|
+
*/
|
|
2348
|
+
'darkPrimary300Color'?: string;
|
|
2349
|
+
/**
|
|
2350
|
+
* The darkPrimary400Color of the company.
|
|
2351
|
+
*/
|
|
2352
|
+
'darkPrimary400Color'?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* The darkPrimary600Color of the company.
|
|
2355
|
+
*/
|
|
2356
|
+
'darkPrimary600Color'?: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* The darkPrimary700Color of the company.
|
|
2359
|
+
*/
|
|
2360
|
+
'darkPrimary700Color'?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* The darkPrimary800Color of the company.
|
|
2363
|
+
*/
|
|
2364
|
+
'darkPrimary800Color'?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* The darkPrimary900Color of the company.
|
|
2367
|
+
*/
|
|
2368
|
+
'darkPrimary900Color'?: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* The darkSecondary50Color of the company.
|
|
2371
|
+
*/
|
|
2372
|
+
'darkSecondary50Color'?: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* The darkSecondary100Color of the company.
|
|
2375
|
+
*/
|
|
2376
|
+
'darkSecondary100Color'?: string;
|
|
2377
|
+
/**
|
|
2378
|
+
* The darkSecondary200Color of the company.
|
|
2379
|
+
*/
|
|
2380
|
+
'darkSecondary200Color'?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
* The darkSecondary300Color of the company.
|
|
2383
|
+
*/
|
|
2384
|
+
'darkSecondary300Color'?: string;
|
|
2385
|
+
/**
|
|
2386
|
+
* The darkSecondary400Color of the company.
|
|
2387
|
+
*/
|
|
2388
|
+
'darkSecondary400Color'?: string;
|
|
2389
|
+
/**
|
|
2390
|
+
* The darkSecondary600Color of the company.
|
|
2391
|
+
*/
|
|
2392
|
+
'darkSecondary600Color'?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* The darkSecondary700Color of the company.
|
|
2395
|
+
*/
|
|
2396
|
+
'darkSecondary700Color'?: string;
|
|
2397
|
+
/**
|
|
2398
|
+
* The darkSecondary800Color of the company.
|
|
2399
|
+
*/
|
|
2400
|
+
'darkSecondary800Color'?: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* The darkSecondary900Color of the company.
|
|
2403
|
+
*/
|
|
2404
|
+
'darkSecondary900Color'?: string;
|
|
2405
|
+
/**
|
|
2406
|
+
* The darkAccent50Color of the company.
|
|
2407
|
+
*/
|
|
2408
|
+
'darkAccent50Color'?: string;
|
|
2409
|
+
/**
|
|
2410
|
+
* The darkAccent100Color of the company.
|
|
2411
|
+
*/
|
|
2412
|
+
'darkAccent100Color'?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* The darkAccent200Color of the company.
|
|
2415
|
+
*/
|
|
2416
|
+
'darkAccent200Color'?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* The darkAccent300Color of the company.
|
|
2419
|
+
*/
|
|
2420
|
+
'darkAccent300Color'?: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* The darkAccent400Color of the company.
|
|
2423
|
+
*/
|
|
2424
|
+
'darkAccent400Color'?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* The darkAccent600Color of the company.
|
|
2427
|
+
*/
|
|
2428
|
+
'darkAccent600Color'?: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* The darkAccent700Color of the company.
|
|
2431
|
+
*/
|
|
2432
|
+
'darkAccent700Color'?: string;
|
|
2433
|
+
/**
|
|
2434
|
+
* The darkAccent800Color of the company.
|
|
2435
|
+
*/
|
|
2436
|
+
'darkAccent800Color'?: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* The darkAccent900Color of the company.
|
|
2439
|
+
*/
|
|
2440
|
+
'darkAccent900Color'?: string;
|
|
2120
2441
|
/**
|
|
2121
2442
|
* The black color of the company in dark mode.
|
|
2122
2443
|
*/
|
|
@@ -2245,9 +2566,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2245
2566
|
};
|
|
2246
2567
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2247
2568
|
export interface ExistingWidgetSummary {
|
|
2248
|
-
'ymetric'?: string;
|
|
2249
|
-
'yproperty'?: string;
|
|
2250
2569
|
'xproperty'?: string;
|
|
2570
|
+
'yproperty'?: string;
|
|
2571
|
+
'ymetric'?: string;
|
|
2251
2572
|
'title'?: string;
|
|
2252
2573
|
'chartType'?: string;
|
|
2253
2574
|
'xProperty'?: string;
|
|
@@ -2319,6 +2640,13 @@ export interface FeedDTO {
|
|
|
2319
2640
|
'cacheTtlSeconds'?: number;
|
|
2320
2641
|
'active'?: boolean;
|
|
2321
2642
|
}
|
|
2643
|
+
export interface FileListItemDTO {
|
|
2644
|
+
'key'?: string;
|
|
2645
|
+
'name'?: string;
|
|
2646
|
+
'size'?: number;
|
|
2647
|
+
'lastModified'?: number;
|
|
2648
|
+
'contentType'?: string;
|
|
2649
|
+
}
|
|
2322
2650
|
export interface FilledProperty {
|
|
2323
2651
|
'icon'?: string;
|
|
2324
2652
|
'name'?: string;
|
|
@@ -2946,10 +3274,110 @@ export interface LoadAppSettingOptionsRequest {
|
|
|
2946
3274
|
*/
|
|
2947
3275
|
'object'?: string;
|
|
2948
3276
|
}
|
|
3277
|
+
export interface Location extends PropertyFormat {
|
|
3278
|
+
}
|
|
2949
3279
|
export interface LoginRequest {
|
|
2950
3280
|
'email': string;
|
|
2951
3281
|
'password': string;
|
|
2952
3282
|
}
|
|
3283
|
+
/**
|
|
3284
|
+
* A map marker from one source: custom lat/lng, a page location property, or an object
|
|
3285
|
+
*/
|
|
3286
|
+
export interface MapLocationDTO {
|
|
3287
|
+
'latitude'?: number;
|
|
3288
|
+
'longitude'?: number;
|
|
3289
|
+
/**
|
|
3290
|
+
* UUID of a location property
|
|
3291
|
+
*/
|
|
3292
|
+
'propertyUuid'?: string;
|
|
3293
|
+
/**
|
|
3294
|
+
* Name of a location property (fallback if uuid missing)
|
|
3295
|
+
*/
|
|
3296
|
+
'propertyName'?: string;
|
|
3297
|
+
/**
|
|
3298
|
+
* When set, resolve markers from published records of this object. Exclusive with propertyUuid and custom lat/lng.
|
|
3299
|
+
*/
|
|
3300
|
+
'objectUuid'?: string;
|
|
3301
|
+
/**
|
|
3302
|
+
* Object name fallback when uuid is missing
|
|
3303
|
+
*/
|
|
3304
|
+
'objectName'?: string;
|
|
3305
|
+
/**
|
|
3306
|
+
* FontAwesome icon key for the marker
|
|
3307
|
+
*/
|
|
3308
|
+
'icon'?: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* Marker icon color (hex or rgba)
|
|
3311
|
+
*/
|
|
3312
|
+
'iconColor'?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Marker pin background fill color (hex or rgba)
|
|
3315
|
+
*/
|
|
3316
|
+
'iconBackgroundColor'?: string;
|
|
3317
|
+
/**
|
|
3318
|
+
* Marker pin size in CSS pixels
|
|
3319
|
+
*/
|
|
3320
|
+
'markerSize'?: number;
|
|
3321
|
+
/**
|
|
3322
|
+
* Marker glyph size in CSS pixels
|
|
3323
|
+
*/
|
|
3324
|
+
'iconSize'?: number;
|
|
3325
|
+
/**
|
|
3326
|
+
* Text shown when hovering the marker (supports smart content)
|
|
3327
|
+
*/
|
|
3328
|
+
'label'?: string;
|
|
3329
|
+
/**
|
|
3330
|
+
* UUID of a property whose value is shown as hover text
|
|
3331
|
+
*/
|
|
3332
|
+
'labelPropertyUuid'?: string;
|
|
3333
|
+
/**
|
|
3334
|
+
* Name of a property whose value is shown as hover text
|
|
3335
|
+
*/
|
|
3336
|
+
'labelPropertyName'?: string;
|
|
3337
|
+
/**
|
|
3338
|
+
* UUID of the preview shown when hovering a bound marker
|
|
3339
|
+
*/
|
|
3340
|
+
'hoverPreviewUuid'?: string;
|
|
3341
|
+
/**
|
|
3342
|
+
* Name of the preview shown when hovering a bound marker
|
|
3343
|
+
*/
|
|
3344
|
+
'hoverPreviewName'?: string;
|
|
3345
|
+
/**
|
|
3346
|
+
* Record this concrete public marker was resolved from
|
|
3347
|
+
*/
|
|
3348
|
+
'recordUuid'?: string;
|
|
3349
|
+
/**
|
|
3350
|
+
* Marker click target: liveUrl, custom, or unset
|
|
3351
|
+
*/
|
|
3352
|
+
'clickLinkType'?: string;
|
|
3353
|
+
/**
|
|
3354
|
+
* Custom URL used when clickLinkType is custom
|
|
3355
|
+
*/
|
|
3356
|
+
'clickLinkUrl'?: string;
|
|
3357
|
+
/**
|
|
3358
|
+
* Open the marker link in a new tab
|
|
3359
|
+
*/
|
|
3360
|
+
'clickLinkOpenInNewWindow'?: boolean;
|
|
3361
|
+
/**
|
|
3362
|
+
* Resolved public URL for this concrete marker
|
|
3363
|
+
*/
|
|
3364
|
+
'href'?: string;
|
|
3365
|
+
/**
|
|
3366
|
+
* Properties exposed as public filters for object-bound markers
|
|
3367
|
+
*/
|
|
3368
|
+
'filterProperties'?: Array<PropertyDTO>;
|
|
3369
|
+
/**
|
|
3370
|
+
* Resolved property values used to filter this concrete marker
|
|
3371
|
+
*/
|
|
3372
|
+
'filterValues'?: {
|
|
3373
|
+
[key: string]: any | null;
|
|
3374
|
+
};
|
|
3375
|
+
}
|
|
3376
|
+
export interface MapMarkerPreviewRequest {
|
|
3377
|
+
'recordUuid'?: string;
|
|
3378
|
+
'previewUuid'?: string;
|
|
3379
|
+
'previewName'?: string;
|
|
3380
|
+
}
|
|
2953
3381
|
export interface MappingDTO {
|
|
2954
3382
|
/**
|
|
2955
3383
|
* Unique identifier for the entity
|
|
@@ -3076,6 +3504,8 @@ export interface ModelRecord {
|
|
|
3076
3504
|
};
|
|
3077
3505
|
'user'?: PublicUserDTO;
|
|
3078
3506
|
}
|
|
3507
|
+
export interface MultiFile extends PropertyFormat {
|
|
3508
|
+
}
|
|
3079
3509
|
export interface MultiLine extends PropertyFormat {
|
|
3080
3510
|
}
|
|
3081
3511
|
export interface MultiSelect extends PropertyFormat {
|
|
@@ -3498,6 +3928,26 @@ export interface PageContentSettingsDTO {
|
|
|
3498
3928
|
* The platforms shown in the share component
|
|
3499
3929
|
*/
|
|
3500
3930
|
'platforms'?: Array<string>;
|
|
3931
|
+
/**
|
|
3932
|
+
* Latitude for the map component
|
|
3933
|
+
*/
|
|
3934
|
+
'mapLatitude'?: number;
|
|
3935
|
+
/**
|
|
3936
|
+
* Longitude for the map component
|
|
3937
|
+
*/
|
|
3938
|
+
'mapLongitude'?: number;
|
|
3939
|
+
/**
|
|
3940
|
+
* Multiple map markers
|
|
3941
|
+
*/
|
|
3942
|
+
'mapLocations'?: Array<MapLocationDTO>;
|
|
3943
|
+
/**
|
|
3944
|
+
* Show a public distance-from-location filter on this map
|
|
3945
|
+
*/
|
|
3946
|
+
'distanceFilterEnabled'?: boolean;
|
|
3947
|
+
/**
|
|
3948
|
+
* Show a public contains filter for city, street, or postcode on this map
|
|
3949
|
+
*/
|
|
3950
|
+
'locationContainsFilterEnabled'?: boolean;
|
|
3501
3951
|
}
|
|
3502
3952
|
export interface PageContentStylingDTO {
|
|
3503
3953
|
/**
|
|
@@ -4476,7 +4926,7 @@ export interface PropertyDTO {
|
|
|
4476
4926
|
* @type PropertyDTOFormat
|
|
4477
4927
|
* Format configuration for the property\'s display and validation
|
|
4478
4928
|
*/
|
|
4479
|
-
export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
4929
|
+
export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | Location | ModelDate | ModelFile | MultiFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
4480
4930
|
export interface PropertyFormat {
|
|
4481
4931
|
'label'?: string;
|
|
4482
4932
|
'name'?: string;
|
|
@@ -4743,6 +5193,16 @@ export interface RecordRelationRequestDTO {
|
|
|
4743
5193
|
*/
|
|
4744
5194
|
'merge'?: boolean;
|
|
4745
5195
|
}
|
|
5196
|
+
export interface RecordSummary {
|
|
5197
|
+
'uuid'?: string;
|
|
5198
|
+
'object'?: string;
|
|
5199
|
+
'properties'?: {
|
|
5200
|
+
[key: string]: any | null;
|
|
5201
|
+
};
|
|
5202
|
+
'parsedProperties'?: {
|
|
5203
|
+
[key: string]: any | null;
|
|
5204
|
+
};
|
|
5205
|
+
}
|
|
4746
5206
|
export interface Recurrence extends PropertyFormat {
|
|
4747
5207
|
}
|
|
4748
5208
|
export interface Reference {
|
|
@@ -5292,6 +5752,7 @@ export interface SettingOption {
|
|
|
5292
5752
|
'name'?: string;
|
|
5293
5753
|
'label'?: string;
|
|
5294
5754
|
'helpText'?: string;
|
|
5755
|
+
'preview'?: string;
|
|
5295
5756
|
}
|
|
5296
5757
|
/**
|
|
5297
5758
|
* DTO representing an item with properties defined for displaying and handling in UI related operations.
|
|
@@ -5454,13 +5915,56 @@ export interface ShowResponseCaraerObjectDTO {
|
|
|
5454
5915
|
};
|
|
5455
5916
|
}
|
|
5456
5917
|
/**
|
|
5457
|
-
*
|
|
5918
|
+
* Represents the response for viewing or showing a specific resource.
|
|
5458
5919
|
*/
|
|
5459
|
-
export interface
|
|
5920
|
+
export interface ShowResponseCmsEnvironmentDTO {
|
|
5921
|
+
/**
|
|
5922
|
+
* A message detailing the result of the operation.
|
|
5923
|
+
*/
|
|
5460
5924
|
'message'?: string;
|
|
5461
|
-
|
|
5462
|
-
|
|
5463
|
-
|
|
5925
|
+
/**
|
|
5926
|
+
* The data payload of the response, if any.
|
|
5927
|
+
*/
|
|
5928
|
+
'data'?: CmsEnvironmentDTO;
|
|
5929
|
+
}
|
|
5930
|
+
/**
|
|
5931
|
+
* Represents the response for viewing or showing a specific resource.
|
|
5932
|
+
*/
|
|
5933
|
+
export interface ShowResponseCmsPageDTO {
|
|
5934
|
+
/**
|
|
5935
|
+
* A message detailing the result of the operation.
|
|
5936
|
+
*/
|
|
5937
|
+
'message'?: string;
|
|
5938
|
+
/**
|
|
5939
|
+
* The data payload of the response, if any.
|
|
5940
|
+
*/
|
|
5941
|
+
'data'?: CmsPageDTO;
|
|
5942
|
+
}
|
|
5943
|
+
/**
|
|
5944
|
+
* Represents the response for viewing or showing a specific resource.
|
|
5945
|
+
*/
|
|
5946
|
+
export interface ShowResponseCmsPageDocument {
|
|
5947
|
+
/**
|
|
5948
|
+
* A message detailing the result of the operation.
|
|
5949
|
+
*/
|
|
5950
|
+
'message'?: string;
|
|
5951
|
+
/**
|
|
5952
|
+
* The data payload of the response, if any.
|
|
5953
|
+
*/
|
|
5954
|
+
'data'?: CmsPageDocument;
|
|
5955
|
+
}
|
|
5956
|
+
/**
|
|
5957
|
+
* Represents the response for viewing or showing a specific resource.
|
|
5958
|
+
*/
|
|
5959
|
+
export interface ShowResponseCompanyDTO {
|
|
5960
|
+
/**
|
|
5961
|
+
* A message detailing the result of the operation.
|
|
5962
|
+
*/
|
|
5963
|
+
'message'?: string;
|
|
5964
|
+
/**
|
|
5965
|
+
* The data payload of the response, if any.
|
|
5966
|
+
*/
|
|
5967
|
+
'data'?: CompanyDTO;
|
|
5464
5968
|
}
|
|
5465
5969
|
/**
|
|
5466
5970
|
* Success response (ShowResponseDeveloperProjectDTO).
|
|
@@ -5515,6 +6019,58 @@ export interface ShowResponseListAppConnectionStatusDTO {
|
|
|
5515
6019
|
*/
|
|
5516
6020
|
'data'?: Array<AppConnectionStatusDTO>;
|
|
5517
6021
|
}
|
|
6022
|
+
/**
|
|
6023
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6024
|
+
*/
|
|
6025
|
+
export interface ShowResponseListCmsEnvironmentDTO {
|
|
6026
|
+
/**
|
|
6027
|
+
* A message detailing the result of the operation.
|
|
6028
|
+
*/
|
|
6029
|
+
'message'?: string;
|
|
6030
|
+
/**
|
|
6031
|
+
* The data payload of the response, if any.
|
|
6032
|
+
*/
|
|
6033
|
+
'data'?: Array<CmsEnvironmentDTO>;
|
|
6034
|
+
}
|
|
6035
|
+
/**
|
|
6036
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6037
|
+
*/
|
|
6038
|
+
export interface ShowResponseListCmsModuleDTO {
|
|
6039
|
+
/**
|
|
6040
|
+
* A message detailing the result of the operation.
|
|
6041
|
+
*/
|
|
6042
|
+
'message'?: string;
|
|
6043
|
+
/**
|
|
6044
|
+
* The data payload of the response, if any.
|
|
6045
|
+
*/
|
|
6046
|
+
'data'?: Array<CmsModuleDTO>;
|
|
6047
|
+
}
|
|
6048
|
+
/**
|
|
6049
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6050
|
+
*/
|
|
6051
|
+
export interface ShowResponseListCmsPageDTO {
|
|
6052
|
+
/**
|
|
6053
|
+
* A message detailing the result of the operation.
|
|
6054
|
+
*/
|
|
6055
|
+
'message'?: string;
|
|
6056
|
+
/**
|
|
6057
|
+
* The data payload of the response, if any.
|
|
6058
|
+
*/
|
|
6059
|
+
'data'?: Array<CmsPageDTO>;
|
|
6060
|
+
}
|
|
6061
|
+
/**
|
|
6062
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6063
|
+
*/
|
|
6064
|
+
export interface ShowResponseListCmsPublicMenuDTO {
|
|
6065
|
+
/**
|
|
6066
|
+
* A message detailing the result of the operation.
|
|
6067
|
+
*/
|
|
6068
|
+
'message'?: string;
|
|
6069
|
+
/**
|
|
6070
|
+
* The data payload of the response, if any.
|
|
6071
|
+
*/
|
|
6072
|
+
'data'?: Array<CmsPublicMenuDTO>;
|
|
6073
|
+
}
|
|
5518
6074
|
/**
|
|
5519
6075
|
* Success response (ShowResponseListEnvironmentDTO).
|
|
5520
6076
|
*/
|
|
@@ -5536,6 +6092,21 @@ export interface ShowResponseListInstalledAppBarDTO {
|
|
|
5536
6092
|
'message'?: string;
|
|
5537
6093
|
'data'?: Array<object>;
|
|
5538
6094
|
}
|
|
6095
|
+
/**
|
|
6096
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6097
|
+
*/
|
|
6098
|
+
export interface ShowResponseListMapStringObject {
|
|
6099
|
+
/**
|
|
6100
|
+
* A message detailing the result of the operation.
|
|
6101
|
+
*/
|
|
6102
|
+
'message'?: string;
|
|
6103
|
+
/**
|
|
6104
|
+
* The data payload of the response, if any.
|
|
6105
|
+
*/
|
|
6106
|
+
'data'?: Array<{
|
|
6107
|
+
[key: string]: any | null;
|
|
6108
|
+
}>;
|
|
6109
|
+
}
|
|
5539
6110
|
/**
|
|
5540
6111
|
* Success response (ShowResponseListPropertyDTO).
|
|
5541
6112
|
*/
|
|
@@ -5556,6 +6127,19 @@ export interface ShowResponseListString {
|
|
|
5556
6127
|
*/
|
|
5557
6128
|
'data'?: Array<string>;
|
|
5558
6129
|
}
|
|
6130
|
+
/**
|
|
6131
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6132
|
+
*/
|
|
6133
|
+
export interface ShowResponseListWebpageAccessGrantDTO {
|
|
6134
|
+
/**
|
|
6135
|
+
* A message detailing the result of the operation.
|
|
6136
|
+
*/
|
|
6137
|
+
'message'?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* The data payload of the response, if any.
|
|
6140
|
+
*/
|
|
6141
|
+
'data'?: Array<WebpageAccessGrantDTO>;
|
|
6142
|
+
}
|
|
5559
6143
|
/**
|
|
5560
6144
|
* Success response (ShowResponseListWebpagePickerItemDTO).
|
|
5561
6145
|
*/
|
|
@@ -5669,13 +6253,17 @@ export interface ShowResponsePageContentDTO {
|
|
|
5669
6253
|
};
|
|
5670
6254
|
}
|
|
5671
6255
|
/**
|
|
5672
|
-
*
|
|
6256
|
+
* Represents the response for viewing or showing a specific resource.
|
|
5673
6257
|
*/
|
|
5674
6258
|
export interface ShowResponsePreviewDTO {
|
|
6259
|
+
/**
|
|
6260
|
+
* A message detailing the result of the operation.
|
|
6261
|
+
*/
|
|
5675
6262
|
'message'?: string;
|
|
5676
|
-
|
|
5677
|
-
|
|
5678
|
-
|
|
6263
|
+
/**
|
|
6264
|
+
* The data payload of the response, if any.
|
|
6265
|
+
*/
|
|
6266
|
+
'data'?: PreviewDTO;
|
|
5679
6267
|
}
|
|
5680
6268
|
/**
|
|
5681
6269
|
* Success response (ShowResponsePropertyDTO).
|
|
@@ -5722,6 +6310,19 @@ export interface ShowResponseServerlessFunctionDTO {
|
|
|
5722
6310
|
[key: string]: any;
|
|
5723
6311
|
};
|
|
5724
6312
|
}
|
|
6313
|
+
/**
|
|
6314
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6315
|
+
*/
|
|
6316
|
+
export interface ShowResponseSignedUrlResultDTO {
|
|
6317
|
+
/**
|
|
6318
|
+
* A message detailing the result of the operation.
|
|
6319
|
+
*/
|
|
6320
|
+
'message'?: string;
|
|
6321
|
+
/**
|
|
6322
|
+
* The data payload of the response, if any.
|
|
6323
|
+
*/
|
|
6324
|
+
'data'?: SignedUrlResultDTO;
|
|
6325
|
+
}
|
|
5725
6326
|
/**
|
|
5726
6327
|
* Success response (ShowResponseString).
|
|
5727
6328
|
*/
|
|
@@ -5778,6 +6379,19 @@ export interface ShowResponseWebMenuDTO {
|
|
|
5778
6379
|
[key: string]: any;
|
|
5779
6380
|
};
|
|
5780
6381
|
}
|
|
6382
|
+
/**
|
|
6383
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6384
|
+
*/
|
|
6385
|
+
export interface ShowResponseWebpageMapLocationsDTO {
|
|
6386
|
+
/**
|
|
6387
|
+
* A message detailing the result of the operation.
|
|
6388
|
+
*/
|
|
6389
|
+
'message'?: string;
|
|
6390
|
+
/**
|
|
6391
|
+
* The data payload of the response, if any.
|
|
6392
|
+
*/
|
|
6393
|
+
'data'?: WebpageMapLocationsDTO;
|
|
6394
|
+
}
|
|
5781
6395
|
/**
|
|
5782
6396
|
* Represents the response for viewing or showing a specific resource.
|
|
5783
6397
|
*/
|
|
@@ -6486,6 +7100,19 @@ export interface SuccessResponseListDeveloperSandboxDTO {
|
|
|
6486
7100
|
*/
|
|
6487
7101
|
'data'?: Array<DeveloperSandboxDTO>;
|
|
6488
7102
|
}
|
|
7103
|
+
/**
|
|
7104
|
+
* Represents a standard successful response with a message and optional data.
|
|
7105
|
+
*/
|
|
7106
|
+
export interface SuccessResponseListFileListItemDTO {
|
|
7107
|
+
/**
|
|
7108
|
+
* A message detailing the result of the operation.
|
|
7109
|
+
*/
|
|
7110
|
+
'message'?: string;
|
|
7111
|
+
/**
|
|
7112
|
+
* The data payload of the response, if any.
|
|
7113
|
+
*/
|
|
7114
|
+
'data'?: Array<FileListItemDTO>;
|
|
7115
|
+
}
|
|
6489
7116
|
/**
|
|
6490
7117
|
* Represents a standard successful response with a message and optional data.
|
|
6491
7118
|
*/
|
|
@@ -6827,6 +7454,10 @@ export interface TemplateWebpageDTO {
|
|
|
6827
7454
|
* Object of the sidebar
|
|
6828
7455
|
*/
|
|
6829
7456
|
'sidebarObject'?: CaraerObjectDTO;
|
|
7457
|
+
/**
|
|
7458
|
+
* UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar.
|
|
7459
|
+
*/
|
|
7460
|
+
'floatingActionBarModuleUuid'?: string;
|
|
6830
7461
|
/**
|
|
6831
7462
|
* Custom options and configurations specific to the webpage.
|
|
6832
7463
|
*/
|
|
@@ -7322,6 +7953,14 @@ export interface WebpageDTO {
|
|
|
7322
7953
|
* Object of the sidebar
|
|
7323
7954
|
*/
|
|
7324
7955
|
'sidebarObject'?: CaraerObjectDTO;
|
|
7956
|
+
/**
|
|
7957
|
+
* UUID of the CMS module rendered as a floating action bar on this page. Null or empty disables the bar.
|
|
7958
|
+
*/
|
|
7959
|
+
'floatingActionBarModuleUuid'?: string;
|
|
7960
|
+
/**
|
|
7961
|
+
* Hydrated module tree for the floating action bar. Set only on public page responses.
|
|
7962
|
+
*/
|
|
7963
|
+
'floatingActionBar'?: PageContentDTO;
|
|
7325
7964
|
/**
|
|
7326
7965
|
* The Object object associated with the webpage, representing application data.
|
|
7327
7966
|
*/
|
|
@@ -7390,6 +8029,15 @@ export interface WebpageEditingStatusDTO {
|
|
|
7390
8029
|
*/
|
|
7391
8030
|
'message'?: string;
|
|
7392
8031
|
}
|
|
8032
|
+
/**
|
|
8033
|
+
* Resolved public map markers for a webpage map block
|
|
8034
|
+
*/
|
|
8035
|
+
export interface WebpageMapLocationsDTO {
|
|
8036
|
+
/**
|
|
8037
|
+
* Concrete markers after applying public filters
|
|
8038
|
+
*/
|
|
8039
|
+
'mapLocations'?: Array<MapLocationDTO>;
|
|
8040
|
+
}
|
|
7393
8041
|
/**
|
|
7394
8042
|
* Data Transfer Object representing options for a webpage.
|
|
7395
8043
|
*/
|
|
@@ -7582,6 +8230,10 @@ export interface WebsiteSettingsDTO {
|
|
|
7582
8230
|
'footerCompanyText'?: string;
|
|
7583
8231
|
'customFooterEnabled'?: boolean;
|
|
7584
8232
|
'customFooterModuleUuid'?: string;
|
|
8233
|
+
'cmsHeaderModule'?: string;
|
|
8234
|
+
'cmsFooterModule'?: string;
|
|
8235
|
+
'cmsCookieBannerModule'?: string;
|
|
8236
|
+
'cmsModuleDefaults'?: string;
|
|
7585
8237
|
'footerBackgroundColor'?: string;
|
|
7586
8238
|
'footerForegroundColor'?: string;
|
|
7587
8239
|
'footerShowSocialButtons'?: boolean;
|
|
@@ -7612,6 +8264,7 @@ export interface WebsiteSettingsDTO {
|
|
|
7612
8264
|
'tertiaryButtonStyling'?: PageContentStylingDTO;
|
|
7613
8265
|
'imageStyling'?: PageContentStylingDTO;
|
|
7614
8266
|
'videoStyling'?: PageContentStylingDTO;
|
|
8267
|
+
'mapStyling'?: PageContentStylingDTO;
|
|
7615
8268
|
'formStyling'?: PageContentStylingDTO;
|
|
7616
8269
|
'sliderStyling'?: PageContentStylingDTO;
|
|
7617
8270
|
'accordionStyling'?: PageContentStylingDTO;
|
|
@@ -9504,166 +10157,1966 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
9504
10157
|
*/
|
|
9505
10158
|
testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
9506
10159
|
/**
|
|
9507
|
-
* Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations.
|
|
9508
|
-
* @summary Test an unsaved webhook for an app
|
|
9509
|
-
* @param {string} appUuid UUID of the app the webhook belongs to
|
|
9510
|
-
* @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters
|
|
10160
|
+
* Generates a test webhook payload from webhook configuration supplied in the request body without persisting the webhook. When recordUuid is omitted, auto-resolves the latest matching record, prefers records that submitted the topic form and that have as many includeRelations as possible, and uses the event from the webhook topic. If no record exists, a simulated record is used and context.testNote (also X-Webhook-Test-Note) explains that plus any missing includeRelations.
|
|
10161
|
+
* @summary Test an unsaved webhook for an app
|
|
10162
|
+
* @param {string} appUuid UUID of the app the webhook belongs to
|
|
10163
|
+
* @param {TestWebhookRequest} testWebhookRequest Webhook configuration and optional test event parameters
|
|
10164
|
+
* @param {*} [options] Override http request option.
|
|
10165
|
+
* @throws {RequiredError}
|
|
10166
|
+
*/
|
|
10167
|
+
testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
10168
|
+
/**
|
|
10169
|
+
* Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO.
|
|
10170
|
+
* @summary Uninstall an application
|
|
10171
|
+
* @param {string} uuid UUID of the application to uninstall
|
|
10172
|
+
* @param {AppRequest} appRequest
|
|
10173
|
+
* @param {*} [options] Override http request option.
|
|
10174
|
+
* @throws {RequiredError}
|
|
10175
|
+
*/
|
|
10176
|
+
uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10177
|
+
/**
|
|
10178
|
+
* Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company.
|
|
10179
|
+
* @summary Update a webhook for an app
|
|
10180
|
+
* @param {string} appUuid UUID of the app that owns the webhook
|
|
10181
|
+
* @param {string} webhookUuid UUID of the webhook to update
|
|
10182
|
+
* @param {SubscribeWebhookDTO} subscribeWebhookDTO
|
|
10183
|
+
* @param {*} [options] Override http request option.
|
|
10184
|
+
* @throws {RequiredError}
|
|
10185
|
+
*/
|
|
10186
|
+
updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateResponse, any, {}>>;
|
|
10187
|
+
/**
|
|
10188
|
+
* Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO.
|
|
10189
|
+
* @summary Update a public app (creator edit)
|
|
10190
|
+
* @param {string} uuid UUID of the public app to update
|
|
10191
|
+
* @param {AppDTO} appDTO
|
|
10192
|
+
* @param {*} [options] Override http request option.
|
|
10193
|
+
* @throws {RequiredError}
|
|
10194
|
+
*/
|
|
10195
|
+
updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10196
|
+
}
|
|
10197
|
+
/**
|
|
10198
|
+
* AutomationsApi - axios parameter creator
|
|
10199
|
+
*/
|
|
10200
|
+
export declare const AutomationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10201
|
+
/**
|
|
10202
|
+
* Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
|
|
10203
|
+
* @summary Get Latenode JWT token for current user
|
|
10204
|
+
* @param {*} [options] Override http request option.
|
|
10205
|
+
* @throws {RequiredError}
|
|
10206
|
+
*/
|
|
10207
|
+
getToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10208
|
+
};
|
|
10209
|
+
/**
|
|
10210
|
+
* AutomationsApi - functional programming interface
|
|
10211
|
+
*/
|
|
10212
|
+
export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
10213
|
+
/**
|
|
10214
|
+
* Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
|
|
10215
|
+
* @summary Get Latenode JWT token for current user
|
|
10216
|
+
* @param {*} [options] Override http request option.
|
|
10217
|
+
* @throws {RequiredError}
|
|
10218
|
+
*/
|
|
10219
|
+
getToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
|
|
10220
|
+
};
|
|
10221
|
+
/**
|
|
10222
|
+
* AutomationsApi - factory interface
|
|
10223
|
+
*/
|
|
10224
|
+
export declare const AutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10225
|
+
/**
|
|
10226
|
+
* Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
|
|
10227
|
+
* @summary Get Latenode JWT token for current user
|
|
10228
|
+
* @param {*} [options] Override http request option.
|
|
10229
|
+
* @throws {RequiredError}
|
|
10230
|
+
*/
|
|
10231
|
+
getToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
|
|
10232
|
+
};
|
|
10233
|
+
/**
|
|
10234
|
+
* AutomationsApi - object-oriented interface
|
|
10235
|
+
*/
|
|
10236
|
+
export declare class AutomationsApi extends BaseAPI {
|
|
10237
|
+
/**
|
|
10238
|
+
* Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
|
|
10239
|
+
* @summary Get Latenode JWT token for current user
|
|
10240
|
+
* @param {*} [options] Override http request option.
|
|
10241
|
+
* @throws {RequiredError}
|
|
10242
|
+
*/
|
|
10243
|
+
getToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
10244
|
+
}
|
|
10245
|
+
/**
|
|
10246
|
+
* BillingApi - axios parameter creator
|
|
10247
|
+
*/
|
|
10248
|
+
export declare const BillingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10249
|
+
/**
|
|
10250
|
+
* Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
|
|
10251
|
+
* @summary Get billing enforcement status
|
|
10252
|
+
* @param {*} [options] Override http request option.
|
|
10253
|
+
* @throws {RequiredError}
|
|
10254
|
+
*/
|
|
10255
|
+
getStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10256
|
+
/**
|
|
10257
|
+
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10258
|
+
* @summary Send billing setup email
|
|
10259
|
+
* @param {*} [options] Override http request option.
|
|
10260
|
+
* @throws {RequiredError}
|
|
10261
|
+
*/
|
|
10262
|
+
sendSetupEmail: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10263
|
+
};
|
|
10264
|
+
/**
|
|
10265
|
+
* BillingApi - functional programming interface
|
|
10266
|
+
*/
|
|
10267
|
+
export declare const BillingApiFp: (configuration?: Configuration) => {
|
|
10268
|
+
/**
|
|
10269
|
+
* Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
|
|
10270
|
+
* @summary Get billing enforcement status
|
|
10271
|
+
* @param {*} [options] Override http request option.
|
|
10272
|
+
* @throws {RequiredError}
|
|
10273
|
+
*/
|
|
10274
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseBillingStatusDTO>>;
|
|
10275
|
+
/**
|
|
10276
|
+
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10277
|
+
* @summary Send billing setup email
|
|
10278
|
+
* @param {*} [options] Override http request option.
|
|
10279
|
+
* @throws {RequiredError}
|
|
10280
|
+
*/
|
|
10281
|
+
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringBoolean>>;
|
|
10282
|
+
};
|
|
10283
|
+
/**
|
|
10284
|
+
* BillingApi - factory interface
|
|
10285
|
+
*/
|
|
10286
|
+
export declare const BillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10287
|
+
/**
|
|
10288
|
+
* Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
|
|
10289
|
+
* @summary Get billing enforcement status
|
|
10290
|
+
* @param {*} [options] Override http request option.
|
|
10291
|
+
* @throws {RequiredError}
|
|
10292
|
+
*/
|
|
10293
|
+
getStatus(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseBillingStatusDTO>;
|
|
10294
|
+
/**
|
|
10295
|
+
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10296
|
+
* @summary Send billing setup email
|
|
10297
|
+
* @param {*} [options] Override http request option.
|
|
10298
|
+
* @throws {RequiredError}
|
|
10299
|
+
*/
|
|
10300
|
+
sendSetupEmail(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringBoolean>;
|
|
10301
|
+
};
|
|
10302
|
+
/**
|
|
10303
|
+
* BillingApi - object-oriented interface
|
|
10304
|
+
*/
|
|
10305
|
+
export declare class BillingApi extends BaseAPI {
|
|
10306
|
+
/**
|
|
10307
|
+
* Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
|
|
10308
|
+
* @summary Get billing enforcement status
|
|
10309
|
+
* @param {*} [options] Override http request option.
|
|
10310
|
+
* @throws {RequiredError}
|
|
10311
|
+
*/
|
|
10312
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseBillingStatusDTO, any, {}>>;
|
|
10313
|
+
/**
|
|
10314
|
+
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10315
|
+
* @summary Send billing setup email
|
|
10316
|
+
* @param {*} [options] Override http request option.
|
|
10317
|
+
* @throws {RequiredError}
|
|
10318
|
+
*/
|
|
10319
|
+
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
|
|
10320
|
+
}
|
|
10321
|
+
/**
|
|
10322
|
+
* CMSModulesApi - axios parameter creator
|
|
10323
|
+
*/
|
|
10324
|
+
export declare const CMSModulesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10325
|
+
/**
|
|
10326
|
+
* Includes retired modules, so a developer can see what a push removed.
|
|
10327
|
+
* @summary List an app\'s CMS modules
|
|
10328
|
+
* @param {string} appUuid
|
|
10329
|
+
* @param {*} [options] Override http request option.
|
|
10330
|
+
* @throws {RequiredError}
|
|
10331
|
+
*/
|
|
10332
|
+
list: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10333
|
+
/**
|
|
10334
|
+
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
10335
|
+
* @summary Publish an app\'s CMS module package
|
|
10336
|
+
* @param {string} appUuid
|
|
10337
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10338
|
+
* @param {*} [options] Override http request option.
|
|
10339
|
+
* @throws {RequiredError}
|
|
10340
|
+
*/
|
|
10341
|
+
publishPackage: (appUuid: string, requestBody: {
|
|
10342
|
+
[key: string]: any | null;
|
|
10343
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10344
|
+
/**
|
|
10345
|
+
* Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
|
|
10346
|
+
* @summary Replace an app\'s CMS module catalog
|
|
10347
|
+
* @param {string} appUuid
|
|
10348
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10349
|
+
* @param {*} [options] Override http request option.
|
|
10350
|
+
* @throws {RequiredError}
|
|
10351
|
+
*/
|
|
10352
|
+
upsert: (appUuid: string, requestBody: {
|
|
10353
|
+
[key: string]: any | null;
|
|
10354
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10355
|
+
};
|
|
10356
|
+
/**
|
|
10357
|
+
* CMSModulesApi - functional programming interface
|
|
10358
|
+
*/
|
|
10359
|
+
export declare const CMSModulesApiFp: (configuration?: Configuration) => {
|
|
10360
|
+
/**
|
|
10361
|
+
* Includes retired modules, so a developer can see what a push removed.
|
|
10362
|
+
* @summary List an app\'s CMS modules
|
|
10363
|
+
* @param {string} appUuid
|
|
10364
|
+
* @param {*} [options] Override http request option.
|
|
10365
|
+
* @throws {RequiredError}
|
|
10366
|
+
*/
|
|
10367
|
+
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsModuleDTO>>;
|
|
10368
|
+
/**
|
|
10369
|
+
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
10370
|
+
* @summary Publish an app\'s CMS module package
|
|
10371
|
+
* @param {string} appUuid
|
|
10372
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10373
|
+
* @param {*} [options] Override http request option.
|
|
10374
|
+
* @throws {RequiredError}
|
|
10375
|
+
*/
|
|
10376
|
+
publishPackage(appUuid: string, requestBody: {
|
|
10377
|
+
[key: string]: any | null;
|
|
10378
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsModuleDTO>>;
|
|
10379
|
+
/**
|
|
10380
|
+
* Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
|
|
10381
|
+
* @summary Replace an app\'s CMS module catalog
|
|
10382
|
+
* @param {string} appUuid
|
|
10383
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10384
|
+
* @param {*} [options] Override http request option.
|
|
10385
|
+
* @throws {RequiredError}
|
|
10386
|
+
*/
|
|
10387
|
+
upsert(appUuid: string, requestBody: {
|
|
10388
|
+
[key: string]: any | null;
|
|
10389
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsModuleDTO>>;
|
|
10390
|
+
};
|
|
10391
|
+
/**
|
|
10392
|
+
* CMSModulesApi - factory interface
|
|
10393
|
+
*/
|
|
10394
|
+
export declare const CMSModulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10395
|
+
/**
|
|
10396
|
+
* Includes retired modules, so a developer can see what a push removed.
|
|
10397
|
+
* @summary List an app\'s CMS modules
|
|
10398
|
+
* @param {string} appUuid
|
|
10399
|
+
* @param {*} [options] Override http request option.
|
|
10400
|
+
* @throws {RequiredError}
|
|
10401
|
+
*/
|
|
10402
|
+
list(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsModuleDTO>;
|
|
10403
|
+
/**
|
|
10404
|
+
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
10405
|
+
* @summary Publish an app\'s CMS module package
|
|
10406
|
+
* @param {string} appUuid
|
|
10407
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10408
|
+
* @param {*} [options] Override http request option.
|
|
10409
|
+
* @throws {RequiredError}
|
|
10410
|
+
*/
|
|
10411
|
+
publishPackage(appUuid: string, requestBody: {
|
|
10412
|
+
[key: string]: any | null;
|
|
10413
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsModuleDTO>;
|
|
10414
|
+
/**
|
|
10415
|
+
* Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
|
|
10416
|
+
* @summary Replace an app\'s CMS module catalog
|
|
10417
|
+
* @param {string} appUuid
|
|
10418
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10419
|
+
* @param {*} [options] Override http request option.
|
|
10420
|
+
* @throws {RequiredError}
|
|
10421
|
+
*/
|
|
10422
|
+
upsert(appUuid: string, requestBody: {
|
|
10423
|
+
[key: string]: any | null;
|
|
10424
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsModuleDTO>;
|
|
10425
|
+
};
|
|
10426
|
+
/**
|
|
10427
|
+
* CMSModulesApi - object-oriented interface
|
|
10428
|
+
*/
|
|
10429
|
+
export declare class CMSModulesApi extends BaseAPI {
|
|
10430
|
+
/**
|
|
10431
|
+
* Includes retired modules, so a developer can see what a push removed.
|
|
10432
|
+
* @summary List an app\'s CMS modules
|
|
10433
|
+
* @param {string} appUuid
|
|
10434
|
+
* @param {*} [options] Override http request option.
|
|
10435
|
+
* @throws {RequiredError}
|
|
10436
|
+
*/
|
|
10437
|
+
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
10438
|
+
/**
|
|
10439
|
+
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
10440
|
+
* @summary Publish an app\'s CMS module package
|
|
10441
|
+
* @param {string} appUuid
|
|
10442
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10443
|
+
* @param {*} [options] Override http request option.
|
|
10444
|
+
* @throws {RequiredError}
|
|
10445
|
+
*/
|
|
10446
|
+
publishPackage(appUuid: string, requestBody: {
|
|
10447
|
+
[key: string]: any | null;
|
|
10448
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
10449
|
+
/**
|
|
10450
|
+
* Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
|
|
10451
|
+
* @summary Replace an app\'s CMS module catalog
|
|
10452
|
+
* @param {string} appUuid
|
|
10453
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10454
|
+
* @param {*} [options] Override http request option.
|
|
10455
|
+
* @throws {RequiredError}
|
|
10456
|
+
*/
|
|
10457
|
+
upsert(appUuid: string, requestBody: {
|
|
10458
|
+
[key: string]: any | null;
|
|
10459
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
10460
|
+
}
|
|
10461
|
+
/**
|
|
10462
|
+
* CMSV2EnvironmentsApi - axios parameter creator
|
|
10463
|
+
*/
|
|
10464
|
+
export declare const CMSV2EnvironmentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10465
|
+
/**
|
|
10466
|
+
*
|
|
10467
|
+
* @summary Create an environment
|
|
10468
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10469
|
+
* @param {*} [options] Override http request option.
|
|
10470
|
+
* @throws {RequiredError}
|
|
10471
|
+
*/
|
|
10472
|
+
create3: (cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10473
|
+
/**
|
|
10474
|
+
*
|
|
10475
|
+
* @summary Delete an environment except main
|
|
10476
|
+
* @param {string} key
|
|
10477
|
+
* @param {*} [options] Override http request option.
|
|
10478
|
+
* @throws {RequiredError}
|
|
10479
|
+
*/
|
|
10480
|
+
delete1: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10481
|
+
/**
|
|
10482
|
+
*
|
|
10483
|
+
* @summary Translation group for a record
|
|
10484
|
+
* @param {string} recordUuid
|
|
10485
|
+
* @param {*} [options] Override http request option.
|
|
10486
|
+
* @throws {RequiredError}
|
|
10487
|
+
*/
|
|
10488
|
+
group: (recordUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10489
|
+
/**
|
|
10490
|
+
*
|
|
10491
|
+
* @summary Link two records as translations
|
|
10492
|
+
* @param {string} fromUuid
|
|
10493
|
+
* @param {string} toUuid
|
|
10494
|
+
* @param {*} [options] Override http request option.
|
|
10495
|
+
* @throws {RequiredError}
|
|
10496
|
+
*/
|
|
10497
|
+
link: (fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10498
|
+
/**
|
|
10499
|
+
*
|
|
10500
|
+
* @summary List company environments
|
|
10501
|
+
* @param {*} [options] Override http request option.
|
|
10502
|
+
* @throws {RequiredError}
|
|
10503
|
+
*/
|
|
10504
|
+
list2: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10505
|
+
/**
|
|
10506
|
+
*
|
|
10507
|
+
* @summary Unlink a translation edge
|
|
10508
|
+
* @param {string} fromUuid
|
|
10509
|
+
* @param {string} toUuid
|
|
10510
|
+
* @param {*} [options] Override http request option.
|
|
10511
|
+
* @throws {RequiredError}
|
|
10512
|
+
*/
|
|
10513
|
+
unlink: (fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10514
|
+
/**
|
|
10515
|
+
*
|
|
10516
|
+
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
10517
|
+
* @param {string} key
|
|
10518
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10519
|
+
* @param {*} [options] Override http request option.
|
|
10520
|
+
* @throws {RequiredError}
|
|
10521
|
+
*/
|
|
10522
|
+
update1: (key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10523
|
+
};
|
|
10524
|
+
/**
|
|
10525
|
+
* CMSV2EnvironmentsApi - functional programming interface
|
|
10526
|
+
*/
|
|
10527
|
+
export declare const CMSV2EnvironmentsApiFp: (configuration?: Configuration) => {
|
|
10528
|
+
/**
|
|
10529
|
+
*
|
|
10530
|
+
* @summary Create an environment
|
|
10531
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10532
|
+
* @param {*} [options] Override http request option.
|
|
10533
|
+
* @throws {RequiredError}
|
|
10534
|
+
*/
|
|
10535
|
+
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsEnvironmentDTO>>;
|
|
10536
|
+
/**
|
|
10537
|
+
*
|
|
10538
|
+
* @summary Delete an environment except main
|
|
10539
|
+
* @param {string} key
|
|
10540
|
+
* @param {*} [options] Override http request option.
|
|
10541
|
+
* @throws {RequiredError}
|
|
10542
|
+
*/
|
|
10543
|
+
delete1(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
10544
|
+
/**
|
|
10545
|
+
*
|
|
10546
|
+
* @summary Translation group for a record
|
|
10547
|
+
* @param {string} recordUuid
|
|
10548
|
+
* @param {*} [options] Override http request option.
|
|
10549
|
+
* @throws {RequiredError}
|
|
10550
|
+
*/
|
|
10551
|
+
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
10552
|
+
/**
|
|
10553
|
+
*
|
|
10554
|
+
* @summary Link two records as translations
|
|
10555
|
+
* @param {string} fromUuid
|
|
10556
|
+
* @param {string} toUuid
|
|
10557
|
+
* @param {*} [options] Override http request option.
|
|
10558
|
+
* @throws {RequiredError}
|
|
10559
|
+
*/
|
|
10560
|
+
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
10561
|
+
/**
|
|
10562
|
+
*
|
|
10563
|
+
* @summary List company environments
|
|
10564
|
+
* @param {*} [options] Override http request option.
|
|
10565
|
+
* @throws {RequiredError}
|
|
10566
|
+
*/
|
|
10567
|
+
list2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsEnvironmentDTO>>;
|
|
10568
|
+
/**
|
|
10569
|
+
*
|
|
10570
|
+
* @summary Unlink a translation edge
|
|
10571
|
+
* @param {string} fromUuid
|
|
10572
|
+
* @param {string} toUuid
|
|
10573
|
+
* @param {*} [options] Override http request option.
|
|
10574
|
+
* @throws {RequiredError}
|
|
10575
|
+
*/
|
|
10576
|
+
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
10577
|
+
/**
|
|
10578
|
+
*
|
|
10579
|
+
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
10580
|
+
* @param {string} key
|
|
10581
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10582
|
+
* @param {*} [options] Override http request option.
|
|
10583
|
+
* @throws {RequiredError}
|
|
10584
|
+
*/
|
|
10585
|
+
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsEnvironmentDTO>>;
|
|
10586
|
+
};
|
|
10587
|
+
/**
|
|
10588
|
+
* CMSV2EnvironmentsApi - factory interface
|
|
10589
|
+
*/
|
|
10590
|
+
export declare const CMSV2EnvironmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10591
|
+
/**
|
|
10592
|
+
*
|
|
10593
|
+
* @summary Create an environment
|
|
10594
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10595
|
+
* @param {*} [options] Override http request option.
|
|
10596
|
+
* @throws {RequiredError}
|
|
10597
|
+
*/
|
|
10598
|
+
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsEnvironmentDTO>;
|
|
10599
|
+
/**
|
|
10600
|
+
*
|
|
10601
|
+
* @summary Delete an environment except main
|
|
10602
|
+
* @param {string} key
|
|
10603
|
+
* @param {*} [options] Override http request option.
|
|
10604
|
+
* @throws {RequiredError}
|
|
10605
|
+
*/
|
|
10606
|
+
delete1(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
10607
|
+
/**
|
|
10608
|
+
*
|
|
10609
|
+
* @summary Translation group for a record
|
|
10610
|
+
* @param {string} recordUuid
|
|
10611
|
+
* @param {*} [options] Override http request option.
|
|
10612
|
+
* @throws {RequiredError}
|
|
10613
|
+
*/
|
|
10614
|
+
group(recordUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
10615
|
+
/**
|
|
10616
|
+
*
|
|
10617
|
+
* @summary Link two records as translations
|
|
10618
|
+
* @param {string} fromUuid
|
|
10619
|
+
* @param {string} toUuid
|
|
10620
|
+
* @param {*} [options] Override http request option.
|
|
10621
|
+
* @throws {RequiredError}
|
|
10622
|
+
*/
|
|
10623
|
+
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
10624
|
+
/**
|
|
10625
|
+
*
|
|
10626
|
+
* @summary List company environments
|
|
10627
|
+
* @param {*} [options] Override http request option.
|
|
10628
|
+
* @throws {RequiredError}
|
|
10629
|
+
*/
|
|
10630
|
+
list2(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsEnvironmentDTO>;
|
|
10631
|
+
/**
|
|
10632
|
+
*
|
|
10633
|
+
* @summary Unlink a translation edge
|
|
10634
|
+
* @param {string} fromUuid
|
|
10635
|
+
* @param {string} toUuid
|
|
10636
|
+
* @param {*} [options] Override http request option.
|
|
10637
|
+
* @throws {RequiredError}
|
|
10638
|
+
*/
|
|
10639
|
+
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
10640
|
+
/**
|
|
10641
|
+
*
|
|
10642
|
+
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
10643
|
+
* @param {string} key
|
|
10644
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10645
|
+
* @param {*} [options] Override http request option.
|
|
10646
|
+
* @throws {RequiredError}
|
|
10647
|
+
*/
|
|
10648
|
+
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsEnvironmentDTO>;
|
|
10649
|
+
};
|
|
10650
|
+
/**
|
|
10651
|
+
* CMSV2EnvironmentsApi - object-oriented interface
|
|
10652
|
+
*/
|
|
10653
|
+
export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
10654
|
+
/**
|
|
10655
|
+
*
|
|
10656
|
+
* @summary Create an environment
|
|
10657
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10658
|
+
* @param {*} [options] Override http request option.
|
|
10659
|
+
* @throws {RequiredError}
|
|
10660
|
+
*/
|
|
10661
|
+
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
10662
|
+
/**
|
|
10663
|
+
*
|
|
10664
|
+
* @summary Delete an environment except main
|
|
10665
|
+
* @param {string} key
|
|
10666
|
+
* @param {*} [options] Override http request option.
|
|
10667
|
+
* @throws {RequiredError}
|
|
10668
|
+
*/
|
|
10669
|
+
delete1(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
10670
|
+
/**
|
|
10671
|
+
*
|
|
10672
|
+
* @summary Translation group for a record
|
|
10673
|
+
* @param {string} recordUuid
|
|
10674
|
+
* @param {*} [options] Override http request option.
|
|
10675
|
+
* @throws {RequiredError}
|
|
10676
|
+
*/
|
|
10677
|
+
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
10678
|
+
/**
|
|
10679
|
+
*
|
|
10680
|
+
* @summary Link two records as translations
|
|
10681
|
+
* @param {string} fromUuid
|
|
10682
|
+
* @param {string} toUuid
|
|
10683
|
+
* @param {*} [options] Override http request option.
|
|
10684
|
+
* @throws {RequiredError}
|
|
10685
|
+
*/
|
|
10686
|
+
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
10687
|
+
/**
|
|
10688
|
+
*
|
|
10689
|
+
* @summary List company environments
|
|
10690
|
+
* @param {*} [options] Override http request option.
|
|
10691
|
+
* @throws {RequiredError}
|
|
10692
|
+
*/
|
|
10693
|
+
list2(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsEnvironmentDTO, any, {}>>;
|
|
10694
|
+
/**
|
|
10695
|
+
*
|
|
10696
|
+
* @summary Unlink a translation edge
|
|
10697
|
+
* @param {string} fromUuid
|
|
10698
|
+
* @param {string} toUuid
|
|
10699
|
+
* @param {*} [options] Override http request option.
|
|
10700
|
+
* @throws {RequiredError}
|
|
10701
|
+
*/
|
|
10702
|
+
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
10703
|
+
/**
|
|
10704
|
+
*
|
|
10705
|
+
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
10706
|
+
* @param {string} key
|
|
10707
|
+
* @param {CmsEnvironmentDTO} cmsEnvironmentDTO
|
|
10708
|
+
* @param {*} [options] Override http request option.
|
|
10709
|
+
* @throws {RequiredError}
|
|
10710
|
+
*/
|
|
10711
|
+
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
10712
|
+
}
|
|
10713
|
+
/**
|
|
10714
|
+
* CMSV2PagesApi - axios parameter creator
|
|
10715
|
+
*/
|
|
10716
|
+
export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10717
|
+
/**
|
|
10718
|
+
* Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself.
|
|
10719
|
+
* @summary Rewrite a page or a module from a prompt
|
|
10720
|
+
* @param {string} recordUuid
|
|
10721
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10722
|
+
* @param {*} [options] Override http request option.
|
|
10723
|
+
* @throws {RequiredError}
|
|
10724
|
+
*/
|
|
10725
|
+
aiRewrite: (recordUuid: string, requestBody: {
|
|
10726
|
+
[key: string]: any | null;
|
|
10727
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10728
|
+
/**
|
|
10729
|
+
*
|
|
10730
|
+
* @summary Create a translated sibling page for an environment
|
|
10731
|
+
* @param {string} recordUuid
|
|
10732
|
+
* @param {string} key
|
|
10733
|
+
* @param {*} [options] Override http request option.
|
|
10734
|
+
* @throws {RequiredError}
|
|
10735
|
+
*/
|
|
10736
|
+
createTranslation: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10737
|
+
/**
|
|
10738
|
+
* Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
|
|
10739
|
+
* @summary Create or reuse the custom 404 page
|
|
10740
|
+
* @param {*} [options] Override http request option.
|
|
10741
|
+
* @throws {RequiredError}
|
|
10742
|
+
*/
|
|
10743
|
+
ensureNotFound: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10744
|
+
/**
|
|
10745
|
+
*
|
|
10746
|
+
* @summary Environment coverage for the builder dropdown
|
|
10747
|
+
* @param {string} recordUuid
|
|
10748
|
+
* @param {*} [options] Override http request option.
|
|
10749
|
+
* @throws {RequiredError}
|
|
10750
|
+
*/
|
|
10751
|
+
environmentCoverage: (recordUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10752
|
+
/**
|
|
10753
|
+
*
|
|
10754
|
+
* @summary Load a page for the builder
|
|
10755
|
+
* @param {string} recordUuid
|
|
10756
|
+
* @param {string} [locale]
|
|
10757
|
+
* @param {string} [state]
|
|
10758
|
+
* @param {*} [options] Override http request option.
|
|
10759
|
+
* @throws {RequiredError}
|
|
10760
|
+
*/
|
|
10761
|
+
get: (recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10762
|
+
/**
|
|
10763
|
+
*
|
|
10764
|
+
* @summary CMS v2 object template document
|
|
10765
|
+
* @param {string} objectUuid
|
|
10766
|
+
* @param {string} [locale]
|
|
10767
|
+
* @param {*} [options] Override http request option.
|
|
10768
|
+
* @throws {RequiredError}
|
|
10769
|
+
*/
|
|
10770
|
+
getTemplate: (objectUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10771
|
+
/**
|
|
10772
|
+
*
|
|
10773
|
+
* @summary Draft snapshots for one locale
|
|
10774
|
+
* @param {string} recordUuid
|
|
10775
|
+
* @param {string} [locale]
|
|
10776
|
+
* @param {*} [options] Override http request option.
|
|
10777
|
+
* @throws {RequiredError}
|
|
10778
|
+
*/
|
|
10779
|
+
history: (recordUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10780
|
+
/**
|
|
10781
|
+
*
|
|
10782
|
+
* @summary Host this page on another environment
|
|
10783
|
+
* @param {string} recordUuid
|
|
10784
|
+
* @param {string} key
|
|
10785
|
+
* @param {*} [options] Override http request option.
|
|
10786
|
+
* @throws {RequiredError}
|
|
10787
|
+
*/
|
|
10788
|
+
hostOnEnvironment: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10789
|
+
/**
|
|
10790
|
+
* Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them.
|
|
10791
|
+
* @summary Modules available to this company
|
|
10792
|
+
* @param {*} [options] Override http request option.
|
|
10793
|
+
* @throws {RequiredError}
|
|
10794
|
+
*/
|
|
10795
|
+
library: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10796
|
+
/**
|
|
10797
|
+
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
10798
|
+
* @summary Apply patches to a page draft
|
|
10799
|
+
* @param {string} recordUuid
|
|
10800
|
+
* @param {CmsPagePatchRequest} cmsPagePatchRequest
|
|
10801
|
+
* @param {*} [options] Override http request option.
|
|
10802
|
+
* @throws {RequiredError}
|
|
10803
|
+
*/
|
|
10804
|
+
patch: (recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10805
|
+
/**
|
|
10806
|
+
* The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed.
|
|
10807
|
+
* @summary Signed preview URL for the builder iframe
|
|
10808
|
+
* @param {string} recordUuid
|
|
10809
|
+
* @param {string} [locale]
|
|
10810
|
+
* @param {string} [state]
|
|
10811
|
+
* @param {*} [options] Override http request option.
|
|
10812
|
+
* @throws {RequiredError}
|
|
10813
|
+
*/
|
|
10814
|
+
previewLink: (recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10815
|
+
/**
|
|
10816
|
+
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
10817
|
+
* @summary Publish one locale, or all of them
|
|
10818
|
+
* @param {string} recordUuid
|
|
10819
|
+
* @param {string} [locale]
|
|
10820
|
+
* @param {boolean} [allLocales]
|
|
10821
|
+
* @param {*} [options] Override http request option.
|
|
10822
|
+
* @throws {RequiredError}
|
|
10823
|
+
*/
|
|
10824
|
+
publish: (recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10825
|
+
/**
|
|
10826
|
+
*
|
|
10827
|
+
* @summary Restore a draft snapshot
|
|
10828
|
+
* @param {string} recordUuid
|
|
10829
|
+
* @param {number} index
|
|
10830
|
+
* @param {string} [locale]
|
|
10831
|
+
* @param {*} [options] Override http request option.
|
|
10832
|
+
* @throws {RequiredError}
|
|
10833
|
+
*/
|
|
10834
|
+
restoreHistory: (recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10835
|
+
/**
|
|
10836
|
+
*
|
|
10837
|
+
* @summary Replace a page draft
|
|
10838
|
+
* @param {string} recordUuid
|
|
10839
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
10840
|
+
* @param {string} [locale]
|
|
10841
|
+
* @param {*} [options] Override http request option.
|
|
10842
|
+
* @throws {RequiredError}
|
|
10843
|
+
*/
|
|
10844
|
+
save: (recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10845
|
+
/**
|
|
10846
|
+
*
|
|
10847
|
+
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
10848
|
+
* @param {string} recordUuid
|
|
10849
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10850
|
+
* @param {string} [locale]
|
|
10851
|
+
* @param {*} [options] Override http request option.
|
|
10852
|
+
* @throws {RequiredError}
|
|
10853
|
+
*/
|
|
10854
|
+
saveMeta: (recordUuid: string, requestBody: {
|
|
10855
|
+
[key: string]: any | null;
|
|
10856
|
+
}, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10857
|
+
/**
|
|
10858
|
+
*
|
|
10859
|
+
* @summary Replace a CMS v2 object template
|
|
10860
|
+
* @param {string} objectUuid
|
|
10861
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
10862
|
+
* @param {string} [locale]
|
|
10863
|
+
* @param {*} [options] Override http request option.
|
|
10864
|
+
* @throws {RequiredError}
|
|
10865
|
+
*/
|
|
10866
|
+
saveTemplate: (objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10867
|
+
/**
|
|
10868
|
+
*
|
|
10869
|
+
* @summary Take one locale offline
|
|
10870
|
+
* @param {string} recordUuid
|
|
10871
|
+
* @param {string} [locale]
|
|
10872
|
+
* @param {*} [options] Override http request option.
|
|
10873
|
+
* @throws {RequiredError}
|
|
10874
|
+
*/
|
|
10875
|
+
unpublish: (recordUuid: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10876
|
+
/**
|
|
10877
|
+
*
|
|
10878
|
+
* @summary Remove an environment from this page only
|
|
10879
|
+
* @param {string} recordUuid
|
|
10880
|
+
* @param {string} key
|
|
10881
|
+
* @param {*} [options] Override http request option.
|
|
10882
|
+
* @throws {RequiredError}
|
|
10883
|
+
*/
|
|
10884
|
+
unselectEnvironment: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10885
|
+
};
|
|
10886
|
+
/**
|
|
10887
|
+
* CMSV2PagesApi - functional programming interface
|
|
10888
|
+
*/
|
|
10889
|
+
export declare const CMSV2PagesApiFp: (configuration?: Configuration) => {
|
|
10890
|
+
/**
|
|
10891
|
+
* Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself.
|
|
10892
|
+
* @summary Rewrite a page or a module from a prompt
|
|
10893
|
+
* @param {string} recordUuid
|
|
10894
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10895
|
+
* @param {*} [options] Override http request option.
|
|
10896
|
+
* @throws {RequiredError}
|
|
10897
|
+
*/
|
|
10898
|
+
aiRewrite(recordUuid: string, requestBody: {
|
|
10899
|
+
[key: string]: any | null;
|
|
10900
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
10901
|
+
/**
|
|
10902
|
+
*
|
|
10903
|
+
* @summary Create a translated sibling page for an environment
|
|
10904
|
+
* @param {string} recordUuid
|
|
10905
|
+
* @param {string} key
|
|
10906
|
+
* @param {*} [options] Override http request option.
|
|
10907
|
+
* @throws {RequiredError}
|
|
10908
|
+
*/
|
|
10909
|
+
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
10910
|
+
/**
|
|
10911
|
+
* Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
|
|
10912
|
+
* @summary Create or reuse the custom 404 page
|
|
10913
|
+
* @param {*} [options] Override http request option.
|
|
10914
|
+
* @throws {RequiredError}
|
|
10915
|
+
*/
|
|
10916
|
+
ensureNotFound(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
10917
|
+
/**
|
|
10918
|
+
*
|
|
10919
|
+
* @summary Environment coverage for the builder dropdown
|
|
10920
|
+
* @param {string} recordUuid
|
|
10921
|
+
* @param {*} [options] Override http request option.
|
|
10922
|
+
* @throws {RequiredError}
|
|
10923
|
+
*/
|
|
10924
|
+
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
10925
|
+
/**
|
|
10926
|
+
*
|
|
10927
|
+
* @summary Load a page for the builder
|
|
10928
|
+
* @param {string} recordUuid
|
|
10929
|
+
* @param {string} [locale]
|
|
10930
|
+
* @param {string} [state]
|
|
10931
|
+
* @param {*} [options] Override http request option.
|
|
10932
|
+
* @throws {RequiredError}
|
|
10933
|
+
*/
|
|
10934
|
+
get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
10935
|
+
/**
|
|
10936
|
+
*
|
|
10937
|
+
* @summary CMS v2 object template document
|
|
10938
|
+
* @param {string} objectUuid
|
|
10939
|
+
* @param {string} [locale]
|
|
10940
|
+
* @param {*} [options] Override http request option.
|
|
10941
|
+
* @throws {RequiredError}
|
|
10942
|
+
*/
|
|
10943
|
+
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDocument>>;
|
|
10944
|
+
/**
|
|
10945
|
+
*
|
|
10946
|
+
* @summary Draft snapshots for one locale
|
|
10947
|
+
* @param {string} recordUuid
|
|
10948
|
+
* @param {string} [locale]
|
|
10949
|
+
* @param {*} [options] Override http request option.
|
|
10950
|
+
* @throws {RequiredError}
|
|
10951
|
+
*/
|
|
10952
|
+
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListMapStringObject>>;
|
|
10953
|
+
/**
|
|
10954
|
+
*
|
|
10955
|
+
* @summary Host this page on another environment
|
|
10956
|
+
* @param {string} recordUuid
|
|
10957
|
+
* @param {string} key
|
|
10958
|
+
* @param {*} [options] Override http request option.
|
|
10959
|
+
* @throws {RequiredError}
|
|
10960
|
+
*/
|
|
10961
|
+
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
10962
|
+
/**
|
|
10963
|
+
* Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them.
|
|
10964
|
+
* @summary Modules available to this company
|
|
10965
|
+
* @param {*} [options] Override http request option.
|
|
10966
|
+
* @throws {RequiredError}
|
|
10967
|
+
*/
|
|
10968
|
+
library(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsModuleDTO>>;
|
|
10969
|
+
/**
|
|
10970
|
+
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
10971
|
+
* @summary Apply patches to a page draft
|
|
10972
|
+
* @param {string} recordUuid
|
|
10973
|
+
* @param {CmsPagePatchRequest} cmsPagePatchRequest
|
|
10974
|
+
* @param {*} [options] Override http request option.
|
|
10975
|
+
* @throws {RequiredError}
|
|
10976
|
+
*/
|
|
10977
|
+
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
10978
|
+
/**
|
|
10979
|
+
* The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed.
|
|
10980
|
+
* @summary Signed preview URL for the builder iframe
|
|
10981
|
+
* @param {string} recordUuid
|
|
10982
|
+
* @param {string} [locale]
|
|
10983
|
+
* @param {string} [state]
|
|
10984
|
+
* @param {*} [options] Override http request option.
|
|
10985
|
+
* @throws {RequiredError}
|
|
10986
|
+
*/
|
|
10987
|
+
previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
10988
|
+
/**
|
|
10989
|
+
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
10990
|
+
* @summary Publish one locale, or all of them
|
|
10991
|
+
* @param {string} recordUuid
|
|
10992
|
+
* @param {string} [locale]
|
|
10993
|
+
* @param {boolean} [allLocales]
|
|
10994
|
+
* @param {*} [options] Override http request option.
|
|
10995
|
+
* @throws {RequiredError}
|
|
10996
|
+
*/
|
|
10997
|
+
publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsPageDTO>>;
|
|
10998
|
+
/**
|
|
10999
|
+
*
|
|
11000
|
+
* @summary Restore a draft snapshot
|
|
11001
|
+
* @param {string} recordUuid
|
|
11002
|
+
* @param {number} index
|
|
11003
|
+
* @param {string} [locale]
|
|
11004
|
+
* @param {*} [options] Override http request option.
|
|
11005
|
+
* @throws {RequiredError}
|
|
11006
|
+
*/
|
|
11007
|
+
restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11008
|
+
/**
|
|
11009
|
+
*
|
|
11010
|
+
* @summary Replace a page draft
|
|
11011
|
+
* @param {string} recordUuid
|
|
11012
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11013
|
+
* @param {string} [locale]
|
|
11014
|
+
* @param {*} [options] Override http request option.
|
|
11015
|
+
* @throws {RequiredError}
|
|
11016
|
+
*/
|
|
11017
|
+
save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11018
|
+
/**
|
|
11019
|
+
*
|
|
11020
|
+
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
11021
|
+
* @param {string} recordUuid
|
|
11022
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11023
|
+
* @param {string} [locale]
|
|
11024
|
+
* @param {*} [options] Override http request option.
|
|
11025
|
+
* @throws {RequiredError}
|
|
11026
|
+
*/
|
|
11027
|
+
saveMeta(recordUuid: string, requestBody: {
|
|
11028
|
+
[key: string]: any | null;
|
|
11029
|
+
}, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11030
|
+
/**
|
|
11031
|
+
*
|
|
11032
|
+
* @summary Replace a CMS v2 object template
|
|
11033
|
+
* @param {string} objectUuid
|
|
11034
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11035
|
+
* @param {string} [locale]
|
|
11036
|
+
* @param {*} [options] Override http request option.
|
|
11037
|
+
* @throws {RequiredError}
|
|
11038
|
+
*/
|
|
11039
|
+
saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDocument>>;
|
|
11040
|
+
/**
|
|
11041
|
+
*
|
|
11042
|
+
* @summary Take one locale offline
|
|
11043
|
+
* @param {string} recordUuid
|
|
11044
|
+
* @param {string} [locale]
|
|
11045
|
+
* @param {*} [options] Override http request option.
|
|
11046
|
+
* @throws {RequiredError}
|
|
11047
|
+
*/
|
|
11048
|
+
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11049
|
+
/**
|
|
11050
|
+
*
|
|
11051
|
+
* @summary Remove an environment from this page only
|
|
11052
|
+
* @param {string} recordUuid
|
|
11053
|
+
* @param {string} key
|
|
11054
|
+
* @param {*} [options] Override http request option.
|
|
11055
|
+
* @throws {RequiredError}
|
|
11056
|
+
*/
|
|
11057
|
+
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11058
|
+
};
|
|
11059
|
+
/**
|
|
11060
|
+
* CMSV2PagesApi - factory interface
|
|
11061
|
+
*/
|
|
11062
|
+
export declare const CMSV2PagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11063
|
+
/**
|
|
11064
|
+
* Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself.
|
|
11065
|
+
* @summary Rewrite a page or a module from a prompt
|
|
11066
|
+
* @param {string} recordUuid
|
|
11067
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11068
|
+
* @param {*} [options] Override http request option.
|
|
11069
|
+
* @throws {RequiredError}
|
|
11070
|
+
*/
|
|
11071
|
+
aiRewrite(recordUuid: string, requestBody: {
|
|
11072
|
+
[key: string]: any | null;
|
|
11073
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11074
|
+
/**
|
|
11075
|
+
*
|
|
11076
|
+
* @summary Create a translated sibling page for an environment
|
|
11077
|
+
* @param {string} recordUuid
|
|
11078
|
+
* @param {string} key
|
|
11079
|
+
* @param {*} [options] Override http request option.
|
|
11080
|
+
* @throws {RequiredError}
|
|
11081
|
+
*/
|
|
11082
|
+
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11083
|
+
/**
|
|
11084
|
+
* Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
|
|
11085
|
+
* @summary Create or reuse the custom 404 page
|
|
11086
|
+
* @param {*} [options] Override http request option.
|
|
11087
|
+
* @throws {RequiredError}
|
|
11088
|
+
*/
|
|
11089
|
+
ensureNotFound(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11090
|
+
/**
|
|
11091
|
+
*
|
|
11092
|
+
* @summary Environment coverage for the builder dropdown
|
|
11093
|
+
* @param {string} recordUuid
|
|
11094
|
+
* @param {*} [options] Override http request option.
|
|
11095
|
+
* @throws {RequiredError}
|
|
11096
|
+
*/
|
|
11097
|
+
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11098
|
+
/**
|
|
11099
|
+
*
|
|
11100
|
+
* @summary Load a page for the builder
|
|
11101
|
+
* @param {string} recordUuid
|
|
11102
|
+
* @param {string} [locale]
|
|
11103
|
+
* @param {string} [state]
|
|
11104
|
+
* @param {*} [options] Override http request option.
|
|
11105
|
+
* @throws {RequiredError}
|
|
11106
|
+
*/
|
|
11107
|
+
get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11108
|
+
/**
|
|
11109
|
+
*
|
|
11110
|
+
* @summary CMS v2 object template document
|
|
11111
|
+
* @param {string} objectUuid
|
|
11112
|
+
* @param {string} [locale]
|
|
11113
|
+
* @param {*} [options] Override http request option.
|
|
11114
|
+
* @throws {RequiredError}
|
|
11115
|
+
*/
|
|
11116
|
+
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDocument>;
|
|
11117
|
+
/**
|
|
11118
|
+
*
|
|
11119
|
+
* @summary Draft snapshots for one locale
|
|
11120
|
+
* @param {string} recordUuid
|
|
11121
|
+
* @param {string} [locale]
|
|
11122
|
+
* @param {*} [options] Override http request option.
|
|
11123
|
+
* @throws {RequiredError}
|
|
11124
|
+
*/
|
|
11125
|
+
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListMapStringObject>;
|
|
11126
|
+
/**
|
|
11127
|
+
*
|
|
11128
|
+
* @summary Host this page on another environment
|
|
11129
|
+
* @param {string} recordUuid
|
|
11130
|
+
* @param {string} key
|
|
11131
|
+
* @param {*} [options] Override http request option.
|
|
11132
|
+
* @throws {RequiredError}
|
|
11133
|
+
*/
|
|
11134
|
+
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11135
|
+
/**
|
|
11136
|
+
* Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them.
|
|
11137
|
+
* @summary Modules available to this company
|
|
11138
|
+
* @param {*} [options] Override http request option.
|
|
11139
|
+
* @throws {RequiredError}
|
|
11140
|
+
*/
|
|
11141
|
+
library(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsModuleDTO>;
|
|
11142
|
+
/**
|
|
11143
|
+
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
11144
|
+
* @summary Apply patches to a page draft
|
|
11145
|
+
* @param {string} recordUuid
|
|
11146
|
+
* @param {CmsPagePatchRequest} cmsPagePatchRequest
|
|
11147
|
+
* @param {*} [options] Override http request option.
|
|
11148
|
+
* @throws {RequiredError}
|
|
11149
|
+
*/
|
|
11150
|
+
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11151
|
+
/**
|
|
11152
|
+
* The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed.
|
|
11153
|
+
* @summary Signed preview URL for the builder iframe
|
|
11154
|
+
* @param {string} recordUuid
|
|
11155
|
+
* @param {string} [locale]
|
|
11156
|
+
* @param {string} [state]
|
|
11157
|
+
* @param {*} [options] Override http request option.
|
|
11158
|
+
* @throws {RequiredError}
|
|
11159
|
+
*/
|
|
11160
|
+
previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11161
|
+
/**
|
|
11162
|
+
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
11163
|
+
* @summary Publish one locale, or all of them
|
|
11164
|
+
* @param {string} recordUuid
|
|
11165
|
+
* @param {string} [locale]
|
|
11166
|
+
* @param {boolean} [allLocales]
|
|
11167
|
+
* @param {*} [options] Override http request option.
|
|
11168
|
+
* @throws {RequiredError}
|
|
11169
|
+
*/
|
|
11170
|
+
publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsPageDTO>;
|
|
11171
|
+
/**
|
|
11172
|
+
*
|
|
11173
|
+
* @summary Restore a draft snapshot
|
|
11174
|
+
* @param {string} recordUuid
|
|
11175
|
+
* @param {number} index
|
|
11176
|
+
* @param {string} [locale]
|
|
11177
|
+
* @param {*} [options] Override http request option.
|
|
11178
|
+
* @throws {RequiredError}
|
|
11179
|
+
*/
|
|
11180
|
+
restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11181
|
+
/**
|
|
11182
|
+
*
|
|
11183
|
+
* @summary Replace a page draft
|
|
11184
|
+
* @param {string} recordUuid
|
|
11185
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11186
|
+
* @param {string} [locale]
|
|
11187
|
+
* @param {*} [options] Override http request option.
|
|
11188
|
+
* @throws {RequiredError}
|
|
11189
|
+
*/
|
|
11190
|
+
save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11191
|
+
/**
|
|
11192
|
+
*
|
|
11193
|
+
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
11194
|
+
* @param {string} recordUuid
|
|
11195
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11196
|
+
* @param {string} [locale]
|
|
11197
|
+
* @param {*} [options] Override http request option.
|
|
11198
|
+
* @throws {RequiredError}
|
|
11199
|
+
*/
|
|
11200
|
+
saveMeta(recordUuid: string, requestBody: {
|
|
11201
|
+
[key: string]: any | null;
|
|
11202
|
+
}, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11203
|
+
/**
|
|
11204
|
+
*
|
|
11205
|
+
* @summary Replace a CMS v2 object template
|
|
11206
|
+
* @param {string} objectUuid
|
|
11207
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11208
|
+
* @param {string} [locale]
|
|
11209
|
+
* @param {*} [options] Override http request option.
|
|
11210
|
+
* @throws {RequiredError}
|
|
11211
|
+
*/
|
|
11212
|
+
saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDocument>;
|
|
11213
|
+
/**
|
|
11214
|
+
*
|
|
11215
|
+
* @summary Take one locale offline
|
|
11216
|
+
* @param {string} recordUuid
|
|
11217
|
+
* @param {string} [locale]
|
|
11218
|
+
* @param {*} [options] Override http request option.
|
|
11219
|
+
* @throws {RequiredError}
|
|
11220
|
+
*/
|
|
11221
|
+
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11222
|
+
/**
|
|
11223
|
+
*
|
|
11224
|
+
* @summary Remove an environment from this page only
|
|
11225
|
+
* @param {string} recordUuid
|
|
11226
|
+
* @param {string} key
|
|
11227
|
+
* @param {*} [options] Override http request option.
|
|
11228
|
+
* @throws {RequiredError}
|
|
11229
|
+
*/
|
|
11230
|
+
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11231
|
+
};
|
|
11232
|
+
/**
|
|
11233
|
+
* CMSV2PagesApi - object-oriented interface
|
|
11234
|
+
*/
|
|
11235
|
+
export declare class CMSV2PagesApi extends BaseAPI {
|
|
11236
|
+
/**
|
|
11237
|
+
* Returns patches the editor applies through the same revision channel as a manual edit, so the change is undoable. Page scope may add, remove and reorder modules. A module\'s code lives in a shared npm package, so the AI rewrites field values and composition, never the component itself.
|
|
11238
|
+
* @summary Rewrite a page or a module from a prompt
|
|
11239
|
+
* @param {string} recordUuid
|
|
11240
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11241
|
+
* @param {*} [options] Override http request option.
|
|
11242
|
+
* @throws {RequiredError}
|
|
11243
|
+
*/
|
|
11244
|
+
aiRewrite(recordUuid: string, requestBody: {
|
|
11245
|
+
[key: string]: any | null;
|
|
11246
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11247
|
+
/**
|
|
11248
|
+
*
|
|
11249
|
+
* @summary Create a translated sibling page for an environment
|
|
11250
|
+
* @param {string} recordUuid
|
|
11251
|
+
* @param {string} key
|
|
11252
|
+
* @param {*} [options] Override http request option.
|
|
11253
|
+
* @throws {RequiredError}
|
|
11254
|
+
*/
|
|
11255
|
+
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11256
|
+
/**
|
|
11257
|
+
* Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
|
|
11258
|
+
* @summary Create or reuse the custom 404 page
|
|
11259
|
+
* @param {*} [options] Override http request option.
|
|
11260
|
+
* @throws {RequiredError}
|
|
11261
|
+
*/
|
|
11262
|
+
ensureNotFound(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11263
|
+
/**
|
|
11264
|
+
*
|
|
11265
|
+
* @summary Environment coverage for the builder dropdown
|
|
11266
|
+
* @param {string} recordUuid
|
|
11267
|
+
* @param {*} [options] Override http request option.
|
|
11268
|
+
* @throws {RequiredError}
|
|
11269
|
+
*/
|
|
11270
|
+
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11271
|
+
/**
|
|
11272
|
+
*
|
|
11273
|
+
* @summary Load a page for the builder
|
|
11274
|
+
* @param {string} recordUuid
|
|
11275
|
+
* @param {string} [locale]
|
|
11276
|
+
* @param {string} [state]
|
|
11277
|
+
* @param {*} [options] Override http request option.
|
|
11278
|
+
* @throws {RequiredError}
|
|
11279
|
+
*/
|
|
11280
|
+
get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11281
|
+
/**
|
|
11282
|
+
*
|
|
11283
|
+
* @summary CMS v2 object template document
|
|
11284
|
+
* @param {string} objectUuid
|
|
11285
|
+
* @param {string} [locale]
|
|
11286
|
+
* @param {*} [options] Override http request option.
|
|
11287
|
+
* @throws {RequiredError}
|
|
11288
|
+
*/
|
|
11289
|
+
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
|
|
11290
|
+
/**
|
|
11291
|
+
*
|
|
11292
|
+
* @summary Draft snapshots for one locale
|
|
11293
|
+
* @param {string} recordUuid
|
|
11294
|
+
* @param {string} [locale]
|
|
11295
|
+
* @param {*} [options] Override http request option.
|
|
11296
|
+
* @throws {RequiredError}
|
|
11297
|
+
*/
|
|
11298
|
+
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListMapStringObject, any, {}>>;
|
|
11299
|
+
/**
|
|
11300
|
+
*
|
|
11301
|
+
* @summary Host this page on another environment
|
|
11302
|
+
* @param {string} recordUuid
|
|
11303
|
+
* @param {string} key
|
|
11304
|
+
* @param {*} [options] Override http request option.
|
|
11305
|
+
* @throws {RequiredError}
|
|
11306
|
+
*/
|
|
11307
|
+
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11308
|
+
/**
|
|
11309
|
+
* Backs the builder\'s library picker. Only modules from installed apps, and never retired ones, because a new page must be able to render them.
|
|
11310
|
+
* @summary Modules available to this company
|
|
11311
|
+
* @param {*} [options] Override http request option.
|
|
11312
|
+
* @throws {RequiredError}
|
|
11313
|
+
*/
|
|
11314
|
+
library(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11315
|
+
/**
|
|
11316
|
+
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
11317
|
+
* @summary Apply patches to a page draft
|
|
11318
|
+
* @param {string} recordUuid
|
|
11319
|
+
* @param {CmsPagePatchRequest} cmsPagePatchRequest
|
|
11320
|
+
* @param {*} [options] Override http request option.
|
|
11321
|
+
* @throws {RequiredError}
|
|
11322
|
+
*/
|
|
11323
|
+
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11324
|
+
/**
|
|
11325
|
+
* The iframe renders the draft document, which the public API will not serve. The signature covers the page and an expiry so a leaked link cannot be retargeted or replayed.
|
|
11326
|
+
* @summary Signed preview URL for the builder iframe
|
|
11327
|
+
* @param {string} recordUuid
|
|
11328
|
+
* @param {string} [locale]
|
|
11329
|
+
* @param {string} [state]
|
|
11330
|
+
* @param {*} [options] Override http request option.
|
|
11331
|
+
* @throws {RequiredError}
|
|
11332
|
+
*/
|
|
11333
|
+
previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11334
|
+
/**
|
|
11335
|
+
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
11336
|
+
* @summary Publish one locale, or all of them
|
|
11337
|
+
* @param {string} recordUuid
|
|
11338
|
+
* @param {string} [locale]
|
|
11339
|
+
* @param {boolean} [allLocales]
|
|
11340
|
+
* @param {*} [options] Override http request option.
|
|
11341
|
+
* @throws {RequiredError}
|
|
11342
|
+
*/
|
|
11343
|
+
publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsPageDTO, any, {}>>;
|
|
11344
|
+
/**
|
|
11345
|
+
*
|
|
11346
|
+
* @summary Restore a draft snapshot
|
|
11347
|
+
* @param {string} recordUuid
|
|
11348
|
+
* @param {number} index
|
|
11349
|
+
* @param {string} [locale]
|
|
11350
|
+
* @param {*} [options] Override http request option.
|
|
11351
|
+
* @throws {RequiredError}
|
|
11352
|
+
*/
|
|
11353
|
+
restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11354
|
+
/**
|
|
11355
|
+
*
|
|
11356
|
+
* @summary Replace a page draft
|
|
11357
|
+
* @param {string} recordUuid
|
|
11358
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11359
|
+
* @param {string} [locale]
|
|
11360
|
+
* @param {*} [options] Override http request option.
|
|
11361
|
+
* @throws {RequiredError}
|
|
11362
|
+
*/
|
|
11363
|
+
save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11364
|
+
/**
|
|
11365
|
+
*
|
|
11366
|
+
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
11367
|
+
* @param {string} recordUuid
|
|
11368
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11369
|
+
* @param {string} [locale]
|
|
11370
|
+
* @param {*} [options] Override http request option.
|
|
11371
|
+
* @throws {RequiredError}
|
|
11372
|
+
*/
|
|
11373
|
+
saveMeta(recordUuid: string, requestBody: {
|
|
11374
|
+
[key: string]: any | null;
|
|
11375
|
+
}, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11376
|
+
/**
|
|
11377
|
+
*
|
|
11378
|
+
* @summary Replace a CMS v2 object template
|
|
11379
|
+
* @param {string} objectUuid
|
|
11380
|
+
* @param {CmsPageDocument} cmsPageDocument
|
|
11381
|
+
* @param {string} [locale]
|
|
11382
|
+
* @param {*} [options] Override http request option.
|
|
11383
|
+
* @throws {RequiredError}
|
|
11384
|
+
*/
|
|
11385
|
+
saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
|
|
11386
|
+
/**
|
|
11387
|
+
*
|
|
11388
|
+
* @summary Take one locale offline
|
|
11389
|
+
* @param {string} recordUuid
|
|
11390
|
+
* @param {string} [locale]
|
|
11391
|
+
* @param {*} [options] Override http request option.
|
|
11392
|
+
* @throws {RequiredError}
|
|
11393
|
+
*/
|
|
11394
|
+
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11395
|
+
/**
|
|
11396
|
+
*
|
|
11397
|
+
* @summary Remove an environment from this page only
|
|
11398
|
+
* @param {string} recordUuid
|
|
11399
|
+
* @param {string} key
|
|
11400
|
+
* @param {*} [options] Override http request option.
|
|
11401
|
+
* @throws {RequiredError}
|
|
11402
|
+
*/
|
|
11403
|
+
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11404
|
+
}
|
|
11405
|
+
/**
|
|
11406
|
+
* CMSV2PublicApi - axios parameter creator
|
|
11407
|
+
*/
|
|
11408
|
+
export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11409
|
+
/**
|
|
11410
|
+
*
|
|
11411
|
+
* @summary Installed app settings with SECRET fields removed
|
|
11412
|
+
* @param {string} xCaraerSubdomain
|
|
11413
|
+
* @param {string} appName
|
|
11414
|
+
* @param {*} [options] Override http request option.
|
|
11415
|
+
* @throws {RequiredError}
|
|
11416
|
+
*/
|
|
11417
|
+
appSettings: (xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11418
|
+
/**
|
|
11419
|
+
*
|
|
11420
|
+
* @summary Redirect to a company file for the website runtime
|
|
11421
|
+
* @param {string} xCaraerSubdomain
|
|
11422
|
+
* @param {string} key
|
|
11423
|
+
* @param {string} [pageUuid]
|
|
11424
|
+
* @param {string} [environment]
|
|
11425
|
+
* @param {string} [locale]
|
|
11426
|
+
* @param {string} [access]
|
|
11427
|
+
* @param {string} [token]
|
|
11428
|
+
* @param {string} [caraerExpires]
|
|
11429
|
+
* @param {string} [caraerSig]
|
|
11430
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11431
|
+
* @param {string} [authorization]
|
|
11432
|
+
* @param {*} [options] Override http request option.
|
|
11433
|
+
* @throws {RequiredError}
|
|
11434
|
+
*/
|
|
11435
|
+
asset: (xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11436
|
+
/**
|
|
11437
|
+
*
|
|
11438
|
+
* @summary Installed apps and modules for a company\'s website build
|
|
11439
|
+
* @param {string} xCaraerSubdomain
|
|
11440
|
+
* @param {*} [options] Override http request option.
|
|
11441
|
+
* @throws {RequiredError}
|
|
11442
|
+
*/
|
|
11443
|
+
buildManifest: (xCaraerSubdomain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11444
|
+
/**
|
|
11445
|
+
*
|
|
11446
|
+
* @summary Navigation menus for the header and footer
|
|
11447
|
+
* @param {string} xCaraerSubdomain
|
|
11448
|
+
* @param {string} [environment]
|
|
11449
|
+
* @param {string} [locale]
|
|
11450
|
+
* @param {*} [options] Override http request option.
|
|
11451
|
+
* @throws {RequiredError}
|
|
11452
|
+
*/
|
|
11453
|
+
menus: (xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11454
|
+
/**
|
|
11455
|
+
*
|
|
11456
|
+
* @summary A published page by URL path
|
|
11457
|
+
* @param {string} xCaraerSubdomain
|
|
11458
|
+
* @param {string} path
|
|
11459
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11460
|
+
* @param {string} [authorization]
|
|
11461
|
+
* @param {string} [environment]
|
|
11462
|
+
* @param {string} [locale]
|
|
11463
|
+
* @param {string} [access]
|
|
11464
|
+
* @param {string} [token]
|
|
11465
|
+
* @param {*} [options] Override http request option.
|
|
11466
|
+
* @throws {RequiredError}
|
|
11467
|
+
*/
|
|
11468
|
+
pageByPath: (xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11469
|
+
/**
|
|
11470
|
+
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
11471
|
+
* @summary A page by record uuid
|
|
11472
|
+
* @param {string} xCaraerSubdomain
|
|
11473
|
+
* @param {string} uuid
|
|
11474
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11475
|
+
* @param {string} [authorization]
|
|
11476
|
+
* @param {string} [environment]
|
|
11477
|
+
* @param {string} [locale]
|
|
11478
|
+
* @param {string} [state]
|
|
11479
|
+
* @param {string} [access]
|
|
11480
|
+
* @param {string} [token]
|
|
11481
|
+
* @param {string} [caraerExpires]
|
|
11482
|
+
* @param {string} [caraerSig]
|
|
11483
|
+
* @param {*} [options] Override http request option.
|
|
11484
|
+
* @throws {RequiredError}
|
|
11485
|
+
*/
|
|
11486
|
+
pageByUuid: (xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11487
|
+
/**
|
|
11488
|
+
*
|
|
11489
|
+
* @summary Protection info for a path, without the page document
|
|
11490
|
+
* @param {string} xCaraerSubdomain
|
|
11491
|
+
* @param {string} path
|
|
11492
|
+
* @param {string} [environment]
|
|
11493
|
+
* @param {string} [locale]
|
|
11494
|
+
* @param {*} [options] Override http request option.
|
|
11495
|
+
* @throws {RequiredError}
|
|
11496
|
+
*/
|
|
11497
|
+
pageGate: (xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11498
|
+
/**
|
|
11499
|
+
*
|
|
11500
|
+
* @summary Published paths per environment, for sitemaps and cache warming
|
|
11501
|
+
* @param {string} xCaraerSubdomain
|
|
11502
|
+
* @param {string} [environment]
|
|
11503
|
+
* @param {string} [locale]
|
|
11504
|
+
* @param {*} [options] Override http request option.
|
|
11505
|
+
* @throws {RequiredError}
|
|
11506
|
+
*/
|
|
11507
|
+
paths: (xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11508
|
+
/**
|
|
11509
|
+
*
|
|
11510
|
+
* @summary Public records visible in an environment
|
|
11511
|
+
* @param {string} xCaraerSubdomain
|
|
11512
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11513
|
+
* @param {string} [environment]
|
|
11514
|
+
* @param {string} [locale]
|
|
11515
|
+
* @param {*} [options] Override http request option.
|
|
11516
|
+
* @throws {RequiredError}
|
|
11517
|
+
*/
|
|
11518
|
+
records: (xCaraerSubdomain: string, requestBody: {
|
|
11519
|
+
[key: string]: any | null;
|
|
11520
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11521
|
+
/**
|
|
11522
|
+
*
|
|
11523
|
+
* @summary Company settings, branding and locales
|
|
11524
|
+
* @param {string} xCaraerSubdomain
|
|
11525
|
+
* @param {*} [options] Override http request option.
|
|
11526
|
+
* @throws {RequiredError}
|
|
11527
|
+
*/
|
|
11528
|
+
settings: (xCaraerSubdomain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11529
|
+
/**
|
|
11530
|
+
*
|
|
11531
|
+
* @summary Unlock a password-protected CMS v2 page
|
|
11532
|
+
* @param {string} xCaraerSubdomain
|
|
11533
|
+
* @param {string} uuid
|
|
11534
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
11535
|
+
* @param {string} [environment]
|
|
11536
|
+
* @param {string} [locale]
|
|
11537
|
+
* @param {*} [options] Override http request option.
|
|
11538
|
+
* @throws {RequiredError}
|
|
11539
|
+
*/
|
|
11540
|
+
unlock: (xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
11541
|
+
[key: string]: string;
|
|
11542
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11543
|
+
};
|
|
11544
|
+
/**
|
|
11545
|
+
* CMSV2PublicApi - functional programming interface
|
|
11546
|
+
*/
|
|
11547
|
+
export declare const CMSV2PublicApiFp: (configuration?: Configuration) => {
|
|
11548
|
+
/**
|
|
11549
|
+
*
|
|
11550
|
+
* @summary Installed app settings with SECRET fields removed
|
|
11551
|
+
* @param {string} xCaraerSubdomain
|
|
11552
|
+
* @param {string} appName
|
|
11553
|
+
* @param {*} [options] Override http request option.
|
|
11554
|
+
* @throws {RequiredError}
|
|
11555
|
+
*/
|
|
11556
|
+
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11557
|
+
/**
|
|
11558
|
+
*
|
|
11559
|
+
* @summary Redirect to a company file for the website runtime
|
|
11560
|
+
* @param {string} xCaraerSubdomain
|
|
11561
|
+
* @param {string} key
|
|
11562
|
+
* @param {string} [pageUuid]
|
|
11563
|
+
* @param {string} [environment]
|
|
11564
|
+
* @param {string} [locale]
|
|
11565
|
+
* @param {string} [access]
|
|
11566
|
+
* @param {string} [token]
|
|
11567
|
+
* @param {string} [caraerExpires]
|
|
11568
|
+
* @param {string} [caraerSig]
|
|
11569
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11570
|
+
* @param {string} [authorization]
|
|
11571
|
+
* @param {*} [options] Override http request option.
|
|
11572
|
+
* @throws {RequiredError}
|
|
11573
|
+
*/
|
|
11574
|
+
asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11575
|
+
/**
|
|
11576
|
+
*
|
|
11577
|
+
* @summary Installed apps and modules for a company\'s website build
|
|
11578
|
+
* @param {string} xCaraerSubdomain
|
|
11579
|
+
* @param {*} [options] Override http request option.
|
|
11580
|
+
* @throws {RequiredError}
|
|
11581
|
+
*/
|
|
11582
|
+
buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11583
|
+
/**
|
|
11584
|
+
*
|
|
11585
|
+
* @summary Navigation menus for the header and footer
|
|
11586
|
+
* @param {string} xCaraerSubdomain
|
|
11587
|
+
* @param {string} [environment]
|
|
11588
|
+
* @param {string} [locale]
|
|
11589
|
+
* @param {*} [options] Override http request option.
|
|
11590
|
+
* @throws {RequiredError}
|
|
11591
|
+
*/
|
|
11592
|
+
menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListCmsPublicMenuDTO>>;
|
|
11593
|
+
/**
|
|
11594
|
+
*
|
|
11595
|
+
* @summary A published page by URL path
|
|
11596
|
+
* @param {string} xCaraerSubdomain
|
|
11597
|
+
* @param {string} path
|
|
11598
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11599
|
+
* @param {string} [authorization]
|
|
11600
|
+
* @param {string} [environment]
|
|
11601
|
+
* @param {string} [locale]
|
|
11602
|
+
* @param {string} [access]
|
|
11603
|
+
* @param {string} [token]
|
|
11604
|
+
* @param {*} [options] Override http request option.
|
|
11605
|
+
* @throws {RequiredError}
|
|
11606
|
+
*/
|
|
11607
|
+
pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11608
|
+
/**
|
|
11609
|
+
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
11610
|
+
* @summary A page by record uuid
|
|
11611
|
+
* @param {string} xCaraerSubdomain
|
|
11612
|
+
* @param {string} uuid
|
|
11613
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11614
|
+
* @param {string} [authorization]
|
|
11615
|
+
* @param {string} [environment]
|
|
11616
|
+
* @param {string} [locale]
|
|
11617
|
+
* @param {string} [state]
|
|
11618
|
+
* @param {string} [access]
|
|
11619
|
+
* @param {string} [token]
|
|
11620
|
+
* @param {string} [caraerExpires]
|
|
11621
|
+
* @param {string} [caraerSig]
|
|
11622
|
+
* @param {*} [options] Override http request option.
|
|
11623
|
+
* @throws {RequiredError}
|
|
11624
|
+
*/
|
|
11625
|
+
pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
|
|
11626
|
+
/**
|
|
11627
|
+
*
|
|
11628
|
+
* @summary Protection info for a path, without the page document
|
|
11629
|
+
* @param {string} xCaraerSubdomain
|
|
11630
|
+
* @param {string} path
|
|
11631
|
+
* @param {string} [environment]
|
|
11632
|
+
* @param {string} [locale]
|
|
11633
|
+
* @param {*} [options] Override http request option.
|
|
11634
|
+
* @throws {RequiredError}
|
|
11635
|
+
*/
|
|
11636
|
+
pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11637
|
+
/**
|
|
11638
|
+
*
|
|
11639
|
+
* @summary Published paths per environment, for sitemaps and cache warming
|
|
11640
|
+
* @param {string} xCaraerSubdomain
|
|
11641
|
+
* @param {string} [environment]
|
|
11642
|
+
* @param {string} [locale]
|
|
11643
|
+
* @param {*} [options] Override http request option.
|
|
11644
|
+
* @throws {RequiredError}
|
|
11645
|
+
*/
|
|
11646
|
+
paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListMapStringObject>>;
|
|
11647
|
+
/**
|
|
11648
|
+
*
|
|
11649
|
+
* @summary Public records visible in an environment
|
|
11650
|
+
* @param {string} xCaraerSubdomain
|
|
11651
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11652
|
+
* @param {string} [environment]
|
|
11653
|
+
* @param {string} [locale]
|
|
11654
|
+
* @param {*} [options] Override http request option.
|
|
11655
|
+
* @throws {RequiredError}
|
|
11656
|
+
*/
|
|
11657
|
+
records(xCaraerSubdomain: string, requestBody: {
|
|
11658
|
+
[key: string]: any | null;
|
|
11659
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11660
|
+
/**
|
|
11661
|
+
*
|
|
11662
|
+
* @summary Company settings, branding and locales
|
|
11663
|
+
* @param {string} xCaraerSubdomain
|
|
11664
|
+
* @param {*} [options] Override http request option.
|
|
11665
|
+
* @throws {RequiredError}
|
|
11666
|
+
*/
|
|
11667
|
+
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
11668
|
+
/**
|
|
11669
|
+
*
|
|
11670
|
+
* @summary Unlock a password-protected CMS v2 page
|
|
11671
|
+
* @param {string} xCaraerSubdomain
|
|
11672
|
+
* @param {string} uuid
|
|
11673
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
11674
|
+
* @param {string} [environment]
|
|
11675
|
+
* @param {string} [locale]
|
|
11676
|
+
* @param {*} [options] Override http request option.
|
|
11677
|
+
* @throws {RequiredError}
|
|
11678
|
+
*/
|
|
11679
|
+
unlock(xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
11680
|
+
[key: string]: string;
|
|
11681
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
11682
|
+
};
|
|
11683
|
+
/**
|
|
11684
|
+
* CMSV2PublicApi - factory interface
|
|
11685
|
+
*/
|
|
11686
|
+
export declare const CMSV2PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11687
|
+
/**
|
|
11688
|
+
*
|
|
11689
|
+
* @summary Installed app settings with SECRET fields removed
|
|
11690
|
+
* @param {string} xCaraerSubdomain
|
|
11691
|
+
* @param {string} appName
|
|
11692
|
+
* @param {*} [options] Override http request option.
|
|
11693
|
+
* @throws {RequiredError}
|
|
11694
|
+
*/
|
|
11695
|
+
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11696
|
+
/**
|
|
11697
|
+
*
|
|
11698
|
+
* @summary Redirect to a company file for the website runtime
|
|
11699
|
+
* @param {string} xCaraerSubdomain
|
|
11700
|
+
* @param {string} key
|
|
11701
|
+
* @param {string} [pageUuid]
|
|
11702
|
+
* @param {string} [environment]
|
|
11703
|
+
* @param {string} [locale]
|
|
11704
|
+
* @param {string} [access]
|
|
11705
|
+
* @param {string} [token]
|
|
11706
|
+
* @param {string} [caraerExpires]
|
|
11707
|
+
* @param {string} [caraerSig]
|
|
11708
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11709
|
+
* @param {string} [authorization]
|
|
11710
|
+
* @param {*} [options] Override http request option.
|
|
11711
|
+
* @throws {RequiredError}
|
|
11712
|
+
*/
|
|
11713
|
+
asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11714
|
+
/**
|
|
11715
|
+
*
|
|
11716
|
+
* @summary Installed apps and modules for a company\'s website build
|
|
11717
|
+
* @param {string} xCaraerSubdomain
|
|
11718
|
+
* @param {*} [options] Override http request option.
|
|
11719
|
+
* @throws {RequiredError}
|
|
11720
|
+
*/
|
|
11721
|
+
buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11722
|
+
/**
|
|
11723
|
+
*
|
|
11724
|
+
* @summary Navigation menus for the header and footer
|
|
11725
|
+
* @param {string} xCaraerSubdomain
|
|
11726
|
+
* @param {string} [environment]
|
|
11727
|
+
* @param {string} [locale]
|
|
11728
|
+
* @param {*} [options] Override http request option.
|
|
11729
|
+
* @throws {RequiredError}
|
|
11730
|
+
*/
|
|
11731
|
+
menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListCmsPublicMenuDTO>;
|
|
11732
|
+
/**
|
|
11733
|
+
*
|
|
11734
|
+
* @summary A published page by URL path
|
|
11735
|
+
* @param {string} xCaraerSubdomain
|
|
11736
|
+
* @param {string} path
|
|
11737
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11738
|
+
* @param {string} [authorization]
|
|
11739
|
+
* @param {string} [environment]
|
|
11740
|
+
* @param {string} [locale]
|
|
11741
|
+
* @param {string} [access]
|
|
11742
|
+
* @param {string} [token]
|
|
11743
|
+
* @param {*} [options] Override http request option.
|
|
11744
|
+
* @throws {RequiredError}
|
|
11745
|
+
*/
|
|
11746
|
+
pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11747
|
+
/**
|
|
11748
|
+
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
11749
|
+
* @summary A page by record uuid
|
|
11750
|
+
* @param {string} xCaraerSubdomain
|
|
11751
|
+
* @param {string} uuid
|
|
11752
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11753
|
+
* @param {string} [authorization]
|
|
11754
|
+
* @param {string} [environment]
|
|
11755
|
+
* @param {string} [locale]
|
|
11756
|
+
* @param {string} [state]
|
|
11757
|
+
* @param {string} [access]
|
|
11758
|
+
* @param {string} [token]
|
|
11759
|
+
* @param {string} [caraerExpires]
|
|
11760
|
+
* @param {string} [caraerSig]
|
|
11761
|
+
* @param {*} [options] Override http request option.
|
|
11762
|
+
* @throws {RequiredError}
|
|
11763
|
+
*/
|
|
11764
|
+
pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
|
|
11765
|
+
/**
|
|
11766
|
+
*
|
|
11767
|
+
* @summary Protection info for a path, without the page document
|
|
11768
|
+
* @param {string} xCaraerSubdomain
|
|
11769
|
+
* @param {string} path
|
|
11770
|
+
* @param {string} [environment]
|
|
11771
|
+
* @param {string} [locale]
|
|
11772
|
+
* @param {*} [options] Override http request option.
|
|
11773
|
+
* @throws {RequiredError}
|
|
11774
|
+
*/
|
|
11775
|
+
pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11776
|
+
/**
|
|
11777
|
+
*
|
|
11778
|
+
* @summary Published paths per environment, for sitemaps and cache warming
|
|
11779
|
+
* @param {string} xCaraerSubdomain
|
|
11780
|
+
* @param {string} [environment]
|
|
11781
|
+
* @param {string} [locale]
|
|
11782
|
+
* @param {*} [options] Override http request option.
|
|
11783
|
+
* @throws {RequiredError}
|
|
11784
|
+
*/
|
|
11785
|
+
paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListMapStringObject>;
|
|
11786
|
+
/**
|
|
11787
|
+
*
|
|
11788
|
+
* @summary Public records visible in an environment
|
|
11789
|
+
* @param {string} xCaraerSubdomain
|
|
11790
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11791
|
+
* @param {string} [environment]
|
|
11792
|
+
* @param {string} [locale]
|
|
11793
|
+
* @param {*} [options] Override http request option.
|
|
11794
|
+
* @throws {RequiredError}
|
|
11795
|
+
*/
|
|
11796
|
+
records(xCaraerSubdomain: string, requestBody: {
|
|
11797
|
+
[key: string]: any | null;
|
|
11798
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11799
|
+
/**
|
|
11800
|
+
*
|
|
11801
|
+
* @summary Company settings, branding and locales
|
|
11802
|
+
* @param {string} xCaraerSubdomain
|
|
11803
|
+
* @param {*} [options] Override http request option.
|
|
11804
|
+
* @throws {RequiredError}
|
|
11805
|
+
*/
|
|
11806
|
+
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
11807
|
+
/**
|
|
11808
|
+
*
|
|
11809
|
+
* @summary Unlock a password-protected CMS v2 page
|
|
11810
|
+
* @param {string} xCaraerSubdomain
|
|
11811
|
+
* @param {string} uuid
|
|
11812
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
11813
|
+
* @param {string} [environment]
|
|
11814
|
+
* @param {string} [locale]
|
|
11815
|
+
* @param {*} [options] Override http request option.
|
|
11816
|
+
* @throws {RequiredError}
|
|
11817
|
+
*/
|
|
11818
|
+
unlock(xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
11819
|
+
[key: string]: string;
|
|
11820
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
11821
|
+
};
|
|
11822
|
+
/**
|
|
11823
|
+
* CMSV2PublicApi - object-oriented interface
|
|
11824
|
+
*/
|
|
11825
|
+
export declare class CMSV2PublicApi extends BaseAPI {
|
|
11826
|
+
/**
|
|
11827
|
+
*
|
|
11828
|
+
* @summary Installed app settings with SECRET fields removed
|
|
11829
|
+
* @param {string} xCaraerSubdomain
|
|
11830
|
+
* @param {string} appName
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @summary Redirect to a company file for the website runtime
|
|
11838
|
+
* @param {string} xCaraerSubdomain
|
|
11839
|
+
* @param {string} key
|
|
11840
|
+
* @param {string} [pageUuid]
|
|
11841
|
+
* @param {string} [environment]
|
|
11842
|
+
* @param {string} [locale]
|
|
11843
|
+
* @param {string} [access]
|
|
11844
|
+
* @param {string} [token]
|
|
11845
|
+
* @param {string} [caraerExpires]
|
|
11846
|
+
* @param {string} [caraerSig]
|
|
11847
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11848
|
+
* @param {string} [authorization]
|
|
11849
|
+
* @param {*} [options] Override http request option.
|
|
11850
|
+
* @throws {RequiredError}
|
|
11851
|
+
*/
|
|
11852
|
+
asset(xCaraerSubdomain: string, key: string, pageUuid?: string, environment?: string, locale?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, xCaraerWebpageAccess?: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11853
|
+
/**
|
|
11854
|
+
*
|
|
11855
|
+
* @summary Installed apps and modules for a company\'s website build
|
|
11856
|
+
* @param {string} xCaraerSubdomain
|
|
11857
|
+
* @param {*} [options] Override http request option.
|
|
11858
|
+
* @throws {RequiredError}
|
|
11859
|
+
*/
|
|
11860
|
+
buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11861
|
+
/**
|
|
11862
|
+
*
|
|
11863
|
+
* @summary Navigation menus for the header and footer
|
|
11864
|
+
* @param {string} xCaraerSubdomain
|
|
11865
|
+
* @param {string} [environment]
|
|
11866
|
+
* @param {string} [locale]
|
|
11867
|
+
* @param {*} [options] Override http request option.
|
|
11868
|
+
* @throws {RequiredError}
|
|
11869
|
+
*/
|
|
11870
|
+
menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListCmsPublicMenuDTO, any, {}>>;
|
|
11871
|
+
/**
|
|
11872
|
+
*
|
|
11873
|
+
* @summary A published page by URL path
|
|
11874
|
+
* @param {string} xCaraerSubdomain
|
|
11875
|
+
* @param {string} path
|
|
11876
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11877
|
+
* @param {string} [authorization]
|
|
11878
|
+
* @param {string} [environment]
|
|
11879
|
+
* @param {string} [locale]
|
|
11880
|
+
* @param {string} [access]
|
|
11881
|
+
* @param {string} [token]
|
|
11882
|
+
* @param {*} [options] Override http request option.
|
|
11883
|
+
* @throws {RequiredError}
|
|
11884
|
+
*/
|
|
11885
|
+
pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11886
|
+
/**
|
|
11887
|
+
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
11888
|
+
* @summary A page by record uuid
|
|
11889
|
+
* @param {string} xCaraerSubdomain
|
|
11890
|
+
* @param {string} uuid
|
|
11891
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
11892
|
+
* @param {string} [authorization]
|
|
11893
|
+
* @param {string} [environment]
|
|
11894
|
+
* @param {string} [locale]
|
|
11895
|
+
* @param {string} [state]
|
|
11896
|
+
* @param {string} [access]
|
|
11897
|
+
* @param {string} [token]
|
|
11898
|
+
* @param {string} [caraerExpires]
|
|
11899
|
+
* @param {string} [caraerSig]
|
|
11900
|
+
* @param {*} [options] Override http request option.
|
|
11901
|
+
* @throws {RequiredError}
|
|
11902
|
+
*/
|
|
11903
|
+
pageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, state?: string, access?: string, token?: string, caraerExpires?: string, caraerSig?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @summary Protection info for a path, without the page document
|
|
11907
|
+
* @param {string} xCaraerSubdomain
|
|
11908
|
+
* @param {string} path
|
|
11909
|
+
* @param {string} [environment]
|
|
11910
|
+
* @param {string} [locale]
|
|
11911
|
+
* @param {*} [options] Override http request option.
|
|
11912
|
+
* @throws {RequiredError}
|
|
11913
|
+
*/
|
|
11914
|
+
pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11915
|
+
/**
|
|
11916
|
+
*
|
|
11917
|
+
* @summary Published paths per environment, for sitemaps and cache warming
|
|
11918
|
+
* @param {string} xCaraerSubdomain
|
|
11919
|
+
* @param {string} [environment]
|
|
11920
|
+
* @param {string} [locale]
|
|
11921
|
+
* @param {*} [options] Override http request option.
|
|
11922
|
+
* @throws {RequiredError}
|
|
11923
|
+
*/
|
|
11924
|
+
paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListMapStringObject, any, {}>>;
|
|
11925
|
+
/**
|
|
11926
|
+
*
|
|
11927
|
+
* @summary Public records visible in an environment
|
|
11928
|
+
* @param {string} xCaraerSubdomain
|
|
11929
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11930
|
+
* @param {string} [environment]
|
|
11931
|
+
* @param {string} [locale]
|
|
11932
|
+
* @param {*} [options] Override http request option.
|
|
11933
|
+
* @throws {RequiredError}
|
|
11934
|
+
*/
|
|
11935
|
+
records(xCaraerSubdomain: string, requestBody: {
|
|
11936
|
+
[key: string]: any | null;
|
|
11937
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11938
|
+
/**
|
|
11939
|
+
*
|
|
11940
|
+
* @summary Company settings, branding and locales
|
|
11941
|
+
* @param {string} xCaraerSubdomain
|
|
11942
|
+
* @param {*} [options] Override http request option.
|
|
11943
|
+
* @throws {RequiredError}
|
|
11944
|
+
*/
|
|
11945
|
+
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11946
|
+
/**
|
|
11947
|
+
*
|
|
11948
|
+
* @summary Unlock a password-protected CMS v2 page
|
|
11949
|
+
* @param {string} xCaraerSubdomain
|
|
11950
|
+
* @param {string} uuid
|
|
11951
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
11952
|
+
* @param {string} [environment]
|
|
11953
|
+
* @param {string} [locale]
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
unlock(xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
11958
|
+
[key: string]: string;
|
|
11959
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11960
|
+
}
|
|
11961
|
+
/**
|
|
11962
|
+
* CMSV2TransferApi - axios parameter creator
|
|
11963
|
+
*/
|
|
11964
|
+
export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11965
|
+
/**
|
|
11966
|
+
*
|
|
11967
|
+
* @summary Attach a manually created caraer-web project
|
|
11968
|
+
* @param {string} companyUuid
|
|
11969
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
9511
11970
|
* @param {*} [options] Override http request option.
|
|
9512
11971
|
* @throws {RequiredError}
|
|
9513
11972
|
*/
|
|
9514
|
-
|
|
11973
|
+
attach: (companyUuid: string, requestBody: {
|
|
11974
|
+
[key: string]: string;
|
|
11975
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9515
11976
|
/**
|
|
9516
|
-
*
|
|
9517
|
-
* @summary
|
|
9518
|
-
* @param {string}
|
|
9519
|
-
* @param {AppRequest} appRequest
|
|
11977
|
+
*
|
|
11978
|
+
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
11979
|
+
* @param {string} companyUuid
|
|
9520
11980
|
* @param {*} [options] Override http request option.
|
|
9521
11981
|
* @throws {RequiredError}
|
|
9522
11982
|
*/
|
|
9523
|
-
|
|
11983
|
+
cutover: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9524
11984
|
/**
|
|
9525
|
-
*
|
|
9526
|
-
* @summary
|
|
9527
|
-
* @param {string}
|
|
9528
|
-
* @param {string} webhookUuid UUID of the webhook to update
|
|
9529
|
-
* @param {SubscribeWebhookDTO} subscribeWebhookDTO
|
|
11985
|
+
*
|
|
11986
|
+
* @summary Restore the live hostname to the stored v1 project
|
|
11987
|
+
* @param {string} companyUuid
|
|
9530
11988
|
* @param {*} [options] Override http request option.
|
|
9531
11989
|
* @throws {RequiredError}
|
|
9532
11990
|
*/
|
|
9533
|
-
|
|
11991
|
+
rollback: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9534
11992
|
/**
|
|
9535
|
-
*
|
|
9536
|
-
* @summary
|
|
9537
|
-
* @param {string}
|
|
9538
|
-
* @param {AppDTO} appDTO
|
|
11993
|
+
*
|
|
11994
|
+
* @summary Transfer status for one company
|
|
11995
|
+
* @param {string} companyUuid
|
|
9539
11996
|
* @param {*} [options] Override http request option.
|
|
9540
11997
|
* @throws {RequiredError}
|
|
9541
11998
|
*/
|
|
9542
|
-
|
|
9543
|
-
}
|
|
11999
|
+
status: (companyUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12000
|
+
};
|
|
9544
12001
|
/**
|
|
9545
|
-
*
|
|
12002
|
+
* CMSV2TransferApi - functional programming interface
|
|
9546
12003
|
*/
|
|
9547
|
-
export declare const
|
|
12004
|
+
export declare const CMSV2TransferApiFp: (configuration?: Configuration) => {
|
|
9548
12005
|
/**
|
|
9549
|
-
*
|
|
9550
|
-
* @summary
|
|
12006
|
+
*
|
|
12007
|
+
* @summary Attach a manually created caraer-web project
|
|
12008
|
+
* @param {string} companyUuid
|
|
12009
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
9551
12010
|
* @param {*} [options] Override http request option.
|
|
9552
12011
|
* @throws {RequiredError}
|
|
9553
12012
|
*/
|
|
9554
|
-
|
|
9555
|
-
|
|
9556
|
-
|
|
9557
|
-
* AutomationsApi - functional programming interface
|
|
9558
|
-
*/
|
|
9559
|
-
export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
12013
|
+
attach(companyUuid: string, requestBody: {
|
|
12014
|
+
[key: string]: string;
|
|
12015
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCompanyDTO>>;
|
|
9560
12016
|
/**
|
|
9561
|
-
*
|
|
9562
|
-
* @summary
|
|
12017
|
+
*
|
|
12018
|
+
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
12019
|
+
* @param {string} companyUuid
|
|
9563
12020
|
* @param {*} [options] Override http request option.
|
|
9564
12021
|
* @throws {RequiredError}
|
|
9565
12022
|
*/
|
|
9566
|
-
|
|
9567
|
-
};
|
|
9568
|
-
/**
|
|
9569
|
-
* AutomationsApi - factory interface
|
|
9570
|
-
*/
|
|
9571
|
-
export declare const AutomationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12023
|
+
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCompanyDTO>>;
|
|
9572
12024
|
/**
|
|
9573
|
-
*
|
|
9574
|
-
* @summary
|
|
12025
|
+
*
|
|
12026
|
+
* @summary Restore the live hostname to the stored v1 project
|
|
12027
|
+
* @param {string} companyUuid
|
|
9575
12028
|
* @param {*} [options] Override http request option.
|
|
9576
12029
|
* @throws {RequiredError}
|
|
9577
12030
|
*/
|
|
9578
|
-
|
|
9579
|
-
};
|
|
9580
|
-
/**
|
|
9581
|
-
* AutomationsApi - object-oriented interface
|
|
9582
|
-
*/
|
|
9583
|
-
export declare class AutomationsApi extends BaseAPI {
|
|
12031
|
+
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCompanyDTO>>;
|
|
9584
12032
|
/**
|
|
9585
|
-
*
|
|
9586
|
-
* @summary
|
|
12033
|
+
*
|
|
12034
|
+
* @summary Transfer status for one company
|
|
12035
|
+
* @param {string} companyUuid
|
|
9587
12036
|
* @param {*} [options] Override http request option.
|
|
9588
12037
|
* @throws {RequiredError}
|
|
9589
12038
|
*/
|
|
9590
|
-
|
|
9591
|
-
}
|
|
12039
|
+
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
12040
|
+
};
|
|
9592
12041
|
/**
|
|
9593
|
-
*
|
|
12042
|
+
* CMSV2TransferApi - factory interface
|
|
9594
12043
|
*/
|
|
9595
|
-
export declare const
|
|
12044
|
+
export declare const CMSV2TransferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9596
12045
|
/**
|
|
9597
|
-
*
|
|
9598
|
-
* @summary
|
|
12046
|
+
*
|
|
12047
|
+
* @summary Attach a manually created caraer-web project
|
|
12048
|
+
* @param {string} companyUuid
|
|
12049
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
9599
12050
|
* @param {*} [options] Override http request option.
|
|
9600
12051
|
* @throws {RequiredError}
|
|
9601
12052
|
*/
|
|
9602
|
-
|
|
12053
|
+
attach(companyUuid: string, requestBody: {
|
|
12054
|
+
[key: string]: string;
|
|
12055
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCompanyDTO>;
|
|
9603
12056
|
/**
|
|
9604
|
-
*
|
|
9605
|
-
* @summary
|
|
12057
|
+
*
|
|
12058
|
+
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
12059
|
+
* @param {string} companyUuid
|
|
9606
12060
|
* @param {*} [options] Override http request option.
|
|
9607
12061
|
* @throws {RequiredError}
|
|
9608
12062
|
*/
|
|
9609
|
-
|
|
9610
|
-
};
|
|
9611
|
-
/**
|
|
9612
|
-
* BillingApi - functional programming interface
|
|
9613
|
-
*/
|
|
9614
|
-
export declare const BillingApiFp: (configuration?: Configuration) => {
|
|
12063
|
+
cutover(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCompanyDTO>;
|
|
9615
12064
|
/**
|
|
9616
|
-
*
|
|
9617
|
-
* @summary
|
|
12065
|
+
*
|
|
12066
|
+
* @summary Restore the live hostname to the stored v1 project
|
|
12067
|
+
* @param {string} companyUuid
|
|
9618
12068
|
* @param {*} [options] Override http request option.
|
|
9619
12069
|
* @throws {RequiredError}
|
|
9620
12070
|
*/
|
|
9621
|
-
|
|
12071
|
+
rollback(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCompanyDTO>;
|
|
9622
12072
|
/**
|
|
9623
|
-
*
|
|
9624
|
-
* @summary
|
|
12073
|
+
*
|
|
12074
|
+
* @summary Transfer status for one company
|
|
12075
|
+
* @param {string} companyUuid
|
|
9625
12076
|
* @param {*} [options] Override http request option.
|
|
9626
12077
|
* @throws {RequiredError}
|
|
9627
12078
|
*/
|
|
9628
|
-
|
|
12079
|
+
status(companyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
9629
12080
|
};
|
|
9630
12081
|
/**
|
|
9631
|
-
*
|
|
12082
|
+
* CMSV2TransferApi - object-oriented interface
|
|
9632
12083
|
*/
|
|
9633
|
-
export declare
|
|
12084
|
+
export declare class CMSV2TransferApi extends BaseAPI {
|
|
9634
12085
|
/**
|
|
9635
|
-
*
|
|
9636
|
-
* @summary
|
|
12086
|
+
*
|
|
12087
|
+
* @summary Attach a manually created caraer-web project
|
|
12088
|
+
* @param {string} companyUuid
|
|
12089
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
9637
12090
|
* @param {*} [options] Override http request option.
|
|
9638
12091
|
* @throws {RequiredError}
|
|
9639
12092
|
*/
|
|
9640
|
-
|
|
12093
|
+
attach(companyUuid: string, requestBody: {
|
|
12094
|
+
[key: string]: string;
|
|
12095
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
9641
12096
|
/**
|
|
9642
|
-
*
|
|
9643
|
-
* @summary
|
|
12097
|
+
*
|
|
12098
|
+
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
12099
|
+
* @param {string} companyUuid
|
|
9644
12100
|
* @param {*} [options] Override http request option.
|
|
9645
12101
|
* @throws {RequiredError}
|
|
9646
12102
|
*/
|
|
9647
|
-
|
|
9648
|
-
};
|
|
9649
|
-
/**
|
|
9650
|
-
* BillingApi - object-oriented interface
|
|
9651
|
-
*/
|
|
9652
|
-
export declare class BillingApi extends BaseAPI {
|
|
12103
|
+
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
9653
12104
|
/**
|
|
9654
|
-
*
|
|
9655
|
-
* @summary
|
|
12105
|
+
*
|
|
12106
|
+
* @summary Restore the live hostname to the stored v1 project
|
|
12107
|
+
* @param {string} companyUuid
|
|
9656
12108
|
* @param {*} [options] Override http request option.
|
|
9657
12109
|
* @throws {RequiredError}
|
|
9658
12110
|
*/
|
|
9659
|
-
|
|
12111
|
+
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
9660
12112
|
/**
|
|
9661
|
-
*
|
|
9662
|
-
* @summary
|
|
12113
|
+
*
|
|
12114
|
+
* @summary Transfer status for one company
|
|
12115
|
+
* @param {string} companyUuid
|
|
9663
12116
|
* @param {*} [options] Override http request option.
|
|
9664
12117
|
* @throws {RequiredError}
|
|
9665
12118
|
*/
|
|
9666
|
-
|
|
12119
|
+
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9667
12120
|
}
|
|
9668
12121
|
/**
|
|
9669
12122
|
* CalendarsApi - axios parameter creator
|
|
@@ -9683,14 +12136,14 @@ export declare const CalendarsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
9683
12136
|
* @param {*} [options] Override http request option.
|
|
9684
12137
|
* @throws {RequiredError}
|
|
9685
12138
|
*/
|
|
9686
|
-
|
|
12139
|
+
create4: (calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9687
12140
|
/**
|
|
9688
12141
|
*
|
|
9689
12142
|
* @summary List calendars visible to the current company
|
|
9690
12143
|
* @param {*} [options] Override http request option.
|
|
9691
12144
|
* @throws {RequiredError}
|
|
9692
12145
|
*/
|
|
9693
|
-
|
|
12146
|
+
list3: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9694
12147
|
/**
|
|
9695
12148
|
*
|
|
9696
12149
|
* @summary List teams that can be linked to a calendar
|
|
@@ -9717,14 +12170,14 @@ export declare const CalendarsApiFp: (configuration?: Configuration) => {
|
|
|
9717
12170
|
* @param {*} [options] Override http request option.
|
|
9718
12171
|
* @throws {RequiredError}
|
|
9719
12172
|
*/
|
|
9720
|
-
|
|
12173
|
+
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateResponseCalendarRecordDTO>>;
|
|
9721
12174
|
/**
|
|
9722
12175
|
*
|
|
9723
12176
|
* @summary List calendars visible to the current company
|
|
9724
12177
|
* @param {*} [options] Override http request option.
|
|
9725
12178
|
* @throws {RequiredError}
|
|
9726
12179
|
*/
|
|
9727
|
-
|
|
12180
|
+
list3(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListCalendarRecordDTO>>;
|
|
9728
12181
|
/**
|
|
9729
12182
|
*
|
|
9730
12183
|
* @summary List teams that can be linked to a calendar
|
|
@@ -9751,14 +12204,14 @@ export declare const CalendarsApiFactory: (configuration?: Configuration, basePa
|
|
|
9751
12204
|
* @param {*} [options] Override http request option.
|
|
9752
12205
|
* @throws {RequiredError}
|
|
9753
12206
|
*/
|
|
9754
|
-
|
|
12207
|
+
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponseCalendarRecordDTO>;
|
|
9755
12208
|
/**
|
|
9756
12209
|
*
|
|
9757
12210
|
* @summary List calendars visible to the current company
|
|
9758
12211
|
* @param {*} [options] Override http request option.
|
|
9759
12212
|
* @throws {RequiredError}
|
|
9760
12213
|
*/
|
|
9761
|
-
|
|
12214
|
+
list3(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListCalendarRecordDTO>;
|
|
9762
12215
|
/**
|
|
9763
12216
|
*
|
|
9764
12217
|
* @summary List teams that can be linked to a calendar
|
|
@@ -9785,14 +12238,14 @@ export declare class CalendarsApi extends BaseAPI {
|
|
|
9785
12238
|
* @param {*} [options] Override http request option.
|
|
9786
12239
|
* @throws {RequiredError}
|
|
9787
12240
|
*/
|
|
9788
|
-
|
|
12241
|
+
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateResponseCalendarRecordDTO, any, {}>>;
|
|
9789
12242
|
/**
|
|
9790
12243
|
*
|
|
9791
12244
|
* @summary List calendars visible to the current company
|
|
9792
12245
|
* @param {*} [options] Override http request option.
|
|
9793
12246
|
* @throws {RequiredError}
|
|
9794
12247
|
*/
|
|
9795
|
-
|
|
12248
|
+
list3(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListCalendarRecordDTO, any, {}>>;
|
|
9796
12249
|
/**
|
|
9797
12250
|
*
|
|
9798
12251
|
* @summary List teams that can be linked to a calendar
|
|
@@ -10507,7 +12960,7 @@ export declare const DeveloperSandboxesApiAxiosParamCreator: (configuration?: Co
|
|
|
10507
12960
|
* @param {*} [options] Override http request option.
|
|
10508
12961
|
* @throws {RequiredError}
|
|
10509
12962
|
*/
|
|
10510
|
-
|
|
12963
|
+
list1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10511
12964
|
/**
|
|
10512
12965
|
*
|
|
10513
12966
|
* @summary Get a developer sandbox
|
|
@@ -10535,7 +12988,7 @@ export declare const DeveloperSandboxesApiFp: (configuration?: Configuration) =>
|
|
|
10535
12988
|
* @param {*} [options] Override http request option.
|
|
10536
12989
|
* @throws {RequiredError}
|
|
10537
12990
|
*/
|
|
10538
|
-
|
|
12991
|
+
list1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListDeveloperSandboxDTO>>;
|
|
10539
12992
|
/**
|
|
10540
12993
|
*
|
|
10541
12994
|
* @summary Get a developer sandbox
|
|
@@ -10563,7 +13016,7 @@ export declare const DeveloperSandboxesApiFactory: (configuration?: Configuratio
|
|
|
10563
13016
|
* @param {*} [options] Override http request option.
|
|
10564
13017
|
* @throws {RequiredError}
|
|
10565
13018
|
*/
|
|
10566
|
-
|
|
13019
|
+
list1(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListDeveloperSandboxDTO>;
|
|
10567
13020
|
/**
|
|
10568
13021
|
*
|
|
10569
13022
|
* @summary Get a developer sandbox
|
|
@@ -10591,7 +13044,7 @@ export declare class DeveloperSandboxesApi extends BaseAPI {
|
|
|
10591
13044
|
* @param {*} [options] Override http request option.
|
|
10592
13045
|
* @throws {RequiredError}
|
|
10593
13046
|
*/
|
|
10594
|
-
|
|
13047
|
+
list1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListDeveloperSandboxDTO, any, {}>>;
|
|
10595
13048
|
/**
|
|
10596
13049
|
*
|
|
10597
13050
|
* @summary Get a developer sandbox
|
|
@@ -10683,6 +13136,14 @@ export declare const FileManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
10683
13136
|
* @throws {RequiredError}
|
|
10684
13137
|
*/
|
|
10685
13138
|
listFiles: (recordUuid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13139
|
+
/**
|
|
13140
|
+
*
|
|
13141
|
+
* @summary List company files with metadata for the media library
|
|
13142
|
+
* @param {string} [recordUuid]
|
|
13143
|
+
* @param {*} [options] Override http request option.
|
|
13144
|
+
* @throws {RequiredError}
|
|
13145
|
+
*/
|
|
13146
|
+
listLibrary: (recordUuid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10686
13147
|
/**
|
|
10687
13148
|
* Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
|
|
10688
13149
|
* @summary Upload files
|
|
@@ -10722,6 +13183,14 @@ export declare const FileManagementApiFp: (configuration?: Configuration) => {
|
|
|
10722
13183
|
* @throws {RequiredError}
|
|
10723
13184
|
*/
|
|
10724
13185
|
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListString>>;
|
|
13186
|
+
/**
|
|
13187
|
+
*
|
|
13188
|
+
* @summary List company files with metadata for the media library
|
|
13189
|
+
* @param {string} [recordUuid]
|
|
13190
|
+
* @param {*} [options] Override http request option.
|
|
13191
|
+
* @throws {RequiredError}
|
|
13192
|
+
*/
|
|
13193
|
+
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListFileListItemDTO>>;
|
|
10725
13194
|
/**
|
|
10726
13195
|
* Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
|
|
10727
13196
|
* @summary Upload files
|
|
@@ -10761,6 +13230,14 @@ export declare const FileManagementApiFactory: (configuration?: Configuration, b
|
|
|
10761
13230
|
* @throws {RequiredError}
|
|
10762
13231
|
*/
|
|
10763
13232
|
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListString>;
|
|
13233
|
+
/**
|
|
13234
|
+
*
|
|
13235
|
+
* @summary List company files with metadata for the media library
|
|
13236
|
+
* @param {string} [recordUuid]
|
|
13237
|
+
* @param {*} [options] Override http request option.
|
|
13238
|
+
* @throws {RequiredError}
|
|
13239
|
+
*/
|
|
13240
|
+
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListFileListItemDTO>;
|
|
10764
13241
|
/**
|
|
10765
13242
|
* Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
|
|
10766
13243
|
* @summary Upload files
|
|
@@ -10800,6 +13277,14 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
10800
13277
|
* @throws {RequiredError}
|
|
10801
13278
|
*/
|
|
10802
13279
|
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
13280
|
+
/**
|
|
13281
|
+
*
|
|
13282
|
+
* @summary List company files with metadata for the media library
|
|
13283
|
+
* @param {string} [recordUuid]
|
|
13284
|
+
* @param {*} [options] Override http request option.
|
|
13285
|
+
* @throws {RequiredError}
|
|
13286
|
+
*/
|
|
13287
|
+
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListFileListItemDTO, any, {}>>;
|
|
10803
13288
|
/**
|
|
10804
13289
|
* Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
|
|
10805
13290
|
* @summary Upload files
|
|
@@ -14883,7 +17368,7 @@ export declare const ServerlessFunctionsApiAxiosParamCreator: (configuration?: C
|
|
|
14883
17368
|
* @param {*} [options] Override http request option.
|
|
14884
17369
|
* @throws {RequiredError}
|
|
14885
17370
|
*/
|
|
14886
|
-
|
|
17371
|
+
create5: (appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14887
17372
|
/**
|
|
14888
17373
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
14889
17374
|
* @summary Delete a serverless function
|
|
@@ -14892,7 +17377,7 @@ export declare const ServerlessFunctionsApiAxiosParamCreator: (configuration?: C
|
|
|
14892
17377
|
* @param {*} [options] Override http request option.
|
|
14893
17378
|
* @throws {RequiredError}
|
|
14894
17379
|
*/
|
|
14895
|
-
|
|
17380
|
+
delete2: (appUuid: string, uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14896
17381
|
/**
|
|
14897
17382
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
14898
17383
|
* @summary List serverless functions for an app
|
|
@@ -14950,7 +17435,7 @@ export declare const ServerlessFunctionsApiAxiosParamCreator: (configuration?: C
|
|
|
14950
17435
|
* @param {*} [options] Override http request option.
|
|
14951
17436
|
* @throws {RequiredError}
|
|
14952
17437
|
*/
|
|
14953
|
-
|
|
17438
|
+
update2: (appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14954
17439
|
};
|
|
14955
17440
|
/**
|
|
14956
17441
|
* ServerlessFunctionsApi - functional programming interface
|
|
@@ -14964,7 +17449,7 @@ export declare const ServerlessFunctionsApiFp: (configuration?: Configuration) =
|
|
|
14964
17449
|
* @param {*} [options] Override http request option.
|
|
14965
17450
|
* @throws {RequiredError}
|
|
14966
17451
|
*/
|
|
14967
|
-
|
|
17452
|
+
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateResponse>>;
|
|
14968
17453
|
/**
|
|
14969
17454
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
14970
17455
|
* @summary Delete a serverless function
|
|
@@ -14973,7 +17458,7 @@ export declare const ServerlessFunctionsApiFp: (configuration?: Configuration) =
|
|
|
14973
17458
|
* @param {*} [options] Override http request option.
|
|
14974
17459
|
* @throws {RequiredError}
|
|
14975
17460
|
*/
|
|
14976
|
-
|
|
17461
|
+
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
14977
17462
|
/**
|
|
14978
17463
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
14979
17464
|
* @summary List serverless functions for an app
|
|
@@ -15031,7 +17516,7 @@ export declare const ServerlessFunctionsApiFp: (configuration?: Configuration) =
|
|
|
15031
17516
|
* @param {*} [options] Override http request option.
|
|
15032
17517
|
* @throws {RequiredError}
|
|
15033
17518
|
*/
|
|
15034
|
-
|
|
17519
|
+
update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseServerlessFunctionDTO>>;
|
|
15035
17520
|
};
|
|
15036
17521
|
/**
|
|
15037
17522
|
* ServerlessFunctionsApi - factory interface
|
|
@@ -15045,7 +17530,7 @@ export declare const ServerlessFunctionsApiFactory: (configuration?: Configurati
|
|
|
15045
17530
|
* @param {*} [options] Override http request option.
|
|
15046
17531
|
* @throws {RequiredError}
|
|
15047
17532
|
*/
|
|
15048
|
-
|
|
17533
|
+
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponse>;
|
|
15049
17534
|
/**
|
|
15050
17535
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
15051
17536
|
* @summary Delete a serverless function
|
|
@@ -15054,7 +17539,7 @@ export declare const ServerlessFunctionsApiFactory: (configuration?: Configurati
|
|
|
15054
17539
|
* @param {*} [options] Override http request option.
|
|
15055
17540
|
* @throws {RequiredError}
|
|
15056
17541
|
*/
|
|
15057
|
-
|
|
17542
|
+
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
15058
17543
|
/**
|
|
15059
17544
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
15060
17545
|
* @summary List serverless functions for an app
|
|
@@ -15112,7 +17597,7 @@ export declare const ServerlessFunctionsApiFactory: (configuration?: Configurati
|
|
|
15112
17597
|
* @param {*} [options] Override http request option.
|
|
15113
17598
|
* @throws {RequiredError}
|
|
15114
17599
|
*/
|
|
15115
|
-
|
|
17600
|
+
update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseServerlessFunctionDTO>;
|
|
15116
17601
|
};
|
|
15117
17602
|
/**
|
|
15118
17603
|
* ServerlessFunctionsApi - object-oriented interface
|
|
@@ -15126,7 +17611,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
15126
17611
|
* @param {*} [options] Override http request option.
|
|
15127
17612
|
* @throws {RequiredError}
|
|
15128
17613
|
*/
|
|
15129
|
-
|
|
17614
|
+
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateResponse, any, {}>>;
|
|
15130
17615
|
/**
|
|
15131
17616
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
15132
17617
|
* @summary Delete a serverless function
|
|
@@ -15135,7 +17620,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
15135
17620
|
* @param {*} [options] Override http request option.
|
|
15136
17621
|
* @throws {RequiredError}
|
|
15137
17622
|
*/
|
|
15138
|
-
|
|
17623
|
+
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
15139
17624
|
/**
|
|
15140
17625
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
15141
17626
|
* @summary List serverless functions for an app
|
|
@@ -15193,7 +17678,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
15193
17678
|
* @param {*} [options] Override http request option.
|
|
15194
17679
|
* @throws {RequiredError}
|
|
15195
17680
|
*/
|
|
15196
|
-
|
|
17681
|
+
update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseServerlessFunctionDTO, any, {}>>;
|
|
15197
17682
|
}
|
|
15198
17683
|
/**
|
|
15199
17684
|
* SyncApi - axios parameter creator
|
|
@@ -16419,6 +18904,40 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
16419
18904
|
* @throws {RequiredError}
|
|
16420
18905
|
*/
|
|
16421
18906
|
getMenus: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18907
|
+
/**
|
|
18908
|
+
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
18909
|
+
* @summary Get filtered map markers for a public webpage
|
|
18910
|
+
* @param {string} xCaraerSubdomain
|
|
18911
|
+
* @param {string} pageUuid
|
|
18912
|
+
* @param {string} componentUuid
|
|
18913
|
+
* @param {RecordPaginationRequest} recordPaginationRequest
|
|
18914
|
+
* @param {string} [xCaraerEnvironment]
|
|
18915
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
18916
|
+
* @param {string} [authorization]
|
|
18917
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
18918
|
+
* @param {string} [access]
|
|
18919
|
+
* @param {string} [token]
|
|
18920
|
+
* @param {*} [options] Override http request option.
|
|
18921
|
+
* @throws {RequiredError}
|
|
18922
|
+
*/
|
|
18923
|
+
getPublicMapLocations: (xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18924
|
+
/**
|
|
18925
|
+
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
18926
|
+
* @summary Get a hydrated preview for one public map marker
|
|
18927
|
+
* @param {string} xCaraerSubdomain
|
|
18928
|
+
* @param {string} pageUuid
|
|
18929
|
+
* @param {string} componentUuid
|
|
18930
|
+
* @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest
|
|
18931
|
+
* @param {string} [xCaraerEnvironment]
|
|
18932
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
18933
|
+
* @param {string} [authorization]
|
|
18934
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
18935
|
+
* @param {string} [access]
|
|
18936
|
+
* @param {string} [token]
|
|
18937
|
+
* @param {*} [options] Override http request option.
|
|
18938
|
+
* @throws {RequiredError}
|
|
18939
|
+
*/
|
|
18940
|
+
getPublicMapMarkerPreview: (xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16422
18941
|
/**
|
|
16423
18942
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
16424
18943
|
* @summary Get previews for a public webpage
|
|
@@ -16761,6 +19280,40 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
16761
19280
|
* @throws {RequiredError}
|
|
16762
19281
|
*/
|
|
16763
19282
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebMenuDTO>>;
|
|
19283
|
+
/**
|
|
19284
|
+
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
19285
|
+
* @summary Get filtered map markers for a public webpage
|
|
19286
|
+
* @param {string} xCaraerSubdomain
|
|
19287
|
+
* @param {string} pageUuid
|
|
19288
|
+
* @param {string} componentUuid
|
|
19289
|
+
* @param {RecordPaginationRequest} recordPaginationRequest
|
|
19290
|
+
* @param {string} [xCaraerEnvironment]
|
|
19291
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
19292
|
+
* @param {string} [authorization]
|
|
19293
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
19294
|
+
* @param {string} [access]
|
|
19295
|
+
* @param {string} [token]
|
|
19296
|
+
* @param {*} [options] Override http request option.
|
|
19297
|
+
* @throws {RequiredError}
|
|
19298
|
+
*/
|
|
19299
|
+
getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageMapLocationsDTO>>;
|
|
19300
|
+
/**
|
|
19301
|
+
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
19302
|
+
* @summary Get a hydrated preview for one public map marker
|
|
19303
|
+
* @param {string} xCaraerSubdomain
|
|
19304
|
+
* @param {string} pageUuid
|
|
19305
|
+
* @param {string} componentUuid
|
|
19306
|
+
* @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest
|
|
19307
|
+
* @param {string} [xCaraerEnvironment]
|
|
19308
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
19309
|
+
* @param {string} [authorization]
|
|
19310
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
19311
|
+
* @param {string} [access]
|
|
19312
|
+
* @param {string} [token]
|
|
19313
|
+
* @param {*} [options] Override http request option.
|
|
19314
|
+
* @throws {RequiredError}
|
|
19315
|
+
*/
|
|
19316
|
+
getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponsePreviewDTO>>;
|
|
16764
19317
|
/**
|
|
16765
19318
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
16766
19319
|
* @summary Get previews for a public webpage
|
|
@@ -17103,6 +19656,40 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
17103
19656
|
* @throws {RequiredError}
|
|
17104
19657
|
*/
|
|
17105
19658
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebMenuDTO>;
|
|
19659
|
+
/**
|
|
19660
|
+
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
19661
|
+
* @summary Get filtered map markers for a public webpage
|
|
19662
|
+
* @param {string} xCaraerSubdomain
|
|
19663
|
+
* @param {string} pageUuid
|
|
19664
|
+
* @param {string} componentUuid
|
|
19665
|
+
* @param {RecordPaginationRequest} recordPaginationRequest
|
|
19666
|
+
* @param {string} [xCaraerEnvironment]
|
|
19667
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
19668
|
+
* @param {string} [authorization]
|
|
19669
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
19670
|
+
* @param {string} [access]
|
|
19671
|
+
* @param {string} [token]
|
|
19672
|
+
* @param {*} [options] Override http request option.
|
|
19673
|
+
* @throws {RequiredError}
|
|
19674
|
+
*/
|
|
19675
|
+
getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageMapLocationsDTO>;
|
|
19676
|
+
/**
|
|
19677
|
+
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
19678
|
+
* @summary Get a hydrated preview for one public map marker
|
|
19679
|
+
* @param {string} xCaraerSubdomain
|
|
19680
|
+
* @param {string} pageUuid
|
|
19681
|
+
* @param {string} componentUuid
|
|
19682
|
+
* @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest
|
|
19683
|
+
* @param {string} [xCaraerEnvironment]
|
|
19684
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
19685
|
+
* @param {string} [authorization]
|
|
19686
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
19687
|
+
* @param {string} [access]
|
|
19688
|
+
* @param {string} [token]
|
|
19689
|
+
* @param {*} [options] Override http request option.
|
|
19690
|
+
* @throws {RequiredError}
|
|
19691
|
+
*/
|
|
19692
|
+
getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponsePreviewDTO>;
|
|
17106
19693
|
/**
|
|
17107
19694
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
17108
19695
|
* @summary Get previews for a public webpage
|
|
@@ -17445,6 +20032,40 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
17445
20032
|
* @throws {RequiredError}
|
|
17446
20033
|
*/
|
|
17447
20034
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseWebMenuDTO, any, {}>>;
|
|
20035
|
+
/**
|
|
20036
|
+
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
20037
|
+
* @summary Get filtered map markers for a public webpage
|
|
20038
|
+
* @param {string} xCaraerSubdomain
|
|
20039
|
+
* @param {string} pageUuid
|
|
20040
|
+
* @param {string} componentUuid
|
|
20041
|
+
* @param {RecordPaginationRequest} recordPaginationRequest
|
|
20042
|
+
* @param {string} [xCaraerEnvironment]
|
|
20043
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
20044
|
+
* @param {string} [authorization]
|
|
20045
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
20046
|
+
* @param {string} [access]
|
|
20047
|
+
* @param {string} [token]
|
|
20048
|
+
* @param {*} [options] Override http request option.
|
|
20049
|
+
* @throws {RequiredError}
|
|
20050
|
+
*/
|
|
20051
|
+
getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseWebpageMapLocationsDTO, any, {}>>;
|
|
20052
|
+
/**
|
|
20053
|
+
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
20054
|
+
* @summary Get a hydrated preview for one public map marker
|
|
20055
|
+
* @param {string} xCaraerSubdomain
|
|
20056
|
+
* @param {string} pageUuid
|
|
20057
|
+
* @param {string} componentUuid
|
|
20058
|
+
* @param {MapMarkerPreviewRequest} mapMarkerPreviewRequest
|
|
20059
|
+
* @param {string} [xCaraerEnvironment]
|
|
20060
|
+
* @param {string} [xCaraerPrimaryEnvironment]
|
|
20061
|
+
* @param {string} [authorization]
|
|
20062
|
+
* @param {string} [xCaraerWebpageAccess]
|
|
20063
|
+
* @param {string} [access]
|
|
20064
|
+
* @param {string} [token]
|
|
20065
|
+
* @param {*} [options] Override http request option.
|
|
20066
|
+
* @throws {RequiredError}
|
|
20067
|
+
*/
|
|
20068
|
+
getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
|
|
17448
20069
|
/**
|
|
17449
20070
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
17450
20071
|
* @summary Get previews for a public webpage
|