@caraer/client 2.0.640 → 2.0.655
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 +2 -0
- package/.openapi-generator/VERSION +1 -1
- package/api.ts +88 -3
- package/dist/api.d.ts +371 -322
- package/dist/api.js +66 -1
- package/dist/base.js +4 -1
- package/dist/esm/api.d.ts +51 -3
- package/dist/esm/api.js +62 -0
- package/docs/AppSettingFieldSchema.md +2 -2
- package/docs/ArchivedRecordObjectDTO.md +28 -0
- package/docs/Record.md +2 -2
- package/docs/RecordRelationRequestDTO.md +1 -1
- package/docs/RecordsApi.md +49 -0
- package/docs/SuccessResponseListArchivedRecordObjectDTO.md +23 -0
- package/package.json +2 -2
- package/tsconfig.json +4 -1
package/dist/api.d.ts
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
14
15
|
import type { RequestArgs } from './base';
|
|
15
16
|
import { BaseAPI } from './base';
|
|
16
17
|
/**
|
|
@@ -1016,8 +1017,8 @@ export interface AppSettingFieldSchema {
|
|
|
1016
1017
|
'clearValue'?: boolean;
|
|
1017
1018
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
1018
1019
|
'valueScope'?: string;
|
|
1019
|
-
'settingsGroup'?: boolean;
|
|
1020
1020
|
'action'?: boolean;
|
|
1021
|
+
'settingsGroup'?: boolean;
|
|
1021
1022
|
'filterPropertyTypes'?: Array<string>;
|
|
1022
1023
|
'filterPropertyFormats'?: Array<string>;
|
|
1023
1024
|
}
|
|
@@ -1047,6 +1048,13 @@ export interface AppSubcategoryDTO {
|
|
|
1047
1048
|
*/
|
|
1048
1049
|
'label'?: string;
|
|
1049
1050
|
}
|
|
1051
|
+
export interface ArchivedRecordObjectDTO {
|
|
1052
|
+
'uuid'?: string;
|
|
1053
|
+
'name'?: string;
|
|
1054
|
+
'label'?: string;
|
|
1055
|
+
'icon'?: string;
|
|
1056
|
+
'index'?: number;
|
|
1057
|
+
}
|
|
1050
1058
|
/**
|
|
1051
1059
|
* The billing settings of the company.
|
|
1052
1060
|
*/
|
|
@@ -3740,11 +3748,11 @@ export interface ModelRecord {
|
|
|
3740
3748
|
'complete'?: boolean;
|
|
3741
3749
|
'deleted'?: boolean;
|
|
3742
3750
|
'uuid': string;
|
|
3743
|
-
'user'?: PublicUserDTO;
|
|
3744
3751
|
'properties'?: Array<FilledProperty>;
|
|
3745
3752
|
'objects'?: {
|
|
3746
3753
|
[key: string]: any | null;
|
|
3747
3754
|
};
|
|
3755
|
+
'user'?: PublicUserDTO;
|
|
3748
3756
|
}
|
|
3749
3757
|
export interface MultiFile extends PropertyFormat {
|
|
3750
3758
|
}
|
|
@@ -5424,7 +5432,7 @@ export interface RecordRelationRequestDTO {
|
|
|
5424
5432
|
*/
|
|
5425
5433
|
'uuid'?: string;
|
|
5426
5434
|
/**
|
|
5427
|
-
*
|
|
5435
|
+
* With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous.
|
|
5428
5436
|
*/
|
|
5429
5437
|
'properties'?: {
|
|
5430
5438
|
[key: string]: any | null;
|
|
@@ -7352,6 +7360,19 @@ export interface SuccessResponseListAppScheduleDTO {
|
|
|
7352
7360
|
*/
|
|
7353
7361
|
'data'?: Array<AppScheduleDTO>;
|
|
7354
7362
|
}
|
|
7363
|
+
/**
|
|
7364
|
+
* Represents a standard successful response with a message and optional data.
|
|
7365
|
+
*/
|
|
7366
|
+
export interface SuccessResponseListArchivedRecordObjectDTO {
|
|
7367
|
+
/**
|
|
7368
|
+
* A message detailing the result of the operation.
|
|
7369
|
+
*/
|
|
7370
|
+
'message'?: string;
|
|
7371
|
+
/**
|
|
7372
|
+
* The data payload of the response, if any.
|
|
7373
|
+
*/
|
|
7374
|
+
'data'?: Array<ArchivedRecordObjectDTO>;
|
|
7375
|
+
}
|
|
7355
7376
|
/**
|
|
7356
7377
|
* Represents a standard successful response with a message and optional data.
|
|
7357
7378
|
*/
|
|
@@ -8692,7 +8713,7 @@ export declare class AppBarIframeSessionsApi extends BaseAPI {
|
|
|
8692
8713
|
* @param {*} [options] Override http request option.
|
|
8693
8714
|
* @throws {RequiredError}
|
|
8694
8715
|
*/
|
|
8695
|
-
createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8716
|
+
createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppBarIframeSessionTokenDTO, any, {}>>;
|
|
8696
8717
|
/**
|
|
8697
8718
|
* Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context.
|
|
8698
8719
|
* @summary Validate an iframe session token
|
|
@@ -8700,7 +8721,7 @@ export declare class AppBarIframeSessionsApi extends BaseAPI {
|
|
|
8700
8721
|
* @param {*} [options] Override http request option.
|
|
8701
8722
|
* @throws {RequiredError}
|
|
8702
8723
|
*/
|
|
8703
|
-
validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8724
|
+
validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppBarIframeSessionContextDTO, any, {}>>;
|
|
8704
8725
|
}
|
|
8705
8726
|
/**
|
|
8706
8727
|
* AppBarsApi - axios parameter creator
|
|
@@ -8799,7 +8820,7 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8799
8820
|
* @param {*} [options] Override http request option.
|
|
8800
8821
|
* @throws {RequiredError}
|
|
8801
8822
|
*/
|
|
8802
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8823
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8803
8824
|
/**
|
|
8804
8825
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8805
8826
|
* @summary Trigger an action-based app bar
|
|
@@ -8808,7 +8829,7 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8808
8829
|
* @param {*} [options] Override http request option.
|
|
8809
8830
|
* @throws {RequiredError}
|
|
8810
8831
|
*/
|
|
8811
|
-
triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8832
|
+
triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
8812
8833
|
}
|
|
8813
8834
|
export declare const ListAppBarsLocationEnum: {
|
|
8814
8835
|
readonly RecordPreview: "RECORD_PREVIEW";
|
|
@@ -9395,7 +9416,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9395
9416
|
* @param {*} [options] Override http request option.
|
|
9396
9417
|
* @throws {RequiredError}
|
|
9397
9418
|
*/
|
|
9398
|
-
deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise<
|
|
9419
|
+
deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9399
9420
|
/**
|
|
9400
9421
|
*
|
|
9401
9422
|
* @summary Delete a state key
|
|
@@ -9404,7 +9425,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9404
9425
|
* @param {*} [options] Override http request option.
|
|
9405
9426
|
* @throws {RequiredError}
|
|
9406
9427
|
*/
|
|
9407
|
-
deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9428
|
+
deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
9408
9429
|
/**
|
|
9409
9430
|
*
|
|
9410
9431
|
* @summary Enqueue an async serverless function job
|
|
@@ -9415,7 +9436,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9415
9436
|
*/
|
|
9416
9437
|
enqueueJob(appUuid: string, requestBody: {
|
|
9417
9438
|
[key: string]: any | null;
|
|
9418
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9439
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9419
9440
|
/**
|
|
9420
9441
|
*
|
|
9421
9442
|
* @summary Get async job status
|
|
@@ -9424,7 +9445,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9424
9445
|
* @param {*} [options] Override http request option.
|
|
9425
9446
|
* @throws {RequiredError}
|
|
9426
9447
|
*/
|
|
9427
|
-
getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<
|
|
9448
|
+
getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9428
9449
|
/**
|
|
9429
9450
|
*
|
|
9430
9451
|
* @summary Load read-only Markdown content for a setting
|
|
@@ -9433,7 +9454,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9433
9454
|
* @param {*} [options] Override http request option.
|
|
9434
9455
|
* @throws {RequiredError}
|
|
9435
9456
|
*/
|
|
9436
|
-
getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<
|
|
9457
|
+
getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
9437
9458
|
/**
|
|
9438
9459
|
*
|
|
9439
9460
|
* @summary Get installation state map
|
|
@@ -9441,7 +9462,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9441
9462
|
* @param {*} [options] Override http request option.
|
|
9442
9463
|
* @throws {RequiredError}
|
|
9443
9464
|
*/
|
|
9444
|
-
getState(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9465
|
+
getState(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9445
9466
|
/**
|
|
9446
9467
|
*
|
|
9447
9468
|
* @summary Get a single state key
|
|
@@ -9450,7 +9471,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9450
9471
|
* @param {*} [options] Override http request option.
|
|
9451
9472
|
* @throws {RequiredError}
|
|
9452
9473
|
*/
|
|
9453
|
-
getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9474
|
+
getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObject, any, {}>>;
|
|
9454
9475
|
/**
|
|
9455
9476
|
*
|
|
9456
9477
|
* @summary List external OAuth connection status
|
|
@@ -9458,7 +9479,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9458
9479
|
* @param {*} [options] Override http request option.
|
|
9459
9480
|
* @throws {RequiredError}
|
|
9460
9481
|
*/
|
|
9461
|
-
listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9482
|
+
listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListAppConnectionStatusDTO, any, {}>>;
|
|
9462
9483
|
/**
|
|
9463
9484
|
*
|
|
9464
9485
|
* @summary List secret names (no values)
|
|
@@ -9466,7 +9487,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9466
9487
|
* @param {*} [options] Override http request option.
|
|
9467
9488
|
* @throws {RequiredError}
|
|
9468
9489
|
*/
|
|
9469
|
-
listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9490
|
+
listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListString, any, {}>>;
|
|
9470
9491
|
/**
|
|
9471
9492
|
*
|
|
9472
9493
|
* @summary Merge COMPANY-scoped installation settings from the app runtime
|
|
@@ -9475,7 +9496,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9475
9496
|
* @param {*} [options] Override http request option.
|
|
9476
9497
|
* @throws {RequiredError}
|
|
9477
9498
|
*/
|
|
9478
|
-
mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<
|
|
9499
|
+
mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9479
9500
|
/**
|
|
9480
9501
|
*
|
|
9481
9502
|
* @summary Set an encrypted secret
|
|
@@ -9487,7 +9508,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9487
9508
|
*/
|
|
9488
9509
|
putSecret(appUuid: string, name: string, requestBody: {
|
|
9489
9510
|
[key: string]: any | null;
|
|
9490
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9511
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9491
9512
|
/**
|
|
9492
9513
|
*
|
|
9493
9514
|
* @summary Replace/merge installation state (shallow merge)
|
|
@@ -9498,7 +9519,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9498
9519
|
*/
|
|
9499
9520
|
putState(appUuid: string, requestBody: {
|
|
9500
9521
|
[key: string]: any | null;
|
|
9501
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9522
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9502
9523
|
/**
|
|
9503
9524
|
*
|
|
9504
9525
|
* @summary Put a single state key
|
|
@@ -9508,7 +9529,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9508
9529
|
* @param {*} [options] Override http request option.
|
|
9509
9530
|
* @throws {RequiredError}
|
|
9510
9531
|
*/
|
|
9511
|
-
putStateKey(appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig): Promise<
|
|
9532
|
+
putStateKey(appUuid: string, key: string, body: object, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObject, any, {}>>;
|
|
9512
9533
|
/**
|
|
9513
9534
|
*
|
|
9514
9535
|
* @summary Revoke external OAuth connection tokens by connection id or provider name
|
|
@@ -9517,7 +9538,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9517
9538
|
* @param {*} [options] Override http request option.
|
|
9518
9539
|
* @throws {RequiredError}
|
|
9519
9540
|
*/
|
|
9520
|
-
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<
|
|
9541
|
+
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9521
9542
|
/**
|
|
9522
9543
|
*
|
|
9523
9544
|
* @summary Run SQL in this installation\'s Postgres schema
|
|
@@ -9528,7 +9549,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9528
9549
|
*/
|
|
9529
9550
|
runInstallationSql(appUuid: string, requestBody: {
|
|
9530
9551
|
[key: string]: any | null;
|
|
9531
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9552
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9532
9553
|
/**
|
|
9533
9554
|
*
|
|
9534
9555
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9537,7 +9558,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9537
9558
|
* @param {*} [options] Override http request option.
|
|
9538
9559
|
* @throws {RequiredError}
|
|
9539
9560
|
*/
|
|
9540
|
-
saveUserSettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<
|
|
9561
|
+
saveUserSettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9541
9562
|
/**
|
|
9542
9563
|
*
|
|
9543
9564
|
* @summary Start external OAuth authorize (returns provider authorize URL)
|
|
@@ -9548,7 +9569,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9548
9569
|
* @param {*} [options] Override http request option.
|
|
9549
9570
|
* @throws {RequiredError}
|
|
9550
9571
|
*/
|
|
9551
|
-
startOAuth(appUuid: string, provider: string, redirectUri?: string, connectionId?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9572
|
+
startOAuth(appUuid: string, provider: string, redirectUri?: string, connectionId?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppOAuthStartResponseDTO, any, {}>>;
|
|
9552
9573
|
/**
|
|
9553
9574
|
*
|
|
9554
9575
|
* @summary Trigger an ACTION setting without saving settings
|
|
@@ -9557,7 +9578,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9557
9578
|
* @param {*} [options] Override http request option.
|
|
9558
9579
|
* @throws {RequiredError}
|
|
9559
9580
|
*/
|
|
9560
|
-
triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<
|
|
9581
|
+
triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9561
9582
|
/**
|
|
9562
9583
|
*
|
|
9563
9584
|
* @summary Update an external OAuth connection display label
|
|
@@ -9569,7 +9590,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9569
9590
|
*/
|
|
9570
9591
|
updateConnectionLabel(appUuid: string, connectionId: string, requestBody: {
|
|
9571
9592
|
[key: string]: string;
|
|
9572
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9593
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9573
9594
|
}
|
|
9574
9595
|
/**
|
|
9575
9596
|
* ApplicationsApi - axios parameter creator
|
|
@@ -10483,7 +10504,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10483
10504
|
* @param {*} [options] Override http request option.
|
|
10484
10505
|
* @throws {RequiredError}
|
|
10485
10506
|
*/
|
|
10486
|
-
createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10507
|
+
createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10487
10508
|
/**
|
|
10488
10509
|
* Creates a private app from its creator manifest, validating the supplied name, settings and app bars before saving. An omitted name is generated. Private apps are automatically installed for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
|
|
10489
10510
|
* @summary Create a private app
|
|
@@ -10491,7 +10512,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10491
10512
|
* @param {*} [options] Override http request option.
|
|
10492
10513
|
* @throws {RequiredError}
|
|
10493
10514
|
*/
|
|
10494
|
-
createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10515
|
+
createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10495
10516
|
/**
|
|
10496
10517
|
* Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user\'s company. Returns the created app details as a CreateResponse wrapping an AppDTO.
|
|
10497
10518
|
* @summary Create a public app
|
|
@@ -10499,7 +10520,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10499
10520
|
* @param {*} [options] Override http request option.
|
|
10500
10521
|
* @throws {RequiredError}
|
|
10501
10522
|
*/
|
|
10502
|
-
createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10523
|
+
createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10503
10524
|
/**
|
|
10504
10525
|
* Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company.
|
|
10505
10526
|
* @summary Delete a webhook for an app
|
|
@@ -10508,7 +10529,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10508
10529
|
* @param {*} [options] Override http request option.
|
|
10509
10530
|
* @throws {RequiredError}
|
|
10510
10531
|
*/
|
|
10511
|
-
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10532
|
+
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
10512
10533
|
/**
|
|
10513
10534
|
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
10514
10535
|
* @summary Delete a private app
|
|
@@ -10516,7 +10537,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10516
10537
|
* @param {*} [options] Override http request option.
|
|
10517
10538
|
* @throws {RequiredError}
|
|
10518
10539
|
*/
|
|
10519
|
-
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10540
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
10520
10541
|
/**
|
|
10521
10542
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10522
10543
|
* @summary Retrieve application details by UUID
|
|
@@ -10524,7 +10545,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10524
10545
|
* @param {*} [options] Override http request option.
|
|
10525
10546
|
* @throws {RequiredError}
|
|
10526
10547
|
*/
|
|
10527
|
-
getApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10548
|
+
getApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10528
10549
|
/**
|
|
10529
10550
|
* Fetches a single webhook that belongs to the specified app.
|
|
10530
10551
|
* @summary Get a webhook for an app
|
|
@@ -10533,7 +10554,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10533
10554
|
* @param {*} [options] Override http request option.
|
|
10534
10555
|
* @throws {RequiredError}
|
|
10535
10556
|
*/
|
|
10536
|
-
getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10557
|
+
getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSubscribeWebhookDTO, any, {}>>;
|
|
10537
10558
|
/**
|
|
10538
10559
|
* Returns the latest match, suppression, and delivery attempts for this webhook on this server. A selected-object topic records MATCHED. A different object records SUPPRESSED. A missing required setting records SKIPPED_MISSING_SETTING.
|
|
10539
10560
|
* @summary Recent webhook delivery decisions
|
|
@@ -10542,7 +10563,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10542
10563
|
* @param {*} [options] Override http request option.
|
|
10543
10564
|
* @throws {RequiredError}
|
|
10544
10565
|
*/
|
|
10545
|
-
getAppWebhookDeliveries(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10566
|
+
getAppWebhookDeliveries(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListEntry, any, {}>>;
|
|
10546
10567
|
/**
|
|
10547
10568
|
* Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company.
|
|
10548
10569
|
* @summary Retrieve a paginated list of webhooks for an app
|
|
@@ -10551,7 +10572,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10551
10572
|
* @param {*} [options] Override http request option.
|
|
10552
10573
|
* @throws {RequiredError}
|
|
10553
10574
|
*/
|
|
10554
|
-
getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10575
|
+
getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSubscribeWebhookDTO, any, {}>>;
|
|
10555
10576
|
/**
|
|
10556
10577
|
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
10557
10578
|
* @summary Retrieve a paginated list of applications
|
|
@@ -10563,7 +10584,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10563
10584
|
* @param {*} [options] Override http request option.
|
|
10564
10585
|
* @throws {RequiredError}
|
|
10565
10586
|
*/
|
|
10566
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10587
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10567
10588
|
/**
|
|
10568
10589
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10569
10590
|
* @summary Get current user\'s company information
|
|
@@ -10571,7 +10592,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10571
10592
|
* @param {*} [options] Override http request option.
|
|
10572
10593
|
* @throws {RequiredError}
|
|
10573
10594
|
*/
|
|
10574
|
-
getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10595
|
+
getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SimplePublicCompanyDTO, any, {}>>;
|
|
10575
10596
|
/**
|
|
10576
10597
|
* Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects.
|
|
10577
10598
|
* @summary Retrieve apps created by the logged-in user\'s selected company
|
|
@@ -10579,7 +10600,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10579
10600
|
* @param {*} [options] Override http request option.
|
|
10580
10601
|
* @throws {RequiredError}
|
|
10581
10602
|
*/
|
|
10582
|
-
getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10603
|
+
getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10583
10604
|
/**
|
|
10584
10605
|
* Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App.
|
|
10585
10606
|
* @summary Get a public app (creator view)
|
|
@@ -10587,7 +10608,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10587
10608
|
* @param {*} [options] Override http request option.
|
|
10588
10609
|
* @throws {RequiredError}
|
|
10589
10610
|
*/
|
|
10590
|
-
getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10611
|
+
getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10591
10612
|
/**
|
|
10592
10613
|
* Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function.
|
|
10593
10614
|
* @summary Get app runtime logs
|
|
@@ -10597,7 +10618,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10597
10618
|
* @param {*} [options] Override http request option.
|
|
10598
10619
|
* @throws {RequiredError}
|
|
10599
10620
|
*/
|
|
10600
|
-
getRuntimeLogs(appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10621
|
+
getRuntimeLogs(appUuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
10601
10622
|
/**
|
|
10602
10623
|
* Returns all supported record webhook events with their details.
|
|
10603
10624
|
* @summary Get available webhook record events
|
|
@@ -10605,7 +10626,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10605
10626
|
* @param {*} [options] Override http request option.
|
|
10606
10627
|
* @throws {RequiredError}
|
|
10607
10628
|
*/
|
|
10608
|
-
getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10629
|
+
getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10609
10630
|
[key: string]: any;
|
|
10610
10631
|
}[], any, {}>>;
|
|
10611
10632
|
/**
|
|
@@ -10615,7 +10636,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10615
10636
|
* @param {*} [options] Override http request option.
|
|
10616
10637
|
* @throws {RequiredError}
|
|
10617
10638
|
*/
|
|
10618
|
-
getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10639
|
+
getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10619
10640
|
[key: string]: any;
|
|
10620
10641
|
}[], any, {}>>;
|
|
10621
10642
|
/**
|
|
@@ -10626,7 +10647,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10626
10647
|
* @param {*} [options] Override http request option.
|
|
10627
10648
|
* @throws {RequiredError}
|
|
10628
10649
|
*/
|
|
10629
|
-
getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise<
|
|
10650
|
+
getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10630
10651
|
[key: string]: string;
|
|
10631
10652
|
}[], any, {}>>;
|
|
10632
10653
|
/**
|
|
@@ -10637,14 +10658,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10637
10658
|
* @param {*} [options] Override http request option.
|
|
10638
10659
|
* @throws {RequiredError}
|
|
10639
10660
|
*/
|
|
10640
|
-
installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10661
|
+
installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10641
10662
|
/**
|
|
10642
10663
|
* Returns the allowed category keys and labels for public app marketplace listings.
|
|
10643
10664
|
* @summary List predefined marketplace app categories
|
|
10644
10665
|
* @param {*} [options] Override http request option.
|
|
10645
10666
|
* @throws {RequiredError}
|
|
10646
10667
|
*/
|
|
10647
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<
|
|
10668
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10648
10669
|
/**
|
|
10649
10670
|
* Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
|
|
10650
10671
|
* @summary List available app categories
|
|
@@ -10653,7 +10674,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10653
10674
|
* @param {*} [options] Override http request option.
|
|
10654
10675
|
* @throws {RequiredError}
|
|
10655
10676
|
*/
|
|
10656
|
-
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10677
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10657
10678
|
/**
|
|
10658
10679
|
* Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
|
|
10659
10680
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10662,7 +10683,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10662
10683
|
* @param {*} [options] Override http request option.
|
|
10663
10684
|
* @throws {RequiredError}
|
|
10664
10685
|
*/
|
|
10665
|
-
loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10686
|
+
loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseLoadAppSettingOptionsResponse, any, {}>>;
|
|
10666
10687
|
/**
|
|
10667
10688
|
* Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY.
|
|
10668
10689
|
* @summary Migrate an app from platform V1 to V2
|
|
@@ -10671,7 +10692,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10671
10692
|
* @param {*} [options] Override http request option.
|
|
10672
10693
|
* @throws {RequiredError}
|
|
10673
10694
|
*/
|
|
10674
|
-
migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise<
|
|
10695
|
+
migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
10675
10696
|
/**
|
|
10676
10697
|
* Resumes future events for only the selected company and resets its failure counter.
|
|
10677
10698
|
* @summary Reactivate a company webhook
|
|
@@ -10680,7 +10701,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10680
10701
|
* @param {*} [options] Override http request option.
|
|
10681
10702
|
* @throws {RequiredError}
|
|
10682
10703
|
*/
|
|
10683
|
-
reactivateAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10704
|
+
reactivateAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSubscribeWebhookDTO, any, {}>>;
|
|
10684
10705
|
/**
|
|
10685
10706
|
* Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO.
|
|
10686
10707
|
* @summary Review a public app
|
|
@@ -10689,7 +10710,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10689
10710
|
* @param {*} [options] Override http request option.
|
|
10690
10711
|
* @throws {RequiredError}
|
|
10691
10712
|
*/
|
|
10692
|
-
reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10713
|
+
reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10693
10714
|
/**
|
|
10694
10715
|
* Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO.
|
|
10695
10716
|
* @summary Rotate application configurations
|
|
@@ -10697,7 +10718,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10697
10718
|
* @param {*} [options] Override http request option.
|
|
10698
10719
|
* @throws {RequiredError}
|
|
10699
10720
|
*/
|
|
10700
|
-
rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10721
|
+
rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10701
10722
|
/**
|
|
10702
10723
|
* Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect.
|
|
10703
10724
|
* @summary Stream app runtime logs (SSE)
|
|
@@ -10705,7 +10726,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10705
10726
|
* @param {*} [options] Override http request option.
|
|
10706
10727
|
* @throws {RequiredError}
|
|
10707
10728
|
*/
|
|
10708
|
-
streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10729
|
+
streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SseEmitter, any, {}>>;
|
|
10709
10730
|
/**
|
|
10710
10731
|
* Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO.
|
|
10711
10732
|
* @summary Submit a public app for review
|
|
@@ -10713,7 +10734,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10713
10734
|
* @param {*} [options] Override http request option.
|
|
10714
10735
|
* @throws {RequiredError}
|
|
10715
10736
|
*/
|
|
10716
|
-
submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10737
|
+
submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10717
10738
|
/**
|
|
10718
10739
|
* Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery.
|
|
10719
10740
|
* @summary Test a webhook for an app
|
|
@@ -10725,7 +10746,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10725
10746
|
* @param {*} [options] Override http request option.
|
|
10726
10747
|
* @throws {RequiredError}
|
|
10727
10748
|
*/
|
|
10728
|
-
testAppWebhook(appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10749
|
+
testAppWebhook(appUuid: string, webhookUuid: string, recordUuid: string, eventType: string, propertyName?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
10729
10750
|
/**
|
|
10730
10751
|
* Generates a test webhook payload using the latest matching record for the topic object. Form-submission topics prefer a record that submitted that form; includeRelations prefer a record that has as many of those related objects as possible. If no record exists, a simulated record is used. Missing includeRelations and simulated samples are explained in context.testNote and the X-Webhook-Test-Note header. Uses the event type from the webhook topic (updated when the topic action is all).
|
|
10731
10752
|
* @summary Test a webhook for an app (auto-resolve)
|
|
@@ -10734,7 +10755,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10734
10755
|
* @param {*} [options] Override http request option.
|
|
10735
10756
|
* @throws {RequiredError}
|
|
10736
10757
|
*/
|
|
10737
|
-
testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10758
|
+
testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
10738
10759
|
/**
|
|
10739
10760
|
* 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.
|
|
10740
10761
|
* @summary Test an unsaved webhook for an app
|
|
@@ -10743,7 +10764,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10743
10764
|
* @param {*} [options] Override http request option.
|
|
10744
10765
|
* @throws {RequiredError}
|
|
10745
10766
|
*/
|
|
10746
|
-
testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10767
|
+
testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
10747
10768
|
/**
|
|
10748
10769
|
* 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.
|
|
10749
10770
|
* @summary Uninstall an application
|
|
@@ -10752,7 +10773,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10752
10773
|
* @param {*} [options] Override http request option.
|
|
10753
10774
|
* @throws {RequiredError}
|
|
10754
10775
|
*/
|
|
10755
|
-
uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10776
|
+
uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10756
10777
|
/**
|
|
10757
10778
|
* Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company.
|
|
10758
10779
|
* @summary Update a webhook for an app
|
|
@@ -10762,7 +10783,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10762
10783
|
* @param {*} [options] Override http request option.
|
|
10763
10784
|
* @throws {RequiredError}
|
|
10764
10785
|
*/
|
|
10765
|
-
updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10786
|
+
updateAppWebhookForApp(appUuid: string, webhookUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10766
10787
|
/**
|
|
10767
10788
|
* 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.
|
|
10768
10789
|
* @summary Update a public app (creator edit)
|
|
@@ -10771,7 +10792,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10771
10792
|
* @param {*} [options] Override http request option.
|
|
10772
10793
|
* @throws {RequiredError}
|
|
10773
10794
|
*/
|
|
10774
|
-
updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10795
|
+
updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10775
10796
|
}
|
|
10776
10797
|
/**
|
|
10777
10798
|
* AutomationsApi - axios parameter creator
|
|
@@ -10819,7 +10840,7 @@ export declare class AutomationsApi extends BaseAPI {
|
|
|
10819
10840
|
* @param {*} [options] Override http request option.
|
|
10820
10841
|
* @throws {RequiredError}
|
|
10821
10842
|
*/
|
|
10822
|
-
getToken(options?: RawAxiosRequestConfig): Promise<
|
|
10843
|
+
getToken(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
10823
10844
|
}
|
|
10824
10845
|
/**
|
|
10825
10846
|
* BillingApi - axios parameter creator
|
|
@@ -10888,14 +10909,14 @@ export declare class BillingApi extends BaseAPI {
|
|
|
10888
10909
|
* @param {*} [options] Override http request option.
|
|
10889
10910
|
* @throws {RequiredError}
|
|
10890
10911
|
*/
|
|
10891
|
-
getStatus(options?: RawAxiosRequestConfig): Promise<
|
|
10912
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseBillingStatusDTO, any, {}>>;
|
|
10892
10913
|
/**
|
|
10893
10914
|
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10894
10915
|
* @summary Send billing setup email
|
|
10895
10916
|
* @param {*} [options] Override http request option.
|
|
10896
10917
|
* @throws {RequiredError}
|
|
10897
10918
|
*/
|
|
10898
|
-
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<
|
|
10919
|
+
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
|
|
10899
10920
|
}
|
|
10900
10921
|
/**
|
|
10901
10922
|
* CMSModulesApi - axios parameter creator
|
|
@@ -11013,7 +11034,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11013
11034
|
* @param {*} [options] Override http request option.
|
|
11014
11035
|
* @throws {RequiredError}
|
|
11015
11036
|
*/
|
|
11016
|
-
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11037
|
+
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11017
11038
|
/**
|
|
11018
11039
|
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
11019
11040
|
* @summary Publish an app\'s CMS module package
|
|
@@ -11024,7 +11045,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11024
11045
|
*/
|
|
11025
11046
|
publishPackage(appUuid: string, requestBody: {
|
|
11026
11047
|
[key: string]: any | null;
|
|
11027
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
11048
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11028
11049
|
/**
|
|
11029
11050
|
* 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.
|
|
11030
11051
|
* @summary Replace an app\'s CMS module catalog
|
|
@@ -11035,7 +11056,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11035
11056
|
*/
|
|
11036
11057
|
upsert(appUuid: string, requestBody: {
|
|
11037
11058
|
[key: string]: any | null;
|
|
11038
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
11059
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11039
11060
|
}
|
|
11040
11061
|
/**
|
|
11041
11062
|
* CMSV2EnvironmentsApi - axios parameter creator
|
|
@@ -11237,7 +11258,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11237
11258
|
* @param {*} [options] Override http request option.
|
|
11238
11259
|
* @throws {RequiredError}
|
|
11239
11260
|
*/
|
|
11240
|
-
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
11261
|
+
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
11241
11262
|
/**
|
|
11242
11263
|
*
|
|
11243
11264
|
* @summary Delete an environment except main
|
|
@@ -11245,7 +11266,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11245
11266
|
* @param {*} [options] Override http request option.
|
|
11246
11267
|
* @throws {RequiredError}
|
|
11247
11268
|
*/
|
|
11248
|
-
delete1(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
11269
|
+
delete1(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11249
11270
|
/**
|
|
11250
11271
|
*
|
|
11251
11272
|
* @summary Translation group for a record
|
|
@@ -11253,7 +11274,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11253
11274
|
* @param {*} [options] Override http request option.
|
|
11254
11275
|
* @throws {RequiredError}
|
|
11255
11276
|
*/
|
|
11256
|
-
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11277
|
+
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11257
11278
|
/**
|
|
11258
11279
|
*
|
|
11259
11280
|
* @summary Link two records as translations
|
|
@@ -11262,14 +11283,14 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11262
11283
|
* @param {*} [options] Override http request option.
|
|
11263
11284
|
* @throws {RequiredError}
|
|
11264
11285
|
*/
|
|
11265
|
-
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11286
|
+
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11266
11287
|
/**
|
|
11267
11288
|
*
|
|
11268
11289
|
* @summary List company environments
|
|
11269
11290
|
* @param {*} [options] Override http request option.
|
|
11270
11291
|
* @throws {RequiredError}
|
|
11271
11292
|
*/
|
|
11272
|
-
list2(options?: RawAxiosRequestConfig): Promise<
|
|
11293
|
+
list2(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsEnvironmentDTO, any, {}>>;
|
|
11273
11294
|
/**
|
|
11274
11295
|
*
|
|
11275
11296
|
* @summary Unlink a translation edge
|
|
@@ -11278,7 +11299,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11278
11299
|
* @param {*} [options] Override http request option.
|
|
11279
11300
|
* @throws {RequiredError}
|
|
11280
11301
|
*/
|
|
11281
|
-
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11302
|
+
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11282
11303
|
/**
|
|
11283
11304
|
*
|
|
11284
11305
|
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
@@ -11287,7 +11308,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11287
11308
|
* @param {*} [options] Override http request option.
|
|
11288
11309
|
* @throws {RequiredError}
|
|
11289
11310
|
*/
|
|
11290
|
-
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
11311
|
+
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
11291
11312
|
}
|
|
11292
11313
|
/**
|
|
11293
11314
|
* CMSV2PagesApi - axios parameter creator
|
|
@@ -11990,7 +12011,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
11990
12011
|
*/
|
|
11991
12012
|
aiRewrite(recordUuid: string, requestBody: {
|
|
11992
12013
|
[key: string]: any | null;
|
|
11993
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12014
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11994
12015
|
/**
|
|
11995
12016
|
*
|
|
11996
12017
|
* @summary Create a translated sibling page for an environment
|
|
@@ -11999,7 +12020,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
11999
12020
|
* @param {*} [options] Override http request option.
|
|
12000
12021
|
* @throws {RequiredError}
|
|
12001
12022
|
*/
|
|
12002
|
-
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12023
|
+
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12003
12024
|
/**
|
|
12004
12025
|
*
|
|
12005
12026
|
* @summary Discard a Modify-this-module playground session
|
|
@@ -12008,14 +12029,14 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12008
12029
|
* @param {*} [options] Override http request option.
|
|
12009
12030
|
* @throws {RequiredError}
|
|
12010
12031
|
*/
|
|
12011
|
-
discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<
|
|
12032
|
+
discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12012
12033
|
/**
|
|
12013
12034
|
* 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.
|
|
12014
12035
|
* @summary Create or reuse the custom 404 page
|
|
12015
12036
|
* @param {*} [options] Override http request option.
|
|
12016
12037
|
* @throws {RequiredError}
|
|
12017
12038
|
*/
|
|
12018
|
-
ensureNotFound(options?: RawAxiosRequestConfig): Promise<
|
|
12039
|
+
ensureNotFound(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12019
12040
|
/**
|
|
12020
12041
|
*
|
|
12021
12042
|
* @summary Environment coverage for the builder dropdown
|
|
@@ -12023,7 +12044,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12023
12044
|
* @param {*} [options] Override http request option.
|
|
12024
12045
|
* @throws {RequiredError}
|
|
12025
12046
|
*/
|
|
12026
|
-
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12047
|
+
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12027
12048
|
/**
|
|
12028
12049
|
*
|
|
12029
12050
|
* @summary Load a page for the builder
|
|
@@ -12033,7 +12054,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12033
12054
|
* @param {*} [options] Override http request option.
|
|
12034
12055
|
* @throws {RequiredError}
|
|
12035
12056
|
*/
|
|
12036
|
-
get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12057
|
+
get(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12037
12058
|
/**
|
|
12038
12059
|
*
|
|
12039
12060
|
* @summary CMS v2 object template document
|
|
@@ -12042,7 +12063,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12042
12063
|
* @param {*} [options] Override http request option.
|
|
12043
12064
|
* @throws {RequiredError}
|
|
12044
12065
|
*/
|
|
12045
|
-
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12066
|
+
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
|
|
12046
12067
|
/**
|
|
12047
12068
|
*
|
|
12048
12069
|
* @summary Draft snapshots for one locale
|
|
@@ -12051,7 +12072,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12051
12072
|
* @param {*} [options] Override http request option.
|
|
12052
12073
|
* @throws {RequiredError}
|
|
12053
12074
|
*/
|
|
12054
|
-
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12075
|
+
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListMapStringObject, any, {}>>;
|
|
12055
12076
|
/**
|
|
12056
12077
|
*
|
|
12057
12078
|
* @summary Host this page on another environment
|
|
@@ -12060,14 +12081,14 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12060
12081
|
* @param {*} [options] Override http request option.
|
|
12061
12082
|
* @throws {RequiredError}
|
|
12062
12083
|
*/
|
|
12063
|
-
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12084
|
+
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12064
12085
|
/**
|
|
12065
12086
|
* 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.
|
|
12066
12087
|
* @summary Modules available to this company
|
|
12067
12088
|
* @param {*} [options] Override http request option.
|
|
12068
12089
|
* @throws {RequiredError}
|
|
12069
12090
|
*/
|
|
12070
|
-
library(options?: RawAxiosRequestConfig): Promise<
|
|
12091
|
+
library(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
12071
12092
|
/**
|
|
12072
12093
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
12073
12094
|
* @summary Apply patches to a page draft
|
|
@@ -12076,7 +12097,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12076
12097
|
* @param {*} [options] Override http request option.
|
|
12077
12098
|
* @throws {RequiredError}
|
|
12078
12099
|
*/
|
|
12079
|
-
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12100
|
+
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12080
12101
|
/**
|
|
12081
12102
|
* 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.
|
|
12082
12103
|
* @summary Signed preview URL for the builder iframe
|
|
@@ -12086,7 +12107,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12086
12107
|
* @param {*} [options] Override http request option.
|
|
12087
12108
|
* @throws {RequiredError}
|
|
12088
12109
|
*/
|
|
12089
|
-
previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12110
|
+
previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12090
12111
|
/**
|
|
12091
12112
|
*
|
|
12092
12113
|
* @summary Rewrite forked module source from a prompt
|
|
@@ -12098,7 +12119,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12098
12119
|
*/
|
|
12099
12120
|
promptModuleFork(recordUuid: string, sessionId: string, requestBody: {
|
|
12100
12121
|
[key: string]: any | null;
|
|
12101
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12122
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12102
12123
|
/**
|
|
12103
12124
|
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
12104
12125
|
* @summary Publish one locale, or all of them
|
|
@@ -12108,7 +12129,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12108
12129
|
* @param {*} [options] Override http request option.
|
|
12109
12130
|
* @throws {RequiredError}
|
|
12110
12131
|
*/
|
|
12111
|
-
publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
12132
|
+
publish(recordUuid: string, locale?: string, allLocales?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsPageDTO, any, {}>>;
|
|
12112
12133
|
/**
|
|
12113
12134
|
*
|
|
12114
12135
|
* @summary Restore a draft snapshot
|
|
@@ -12118,7 +12139,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12118
12139
|
* @param {*} [options] Override http request option.
|
|
12119
12140
|
* @throws {RequiredError}
|
|
12120
12141
|
*/
|
|
12121
|
-
restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12142
|
+
restoreHistory(recordUuid: string, index: number, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12122
12143
|
/**
|
|
12123
12144
|
*
|
|
12124
12145
|
* @summary Replace a page draft
|
|
@@ -12128,7 +12149,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12128
12149
|
* @param {*} [options] Override http request option.
|
|
12129
12150
|
* @throws {RequiredError}
|
|
12130
12151
|
*/
|
|
12131
|
-
save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12152
|
+
save(recordUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12132
12153
|
/**
|
|
12133
12154
|
*
|
|
12134
12155
|
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
@@ -12140,7 +12161,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12140
12161
|
*/
|
|
12141
12162
|
saveMeta(recordUuid: string, requestBody: {
|
|
12142
12163
|
[key: string]: any | null;
|
|
12143
|
-
}, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12164
|
+
}, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12144
12165
|
/**
|
|
12145
12166
|
* Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
|
|
12146
12167
|
* @summary Publish the forked module into a private app
|
|
@@ -12152,7 +12173,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12152
12173
|
*/
|
|
12153
12174
|
saveModuleFork(recordUuid: string, sessionId: string, requestBody: {
|
|
12154
12175
|
[key: string]: any | null;
|
|
12155
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12176
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12156
12177
|
/**
|
|
12157
12178
|
*
|
|
12158
12179
|
* @summary Replace a CMS v2 object template
|
|
@@ -12162,7 +12183,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12162
12183
|
* @param {*} [options] Override http request option.
|
|
12163
12184
|
* @throws {RequiredError}
|
|
12164
12185
|
*/
|
|
12165
|
-
saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12186
|
+
saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
|
|
12166
12187
|
/**
|
|
12167
12188
|
* CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it.
|
|
12168
12189
|
* @summary Start a Modify-this-module playground session
|
|
@@ -12173,7 +12194,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12173
12194
|
*/
|
|
12174
12195
|
startModuleFork(recordUuid: string, requestBody: {
|
|
12175
12196
|
[key: string]: any | null;
|
|
12176
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12197
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12177
12198
|
/**
|
|
12178
12199
|
*
|
|
12179
12200
|
* @summary Take one locale offline
|
|
@@ -12182,7 +12203,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12182
12203
|
* @param {*} [options] Override http request option.
|
|
12183
12204
|
* @throws {RequiredError}
|
|
12184
12205
|
*/
|
|
12185
|
-
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12206
|
+
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12186
12207
|
/**
|
|
12187
12208
|
*
|
|
12188
12209
|
* @summary Remove an environment from this page only
|
|
@@ -12191,7 +12212,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12191
12212
|
* @param {*} [options] Override http request option.
|
|
12192
12213
|
* @throws {RequiredError}
|
|
12193
12214
|
*/
|
|
12194
|
-
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12215
|
+
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12195
12216
|
/**
|
|
12196
12217
|
* Writes test values into the playground session without changing the live page.
|
|
12197
12218
|
* @summary Preview field values on the forked module
|
|
@@ -12203,7 +12224,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12203
12224
|
*/
|
|
12204
12225
|
updateModuleForkFields(recordUuid: string, sessionId: string, requestBody: {
|
|
12205
12226
|
[key: string]: any | null;
|
|
12206
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12227
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12207
12228
|
}
|
|
12208
12229
|
/**
|
|
12209
12230
|
* CMSV2PublicApi - axios parameter creator
|
|
@@ -12667,7 +12688,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12667
12688
|
* @param {*} [options] Override http request option.
|
|
12668
12689
|
* @throws {RequiredError}
|
|
12669
12690
|
*/
|
|
12670
|
-
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<
|
|
12691
|
+
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12671
12692
|
/**
|
|
12672
12693
|
*
|
|
12673
12694
|
* @summary Redirect to a company file for the website runtime
|
|
@@ -12685,7 +12706,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12685
12706
|
* @param {*} [options] Override http request option.
|
|
12686
12707
|
* @throws {RequiredError}
|
|
12687
12708
|
*/
|
|
12688
|
-
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<
|
|
12709
|
+
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<globalAxios.AxiosResponse<void, any, {}>>;
|
|
12689
12710
|
/**
|
|
12690
12711
|
*
|
|
12691
12712
|
* @summary Installed apps and modules for a company\'s website build
|
|
@@ -12694,7 +12715,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12694
12715
|
* @param {*} [options] Override http request option.
|
|
12695
12716
|
* @throws {RequiredError}
|
|
12696
12717
|
*/
|
|
12697
|
-
buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12718
|
+
buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12698
12719
|
/**
|
|
12699
12720
|
*
|
|
12700
12721
|
* @summary Navigation menus for the header and footer
|
|
@@ -12704,7 +12725,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12704
12725
|
* @param {*} [options] Override http request option.
|
|
12705
12726
|
* @throws {RequiredError}
|
|
12706
12727
|
*/
|
|
12707
|
-
menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12728
|
+
menus(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsPublicMenuDTO, any, {}>>;
|
|
12708
12729
|
/**
|
|
12709
12730
|
*
|
|
12710
12731
|
* @summary A published page by URL path
|
|
@@ -12719,7 +12740,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12719
12740
|
* @param {*} [options] Override http request option.
|
|
12720
12741
|
* @throws {RequiredError}
|
|
12721
12742
|
*/
|
|
12722
|
-
pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12743
|
+
pageByPath(xCaraerSubdomain: string, path: string, xCaraerWebpageAccess?: string, authorization?: string, environment?: string, locale?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12723
12744
|
/**
|
|
12724
12745
|
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
12725
12746
|
* @summary A page by record uuid
|
|
@@ -12737,7 +12758,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12737
12758
|
* @param {*} [options] Override http request option.
|
|
12738
12759
|
* @throws {RequiredError}
|
|
12739
12760
|
*/
|
|
12740
|
-
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<
|
|
12761
|
+
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<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12741
12762
|
/**
|
|
12742
12763
|
*
|
|
12743
12764
|
* @summary Protection info for a path, without the page document
|
|
@@ -12748,7 +12769,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12748
12769
|
* @param {*} [options] Override http request option.
|
|
12749
12770
|
* @throws {RequiredError}
|
|
12750
12771
|
*/
|
|
12751
|
-
pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12772
|
+
pageGate(xCaraerSubdomain: string, path: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12752
12773
|
/**
|
|
12753
12774
|
*
|
|
12754
12775
|
* @summary Published paths per environment, for sitemaps and cache warming
|
|
@@ -12758,7 +12779,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12758
12779
|
* @param {*} [options] Override http request option.
|
|
12759
12780
|
* @throws {RequiredError}
|
|
12760
12781
|
*/
|
|
12761
|
-
paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12782
|
+
paths(xCaraerSubdomain: string, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListMapStringObject, any, {}>>;
|
|
12762
12783
|
/**
|
|
12763
12784
|
*
|
|
12764
12785
|
* @summary Public records visible in an environment
|
|
@@ -12771,7 +12792,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12771
12792
|
*/
|
|
12772
12793
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12773
12794
|
[key: string]: any | null;
|
|
12774
|
-
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12795
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12775
12796
|
/**
|
|
12776
12797
|
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12777
12798
|
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
@@ -12781,7 +12802,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12781
12802
|
* @param {*} [options] Override http request option.
|
|
12782
12803
|
* @throws {RequiredError}
|
|
12783
12804
|
*/
|
|
12784
|
-
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12805
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
12785
12806
|
/**
|
|
12786
12807
|
*
|
|
12787
12808
|
* @summary Company settings, branding and locales
|
|
@@ -12789,7 +12810,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12789
12810
|
* @param {*} [options] Override http request option.
|
|
12790
12811
|
* @throws {RequiredError}
|
|
12791
12812
|
*/
|
|
12792
|
-
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<
|
|
12813
|
+
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12793
12814
|
/**
|
|
12794
12815
|
*
|
|
12795
12816
|
* @summary Unlock a password-protected CMS v2 page
|
|
@@ -12803,7 +12824,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12803
12824
|
*/
|
|
12804
12825
|
unlock(xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
12805
12826
|
[key: string]: string;
|
|
12806
|
-
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12827
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
12807
12828
|
}
|
|
12808
12829
|
/**
|
|
12809
12830
|
* CMSV2TransferApi - axios parameter creator
|
|
@@ -12939,7 +12960,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12939
12960
|
*/
|
|
12940
12961
|
attach(companyUuid: string, requestBody: {
|
|
12941
12962
|
[key: string]: string;
|
|
12942
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12963
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12943
12964
|
/**
|
|
12944
12965
|
*
|
|
12945
12966
|
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
@@ -12947,7 +12968,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12947
12968
|
* @param {*} [options] Override http request option.
|
|
12948
12969
|
* @throws {RequiredError}
|
|
12949
12970
|
*/
|
|
12950
|
-
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12971
|
+
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12951
12972
|
/**
|
|
12952
12973
|
*
|
|
12953
12974
|
* @summary Restore the live hostname to the stored v1 project
|
|
@@ -12955,7 +12976,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12955
12976
|
* @param {*} [options] Override http request option.
|
|
12956
12977
|
* @throws {RequiredError}
|
|
12957
12978
|
*/
|
|
12958
|
-
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12979
|
+
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12959
12980
|
/**
|
|
12960
12981
|
*
|
|
12961
12982
|
* @summary Transfer status for one company
|
|
@@ -12963,7 +12984,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12963
12984
|
* @param {*} [options] Override http request option.
|
|
12964
12985
|
* @throws {RequiredError}
|
|
12965
12986
|
*/
|
|
12966
|
-
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12987
|
+
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12967
12988
|
}
|
|
12968
12989
|
/**
|
|
12969
12990
|
* CMSWebsiteUpdatesApi - axios parameter creator
|
|
@@ -13062,14 +13083,14 @@ export declare class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
|
13062
13083
|
* @param {*} [options] Override http request option.
|
|
13063
13084
|
* @throws {RequiredError}
|
|
13064
13085
|
*/
|
|
13065
|
-
pending(options?: RawAxiosRequestConfig): Promise<
|
|
13086
|
+
pending(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13066
13087
|
/**
|
|
13067
13088
|
*
|
|
13068
13089
|
* @summary Build a preview site with every pending module update
|
|
13069
13090
|
* @param {*} [options] Override http request option.
|
|
13070
13091
|
* @throws {RequiredError}
|
|
13071
13092
|
*/
|
|
13072
|
-
preview(options?: RawAxiosRequestConfig): Promise<
|
|
13093
|
+
preview(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13073
13094
|
/**
|
|
13074
13095
|
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
13075
13096
|
* @summary Promote a previewed module set to production
|
|
@@ -13079,7 +13100,7 @@ export declare class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
|
13079
13100
|
*/
|
|
13080
13101
|
promote(requestBody?: {
|
|
13081
13102
|
[key: string]: any | null;
|
|
13082
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
13103
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13083
13104
|
}
|
|
13084
13105
|
/**
|
|
13085
13106
|
* CalendarsApi - axios parameter creator
|
|
@@ -13193,7 +13214,7 @@ export declare class CalendarsApi extends BaseAPI {
|
|
|
13193
13214
|
* @param {*} [options] Override http request option.
|
|
13194
13215
|
* @throws {RequiredError}
|
|
13195
13216
|
*/
|
|
13196
|
-
bootstrap(options?: RawAxiosRequestConfig): Promise<
|
|
13217
|
+
bootstrap(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCalendarBootstrapDTO, any, {}>>;
|
|
13197
13218
|
/**
|
|
13198
13219
|
*
|
|
13199
13220
|
* @summary Create a calendar owned by the current user
|
|
@@ -13201,21 +13222,21 @@ export declare class CalendarsApi extends BaseAPI {
|
|
|
13201
13222
|
* @param {*} [options] Override http request option.
|
|
13202
13223
|
* @throws {RequiredError}
|
|
13203
13224
|
*/
|
|
13204
|
-
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13225
|
+
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseCalendarRecordDTO, any, {}>>;
|
|
13205
13226
|
/**
|
|
13206
13227
|
*
|
|
13207
13228
|
* @summary List calendars visible to the current company
|
|
13208
13229
|
* @param {*} [options] Override http request option.
|
|
13209
13230
|
* @throws {RequiredError}
|
|
13210
13231
|
*/
|
|
13211
|
-
list3(options?: RawAxiosRequestConfig): Promise<
|
|
13232
|
+
list3(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCalendarRecordDTO, any, {}>>;
|
|
13212
13233
|
/**
|
|
13213
13234
|
*
|
|
13214
13235
|
* @summary List teams that can be linked to a calendar
|
|
13215
13236
|
* @param {*} [options] Override http request option.
|
|
13216
13237
|
* @throws {RequiredError}
|
|
13217
13238
|
*/
|
|
13218
|
-
listTeams(options?: RawAxiosRequestConfig): Promise<
|
|
13239
|
+
listTeams(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCalendarTeamOptionDTO, any, {}>>;
|
|
13219
13240
|
}
|
|
13220
13241
|
/**
|
|
13221
13242
|
* CompanyApi - axios parameter creator
|
|
@@ -13549,14 +13570,14 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13549
13570
|
* @param {*} [options] Override http request option.
|
|
13550
13571
|
* @throws {RequiredError}
|
|
13551
13572
|
*/
|
|
13552
|
-
createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13573
|
+
createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCompanyDTO, any, {}>>;
|
|
13553
13574
|
/**
|
|
13554
13575
|
* Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope.
|
|
13555
13576
|
* @summary Get current company
|
|
13556
13577
|
* @param {*} [options] Override http request option.
|
|
13557
13578
|
* @throws {RequiredError}
|
|
13558
13579
|
*/
|
|
13559
|
-
getCompany(options?: RawAxiosRequestConfig): Promise<
|
|
13580
|
+
getCompany(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
13560
13581
|
/**
|
|
13561
13582
|
* Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope.
|
|
13562
13583
|
* @summary Get company by UUID
|
|
@@ -13564,14 +13585,14 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13564
13585
|
* @param {*} [options] Override http request option.
|
|
13565
13586
|
* @throws {RequiredError}
|
|
13566
13587
|
*/
|
|
13567
|
-
getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13588
|
+
getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
13568
13589
|
/**
|
|
13569
13590
|
* Returns the digital identity (branding) for the company currently selected by the logged-in user.
|
|
13570
13591
|
* @summary Get digital identity
|
|
13571
13592
|
* @param {*} [options] Override http request option.
|
|
13572
13593
|
* @throws {RequiredError}
|
|
13573
13594
|
*/
|
|
13574
|
-
getDigitalIdentity(options?: RawAxiosRequestConfig): Promise<
|
|
13595
|
+
getDigitalIdentity(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseDigitalIdentityDTO, any, {}>>;
|
|
13575
13596
|
/**
|
|
13576
13597
|
* Returns the home analytics dashboard for a suite. Empty dashboard when none is saved.
|
|
13577
13598
|
* @summary Get suite dashboard
|
|
@@ -13579,21 +13600,21 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13579
13600
|
* @param {*} [options] Override http request option.
|
|
13580
13601
|
* @throws {RequiredError}
|
|
13581
13602
|
*/
|
|
13582
|
-
getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise<
|
|
13603
|
+
getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAnalyticsDashboardConfig, any, {}>>;
|
|
13583
13604
|
/**
|
|
13584
13605
|
* Returns all home analytics dashboards keyed by suite name for the selected company.
|
|
13585
13606
|
* @summary List suite dashboards
|
|
13586
13607
|
* @param {*} [options] Override http request option.
|
|
13587
13608
|
* @throws {RequiredError}
|
|
13588
13609
|
*/
|
|
13589
|
-
getSuiteDashboards(options?: RawAxiosRequestConfig): Promise<
|
|
13610
|
+
getSuiteDashboards(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringAnalyticsDashboardConfig, any, {}>>;
|
|
13590
13611
|
/**
|
|
13591
13612
|
* Returns the website settings for the company currently selected by the logged-in user.
|
|
13592
13613
|
* @summary Get website settings
|
|
13593
13614
|
* @param {*} [options] Override http request option.
|
|
13594
13615
|
* @throws {RequiredError}
|
|
13595
13616
|
*/
|
|
13596
|
-
getWebsiteSettings(options?: RawAxiosRequestConfig): Promise<
|
|
13617
|
+
getWebsiteSettings(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebsiteSettingsDTO, any, {}>>;
|
|
13597
13618
|
/**
|
|
13598
13619
|
* Clears the per-company webhook circuit breaker so outbound deliveries resume immediately.
|
|
13599
13620
|
* @summary Resume webhook dispatch
|
|
@@ -13601,7 +13622,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13601
13622
|
* @param {*} [options] Override http request option.
|
|
13602
13623
|
* @throws {RequiredError}
|
|
13603
13624
|
*/
|
|
13604
|
-
resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13625
|
+
resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
13605
13626
|
/**
|
|
13606
13627
|
* Updates a company by UUID. Request body should contain the company fields to update.
|
|
13607
13628
|
* @summary Update company
|
|
@@ -13610,7 +13631,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13610
13631
|
* @param {*} [options] Override http request option.
|
|
13611
13632
|
* @throws {RequiredError}
|
|
13612
13633
|
*/
|
|
13613
|
-
updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13634
|
+
updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13614
13635
|
/**
|
|
13615
13636
|
* Updates the digital identity (branding) for the company currently selected by the logged-in user.
|
|
13616
13637
|
* @summary Update digital identity
|
|
@@ -13618,7 +13639,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13618
13639
|
* @param {*} [options] Override http request option.
|
|
13619
13640
|
* @throws {RequiredError}
|
|
13620
13641
|
*/
|
|
13621
|
-
updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13642
|
+
updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13622
13643
|
/**
|
|
13623
13644
|
* Creates or replaces the home analytics dashboard for a suite.
|
|
13624
13645
|
* @summary Update suite dashboard
|
|
@@ -13627,7 +13648,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13627
13648
|
* @param {*} [options] Override http request option.
|
|
13628
13649
|
* @throws {RequiredError}
|
|
13629
13650
|
*/
|
|
13630
|
-
updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise<
|
|
13651
|
+
updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13631
13652
|
/**
|
|
13632
13653
|
* Updates the website settings for the company currently selected by the logged-in user.
|
|
13633
13654
|
* @summary Update website settings
|
|
@@ -13635,7 +13656,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13635
13656
|
* @param {*} [options] Override http request option.
|
|
13636
13657
|
* @throws {RequiredError}
|
|
13637
13658
|
*/
|
|
13638
|
-
updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13659
|
+
updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13639
13660
|
/**
|
|
13640
13661
|
* Uploads a font file to S3 storage and returns the public URL.
|
|
13641
13662
|
* @summary Upload a font file
|
|
@@ -13643,7 +13664,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13643
13664
|
* @param {*} [options] Override http request option.
|
|
13644
13665
|
* @throws {RequiredError}
|
|
13645
13666
|
*/
|
|
13646
|
-
uploadFont(file: File, options?: RawAxiosRequestConfig): Promise<
|
|
13667
|
+
uploadFont(file: File, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
13647
13668
|
}
|
|
13648
13669
|
/**
|
|
13649
13670
|
* DeveloperProjectsApi - axios parameter creator
|
|
@@ -13875,7 +13896,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13875
13896
|
* @param {*} [options] Override http request option.
|
|
13876
13897
|
* @throws {RequiredError}
|
|
13877
13898
|
*/
|
|
13878
|
-
create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13899
|
+
create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
13879
13900
|
/**
|
|
13880
13901
|
* Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build.
|
|
13881
13902
|
* @summary Upload a project build
|
|
@@ -13884,7 +13905,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13884
13905
|
* @param {*} [options] Override http request option.
|
|
13885
13906
|
* @throws {RequiredError}
|
|
13886
13907
|
*/
|
|
13887
|
-
createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13908
|
+
createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
13888
13909
|
/**
|
|
13889
13910
|
* Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive.
|
|
13890
13911
|
* @summary Deploy a project build
|
|
@@ -13894,7 +13915,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13894
13915
|
* @param {*} [options] Override http request option.
|
|
13895
13916
|
* @throws {RequiredError}
|
|
13896
13917
|
*/
|
|
13897
|
-
deploy(projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13918
|
+
deploy(projectUuid: string, buildUuid: string, deployBuildRequest?: DeployBuildRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
13898
13919
|
/**
|
|
13899
13920
|
* Returns the zip of the build currently deployed for this project. That archive is the source of truth for functions and CMS modules.
|
|
13900
13921
|
* @summary Download the deployed project source
|
|
@@ -13902,7 +13923,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13902
13923
|
* @param {*} [options] Override http request option.
|
|
13903
13924
|
* @throws {RequiredError}
|
|
13904
13925
|
*/
|
|
13905
|
-
deployedSource(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13926
|
+
deployedSource(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
13906
13927
|
/**
|
|
13907
13928
|
*
|
|
13908
13929
|
* @summary Get a project build
|
|
@@ -13911,7 +13932,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13911
13932
|
* @param {*} [options] Override http request option.
|
|
13912
13933
|
* @throws {RequiredError}
|
|
13913
13934
|
*/
|
|
13914
|
-
getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13935
|
+
getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
13915
13936
|
/**
|
|
13916
13937
|
*
|
|
13917
13938
|
* @summary List project builds
|
|
@@ -13919,7 +13940,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13919
13940
|
* @param {*} [options] Override http request option.
|
|
13920
13941
|
* @throws {RequiredError}
|
|
13921
13942
|
*/
|
|
13922
|
-
listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13943
|
+
listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListProjectBuildDTO, any, {}>>;
|
|
13923
13944
|
/**
|
|
13924
13945
|
*
|
|
13925
13946
|
* @summary List project deploys
|
|
@@ -13927,7 +13948,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13927
13948
|
* @param {*} [options] Override http request option.
|
|
13928
13949
|
* @throws {RequiredError}
|
|
13929
13950
|
*/
|
|
13930
|
-
listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13951
|
+
listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListProjectDeployDTO, any, {}>>;
|
|
13931
13952
|
/**
|
|
13932
13953
|
*
|
|
13933
13954
|
* @summary Get a developer project
|
|
@@ -13935,7 +13956,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13935
13956
|
* @param {*} [options] Override http request option.
|
|
13936
13957
|
* @throws {RequiredError}
|
|
13937
13958
|
*/
|
|
13938
|
-
show3(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13959
|
+
show3(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseDeveloperProjectDTO, any, {}>>;
|
|
13939
13960
|
}
|
|
13940
13961
|
/**
|
|
13941
13962
|
* DeveloperSandboxesApi - axios parameter creator
|
|
@@ -14032,14 +14053,14 @@ export declare class DeveloperSandboxesApi extends BaseAPI {
|
|
|
14032
14053
|
* @param {*} [options] Override http request option.
|
|
14033
14054
|
* @throws {RequiredError}
|
|
14034
14055
|
*/
|
|
14035
|
-
create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14056
|
+
create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14036
14057
|
/**
|
|
14037
14058
|
* Lists sandboxes owned by the caller\'s selected company.
|
|
14038
14059
|
* @summary List developer sandboxes
|
|
14039
14060
|
* @param {*} [options] Override http request option.
|
|
14040
14061
|
* @throws {RequiredError}
|
|
14041
14062
|
*/
|
|
14042
|
-
list1(options?: RawAxiosRequestConfig): Promise<
|
|
14063
|
+
list1(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListDeveloperSandboxDTO, any, {}>>;
|
|
14043
14064
|
/**
|
|
14044
14065
|
*
|
|
14045
14066
|
* @summary Get a developer sandbox
|
|
@@ -14047,7 +14068,7 @@ export declare class DeveloperSandboxesApi extends BaseAPI {
|
|
|
14047
14068
|
* @param {*} [options] Override http request option.
|
|
14048
14069
|
* @throws {RequiredError}
|
|
14049
14070
|
*/
|
|
14050
|
-
show2(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14071
|
+
show2(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
14051
14072
|
}
|
|
14052
14073
|
/**
|
|
14053
14074
|
* FeedsApi - axios parameter creator
|
|
@@ -14099,7 +14120,7 @@ export declare class FeedsApi extends BaseAPI {
|
|
|
14099
14120
|
* @param {*} [options] Override http request option.
|
|
14100
14121
|
* @throws {RequiredError}
|
|
14101
14122
|
*/
|
|
14102
|
-
index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14123
|
+
index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFeedDTO, any, {}>>;
|
|
14103
14124
|
}
|
|
14104
14125
|
/**
|
|
14105
14126
|
* FileManagementApi - axios parameter creator
|
|
@@ -14253,7 +14274,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14253
14274
|
* @param {*} [options] Override http request option.
|
|
14254
14275
|
* @throws {RequiredError}
|
|
14255
14276
|
*/
|
|
14256
|
-
deleteFile(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
14277
|
+
deleteFile(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
14257
14278
|
/**
|
|
14258
14279
|
* Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters.
|
|
14259
14280
|
* @summary Download file
|
|
@@ -14263,7 +14284,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14263
14284
|
* @param {*} [options] Override http request option.
|
|
14264
14285
|
* @throws {RequiredError}
|
|
14265
14286
|
*/
|
|
14266
|
-
downloadFile(key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
14287
|
+
downloadFile(key: string, expireAfter?: number, download?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
14267
14288
|
/**
|
|
14268
14289
|
* Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record.
|
|
14269
14290
|
* @summary List files
|
|
@@ -14271,7 +14292,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14271
14292
|
* @param {*} [options] Override http request option.
|
|
14272
14293
|
* @throws {RequiredError}
|
|
14273
14294
|
*/
|
|
14274
|
-
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14295
|
+
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
14275
14296
|
/**
|
|
14276
14297
|
*
|
|
14277
14298
|
* @summary List company files with metadata for the media library
|
|
@@ -14279,7 +14300,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14279
14300
|
* @param {*} [options] Override http request option.
|
|
14280
14301
|
* @throws {RequiredError}
|
|
14281
14302
|
*/
|
|
14282
|
-
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14303
|
+
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListFileListItemDTO, any, {}>>;
|
|
14283
14304
|
/**
|
|
14284
14305
|
* 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.
|
|
14285
14306
|
* @summary Upload files
|
|
@@ -14287,7 +14308,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14287
14308
|
* @param {*} [options] Override http request option.
|
|
14288
14309
|
* @throws {RequiredError}
|
|
14289
14310
|
*/
|
|
14290
|
-
uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14311
|
+
uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
14291
14312
|
}
|
|
14292
14313
|
/**
|
|
14293
14314
|
* FilterApi - axios parameter creator
|
|
@@ -14441,7 +14462,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14441
14462
|
* @param {*} [options] Override http request option.
|
|
14442
14463
|
* @throws {RequiredError}
|
|
14443
14464
|
*/
|
|
14444
|
-
createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14465
|
+
createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14445
14466
|
/**
|
|
14446
14467
|
* Soft deletes a saved filter identified by its UUID.
|
|
14447
14468
|
* @summary Delete a saved filter
|
|
@@ -14449,7 +14470,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14449
14470
|
* @param {*} [options] Override http request option.
|
|
14450
14471
|
* @throws {RequiredError}
|
|
14451
14472
|
*/
|
|
14452
|
-
deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14473
|
+
deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
14453
14474
|
/**
|
|
14454
14475
|
* Retrieves details of a saved filter by its UUID.
|
|
14455
14476
|
* @summary Fetch a specific saved filter
|
|
@@ -14457,7 +14478,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14457
14478
|
* @param {*} [options] Override http request option.
|
|
14458
14479
|
* @throws {RequiredError}
|
|
14459
14480
|
*/
|
|
14460
|
-
getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14481
|
+
getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSavedFilterDTO, any, {}>>;
|
|
14461
14482
|
/**
|
|
14462
14483
|
* Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort.
|
|
14463
14484
|
* @summary Fetch paginated saved filters
|
|
@@ -14466,7 +14487,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14466
14487
|
* @param {*} [options] Override http request option.
|
|
14467
14488
|
* @throws {RequiredError}
|
|
14468
14489
|
*/
|
|
14469
|
-
getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14490
|
+
getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSavedFilterDTO, any, {}>>;
|
|
14470
14491
|
/**
|
|
14471
14492
|
* Updates an existing saved filter identified by its UUID.
|
|
14472
14493
|
* @summary Update an existing saved filter
|
|
@@ -14475,7 +14496,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14475
14496
|
* @param {*} [options] Override http request option.
|
|
14476
14497
|
* @throws {RequiredError}
|
|
14477
14498
|
*/
|
|
14478
|
-
updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14499
|
+
updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
14479
14500
|
}
|
|
14480
14501
|
/**
|
|
14481
14502
|
* FormsApi - axios parameter creator
|
|
@@ -14911,7 +14932,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14911
14932
|
* @param {*} [options] Override http request option.
|
|
14912
14933
|
* @throws {RequiredError}
|
|
14913
14934
|
*/
|
|
14914
|
-
chatField(companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14935
|
+
chatField(companyUuid: string, fieldUuid: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
14915
14936
|
/**
|
|
14916
14937
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14917
14938
|
* @summary AI form step (public)
|
|
@@ -14922,7 +14943,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14922
14943
|
* @param {*} [options] Override http request option.
|
|
14923
14944
|
* @throws {RequiredError}
|
|
14924
14945
|
*/
|
|
14925
|
-
chatStep(companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14946
|
+
chatStep(companyUuid: string, stepTitle: string, prompt: string, formWithAiPromptDTO: FormWithAiPromptDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
14926
14947
|
/**
|
|
14927
14948
|
* Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced.
|
|
14928
14949
|
* @summary Create a new form
|
|
@@ -14930,7 +14951,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14930
14951
|
* @param {*} [options] Override http request option.
|
|
14931
14952
|
* @throws {RequiredError}
|
|
14932
14953
|
*/
|
|
14933
|
-
createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14954
|
+
createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14934
14955
|
/**
|
|
14935
14956
|
* Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse.
|
|
14936
14957
|
* @summary Delete a form
|
|
@@ -14938,7 +14959,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14938
14959
|
* @param {*} [options] Override http request option.
|
|
14939
14960
|
* @throws {RequiredError}
|
|
14940
14961
|
*/
|
|
14941
|
-
deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14962
|
+
deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
14942
14963
|
/**
|
|
14943
14964
|
* Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse.
|
|
14944
14965
|
* @summary Get form by UUID
|
|
@@ -14946,7 +14967,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14946
14967
|
* @param {*} [options] Override http request option.
|
|
14947
14968
|
* @throws {RequiredError}
|
|
14948
14969
|
*/
|
|
14949
|
-
getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14970
|
+
getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseFormDTO, any, {}>>;
|
|
14950
14971
|
/**
|
|
14951
14972
|
* Retrieves a specific form by its UUID. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14952
14973
|
* @summary Get form by UUID
|
|
@@ -14955,7 +14976,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14955
14976
|
* @param {*} [options] Override http request option.
|
|
14956
14977
|
* @throws {RequiredError}
|
|
14957
14978
|
*/
|
|
14958
|
-
getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14979
|
+
getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePublicFormDTO, any, {}>>;
|
|
14959
14980
|
/**
|
|
14960
14981
|
* Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data.
|
|
14961
14982
|
* @summary Get paginated list of forms
|
|
@@ -14963,7 +14984,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14963
14984
|
* @param {*} [options] Override http request option.
|
|
14964
14985
|
* @throws {RequiredError}
|
|
14965
14986
|
*/
|
|
14966
|
-
getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14987
|
+
getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFormDTO, any, {}>>;
|
|
14967
14988
|
/**
|
|
14968
14989
|
* Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object.
|
|
14969
14990
|
* @summary Get forms by object UUID
|
|
@@ -14972,7 +14993,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14972
14993
|
* @param {*} [options] Override http request option.
|
|
14973
14994
|
* @throws {RequiredError}
|
|
14974
14995
|
*/
|
|
14975
|
-
getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14996
|
+
getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFormDTO, any, {}>>;
|
|
14976
14997
|
/**
|
|
14977
14998
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14978
14999
|
* @summary Get all forms for a company
|
|
@@ -14981,14 +15002,14 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14981
15002
|
* @param {*} [options] Override http request option.
|
|
14982
15003
|
* @throws {RequiredError}
|
|
14983
15004
|
*/
|
|
14984
|
-
getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15005
|
+
getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePublicFormDTO, any, {}>>;
|
|
14985
15006
|
/**
|
|
14986
15007
|
* Returns distinct custom objects that have at least one non-deleted form, ordered by object index.
|
|
14987
15008
|
* @summary List objects that have forms
|
|
14988
15009
|
* @param {*} [options] Override http request option.
|
|
14989
15010
|
* @throws {RequiredError}
|
|
14990
15011
|
*/
|
|
14991
|
-
getObjectsWithForms(options?: RawAxiosRequestConfig): Promise<
|
|
15012
|
+
getObjectsWithForms(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListFormObjectSummaryDTO, any, {}>>;
|
|
14992
15013
|
/**
|
|
14993
15014
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14994
15015
|
* @summary Property options (public)
|
|
@@ -14998,7 +15019,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14998
15019
|
* @param {*} [options] Override http request option.
|
|
14999
15020
|
* @throws {RequiredError}
|
|
15000
15021
|
*/
|
|
15001
|
-
getOptions(propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15022
|
+
getOptions(propertyUuid: string, companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyOption, any, {}>>;
|
|
15002
15023
|
/**
|
|
15003
15024
|
* Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse.
|
|
15004
15025
|
* @summary Restore a deleted form
|
|
@@ -15006,7 +15027,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15006
15027
|
* @param {*} [options] Override http request option.
|
|
15007
15028
|
* @throws {RequiredError}
|
|
15008
15029
|
*/
|
|
15009
|
-
restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
15030
|
+
restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
15010
15031
|
/**
|
|
15011
15032
|
* Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
15012
15033
|
* @summary Submit a form
|
|
@@ -15016,7 +15037,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15016
15037
|
* @param {*} [options] Override http request option.
|
|
15017
15038
|
* @throws {RequiredError}
|
|
15018
15039
|
*/
|
|
15019
|
-
submit(companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15040
|
+
submit(companyUuid: string, formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15020
15041
|
/**
|
|
15021
15042
|
* Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced.
|
|
15022
15043
|
* @summary Update an existing form
|
|
@@ -15025,7 +15046,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15025
15046
|
* @param {*} [options] Override http request option.
|
|
15026
15047
|
* @throws {RequiredError}
|
|
15027
15048
|
*/
|
|
15028
|
-
updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15049
|
+
updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15029
15050
|
/**
|
|
15030
15051
|
* Submits a file with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
15031
15052
|
* @summary Submit a file
|
|
@@ -15035,7 +15056,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15035
15056
|
* @param {*} [options] Override http request option.
|
|
15036
15057
|
* @throws {RequiredError}
|
|
15037
15058
|
*/
|
|
15038
|
-
uploadFiles(companyUuid: string, formUuid: string, files: Array<File>, options?: RawAxiosRequestConfig): Promise<
|
|
15059
|
+
uploadFiles(companyUuid: string, formUuid: string, files: Array<File>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
15039
15060
|
}
|
|
15040
15061
|
/**
|
|
15041
15062
|
* ModuleApi - axios parameter creator
|
|
@@ -15309,7 +15330,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15309
15330
|
* @param {*} [options] Override http request option.
|
|
15310
15331
|
* @throws {RequiredError}
|
|
15311
15332
|
*/
|
|
15312
|
-
createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15333
|
+
createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
15313
15334
|
/**
|
|
15314
15335
|
* Creates a module in the user\'s personal library.
|
|
15315
15336
|
* @summary Create a personal module
|
|
@@ -15317,7 +15338,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15317
15338
|
* @param {*} [options] Override http request option.
|
|
15318
15339
|
* @throws {RequiredError}
|
|
15319
15340
|
*/
|
|
15320
|
-
createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15341
|
+
createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
15321
15342
|
/**
|
|
15322
15343
|
* Deletes a module by its UUID.
|
|
15323
15344
|
* @summary Delete a module
|
|
@@ -15325,7 +15346,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15325
15346
|
* @param {*} [options] Override http request option.
|
|
15326
15347
|
* @throws {RequiredError}
|
|
15327
15348
|
*/
|
|
15328
|
-
deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15349
|
+
deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
15329
15350
|
/**
|
|
15330
15351
|
* Deletes a personal module for the logged-in user.
|
|
15331
15352
|
* @summary Delete a personal module
|
|
@@ -15333,7 +15354,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15333
15354
|
* @param {*} [options] Override http request option.
|
|
15334
15355
|
* @throws {RequiredError}
|
|
15335
15356
|
*/
|
|
15336
|
-
deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15357
|
+
deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
15337
15358
|
/**
|
|
15338
15359
|
* Retrieves details of a module by its UUID.
|
|
15339
15360
|
* @summary Fetch a specific module
|
|
@@ -15341,7 +15362,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15341
15362
|
* @param {*} [options] Override http request option.
|
|
15342
15363
|
* @throws {RequiredError}
|
|
15343
15364
|
*/
|
|
15344
|
-
getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15365
|
+
getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePageContentDTO, any, {}>>;
|
|
15345
15366
|
/**
|
|
15346
15367
|
* Retrieves a paginated list of modules.
|
|
15347
15368
|
* @summary Fetch paginated modules
|
|
@@ -15349,7 +15370,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15349
15370
|
* @param {*} [options] Override http request option.
|
|
15350
15371
|
* @throws {RequiredError}
|
|
15351
15372
|
*/
|
|
15352
|
-
getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15373
|
+
getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePageContentDTO, any, {}>>;
|
|
15353
15374
|
/**
|
|
15354
15375
|
* Retrieves a personal module by UUID for the logged-in user.
|
|
15355
15376
|
* @summary Fetch a personal module
|
|
@@ -15357,7 +15378,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15357
15378
|
* @param {*} [options] Override http request option.
|
|
15358
15379
|
* @throws {RequiredError}
|
|
15359
15380
|
*/
|
|
15360
|
-
getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15381
|
+
getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePageContentDTO, any, {}>>;
|
|
15361
15382
|
/**
|
|
15362
15383
|
* Retrieves personal modules for the logged-in user.
|
|
15363
15384
|
* @summary Fetch paginated personal modules
|
|
@@ -15365,7 +15386,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15365
15386
|
* @param {*} [options] Override http request option.
|
|
15366
15387
|
* @throws {RequiredError}
|
|
15367
15388
|
*/
|
|
15368
|
-
getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15389
|
+
getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePageContentDTO, any, {}>>;
|
|
15369
15390
|
/**
|
|
15370
15391
|
* Updates the details of an existing module.
|
|
15371
15392
|
* @summary Update an existing module
|
|
@@ -15374,7 +15395,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15374
15395
|
* @param {*} [options] Override http request option.
|
|
15375
15396
|
* @throws {RequiredError}
|
|
15376
15397
|
*/
|
|
15377
|
-
updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15398
|
+
updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15378
15399
|
/**
|
|
15379
15400
|
* Updates a personal module for the logged-in user.
|
|
15380
15401
|
* @summary Update a personal module
|
|
@@ -15383,7 +15404,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15383
15404
|
* @param {*} [options] Override http request option.
|
|
15384
15405
|
* @throws {RequiredError}
|
|
15385
15406
|
*/
|
|
15386
|
-
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15407
|
+
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15387
15408
|
}
|
|
15388
15409
|
/**
|
|
15389
15410
|
* NotificationsApi - axios parameter creator
|
|
@@ -15552,14 +15573,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15552
15573
|
* @param {*} [options] Override http request option.
|
|
15553
15574
|
* @throws {RequiredError}
|
|
15554
15575
|
*/
|
|
15555
|
-
dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15576
|
+
dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseString, any, {}>>;
|
|
15556
15577
|
/**
|
|
15557
15578
|
*
|
|
15558
15579
|
* @summary Mint a Firebase custom token so the app can listen to its inbox
|
|
15559
15580
|
* @param {*} [options] Override http request option.
|
|
15560
15581
|
* @throws {RequiredError}
|
|
15561
15582
|
*/
|
|
15562
|
-
firebaseToken(options?: RawAxiosRequestConfig): Promise<
|
|
15583
|
+
firebaseToken(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
15563
15584
|
/**
|
|
15564
15585
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15565
15586
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15568,14 +15589,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15568
15589
|
* @param {*} [options] Override http request option.
|
|
15569
15590
|
* @throws {RequiredError}
|
|
15570
15591
|
*/
|
|
15571
|
-
listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
15592
|
+
listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
|
|
15572
15593
|
/**
|
|
15573
15594
|
*
|
|
15574
15595
|
* @summary Mark all notifications as read
|
|
15575
15596
|
* @param {*} [options] Override http request option.
|
|
15576
15597
|
* @throws {RequiredError}
|
|
15577
15598
|
*/
|
|
15578
|
-
markAllAsRead(options?: RawAxiosRequestConfig): Promise<
|
|
15599
|
+
markAllAsRead(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15579
15600
|
/**
|
|
15580
15601
|
*
|
|
15581
15602
|
* @summary Mark a notification as read
|
|
@@ -15583,7 +15604,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15583
15604
|
* @param {*} [options] Override http request option.
|
|
15584
15605
|
* @throws {RequiredError}
|
|
15585
15606
|
*/
|
|
15586
|
-
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15607
|
+
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15587
15608
|
/**
|
|
15588
15609
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
15589
15610
|
* @summary Send a notification (app token)
|
|
@@ -15591,7 +15612,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15591
15612
|
* @param {*} [options] Override http request option.
|
|
15592
15613
|
* @throws {RequiredError}
|
|
15593
15614
|
*/
|
|
15594
|
-
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15615
|
+
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseMapStringString, any, {}>>;
|
|
15595
15616
|
}
|
|
15596
15617
|
/**
|
|
15597
15618
|
* ObjectsApi - axios parameter creator
|
|
@@ -16051,7 +16072,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16051
16072
|
* @param {*} [options] Override http request option.
|
|
16052
16073
|
* @throws {RequiredError}
|
|
16053
16074
|
*/
|
|
16054
|
-
createObject(caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16075
|
+
createObject(caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
16055
16076
|
/**
|
|
16056
16077
|
* Deletes a specific object identified by its UUID.
|
|
16057
16078
|
* @summary Delete object by UUID
|
|
@@ -16059,14 +16080,14 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16059
16080
|
* @param {*} [options] Override http request option.
|
|
16060
16081
|
* @throws {RequiredError}
|
|
16061
16082
|
*/
|
|
16062
|
-
deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16083
|
+
deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16063
16084
|
/**
|
|
16064
16085
|
* Returns all company users, teams, and installed apps that can receive record access on an object.
|
|
16065
16086
|
* @summary List access grant candidates
|
|
16066
16087
|
* @param {*} [options] Override http request option.
|
|
16067
16088
|
* @throws {RequiredError}
|
|
16068
16089
|
*/
|
|
16069
|
-
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<
|
|
16090
|
+
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObjectAccessGrantCandidatesDTO, any, {}>>;
|
|
16070
16091
|
/**
|
|
16071
16092
|
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16072
16093
|
* @summary Get object by UUID
|
|
@@ -16077,7 +16098,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16077
16098
|
* @param {*} [options] Override http request option.
|
|
16078
16099
|
* @throws {RequiredError}
|
|
16079
16100
|
*/
|
|
16080
|
-
getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16101
|
+
getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCaraerObjectDTO, any, {}>>;
|
|
16081
16102
|
/**
|
|
16082
16103
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
16083
16104
|
* @summary Fetch paginated objects
|
|
@@ -16088,7 +16109,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16088
16109
|
* @param {*} [options] Override http request option.
|
|
16089
16110
|
* @throws {RequiredError}
|
|
16090
16111
|
*/
|
|
16091
|
-
getObjects(paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16112
|
+
getObjects(paginationRequest: PaginationRequest, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseCaraerObjectDTO, any, {}>>;
|
|
16092
16113
|
/**
|
|
16093
16114
|
* Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse.
|
|
16094
16115
|
* @summary Get specific preview by name
|
|
@@ -16097,7 +16118,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16097
16118
|
* @param {*} [options] Override http request option.
|
|
16098
16119
|
* @throws {RequiredError}
|
|
16099
16120
|
*/
|
|
16100
|
-
getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise<
|
|
16121
|
+
getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
|
|
16101
16122
|
/**
|
|
16102
16123
|
* Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs.
|
|
16103
16124
|
* @summary Get all previews over all objects
|
|
@@ -16105,7 +16126,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16105
16126
|
* @param {*} [options] Override http request option.
|
|
16106
16127
|
* @throws {RequiredError}
|
|
16107
16128
|
*/
|
|
16108
|
-
getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16129
|
+
getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
16109
16130
|
/**
|
|
16110
16131
|
* Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs.
|
|
16111
16132
|
* @summary Get all previews of an object
|
|
@@ -16114,7 +16135,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16114
16135
|
* @param {*} [options] Override http request option.
|
|
16115
16136
|
* @throws {RequiredError}
|
|
16116
16137
|
*/
|
|
16117
|
-
getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16138
|
+
getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
16118
16139
|
/**
|
|
16119
16140
|
* Accepts a request to grant record-level scopes on the object to selected users, teams, and installed apps. Validation runs synchronously; grants are applied asynchronously. Returns 202 Accepted on success.
|
|
16120
16141
|
* @summary Grant object record access
|
|
@@ -16123,7 +16144,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16123
16144
|
* @param {*} [options] Override http request option.
|
|
16124
16145
|
* @throws {RequiredError}
|
|
16125
16146
|
*/
|
|
16126
|
-
grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16147
|
+
grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
16127
16148
|
/**
|
|
16128
16149
|
* Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed.
|
|
16129
16150
|
* @summary Permanently delete archived object
|
|
@@ -16131,7 +16152,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16131
16152
|
* @param {*} [options] Override http request option.
|
|
16132
16153
|
* @throws {RequiredError}
|
|
16133
16154
|
*/
|
|
16134
|
-
permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16155
|
+
permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16135
16156
|
/**
|
|
16136
16157
|
* Creates or updates a preview for a specific object. The preview type is determined by the \'name\' path variable. Depending on the preview type (e.g., \'detail\', \'flow\', \'pill\', or \'page\'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model.
|
|
16137
16158
|
* @summary Save object preview
|
|
@@ -16141,7 +16162,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16141
16162
|
* @param {*} [options] Override http request option.
|
|
16142
16163
|
* @throws {RequiredError}
|
|
16143
16164
|
*/
|
|
16144
|
-
savePreview(uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16165
|
+
savePreview(uuid: string, name: string, previewDTO: PreviewDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
16145
16166
|
/**
|
|
16146
16167
|
* Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Leftover nodes with a unique object label and no primary_object are stamped first. Records that reference the object as primary object, extended object, or label are re-extended.
|
|
16147
16168
|
* @summary Sync extended objects for existing records
|
|
@@ -16149,7 +16170,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16149
16170
|
* @param {*} [options] Override http request option.
|
|
16150
16171
|
* @throws {RequiredError}
|
|
16151
16172
|
*/
|
|
16152
|
-
syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16173
|
+
syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringInteger, any, {}>>;
|
|
16153
16174
|
/**
|
|
16154
16175
|
* Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response.
|
|
16155
16176
|
* @summary Update object indices
|
|
@@ -16162,7 +16183,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16162
16183
|
*/
|
|
16163
16184
|
updateIndices3(requestBody: {
|
|
16164
16185
|
[key: string]: number;
|
|
16165
|
-
}, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16186
|
+
}, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCaraerObjectDTO, any, {}>>;
|
|
16166
16187
|
/**
|
|
16167
16188
|
* Sets which properties on this object should generate lifecycle history records when their values change.
|
|
16168
16189
|
* @summary Configure lifecycle property tracking
|
|
@@ -16171,7 +16192,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16171
16192
|
* @param {*} [options] Override http request option.
|
|
16172
16193
|
* @throws {RequiredError}
|
|
16173
16194
|
*/
|
|
16174
|
-
updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16195
|
+
updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16175
16196
|
/**
|
|
16176
16197
|
* Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed).
|
|
16177
16198
|
* @summary Update object by UUID
|
|
@@ -16183,7 +16204,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16183
16204
|
* @param {*} [options] Override http request option.
|
|
16184
16205
|
* @throws {RequiredError}
|
|
16185
16206
|
*/
|
|
16186
|
-
updateObject(uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16207
|
+
updateObject(uuid: string, caraerObjectDTO: CaraerObjectDTO, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16187
16208
|
}
|
|
16188
16209
|
/**
|
|
16189
16210
|
* PropertyApi - axios parameter creator
|
|
@@ -16593,7 +16614,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16593
16614
|
* @param {*} [options] Override http request option.
|
|
16594
16615
|
* @throws {RequiredError}
|
|
16595
16616
|
*/
|
|
16596
|
-
copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16617
|
+
copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListPropertyDTO, any, {}>>;
|
|
16597
16618
|
/**
|
|
16598
16619
|
* Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string).
|
|
16599
16620
|
* @summary Create a new property
|
|
@@ -16602,7 +16623,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16602
16623
|
* @param {*} [options] Override http request option.
|
|
16603
16624
|
* @throws {RequiredError}
|
|
16604
16625
|
*/
|
|
16605
|
-
createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16626
|
+
createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
16606
16627
|
/**
|
|
16607
16628
|
* Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details.
|
|
16608
16629
|
* @summary Delete a property
|
|
@@ -16611,7 +16632,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16611
16632
|
* @param {*} [options] Override http request option.
|
|
16612
16633
|
* @throws {RequiredError}
|
|
16613
16634
|
*/
|
|
16614
|
-
deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16635
|
+
deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16615
16636
|
/**
|
|
16616
16637
|
* Returns the calculation functions available for each property type (for example min/max on numbers).
|
|
16617
16638
|
* @summary Retrieve allowed calculation types per property type
|
|
@@ -16619,7 +16640,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16619
16640
|
* @param {*} [options] Override http request option.
|
|
16620
16641
|
* @throws {RequiredError}
|
|
16621
16642
|
*/
|
|
16622
|
-
getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16643
|
+
getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyCalculationTypeDTO, any, {}>>;
|
|
16623
16644
|
/**
|
|
16624
16645
|
* Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances.
|
|
16625
16646
|
* @summary Retrieve property formats
|
|
@@ -16627,7 +16648,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16627
16648
|
* @param {*} [options] Override http request option.
|
|
16628
16649
|
* @throws {RequiredError}
|
|
16629
16650
|
*/
|
|
16630
|
-
getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16651
|
+
getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyFormat, any, {}>>;
|
|
16631
16652
|
/**
|
|
16632
16653
|
* Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects.
|
|
16633
16654
|
* @summary Fetch paginated properties
|
|
@@ -16636,7 +16657,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16636
16657
|
* @param {*} [options] Override http request option.
|
|
16637
16658
|
* @throws {RequiredError}
|
|
16638
16659
|
*/
|
|
16639
|
-
getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16660
|
+
getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyDTO, any, {}>>;
|
|
16640
16661
|
/**
|
|
16641
16662
|
* Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details.
|
|
16642
16663
|
* @summary Fetch a specific property
|
|
@@ -16645,7 +16666,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16645
16666
|
* @param {*} [options] Override http request option.
|
|
16646
16667
|
* @throws {RequiredError}
|
|
16647
16668
|
*/
|
|
16648
|
-
getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16669
|
+
getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePropertyDTO, any, {}>>;
|
|
16649
16670
|
/**
|
|
16650
16671
|
* Returns calculation functions supported for the property\'s type.
|
|
16651
16672
|
* @summary Retrieve allowed calculation types for a property
|
|
@@ -16654,7 +16675,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16654
16675
|
* @param {*} [options] Override http request option.
|
|
16655
16676
|
* @throws {RequiredError}
|
|
16656
16677
|
*/
|
|
16657
|
-
getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16678
|
+
getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
16658
16679
|
/**
|
|
16659
16680
|
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
16660
16681
|
* @summary Permanently remove archived property
|
|
@@ -16663,7 +16684,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16663
16684
|
* @param {*} [options] Override http request option.
|
|
16664
16685
|
* @throws {RequiredError}
|
|
16665
16686
|
*/
|
|
16666
|
-
permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16687
|
+
permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16667
16688
|
/**
|
|
16668
16689
|
* Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms.
|
|
16669
16690
|
* @summary Pin a property
|
|
@@ -16672,7 +16693,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16672
16693
|
* @param {*} [options] Override http request option.
|
|
16673
16694
|
* @throws {RequiredError}
|
|
16674
16695
|
*/
|
|
16675
|
-
pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16696
|
+
pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16676
16697
|
/**
|
|
16677
16698
|
* Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details.
|
|
16678
16699
|
* @summary Restore a soft-deleted property
|
|
@@ -16681,7 +16702,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16681
16702
|
* @param {*} [options] Override http request option.
|
|
16682
16703
|
* @throws {RequiredError}
|
|
16683
16704
|
*/
|
|
16684
|
-
restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16705
|
+
restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
16685
16706
|
/**
|
|
16686
16707
|
* Removes the pin for the specified property for the logged-in user.
|
|
16687
16708
|
* @summary Unpin a property
|
|
@@ -16690,7 +16711,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16690
16711
|
* @param {*} [options] Override http request option.
|
|
16691
16712
|
* @throws {RequiredError}
|
|
16692
16713
|
*/
|
|
16693
|
-
unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16714
|
+
unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16694
16715
|
/**
|
|
16695
16716
|
* Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects.
|
|
16696
16717
|
* @summary Update property indices
|
|
@@ -16701,7 +16722,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16701
16722
|
*/
|
|
16702
16723
|
updateIndices2(objectUuid: string, requestBody: {
|
|
16703
16724
|
[key: string]: number;
|
|
16704
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
16725
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListPropertyDTO, any, {}>>;
|
|
16705
16726
|
/**
|
|
16706
16727
|
* Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string).
|
|
16707
16728
|
* @summary Update an existing property
|
|
@@ -16711,7 +16732,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16711
16732
|
* @param {*} [options] Override http request option.
|
|
16712
16733
|
* @throws {RequiredError}
|
|
16713
16734
|
*/
|
|
16714
|
-
updateProperty(objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16735
|
+
updateProperty(objectUuid: string, propertyUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16715
16736
|
}
|
|
16716
16737
|
/**
|
|
16717
16738
|
* RecordsApi - axios parameter creator
|
|
@@ -16742,6 +16763,13 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16742
16763
|
* @throws {RequiredError}
|
|
16743
16764
|
*/
|
|
16744
16765
|
aggregateBatch: (aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16766
|
+
/**
|
|
16767
|
+
* Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
|
|
16768
|
+
* @summary List objects with visible archived records
|
|
16769
|
+
* @param {*} [options] Override http request option.
|
|
16770
|
+
* @throws {RequiredError}
|
|
16771
|
+
*/
|
|
16772
|
+
archivedObjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16745
16773
|
/**
|
|
16746
16774
|
* Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
|
|
16747
16775
|
* @summary Bulk delete records
|
|
@@ -17008,6 +17036,13 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17008
17036
|
* @throws {RequiredError}
|
|
17009
17037
|
*/
|
|
17010
17038
|
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListAggregateResponse>>;
|
|
17039
|
+
/**
|
|
17040
|
+
* Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
|
|
17041
|
+
* @summary List objects with visible archived records
|
|
17042
|
+
* @param {*} [options] Override http request option.
|
|
17043
|
+
* @throws {RequiredError}
|
|
17044
|
+
*/
|
|
17045
|
+
archivedObjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>>;
|
|
17011
17046
|
/**
|
|
17012
17047
|
* Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
|
|
17013
17048
|
* @summary Bulk delete records
|
|
@@ -17274,6 +17309,13 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17274
17309
|
* @throws {RequiredError}
|
|
17275
17310
|
*/
|
|
17276
17311
|
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListAggregateResponse>;
|
|
17312
|
+
/**
|
|
17313
|
+
* Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
|
|
17314
|
+
* @summary List objects with visible archived records
|
|
17315
|
+
* @param {*} [options] Override http request option.
|
|
17316
|
+
* @throws {RequiredError}
|
|
17317
|
+
*/
|
|
17318
|
+
archivedObjects(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>;
|
|
17277
17319
|
/**
|
|
17278
17320
|
* Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
|
|
17279
17321
|
* @summary Bulk delete records
|
|
@@ -17523,7 +17565,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17523
17565
|
* @param {*} [options] Override http request option.
|
|
17524
17566
|
* @throws {RequiredError}
|
|
17525
17567
|
*/
|
|
17526
|
-
_delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise<
|
|
17568
|
+
_delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17527
17569
|
/**
|
|
17528
17570
|
* Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters.
|
|
17529
17571
|
* @summary Aggregate records for analytics charts
|
|
@@ -17531,7 +17573,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17531
17573
|
* @param {*} [options] Override http request option.
|
|
17532
17574
|
* @throws {RequiredError}
|
|
17533
17575
|
*/
|
|
17534
|
-
aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17576
|
+
aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseAggregateResponse, any, {}>>;
|
|
17535
17577
|
/**
|
|
17536
17578
|
* Runs multiple aggregation requests for dashboard widgets.
|
|
17537
17579
|
* @summary Batch aggregate records for analytics dashboards
|
|
@@ -17539,7 +17581,14 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17539
17581
|
* @param {*} [options] Override http request option.
|
|
17540
17582
|
* @throws {RequiredError}
|
|
17541
17583
|
*/
|
|
17542
|
-
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17584
|
+
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListAggregateResponse, any, {}>>;
|
|
17585
|
+
/**
|
|
17586
|
+
* Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
|
|
17587
|
+
* @summary List objects with visible archived records
|
|
17588
|
+
* @param {*} [options] Override http request option.
|
|
17589
|
+
* @throws {RequiredError}
|
|
17590
|
+
*/
|
|
17591
|
+
archivedObjects(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListArchivedRecordObjectDTO, any, {}>>;
|
|
17543
17592
|
/**
|
|
17544
17593
|
* Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
|
|
17545
17594
|
* @summary Bulk delete records
|
|
@@ -17548,7 +17597,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17548
17597
|
* @param {*} [options] Override http request option.
|
|
17549
17598
|
* @throws {RequiredError}
|
|
17550
17599
|
*/
|
|
17551
|
-
bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17600
|
+
bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BulkDeleteRecordsResponse, any, {}>>;
|
|
17552
17601
|
/**
|
|
17553
17602
|
* Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors.
|
|
17554
17603
|
* @summary Bulk create or update records
|
|
@@ -17558,7 +17607,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17558
17607
|
* @param {*} [options] Override http request option.
|
|
17559
17608
|
* @throws {RequiredError}
|
|
17560
17609
|
*/
|
|
17561
|
-
bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
17610
|
+
bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BulkEditRecordsResponse, any, {}>>;
|
|
17562
17611
|
/**
|
|
17563
17612
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17564
17613
|
* @summary Create a new record
|
|
@@ -17570,7 +17619,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17570
17619
|
* @param {*} [options] Override http request option.
|
|
17571
17620
|
* @throws {RequiredError}
|
|
17572
17621
|
*/
|
|
17573
|
-
create(objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17622
|
+
create(objectName: string, recordDTO: RecordDTO, parse?: CreateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
17574
17623
|
/**
|
|
17575
17624
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17576
17625
|
* @summary Create or update a record
|
|
@@ -17582,7 +17631,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17582
17631
|
* @param {*} [options] Override http request option.
|
|
17583
17632
|
* @throws {RequiredError}
|
|
17584
17633
|
*/
|
|
17585
|
-
createOrUpdate(objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17634
|
+
createOrUpdate(objectName: string, recordDTO: RecordDTO, parse?: CreateOrUpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: CreateOrUpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
17586
17635
|
/**
|
|
17587
17636
|
* Creates a relation between two records identified by their UUIDs using the provided relation name.
|
|
17588
17637
|
* @summary Create a relation between records
|
|
@@ -17594,7 +17643,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17594
17643
|
* @param {*} [options] Override http request option.
|
|
17595
17644
|
* @throws {RequiredError}
|
|
17596
17645
|
*/
|
|
17597
|
-
createRelation(fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<
|
|
17646
|
+
createRelation(fromUuid: string, relationName: string, toUuid: string, primary?: object, relationEdgeRequestDTO?: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17598
17647
|
/**
|
|
17599
17648
|
* Deletes a relation between two records identified by their UUIDs and the relation name.
|
|
17600
17649
|
* @summary Delete a relation between records
|
|
@@ -17604,7 +17653,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17604
17653
|
* @param {*} [options] Override http request option.
|
|
17605
17654
|
* @throws {RequiredError}
|
|
17606
17655
|
*/
|
|
17607
|
-
deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
17656
|
+
deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17608
17657
|
/**
|
|
17609
17658
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
17610
17659
|
* @summary Extend a record
|
|
@@ -17615,7 +17664,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17615
17664
|
* @param {*} [options] Override http request option.
|
|
17616
17665
|
* @throws {RequiredError}
|
|
17617
17666
|
*/
|
|
17618
|
-
extend(uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17667
|
+
extend(uuid: string, extendRecordRequest: ExtendRecordRequest, recordReturnFormat?: ExtendRecordReturnFormatEnum, parse?: ExtendParseEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseObject, any, {}>>;
|
|
17619
17668
|
/**
|
|
17620
17669
|
* Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details.
|
|
17621
17670
|
* @summary Fetch paginated records
|
|
@@ -17627,7 +17676,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17627
17676
|
* @param {*} [options] Override http request option.
|
|
17628
17677
|
* @throws {RequiredError}
|
|
17629
17678
|
*/
|
|
17630
|
-
index(recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17679
|
+
index(recordPaginationRequest: RecordPaginationRequest, parse?: IndexParseEnum, archived?: boolean, relatedRecordUuid?: string, recordReturnFormat?: IndexRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseObject, any, {}>>;
|
|
17631
17680
|
/**
|
|
17632
17681
|
* Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the \'status\' property of the main object. Returns a SuccessResponse containing the flow records.
|
|
17633
17682
|
* @summary Fetch records for flow view
|
|
@@ -17637,7 +17686,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17637
17686
|
* @param {*} [options] Override http request option.
|
|
17638
17687
|
* @throws {RequiredError}
|
|
17639
17688
|
*/
|
|
17640
|
-
indexFlow(flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17689
|
+
indexFlow(flowPaginationRequest: FlowPaginationRequest, relatedRecordUuid?: string, parse?: IndexFlowParseEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseFlow, any, {}>>;
|
|
17641
17690
|
/**
|
|
17642
17691
|
* Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects.
|
|
17643
17692
|
* @summary Fetch records for page view
|
|
@@ -17650,7 +17699,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17650
17699
|
* @param {*} [options] Override http request option.
|
|
17651
17700
|
* @throws {RequiredError}
|
|
17652
17701
|
*/
|
|
17653
|
-
indexPage(recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
17702
|
+
indexPage(recordPaginationRequest: RecordPaginationRequest, environment?: string, relatedRecordUuid?: string, fields?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseObject, any, {}>>;
|
|
17654
17703
|
/**
|
|
17655
17704
|
* Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view.
|
|
17656
17705
|
* @summary Fetch records for table view
|
|
@@ -17659,7 +17708,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17659
17708
|
* @param {*} [options] Override http request option.
|
|
17660
17709
|
* @throws {RequiredError}
|
|
17661
17710
|
*/
|
|
17662
|
-
indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
17711
|
+
indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseTable, any, {}>>;
|
|
17663
17712
|
/**
|
|
17664
17713
|
* Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data.
|
|
17665
17714
|
* @summary Get record preview
|
|
@@ -17670,7 +17719,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17670
17719
|
* @param {*} [options] Override http request option.
|
|
17671
17720
|
* @throws {RequiredError}
|
|
17672
17721
|
*/
|
|
17673
|
-
preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17722
|
+
preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
|
|
17674
17723
|
/**
|
|
17675
17724
|
* Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
|
|
17676
17725
|
* @summary Advanced graph-aware record query
|
|
@@ -17678,7 +17727,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17678
17727
|
* @param {*} [options] Override http request option.
|
|
17679
17728
|
* @throws {RequiredError}
|
|
17680
17729
|
*/
|
|
17681
|
-
query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17730
|
+
query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AdvancedRecordQueryResponse, any, {}>>;
|
|
17682
17731
|
/**
|
|
17683
17732
|
* Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored.
|
|
17684
17733
|
* @summary Restore a deleted record
|
|
@@ -17686,7 +17735,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17686
17735
|
* @param {*} [options] Override http request option.
|
|
17687
17736
|
* @throws {RequiredError}
|
|
17688
17737
|
*/
|
|
17689
|
-
restore(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
17738
|
+
restore(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17690
17739
|
/**
|
|
17691
17740
|
* Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records.
|
|
17692
17741
|
* @summary Search records
|
|
@@ -17697,7 +17746,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17697
17746
|
* @param {*} [options] Override http request option.
|
|
17698
17747
|
* @throws {RequiredError}
|
|
17699
17748
|
*/
|
|
17700
|
-
search(searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17749
|
+
search(searchRequest: SearchRequest, archived?: boolean, parse?: SearchParseEnum, recordReturnFormat?: SearchRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseObject, any, {}>>;
|
|
17701
17750
|
/**
|
|
17702
17751
|
* Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers.
|
|
17703
17752
|
* @summary Search records across objects
|
|
@@ -17707,7 +17756,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17707
17756
|
* @param {*} [options] Override http request option.
|
|
17708
17757
|
* @throws {RequiredError}
|
|
17709
17758
|
*/
|
|
17710
|
-
searchCrossObject(crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17759
|
+
searchCrossObject(crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest, archived?: boolean, parse?: SearchCrossObjectParseEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
17711
17760
|
/**
|
|
17712
17761
|
* Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known.
|
|
17713
17762
|
* @summary Get record details
|
|
@@ -17719,7 +17768,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17719
17768
|
* @param {*} [options] Override http request option.
|
|
17720
17769
|
* @throws {RequiredError}
|
|
17721
17770
|
*/
|
|
17722
|
-
show(uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig): Promise<
|
|
17771
|
+
show(uuid: string, object?: string, recordReturnFormat?: ShowRecordReturnFormatEnum, parse?: ShowParseEnum, fields?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObject, any, {}>>;
|
|
17723
17772
|
/**
|
|
17724
17773
|
* Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}.
|
|
17725
17774
|
* @summary Get record details by object
|
|
@@ -17730,7 +17779,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17730
17779
|
* @param {*} [options] Override http request option.
|
|
17731
17780
|
* @throws {RequiredError}
|
|
17732
17781
|
*/
|
|
17733
|
-
showByObject(objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17782
|
+
showByObject(objectName: string, uuid: string, recordReturnFormat?: ShowByObjectRecordReturnFormatEnum, parse?: ShowByObjectParseEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObject, any, {}>>;
|
|
17734
17783
|
/**
|
|
17735
17784
|
* Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable.
|
|
17736
17785
|
* @summary Suggest analytics widgets with AI
|
|
@@ -17738,7 +17787,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17738
17787
|
* @param {*} [options] Override http request option.
|
|
17739
17788
|
* @throws {RequiredError}
|
|
17740
17789
|
*/
|
|
17741
|
-
suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17790
|
+
suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseSuggestAnalyticsWidgetsResponse, any, {}>>;
|
|
17742
17791
|
/**
|
|
17743
17792
|
* Updates a record\'s details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17744
17793
|
* @summary Update a record
|
|
@@ -17751,7 +17800,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17751
17800
|
* @param {*} [options] Override http request option.
|
|
17752
17801
|
* @throws {RequiredError}
|
|
17753
17802
|
*/
|
|
17754
|
-
update(uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17803
|
+
update(uuid: string, objectName: string, recordDTO: RecordDTO, parse?: UpdateParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
17755
17804
|
/**
|
|
17756
17805
|
* Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known.
|
|
17757
17806
|
* @summary Update a record by UUID
|
|
@@ -17764,7 +17813,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17764
17813
|
* @param {*} [options] Override http request option.
|
|
17765
17814
|
* @throws {RequiredError}
|
|
17766
17815
|
*/
|
|
17767
|
-
updateByUuid(uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<
|
|
17816
|
+
updateByUuid(uuid: string, recordDTO: RecordDTO, object?: string, parse?: UpdateByUuidParseEnum, ignoreErrors?: boolean, recordReturnFormat?: UpdateByUuidRecordReturnFormatEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
17768
17817
|
/**
|
|
17769
17818
|
* Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key.
|
|
17770
17819
|
* @summary Update relation edge properties
|
|
@@ -17775,7 +17824,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17775
17824
|
* @param {*} [options] Override http request option.
|
|
17776
17825
|
* @throws {RequiredError}
|
|
17777
17826
|
*/
|
|
17778
|
-
updateRelationEdge(fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<
|
|
17827
|
+
updateRelationEdge(fromUuid: string, relationName: string, toUuid: string, relationEdgeRequestDTO: RelationEdgeRequestDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17779
17828
|
}
|
|
17780
17829
|
export declare const CreateParseEnum: {
|
|
17781
17830
|
readonly Db: "DB";
|
|
@@ -18261,7 +18310,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18261
18310
|
* @param {*} [options] Override http request option.
|
|
18262
18311
|
* @throws {RequiredError}
|
|
18263
18312
|
*/
|
|
18264
|
-
addConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<
|
|
18313
|
+
addConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
18265
18314
|
/**
|
|
18266
18315
|
* Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created.
|
|
18267
18316
|
* @summary Create or update a relation
|
|
@@ -18270,7 +18319,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18270
18319
|
* @param {*} [options] Override http request option.
|
|
18271
18320
|
* @throws {RequiredError}
|
|
18272
18321
|
*/
|
|
18273
|
-
createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18322
|
+
createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
18274
18323
|
/**
|
|
18275
18324
|
* Deletes a connection between two objects for a given relation using the specified UUIDs.
|
|
18276
18325
|
* @summary Delete a connection from a relation
|
|
@@ -18280,7 +18329,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18280
18329
|
* @param {*} [options] Override http request option.
|
|
18281
18330
|
* @throws {RequiredError}
|
|
18282
18331
|
*/
|
|
18283
|
-
deleteConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<
|
|
18332
|
+
deleteConnection(relationUuid: string, from: string, to: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
18284
18333
|
/**
|
|
18285
18334
|
* Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details.
|
|
18286
18335
|
* @summary Delete a relation
|
|
@@ -18288,7 +18337,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18288
18337
|
* @param {*} [options] Override http request option.
|
|
18289
18338
|
* @throws {RequiredError}
|
|
18290
18339
|
*/
|
|
18291
|
-
deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18340
|
+
deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18292
18341
|
/**
|
|
18293
18342
|
* Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO.
|
|
18294
18343
|
* @summary Get relation details
|
|
@@ -18296,7 +18345,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18296
18345
|
* @param {*} [options] Override http request option.
|
|
18297
18346
|
* @throws {RequiredError}
|
|
18298
18347
|
*/
|
|
18299
|
-
getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18348
|
+
getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseRelationDTO, any, {}>>;
|
|
18300
18349
|
/**
|
|
18301
18350
|
* Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object.
|
|
18302
18351
|
* @summary Get relation details for a specific object
|
|
@@ -18305,7 +18354,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18305
18354
|
* @param {*} [options] Override http request option.
|
|
18306
18355
|
* @throws {RequiredError}
|
|
18307
18356
|
*/
|
|
18308
|
-
getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18357
|
+
getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseRelationDTO, any, {}>>;
|
|
18309
18358
|
/**
|
|
18310
18359
|
* Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria.
|
|
18311
18360
|
* @summary Fetch paginated relations
|
|
@@ -18313,7 +18362,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18313
18362
|
* @param {*} [options] Override http request option.
|
|
18314
18363
|
* @throws {RequiredError}
|
|
18315
18364
|
*/
|
|
18316
|
-
getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18365
|
+
getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseRelationDTO, any, {}>>;
|
|
18317
18366
|
/**
|
|
18318
18367
|
* Retrieves all relations between two objects based on the provided object UUIDs.
|
|
18319
18368
|
* @summary Get all relations between two objects
|
|
@@ -18323,7 +18372,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18323
18372
|
* @param {*} [options] Override http request option.
|
|
18324
18373
|
* @throws {RequiredError}
|
|
18325
18374
|
*/
|
|
18326
|
-
getRelationsBetweenObjects(fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18375
|
+
getRelationsBetweenObjects(fromObjectUuid: string, toObjectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseRelationDTO, any, {}>>;
|
|
18327
18376
|
/**
|
|
18328
18377
|
* Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID.
|
|
18329
18378
|
* @summary Fetch relations for a specific object
|
|
@@ -18332,7 +18381,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18332
18381
|
* @param {*} [options] Override http request option.
|
|
18333
18382
|
* @throws {RequiredError}
|
|
18334
18383
|
*/
|
|
18335
|
-
getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18384
|
+
getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseRelationDTO, any, {}>>;
|
|
18336
18385
|
/**
|
|
18337
18386
|
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
18338
18387
|
* @summary Permanently delete archived relation
|
|
@@ -18340,7 +18389,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18340
18389
|
* @param {*} [options] Override http request option.
|
|
18341
18390
|
* @throws {RequiredError}
|
|
18342
18391
|
*/
|
|
18343
|
-
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18392
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18344
18393
|
/**
|
|
18345
18394
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
18346
18395
|
* @summary Restore a deleted relation
|
|
@@ -18348,7 +18397,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18348
18397
|
* @param {*} [options] Override http request option.
|
|
18349
18398
|
* @throws {RequiredError}
|
|
18350
18399
|
*/
|
|
18351
|
-
restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18400
|
+
restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
18352
18401
|
/**
|
|
18353
18402
|
* Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects.
|
|
18354
18403
|
* @summary Update relation indices
|
|
@@ -18358,7 +18407,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18358
18407
|
*/
|
|
18359
18408
|
updateIndices(requestBody: {
|
|
18360
18409
|
[key: string]: number;
|
|
18361
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
18410
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCollectionRelation, any, {}>>;
|
|
18362
18411
|
}
|
|
18363
18412
|
/**
|
|
18364
18413
|
* ServerlessFunctionsApi - axios parameter creator
|
|
@@ -18615,7 +18664,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18615
18664
|
* @param {*} [options] Override http request option.
|
|
18616
18665
|
* @throws {RequiredError}
|
|
18617
18666
|
*/
|
|
18618
|
-
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18667
|
+
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
18619
18668
|
/**
|
|
18620
18669
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
18621
18670
|
* @summary Delete a serverless function
|
|
@@ -18624,7 +18673,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18624
18673
|
* @param {*} [options] Override http request option.
|
|
18625
18674
|
* @throws {RequiredError}
|
|
18626
18675
|
*/
|
|
18627
|
-
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18676
|
+
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18628
18677
|
/**
|
|
18629
18678
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
18630
18679
|
* @summary List serverless functions for an app
|
|
@@ -18633,7 +18682,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18633
18682
|
* @param {*} [options] Override http request option.
|
|
18634
18683
|
* @throws {RequiredError}
|
|
18635
18684
|
*/
|
|
18636
|
-
index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18685
|
+
index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseServerlessFunctionDTO, any, {}>>;
|
|
18637
18686
|
/**
|
|
18638
18687
|
* Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function.
|
|
18639
18688
|
* @summary Get serverless function logs
|
|
@@ -18644,7 +18693,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18644
18693
|
* @param {*} [options] Override http request option.
|
|
18645
18694
|
* @throws {RequiredError}
|
|
18646
18695
|
*/
|
|
18647
|
-
logs(appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
18696
|
+
logs(appUuid: string, uuid: string, since?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
18648
18697
|
/**
|
|
18649
18698
|
* Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything.
|
|
18650
18699
|
* @summary Generate a sample webhook payload
|
|
@@ -18653,7 +18702,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18653
18702
|
* @param {*} [options] Override http request option.
|
|
18654
18703
|
* @throws {RequiredError}
|
|
18655
18704
|
*/
|
|
18656
|
-
samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18705
|
+
samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseObject, any, {}>>;
|
|
18657
18706
|
/**
|
|
18658
18707
|
* Retrieves a serverless function by its UUID, ensuring it belongs to the specified app.
|
|
18659
18708
|
* @summary Get a serverless function
|
|
@@ -18662,7 +18711,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18662
18711
|
* @param {*} [options] Override http request option.
|
|
18663
18712
|
* @throws {RequiredError}
|
|
18664
18713
|
*/
|
|
18665
|
-
show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18714
|
+
show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseServerlessFunctionDTO, any, {}>>;
|
|
18666
18715
|
/**
|
|
18667
18716
|
* Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks.
|
|
18668
18717
|
* @summary Test a serverless function
|
|
@@ -18672,7 +18721,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18672
18721
|
* @param {*} [options] Override http request option.
|
|
18673
18722
|
* @throws {RequiredError}
|
|
18674
18723
|
*/
|
|
18675
|
-
testServerlessFunction(appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18724
|
+
testServerlessFunction(appUuid: string, uuid: string, testServerlessFunctionRequest: TestServerlessFunctionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
18676
18725
|
/**
|
|
18677
18726
|
* Updates an existing serverless function\'s runtime and code, keeping it attached to the same app.
|
|
18678
18727
|
* @summary Update a serverless function
|
|
@@ -18682,7 +18731,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18682
18731
|
* @param {*} [options] Override http request option.
|
|
18683
18732
|
* @throws {RequiredError}
|
|
18684
18733
|
*/
|
|
18685
|
-
update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18734
|
+
update2(appUuid: string, uuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseServerlessFunctionDTO, any, {}>>;
|
|
18686
18735
|
}
|
|
18687
18736
|
/**
|
|
18688
18737
|
* SyncApi - axios parameter creator
|
|
@@ -18863,7 +18912,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18863
18912
|
* @param {*} [options] Override http request option.
|
|
18864
18913
|
* @throws {RequiredError}
|
|
18865
18914
|
*/
|
|
18866
|
-
createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18915
|
+
createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
18867
18916
|
/**
|
|
18868
18917
|
* Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details.
|
|
18869
18918
|
* @summary Delete a sync
|
|
@@ -18872,7 +18921,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18872
18921
|
* @param {*} [options] Override http request option.
|
|
18873
18922
|
* @throws {RequiredError}
|
|
18874
18923
|
*/
|
|
18875
|
-
deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18924
|
+
deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18876
18925
|
/**
|
|
18877
18926
|
* Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details.
|
|
18878
18927
|
* @summary Get a sync
|
|
@@ -18881,7 +18930,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18881
18930
|
* @param {*} [options] Override http request option.
|
|
18882
18931
|
* @throws {RequiredError}
|
|
18883
18932
|
*/
|
|
18884
|
-
getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18933
|
+
getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SyncDTO, any, {}>>;
|
|
18885
18934
|
/**
|
|
18886
18935
|
* Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria.
|
|
18887
18936
|
* @summary Fetch paginated syncs
|
|
@@ -18889,7 +18938,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18889
18938
|
* @param {*} [options] Override http request option.
|
|
18890
18939
|
* @throws {RequiredError}
|
|
18891
18940
|
*/
|
|
18892
|
-
getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18941
|
+
getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSyncDTO, any, {}>>;
|
|
18893
18942
|
/**
|
|
18894
18943
|
* Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details.
|
|
18895
18944
|
* @summary Restore a deleted sync
|
|
@@ -18897,7 +18946,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18897
18946
|
* @param {*} [options] Override http request option.
|
|
18898
18947
|
* @throws {RequiredError}
|
|
18899
18948
|
*/
|
|
18900
|
-
restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18949
|
+
restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
18901
18950
|
/**
|
|
18902
18951
|
* Updates an existing sync. Returns a UpdateResponse containing the updated sync details.
|
|
18903
18952
|
* @summary Update a sync
|
|
@@ -18906,7 +18955,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18906
18955
|
* @param {*} [options] Override http request option.
|
|
18907
18956
|
* @throws {RequiredError}
|
|
18908
18957
|
*/
|
|
18909
|
-
updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18958
|
+
updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
18910
18959
|
}
|
|
18911
18960
|
/**
|
|
18912
18961
|
* TraitsApi - axios parameter creator
|
|
@@ -19197,7 +19246,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19197
19246
|
* @param {*} [options] Override http request option.
|
|
19198
19247
|
* @throws {RequiredError}
|
|
19199
19248
|
*/
|
|
19200
|
-
createTrait(objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig): Promise<
|
|
19249
|
+
createTrait(objectUuid: string, traitName: string, body: object, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
19201
19250
|
/**
|
|
19202
19251
|
* Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed.
|
|
19203
19252
|
* @summary Delete a trait from an object
|
|
@@ -19206,7 +19255,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19206
19255
|
* @param {*} [options] Override http request option.
|
|
19207
19256
|
* @throws {RequiredError}
|
|
19208
19257
|
*/
|
|
19209
|
-
deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<
|
|
19258
|
+
deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19210
19259
|
/**
|
|
19211
19260
|
* Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown.
|
|
19212
19261
|
* @summary Fetch a specific trait for an object
|
|
@@ -19215,7 +19264,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19215
19264
|
* @param {*} [options] Override http request option.
|
|
19216
19265
|
* @throws {RequiredError}
|
|
19217
19266
|
*/
|
|
19218
|
-
getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<
|
|
19267
|
+
getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseTraitDTO, any, {}>>;
|
|
19219
19268
|
/**
|
|
19220
19269
|
* Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100.
|
|
19221
19270
|
* @summary Fetch all traits for an object
|
|
@@ -19223,7 +19272,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19223
19272
|
* @param {*} [options] Override http request option.
|
|
19224
19273
|
* @throws {RequiredError}
|
|
19225
19274
|
*/
|
|
19226
|
-
getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19275
|
+
getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseTraitDTO, any, {}>>;
|
|
19227
19276
|
/**
|
|
19228
19277
|
* Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login.
|
|
19229
19278
|
* @summary Respond to an event invitation (email link)
|
|
@@ -19236,7 +19285,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19236
19285
|
* @param {*} [options] Override http request option.
|
|
19237
19286
|
* @throws {RequiredError}
|
|
19238
19287
|
*/
|
|
19239
|
-
rsvpBrowserGet(companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig): Promise<
|
|
19288
|
+
rsvpBrowserGet(companyUuid: string, eventUuid: string, attendeeUuid: string, partstat?: string, scope?: string, switchAccount?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
19240
19289
|
/**
|
|
19241
19290
|
*
|
|
19242
19291
|
* @summary Email/password login for RSVP
|
|
@@ -19250,7 +19299,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19250
19299
|
* @param {*} [options] Override http request option.
|
|
19251
19300
|
* @throws {RequiredError}
|
|
19252
19301
|
*/
|
|
19253
|
-
rsvpBrowserLogin(companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<
|
|
19302
|
+
rsvpBrowserLogin(companyUuid: string, eventUuid: string, attendeeUuid: string, email: string, password: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
19254
19303
|
/**
|
|
19255
19304
|
*
|
|
19256
19305
|
* @summary Start social login for RSVP
|
|
@@ -19263,7 +19312,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19263
19312
|
* @param {*} [options] Override http request option.
|
|
19264
19313
|
* @throws {RequiredError}
|
|
19265
19314
|
*/
|
|
19266
|
-
rsvpBrowserSocial(companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<
|
|
19315
|
+
rsvpBrowserSocial(companyUuid: string, eventUuid: string, attendeeUuid: string, provider: string, partstat?: string, scope?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
19267
19316
|
/**
|
|
19268
19317
|
* Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules.
|
|
19269
19318
|
* @summary Update event RSVP (JSON)
|
|
@@ -19274,7 +19323,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19274
19323
|
* @param {*} [options] Override http request option.
|
|
19275
19324
|
* @throws {RequiredError}
|
|
19276
19325
|
*/
|
|
19277
|
-
rsvpJson(companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig): Promise<
|
|
19326
|
+
rsvpJson(companyUuid: string, eventUuid: string, attendeeUuid: string, eventRsvpRequest: EventRsvpRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19278
19327
|
}
|
|
19279
19328
|
/**
|
|
19280
19329
|
* ViewsApi - axios parameter creator
|
|
@@ -19501,7 +19550,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19501
19550
|
* @param {*} [options] Override http request option.
|
|
19502
19551
|
* @throws {RequiredError}
|
|
19503
19552
|
*/
|
|
19504
|
-
createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19553
|
+
createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
19505
19554
|
/**
|
|
19506
19555
|
* Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion.
|
|
19507
19556
|
* @summary Delete a view
|
|
@@ -19510,7 +19559,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19510
19559
|
* @param {*} [options] Override http request option.
|
|
19511
19560
|
* @throws {RequiredError}
|
|
19512
19561
|
*/
|
|
19513
|
-
deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19562
|
+
deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19514
19563
|
/**
|
|
19515
19564
|
* Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details.
|
|
19516
19565
|
* @summary Toggle view favorite status
|
|
@@ -19519,7 +19568,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19519
19568
|
* @param {*} [options] Override http request option.
|
|
19520
19569
|
* @throws {RequiredError}
|
|
19521
19570
|
*/
|
|
19522
|
-
favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19571
|
+
favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19523
19572
|
/**
|
|
19524
19573
|
* Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO.
|
|
19525
19574
|
* @summary Get view details
|
|
@@ -19528,7 +19577,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19528
19577
|
* @param {*} [options] Override http request option.
|
|
19529
19578
|
* @throws {RequiredError}
|
|
19530
19579
|
*/
|
|
19531
|
-
getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19580
|
+
getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseViewDTO, any, {}>>;
|
|
19532
19581
|
/**
|
|
19533
19582
|
* Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects.
|
|
19534
19583
|
* @summary Fetch paginated views for an object
|
|
@@ -19537,7 +19586,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19537
19586
|
* @param {*} [options] Override http request option.
|
|
19538
19587
|
* @throws {RequiredError}
|
|
19539
19588
|
*/
|
|
19540
|
-
getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
19589
|
+
getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseViewDTO, any, {}>>;
|
|
19541
19590
|
/**
|
|
19542
19591
|
* Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs.
|
|
19543
19592
|
* @summary Update view indices
|
|
@@ -19548,7 +19597,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19548
19597
|
*/
|
|
19549
19598
|
updateIndices1(objectUuid: string, requestBody: {
|
|
19550
19599
|
[key: string]: number;
|
|
19551
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
19600
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
19552
19601
|
/**
|
|
19553
19602
|
* Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data.
|
|
19554
19603
|
* @summary Update an existing view
|
|
@@ -19558,7 +19607,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19558
19607
|
* @param {*} [options] Override http request option.
|
|
19559
19608
|
* @throws {RequiredError}
|
|
19560
19609
|
*/
|
|
19561
|
-
updateView(objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19610
|
+
updateView(objectUuid: string, viewUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19562
19611
|
}
|
|
19563
19612
|
/**
|
|
19564
19613
|
* WebMenusApi - axios parameter creator
|
|
@@ -19733,7 +19782,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19733
19782
|
* @param {*} [options] Override http request option.
|
|
19734
19783
|
* @throws {RequiredError}
|
|
19735
19784
|
*/
|
|
19736
|
-
createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19785
|
+
createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
19737
19786
|
/**
|
|
19738
19787
|
* Delete web menu
|
|
19739
19788
|
* @summary Delete web menu
|
|
@@ -19741,7 +19790,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19741
19790
|
* @param {*} [options] Override http request option.
|
|
19742
19791
|
* @throws {RequiredError}
|
|
19743
19792
|
*/
|
|
19744
|
-
deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19793
|
+
deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19745
19794
|
/**
|
|
19746
19795
|
* Show web menu
|
|
19747
19796
|
* @summary Show web menu
|
|
@@ -19749,7 +19798,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19749
19798
|
* @param {*} [options] Override http request option.
|
|
19750
19799
|
* @throws {RequiredError}
|
|
19751
19800
|
*/
|
|
19752
|
-
getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19801
|
+
getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebMenuDTO, any, {}>>;
|
|
19753
19802
|
/**
|
|
19754
19803
|
* Index web menus
|
|
19755
19804
|
* @summary Index web menus
|
|
@@ -19757,7 +19806,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19757
19806
|
* @param {*} [options] Override http request option.
|
|
19758
19807
|
* @throws {RequiredError}
|
|
19759
19808
|
*/
|
|
19760
|
-
indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
19809
|
+
indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebMenuDTO, any, {}>>;
|
|
19761
19810
|
/**
|
|
19762
19811
|
* Restore a deleted web menu by its UUID
|
|
19763
19812
|
* @summary Restore deleted web menu
|
|
@@ -19765,7 +19814,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19765
19814
|
* @param {*} [options] Override http request option.
|
|
19766
19815
|
* @throws {RequiredError}
|
|
19767
19816
|
*/
|
|
19768
|
-
restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19817
|
+
restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
19769
19818
|
/**
|
|
19770
19819
|
* Update web menu
|
|
19771
19820
|
* @summary Update web menu
|
|
@@ -19774,7 +19823,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19774
19823
|
* @param {*} [options] Override http request option.
|
|
19775
19824
|
* @throws {RequiredError}
|
|
19776
19825
|
*/
|
|
19777
|
-
updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19826
|
+
updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19778
19827
|
}
|
|
19779
19828
|
/**
|
|
19780
19829
|
* WebpagesApi - axios parameter creator
|
|
@@ -20940,7 +20989,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20940
20989
|
* @param {*} [options] Override http request option.
|
|
20941
20990
|
* @throws {RequiredError}
|
|
20942
20991
|
*/
|
|
20943
|
-
claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
20992
|
+
claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
20944
20993
|
/**
|
|
20945
20994
|
* Registers the current user as editing this webpage so other users are blocked from opening the builder.
|
|
20946
20995
|
* @summary Claim a webpage editing session
|
|
@@ -20949,7 +20998,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20949
20998
|
* @param {*} [options] Override http request option.
|
|
20950
20999
|
* @throws {RequiredError}
|
|
20951
21000
|
*/
|
|
20952
|
-
claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21001
|
+
claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
20953
21002
|
/**
|
|
20954
21003
|
* Copies selected properties for the chosen environments (e.g. production_title → german_production_title).
|
|
20955
21004
|
* @summary Copy properties to environments
|
|
@@ -20957,7 +21006,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20957
21006
|
* @param {*} [options] Override http request option.
|
|
20958
21007
|
* @throws {RequiredError}
|
|
20959
21008
|
*/
|
|
20960
|
-
copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
21009
|
+
copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListPropertyDTO, any, {}>>;
|
|
20961
21010
|
/**
|
|
20962
21011
|
* Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO.
|
|
20963
21012
|
* @summary Copy a template webpage from one environment to another
|
|
@@ -20967,7 +21016,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20967
21016
|
* @param {*} [options] Override http request option.
|
|
20968
21017
|
* @throws {RequiredError}
|
|
20969
21018
|
*/
|
|
20970
|
-
copyTemplateWebpage(objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21019
|
+
copyTemplateWebpage(objectName: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
20971
21020
|
/**
|
|
20972
21021
|
* Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO.
|
|
20973
21022
|
* @summary Copy a webpage from one environment to another
|
|
@@ -20977,7 +21026,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20977
21026
|
* @param {*} [options] Override http request option.
|
|
20978
21027
|
* @throws {RequiredError}
|
|
20979
21028
|
*/
|
|
20980
|
-
copyWebpage(uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21029
|
+
copyWebpage(uuid: string, fromEnvironment: string, toEnvironment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
20981
21030
|
/**
|
|
20982
21031
|
* Creates an environment.
|
|
20983
21032
|
* @summary Create an environment
|
|
@@ -20985,7 +21034,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20985
21034
|
* @param {*} [options] Override http request option.
|
|
20986
21035
|
* @throws {RequiredError}
|
|
20987
21036
|
*/
|
|
20988
|
-
createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise<
|
|
21037
|
+
createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
20989
21038
|
/**
|
|
20990
21039
|
* Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details.
|
|
20991
21040
|
* @summary Create or update template webpage
|
|
@@ -20995,7 +21044,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20995
21044
|
* @param {*} [options] Override http request option.
|
|
20996
21045
|
* @throws {RequiredError}
|
|
20997
21046
|
*/
|
|
20998
|
-
createOrUpdateTemplateWebpage(objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig): Promise<
|
|
21047
|
+
createOrUpdateTemplateWebpage(objectName: string, environment: string, templateWebpageDTO: TemplateWebpageDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
20999
21048
|
/**
|
|
21000
21049
|
*
|
|
21001
21050
|
* @summary Generate signed URL for protected webpage
|
|
@@ -21005,7 +21054,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21005
21054
|
* @param {*} [options] Override http request option.
|
|
21006
21055
|
* @throws {RequiredError}
|
|
21007
21056
|
*/
|
|
21008
|
-
createSignedUrl(uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig): Promise<
|
|
21057
|
+
createSignedUrl(uuid: string, environment?: string, createSignedUrlRequest?: CreateSignedUrlRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseSignedUrlResultDTO, any, {}>>;
|
|
21009
21058
|
/**
|
|
21010
21059
|
* Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced.
|
|
21011
21060
|
* @summary Create a new webpage
|
|
@@ -21014,7 +21063,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21014
21063
|
* @param {*} [options] Override http request option.
|
|
21015
21064
|
* @throws {RequiredError}
|
|
21016
21065
|
*/
|
|
21017
|
-
createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21066
|
+
createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
21018
21067
|
/**
|
|
21019
21068
|
* Soft deletes an environment.
|
|
21020
21069
|
* @summary Delete an environment
|
|
@@ -21022,7 +21071,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21022
21071
|
* @param {*} [options] Override http request option.
|
|
21023
21072
|
* @throws {RequiredError}
|
|
21024
21073
|
*/
|
|
21025
|
-
deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21074
|
+
deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21026
21075
|
/**
|
|
21027
21076
|
* Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects.
|
|
21028
21077
|
* @summary Get all public webpage slugs
|
|
@@ -21032,7 +21081,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21032
21081
|
* @param {*} [options] Override http request option.
|
|
21033
21082
|
* @throws {RequiredError}
|
|
21034
21083
|
*/
|
|
21035
|
-
getAllSlugs(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21084
|
+
getAllSlugs(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePublicEnvironmentDTO, any, {}>>;
|
|
21036
21085
|
/**
|
|
21037
21086
|
* Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details.
|
|
21038
21087
|
* @summary Fetch public company settings
|
|
@@ -21042,14 +21091,14 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21042
21091
|
* @param {*} [options] Override http request option.
|
|
21043
21092
|
* @throws {RequiredError}
|
|
21044
21093
|
*/
|
|
21045
|
-
getCompanySettings(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21094
|
+
getCompanySettings(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SimplePublicCompanyDTO, any, {}>>;
|
|
21046
21095
|
/**
|
|
21047
21096
|
* Retrieves a list of all environments.
|
|
21048
21097
|
* @summary Get all environments
|
|
21049
21098
|
* @param {*} [options] Override http request option.
|
|
21050
21099
|
* @throws {RequiredError}
|
|
21051
21100
|
*/
|
|
21052
|
-
getEnvironments(options?: RawAxiosRequestConfig): Promise<
|
|
21101
|
+
getEnvironments(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListEnvironmentDTO, any, {}>>;
|
|
21053
21102
|
/**
|
|
21054
21103
|
* Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects.
|
|
21055
21104
|
* @summary Fetch public web menus
|
|
@@ -21059,7 +21108,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21059
21108
|
* @param {*} [options] Override http request option.
|
|
21060
21109
|
* @throws {RequiredError}
|
|
21061
21110
|
*/
|
|
21062
|
-
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21111
|
+
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebMenuDTO, any, {}>>;
|
|
21063
21112
|
/**
|
|
21064
21113
|
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
21065
21114
|
* @summary Get filtered map markers for a public webpage
|
|
@@ -21076,7 +21125,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21076
21125
|
* @param {*} [options] Override http request option.
|
|
21077
21126
|
* @throws {RequiredError}
|
|
21078
21127
|
*/
|
|
21079
|
-
getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21128
|
+
getPublicMapLocations(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, recordPaginationRequest: RecordPaginationRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebpageMapLocationsDTO, any, {}>>;
|
|
21080
21129
|
/**
|
|
21081
21130
|
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
21082
21131
|
* @summary Get a hydrated preview for one public map marker
|
|
@@ -21093,7 +21142,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21093
21142
|
* @param {*} [options] Override http request option.
|
|
21094
21143
|
* @throws {RequiredError}
|
|
21095
21144
|
*/
|
|
21096
|
-
getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21145
|
+
getPublicMapMarkerPreview(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, mapMarkerPreviewRequest: MapMarkerPreviewRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
|
|
21097
21146
|
/**
|
|
21098
21147
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
21099
21148
|
* @summary Get previews for a public webpage
|
|
@@ -21110,7 +21159,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21110
21159
|
* @param {*} [options] Override http request option.
|
|
21111
21160
|
* @throws {RequiredError}
|
|
21112
21161
|
*/
|
|
21113
|
-
getPublicPreviews(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21162
|
+
getPublicPreviews(xCaraerSubdomain: string, pageUuid: string, componentUuid: string, layout: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
21114
21163
|
/**
|
|
21115
21164
|
* Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data.
|
|
21116
21165
|
* @summary Get a public webpage by slug
|
|
@@ -21126,7 +21175,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21126
21175
|
* @param {*} [options] Override http request option.
|
|
21127
21176
|
* @throws {RequiredError}
|
|
21128
21177
|
*/
|
|
21129
|
-
getPublicWebpage(xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21178
|
+
getPublicWebpage(xCaraerSubdomain: string, rootSlug: string, slug: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageDTO, any, {}>>;
|
|
21130
21179
|
/**
|
|
21131
21180
|
* Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data.
|
|
21132
21181
|
* @summary Get a public webpage by UUID
|
|
@@ -21141,7 +21190,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21141
21190
|
* @param {*} [options] Override http request option.
|
|
21142
21191
|
* @throws {RequiredError}
|
|
21143
21192
|
*/
|
|
21144
|
-
getPublicWebpageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21193
|
+
getPublicWebpageByUuid(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, authorization?: string, xCaraerWebpageAccess?: string, access?: string, token?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageDTO, any, {}>>;
|
|
21145
21194
|
/**
|
|
21146
21195
|
* Returns protection requirements without page content.
|
|
21147
21196
|
* @summary Get webpage protection metadata
|
|
@@ -21152,7 +21201,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21152
21201
|
* @param {*} [options] Override http request option.
|
|
21153
21202
|
* @throws {RequiredError}
|
|
21154
21203
|
*/
|
|
21155
|
-
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21204
|
+
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebpageProtectionInfoDTO, any, {}>>;
|
|
21156
21205
|
/**
|
|
21157
21206
|
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
21158
21207
|
* @summary Fetch public website module
|
|
@@ -21161,7 +21210,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21161
21210
|
* @param {*} [options] Override http request option.
|
|
21162
21211
|
* @throws {RequiredError}
|
|
21163
21212
|
*/
|
|
21164
|
-
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21213
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponse, any, {}>>;
|
|
21165
21214
|
/**
|
|
21166
21215
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
21167
21216
|
* @summary Get template webpage
|
|
@@ -21170,7 +21219,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21170
21219
|
* @param {*} [options] Override http request option.
|
|
21171
21220
|
* @throws {RequiredError}
|
|
21172
21221
|
*/
|
|
21173
|
-
getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21222
|
+
getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseTemplateWebpageDTO, any, {}>>;
|
|
21174
21223
|
/**
|
|
21175
21224
|
* Returns whether another user is actively editing the template webpage for the given object and environment.
|
|
21176
21225
|
* @summary Check if a template webpage is being edited
|
|
@@ -21179,7 +21228,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21179
21228
|
* @param {*} [options] Override http request option.
|
|
21180
21229
|
* @throws {RequiredError}
|
|
21181
21230
|
*/
|
|
21182
|
-
getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21231
|
+
getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
21183
21232
|
/**
|
|
21184
21233
|
* Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true.
|
|
21185
21234
|
* @summary Get webpage details
|
|
@@ -21189,7 +21238,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21189
21238
|
* @param {*} [options] Override http request option.
|
|
21190
21239
|
* @throws {RequiredError}
|
|
21191
21240
|
*/
|
|
21192
|
-
getWebpage(uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21241
|
+
getWebpage(uuid: string, smartened?: boolean, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageDTO, any, {}>>;
|
|
21193
21242
|
/**
|
|
21194
21243
|
* Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection).
|
|
21195
21244
|
* @summary Check if a webpage is being edited
|
|
@@ -21198,7 +21247,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21198
21247
|
* @param {*} [options] Override http request option.
|
|
21199
21248
|
* @throws {RequiredError}
|
|
21200
21249
|
*/
|
|
21201
|
-
getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21250
|
+
getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
21202
21251
|
/**
|
|
21203
21252
|
* Returns uuid and title for all webpage records across objects with a Page trait. Supports optional filters for published pages and excluding template-related pages.
|
|
21204
21253
|
* @summary List webpages for picker dropdowns
|
|
@@ -21208,7 +21257,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21208
21257
|
* @param {*} [options] Override http request option.
|
|
21209
21258
|
* @throws {RequiredError}
|
|
21210
21259
|
*/
|
|
21211
|
-
getWebpagePickerPages(environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
21260
|
+
getWebpagePickerPages(environment?: string, publishedOnly?: boolean, excludeTemplateRelated?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListWebpagePickerItemDTO, any, {}>>;
|
|
21212
21261
|
/**
|
|
21213
21262
|
*
|
|
21214
21263
|
* @summary List signed URL grants for a webpage
|
|
@@ -21217,7 +21266,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21217
21266
|
* @param {*} [options] Override http request option.
|
|
21218
21267
|
* @throws {RequiredError}
|
|
21219
21268
|
*/
|
|
21220
|
-
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21269
|
+
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
|
|
21221
21270
|
/**
|
|
21222
21271
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
21223
21272
|
* @summary Public URL for a library file
|
|
@@ -21225,7 +21274,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21225
21274
|
* @param {*} [options] Override http request option.
|
|
21226
21275
|
* @throws {RequiredError}
|
|
21227
21276
|
*/
|
|
21228
|
-
publishFile(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
21277
|
+
publishFile(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21229
21278
|
/**
|
|
21230
21279
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
21231
21280
|
* @summary Publish a webpage
|
|
@@ -21235,7 +21284,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21235
21284
|
* @param {*} [options] Override http request option.
|
|
21236
21285
|
* @throws {RequiredError}
|
|
21237
21286
|
*/
|
|
21238
|
-
publishWebpage(uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21287
|
+
publishWebpage(uuid: string, publishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
21239
21288
|
/**
|
|
21240
21289
|
* Releases the editing session held by the current user for this template webpage.
|
|
21241
21290
|
* @summary Release a template webpage editing session
|
|
@@ -21244,7 +21293,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21244
21293
|
* @param {*} [options] Override http request option.
|
|
21245
21294
|
* @throws {RequiredError}
|
|
21246
21295
|
*/
|
|
21247
|
-
releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21296
|
+
releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21248
21297
|
/**
|
|
21249
21298
|
* Releases the editing session held by the current user for this webpage.
|
|
21250
21299
|
* @summary Release a webpage editing session
|
|
@@ -21252,7 +21301,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21252
21301
|
* @param {*} [options] Override http request option.
|
|
21253
21302
|
* @throws {RequiredError}
|
|
21254
21303
|
*/
|
|
21255
|
-
releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21304
|
+
releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21256
21305
|
/**
|
|
21257
21306
|
*
|
|
21258
21307
|
* @summary Revoke a signed URL grant
|
|
@@ -21262,7 +21311,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21262
21311
|
* @param {*} [options] Override http request option.
|
|
21263
21312
|
* @throws {RequiredError}
|
|
21264
21313
|
*/
|
|
21265
|
-
revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21314
|
+
revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21266
21315
|
/**
|
|
21267
21316
|
* Validates password and returns a short-lived access token.
|
|
21268
21317
|
* @summary Unlock password-protected webpage
|
|
@@ -21274,7 +21323,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21274
21323
|
* @param {*} [options] Override http request option.
|
|
21275
21324
|
* @throws {RequiredError}
|
|
21276
21325
|
*/
|
|
21277
|
-
unlockPublicWebpage(xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21326
|
+
unlockPublicWebpage(xCaraerSubdomain: string, uuid: string, webpageUnlockRequest: WebpageUnlockRequest, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21278
21327
|
/**
|
|
21279
21328
|
* Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details.
|
|
21280
21329
|
* @summary Unpublish a webpage
|
|
@@ -21284,7 +21333,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21284
21333
|
* @param {*} [options] Override http request option.
|
|
21285
21334
|
* @throws {RequiredError}
|
|
21286
21335
|
*/
|
|
21287
|
-
unpublishWebpage(uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21336
|
+
unpublishWebpage(uuid: string, unpublishAt?: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
21288
21337
|
/**
|
|
21289
21338
|
* Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced.
|
|
21290
21339
|
* @summary Update a webpage
|
|
@@ -21294,7 +21343,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21294
21343
|
* @param {*} [options] Override http request option.
|
|
21295
21344
|
* @throws {RequiredError}
|
|
21296
21345
|
*/
|
|
21297
|
-
updateWebpage(uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21346
|
+
updateWebpage(uuid: string, webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
21298
21347
|
/**
|
|
21299
21348
|
* Uploads a file to S3 storage under the specified webpage\'s attachments folder, sets the file\'s ACL to public, and returns the public URL for the file in a SuccessResponse.
|
|
21300
21349
|
* @summary Upload a file for a webpage
|
|
@@ -21302,7 +21351,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21302
21351
|
* @param {*} [options] Override http request option.
|
|
21303
21352
|
* @throws {RequiredError}
|
|
21304
21353
|
*/
|
|
21305
|
-
uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21354
|
+
uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21306
21355
|
/**
|
|
21307
21356
|
* Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse.
|
|
21308
21357
|
* @summary Upload a file
|
|
@@ -21310,5 +21359,5 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21310
21359
|
* @param {*} [options] Override http request option.
|
|
21311
21360
|
* @throws {RequiredError}
|
|
21312
21361
|
*/
|
|
21313
|
-
uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise<
|
|
21362
|
+
uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21314
21363
|
}
|