@caraer/client 2.0.650 → 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/VERSION +1 -1
- package/api.ts +2 -2
- package/dist/api.d.ts +323 -322
- package/dist/api.js +4 -1
- package/dist/base.js +4 -1
- package/dist/esm/api.d.ts +2 -2
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/Record.md +2 -2
- 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
|
/**
|
|
@@ -2813,9 +2814,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2813
2814
|
};
|
|
2814
2815
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2815
2816
|
export interface ExistingWidgetSummary {
|
|
2817
|
+
'xproperty'?: string;
|
|
2816
2818
|
'ymetric'?: string;
|
|
2817
2819
|
'yproperty'?: string;
|
|
2818
|
-
'xproperty'?: string;
|
|
2819
2820
|
'title'?: string;
|
|
2820
2821
|
'chartType'?: string;
|
|
2821
2822
|
'xProperty'?: string;
|
|
@@ -3747,11 +3748,11 @@ export interface ModelRecord {
|
|
|
3747
3748
|
'complete'?: boolean;
|
|
3748
3749
|
'deleted'?: boolean;
|
|
3749
3750
|
'uuid': string;
|
|
3750
|
-
'user'?: PublicUserDTO;
|
|
3751
3751
|
'properties'?: Array<FilledProperty>;
|
|
3752
3752
|
'objects'?: {
|
|
3753
3753
|
[key: string]: any | null;
|
|
3754
3754
|
};
|
|
3755
|
+
'user'?: PublicUserDTO;
|
|
3755
3756
|
}
|
|
3756
3757
|
export interface MultiFile extends PropertyFormat {
|
|
3757
3758
|
}
|
|
@@ -8712,7 +8713,7 @@ export declare class AppBarIframeSessionsApi extends BaseAPI {
|
|
|
8712
8713
|
* @param {*} [options] Override http request option.
|
|
8713
8714
|
* @throws {RequiredError}
|
|
8714
8715
|
*/
|
|
8715
|
-
createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8716
|
+
createIframeSession(appBarUuid: string, appBarIframeSessionRequest?: AppBarIframeSessionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppBarIframeSessionTokenDTO, any, {}>>;
|
|
8716
8717
|
/**
|
|
8717
8718
|
* Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context.
|
|
8718
8719
|
* @summary Validate an iframe session token
|
|
@@ -8720,7 +8721,7 @@ export declare class AppBarIframeSessionsApi extends BaseAPI {
|
|
|
8720
8721
|
* @param {*} [options] Override http request option.
|
|
8721
8722
|
* @throws {RequiredError}
|
|
8722
8723
|
*/
|
|
8723
|
-
validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8724
|
+
validateIframeSession(appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppBarIframeSessionContextDTO, any, {}>>;
|
|
8724
8725
|
}
|
|
8725
8726
|
/**
|
|
8726
8727
|
* AppBarsApi - axios parameter creator
|
|
@@ -8819,7 +8820,7 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8819
8820
|
* @param {*} [options] Override http request option.
|
|
8820
8821
|
* @throws {RequiredError}
|
|
8821
8822
|
*/
|
|
8822
|
-
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, {}>>;
|
|
8823
8824
|
/**
|
|
8824
8825
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8825
8826
|
* @summary Trigger an action-based app bar
|
|
@@ -8828,7 +8829,7 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8828
8829
|
* @param {*} [options] Override http request option.
|
|
8829
8830
|
* @throws {RequiredError}
|
|
8830
8831
|
*/
|
|
8831
|
-
triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8832
|
+
triggerAppBar(appBarUuid: string, appBarTriggerRequest?: AppBarTriggerRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
8832
8833
|
}
|
|
8833
8834
|
export declare const ListAppBarsLocationEnum: {
|
|
8834
8835
|
readonly RecordPreview: "RECORD_PREVIEW";
|
|
@@ -9415,7 +9416,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9415
9416
|
* @param {*} [options] Override http request option.
|
|
9416
9417
|
* @throws {RequiredError}
|
|
9417
9418
|
*/
|
|
9418
|
-
deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise<
|
|
9419
|
+
deleteSecret(appUuid: string, name: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9419
9420
|
/**
|
|
9420
9421
|
*
|
|
9421
9422
|
* @summary Delete a state key
|
|
@@ -9424,7 +9425,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9424
9425
|
* @param {*} [options] Override http request option.
|
|
9425
9426
|
* @throws {RequiredError}
|
|
9426
9427
|
*/
|
|
9427
|
-
deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9428
|
+
deleteStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
9428
9429
|
/**
|
|
9429
9430
|
*
|
|
9430
9431
|
* @summary Enqueue an async serverless function job
|
|
@@ -9435,7 +9436,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9435
9436
|
*/
|
|
9436
9437
|
enqueueJob(appUuid: string, requestBody: {
|
|
9437
9438
|
[key: string]: any | null;
|
|
9438
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9439
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9439
9440
|
/**
|
|
9440
9441
|
*
|
|
9441
9442
|
* @summary Get async job status
|
|
@@ -9444,7 +9445,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9444
9445
|
* @param {*} [options] Override http request option.
|
|
9445
9446
|
* @throws {RequiredError}
|
|
9446
9447
|
*/
|
|
9447
|
-
getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<
|
|
9448
|
+
getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9448
9449
|
/**
|
|
9449
9450
|
*
|
|
9450
9451
|
* @summary Load read-only Markdown content for a setting
|
|
@@ -9453,7 +9454,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9453
9454
|
* @param {*} [options] Override http request option.
|
|
9454
9455
|
* @throws {RequiredError}
|
|
9455
9456
|
*/
|
|
9456
|
-
getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<
|
|
9457
|
+
getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
9457
9458
|
/**
|
|
9458
9459
|
*
|
|
9459
9460
|
* @summary Get installation state map
|
|
@@ -9461,7 +9462,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9461
9462
|
* @param {*} [options] Override http request option.
|
|
9462
9463
|
* @throws {RequiredError}
|
|
9463
9464
|
*/
|
|
9464
|
-
getState(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9465
|
+
getState(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9465
9466
|
/**
|
|
9466
9467
|
*
|
|
9467
9468
|
* @summary Get a single state key
|
|
@@ -9470,7 +9471,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9470
9471
|
* @param {*} [options] Override http request option.
|
|
9471
9472
|
* @throws {RequiredError}
|
|
9472
9473
|
*/
|
|
9473
|
-
getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9474
|
+
getStateKey(appUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObject, any, {}>>;
|
|
9474
9475
|
/**
|
|
9475
9476
|
*
|
|
9476
9477
|
* @summary List external OAuth connection status
|
|
@@ -9478,7 +9479,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9478
9479
|
* @param {*} [options] Override http request option.
|
|
9479
9480
|
* @throws {RequiredError}
|
|
9480
9481
|
*/
|
|
9481
|
-
listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9482
|
+
listConnections(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListAppConnectionStatusDTO, any, {}>>;
|
|
9482
9483
|
/**
|
|
9483
9484
|
*
|
|
9484
9485
|
* @summary List secret names (no values)
|
|
@@ -9486,7 +9487,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9486
9487
|
* @param {*} [options] Override http request option.
|
|
9487
9488
|
* @throws {RequiredError}
|
|
9488
9489
|
*/
|
|
9489
|
-
listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
9490
|
+
listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListString, any, {}>>;
|
|
9490
9491
|
/**
|
|
9491
9492
|
*
|
|
9492
9493
|
* @summary Merge COMPANY-scoped installation settings from the app runtime
|
|
@@ -9495,7 +9496,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9495
9496
|
* @param {*} [options] Override http request option.
|
|
9496
9497
|
* @throws {RequiredError}
|
|
9497
9498
|
*/
|
|
9498
|
-
mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<
|
|
9499
|
+
mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9499
9500
|
/**
|
|
9500
9501
|
*
|
|
9501
9502
|
* @summary Set an encrypted secret
|
|
@@ -9507,7 +9508,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9507
9508
|
*/
|
|
9508
9509
|
putSecret(appUuid: string, name: string, requestBody: {
|
|
9509
9510
|
[key: string]: any | null;
|
|
9510
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9511
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9511
9512
|
/**
|
|
9512
9513
|
*
|
|
9513
9514
|
* @summary Replace/merge installation state (shallow merge)
|
|
@@ -9518,7 +9519,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9518
9519
|
*/
|
|
9519
9520
|
putState(appUuid: string, requestBody: {
|
|
9520
9521
|
[key: string]: any | null;
|
|
9521
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9522
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9522
9523
|
/**
|
|
9523
9524
|
*
|
|
9524
9525
|
* @summary Put a single state key
|
|
@@ -9528,7 +9529,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9528
9529
|
* @param {*} [options] Override http request option.
|
|
9529
9530
|
* @throws {RequiredError}
|
|
9530
9531
|
*/
|
|
9531
|
-
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, {}>>;
|
|
9532
9533
|
/**
|
|
9533
9534
|
*
|
|
9534
9535
|
* @summary Revoke external OAuth connection tokens by connection id or provider name
|
|
@@ -9537,7 +9538,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9537
9538
|
* @param {*} [options] Override http request option.
|
|
9538
9539
|
* @throws {RequiredError}
|
|
9539
9540
|
*/
|
|
9540
|
-
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<
|
|
9541
|
+
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9541
9542
|
/**
|
|
9542
9543
|
*
|
|
9543
9544
|
* @summary Run SQL in this installation\'s Postgres schema
|
|
@@ -9548,7 +9549,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9548
9549
|
*/
|
|
9549
9550
|
runInstallationSql(appUuid: string, requestBody: {
|
|
9550
9551
|
[key: string]: any | null;
|
|
9551
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9552
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9552
9553
|
/**
|
|
9553
9554
|
*
|
|
9554
9555
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9557,7 +9558,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9557
9558
|
* @param {*} [options] Override http request option.
|
|
9558
9559
|
* @throws {RequiredError}
|
|
9559
9560
|
*/
|
|
9560
|
-
saveUserSettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<
|
|
9561
|
+
saveUserSettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9561
9562
|
/**
|
|
9562
9563
|
*
|
|
9563
9564
|
* @summary Start external OAuth authorize (returns provider authorize URL)
|
|
@@ -9568,7 +9569,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9568
9569
|
* @param {*} [options] Override http request option.
|
|
9569
9570
|
* @throws {RequiredError}
|
|
9570
9571
|
*/
|
|
9571
|
-
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, {}>>;
|
|
9572
9573
|
/**
|
|
9573
9574
|
*
|
|
9574
9575
|
* @summary Trigger an ACTION setting without saving settings
|
|
@@ -9577,7 +9578,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9577
9578
|
* @param {*} [options] Override http request option.
|
|
9578
9579
|
* @throws {RequiredError}
|
|
9579
9580
|
*/
|
|
9580
|
-
triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<
|
|
9581
|
+
triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9581
9582
|
/**
|
|
9582
9583
|
*
|
|
9583
9584
|
* @summary Update an external OAuth connection display label
|
|
@@ -9589,7 +9590,7 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9589
9590
|
*/
|
|
9590
9591
|
updateConnectionLabel(appUuid: string, connectionId: string, requestBody: {
|
|
9591
9592
|
[key: string]: string;
|
|
9592
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9593
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
9593
9594
|
}
|
|
9594
9595
|
/**
|
|
9595
9596
|
* ApplicationsApi - axios parameter creator
|
|
@@ -10503,7 +10504,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10503
10504
|
* @param {*} [options] Override http request option.
|
|
10504
10505
|
* @throws {RequiredError}
|
|
10505
10506
|
*/
|
|
10506
|
-
createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10507
|
+
createAppWebhookForApp(appUuid: string, subscribeWebhookDTO: SubscribeWebhookDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10507
10508
|
/**
|
|
10508
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.
|
|
10509
10510
|
* @summary Create a private app
|
|
@@ -10511,7 +10512,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10511
10512
|
* @param {*} [options] Override http request option.
|
|
10512
10513
|
* @throws {RequiredError}
|
|
10513
10514
|
*/
|
|
10514
|
-
createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10515
|
+
createPrivateApp(createPrivateAppRequest: CreatePrivateAppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10515
10516
|
/**
|
|
10516
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.
|
|
10517
10518
|
* @summary Create a public app
|
|
@@ -10519,7 +10520,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10519
10520
|
* @param {*} [options] Override http request option.
|
|
10520
10521
|
* @throws {RequiredError}
|
|
10521
10522
|
*/
|
|
10522
|
-
createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10523
|
+
createPublicApp(appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
10523
10524
|
/**
|
|
10524
10525
|
* Deletes a webhook that belongs to the specified app and the authenticated user\'s selected company.
|
|
10525
10526
|
* @summary Delete a webhook for an app
|
|
@@ -10528,7 +10529,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10528
10529
|
* @param {*} [options] Override http request option.
|
|
10529
10530
|
* @throws {RequiredError}
|
|
10530
10531
|
*/
|
|
10531
|
-
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10532
|
+
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
10532
10533
|
/**
|
|
10533
10534
|
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
10534
10535
|
* @summary Delete a private app
|
|
@@ -10536,7 +10537,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10536
10537
|
* @param {*} [options] Override http request option.
|
|
10537
10538
|
* @throws {RequiredError}
|
|
10538
10539
|
*/
|
|
10539
|
-
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10540
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
10540
10541
|
/**
|
|
10541
10542
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10542
10543
|
* @summary Retrieve application details by UUID
|
|
@@ -10544,7 +10545,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10544
10545
|
* @param {*} [options] Override http request option.
|
|
10545
10546
|
* @throws {RequiredError}
|
|
10546
10547
|
*/
|
|
10547
|
-
getApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10548
|
+
getApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10548
10549
|
/**
|
|
10549
10550
|
* Fetches a single webhook that belongs to the specified app.
|
|
10550
10551
|
* @summary Get a webhook for an app
|
|
@@ -10553,7 +10554,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10553
10554
|
* @param {*} [options] Override http request option.
|
|
10554
10555
|
* @throws {RequiredError}
|
|
10555
10556
|
*/
|
|
10556
|
-
getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10557
|
+
getAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSubscribeWebhookDTO, any, {}>>;
|
|
10557
10558
|
/**
|
|
10558
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.
|
|
10559
10560
|
* @summary Recent webhook delivery decisions
|
|
@@ -10562,7 +10563,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10562
10563
|
* @param {*} [options] Override http request option.
|
|
10563
10564
|
* @throws {RequiredError}
|
|
10564
10565
|
*/
|
|
10565
|
-
getAppWebhookDeliveries(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10566
|
+
getAppWebhookDeliveries(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListEntry, any, {}>>;
|
|
10566
10567
|
/**
|
|
10567
10568
|
* Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user\'s selected company.
|
|
10568
10569
|
* @summary Retrieve a paginated list of webhooks for an app
|
|
@@ -10571,7 +10572,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10571
10572
|
* @param {*} [options] Override http request option.
|
|
10572
10573
|
* @throws {RequiredError}
|
|
10573
10574
|
*/
|
|
10574
|
-
getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10575
|
+
getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSubscribeWebhookDTO, any, {}>>;
|
|
10575
10576
|
/**
|
|
10576
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.
|
|
10577
10578
|
* @summary Retrieve a paginated list of applications
|
|
@@ -10583,7 +10584,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10583
10584
|
* @param {*} [options] Override http request option.
|
|
10584
10585
|
* @throws {RequiredError}
|
|
10585
10586
|
*/
|
|
10586
|
-
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, {}>>;
|
|
10587
10588
|
/**
|
|
10588
10589
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10589
10590
|
* @summary Get current user\'s company information
|
|
@@ -10591,7 +10592,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10591
10592
|
* @param {*} [options] Override http request option.
|
|
10592
10593
|
* @throws {RequiredError}
|
|
10593
10594
|
*/
|
|
10594
|
-
getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10595
|
+
getCompanyInformation(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SimplePublicCompanyDTO, any, {}>>;
|
|
10595
10596
|
/**
|
|
10596
10597
|
* Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects.
|
|
10597
10598
|
* @summary Retrieve apps created by the logged-in user\'s selected company
|
|
@@ -10599,7 +10600,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10599
10600
|
* @param {*} [options] Override http request option.
|
|
10600
10601
|
* @throws {RequiredError}
|
|
10601
10602
|
*/
|
|
10602
|
-
getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10603
|
+
getMyCreatedApps(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10603
10604
|
/**
|
|
10604
10605
|
* Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App.
|
|
10605
10606
|
* @summary Get a public app (creator view)
|
|
@@ -10607,7 +10608,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10607
10608
|
* @param {*} [options] Override http request option.
|
|
10608
10609
|
* @throws {RequiredError}
|
|
10609
10610
|
*/
|
|
10610
|
-
getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10611
|
+
getPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10611
10612
|
/**
|
|
10612
10613
|
* Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function.
|
|
10613
10614
|
* @summary Get app runtime logs
|
|
@@ -10617,7 +10618,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10617
10618
|
* @param {*} [options] Override http request option.
|
|
10618
10619
|
* @throws {RequiredError}
|
|
10619
10620
|
*/
|
|
10620
|
-
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, {}>>;
|
|
10621
10622
|
/**
|
|
10622
10623
|
* Returns all supported record webhook events with their details.
|
|
10623
10624
|
* @summary Get available webhook record events
|
|
@@ -10625,7 +10626,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10625
10626
|
* @param {*} [options] Override http request option.
|
|
10626
10627
|
* @throws {RequiredError}
|
|
10627
10628
|
*/
|
|
10628
|
-
getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10629
|
+
getWebhookEvents(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10629
10630
|
[key: string]: any;
|
|
10630
10631
|
}[], any, {}>>;
|
|
10631
10632
|
/**
|
|
@@ -10635,7 +10636,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10635
10636
|
* @param {*} [options] Override http request option.
|
|
10636
10637
|
* @throws {RequiredError}
|
|
10637
10638
|
*/
|
|
10638
|
-
getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10639
|
+
getWebhookFormats(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10639
10640
|
[key: string]: any;
|
|
10640
10641
|
}[], any, {}>>;
|
|
10641
10642
|
/**
|
|
@@ -10646,7 +10647,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10646
10647
|
* @param {*} [options] Override http request option.
|
|
10647
10648
|
* @throws {RequiredError}
|
|
10648
10649
|
*/
|
|
10649
|
-
getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise<
|
|
10650
|
+
getWebhookPropertyTopics(appUuid: string, object: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
10650
10651
|
[key: string]: string;
|
|
10651
10652
|
}[], any, {}>>;
|
|
10652
10653
|
/**
|
|
@@ -10657,14 +10658,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10657
10658
|
* @param {*} [options] Override http request option.
|
|
10658
10659
|
* @throws {RequiredError}
|
|
10659
10660
|
*/
|
|
10660
|
-
installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10661
|
+
installApp(uuid: string, installAppRequest?: InstallAppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10661
10662
|
/**
|
|
10662
10663
|
* Returns the allowed category keys and labels for public app marketplace listings.
|
|
10663
10664
|
* @summary List predefined marketplace app categories
|
|
10664
10665
|
* @param {*} [options] Override http request option.
|
|
10665
10666
|
* @throws {RequiredError}
|
|
10666
10667
|
*/
|
|
10667
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<
|
|
10668
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10668
10669
|
/**
|
|
10669
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.
|
|
10670
10671
|
* @summary List available app categories
|
|
@@ -10673,7 +10674,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10673
10674
|
* @param {*} [options] Override http request option.
|
|
10674
10675
|
* @throws {RequiredError}
|
|
10675
10676
|
*/
|
|
10676
|
-
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10677
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10677
10678
|
/**
|
|
10678
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.
|
|
10679
10680
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10682,7 +10683,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10682
10683
|
* @param {*} [options] Override http request option.
|
|
10683
10684
|
* @throws {RequiredError}
|
|
10684
10685
|
*/
|
|
10685
|
-
loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10686
|
+
loadSettingOptions(uuid: string, loadAppSettingOptionsRequest: LoadAppSettingOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseLoadAppSettingOptionsResponse, any, {}>>;
|
|
10686
10687
|
/**
|
|
10687
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.
|
|
10688
10689
|
* @summary Migrate an app from platform V1 to V2
|
|
@@ -10691,7 +10692,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10691
10692
|
* @param {*} [options] Override http request option.
|
|
10692
10693
|
* @throws {RequiredError}
|
|
10693
10694
|
*/
|
|
10694
|
-
migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise<
|
|
10695
|
+
migrateToV2(uuid: string, migrateAppToV2Request?: MigrateAppToV2Request, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
10695
10696
|
/**
|
|
10696
10697
|
* Resumes future events for only the selected company and resets its failure counter.
|
|
10697
10698
|
* @summary Reactivate a company webhook
|
|
@@ -10700,7 +10701,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10700
10701
|
* @param {*} [options] Override http request option.
|
|
10701
10702
|
* @throws {RequiredError}
|
|
10702
10703
|
*/
|
|
10703
|
-
reactivateAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10704
|
+
reactivateAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSubscribeWebhookDTO, any, {}>>;
|
|
10704
10705
|
/**
|
|
10705
10706
|
* Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO.
|
|
10706
10707
|
* @summary Review a public app
|
|
@@ -10709,7 +10710,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10709
10710
|
* @param {*} [options] Override http request option.
|
|
10710
10711
|
* @throws {RequiredError}
|
|
10711
10712
|
*/
|
|
10712
|
-
reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10713
|
+
reviewPublicApp(uuid: string, reviewRequest: ReviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10713
10714
|
/**
|
|
10714
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.
|
|
10715
10716
|
* @summary Rotate application configurations
|
|
@@ -10717,7 +10718,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10717
10718
|
* @param {*} [options] Override http request option.
|
|
10718
10719
|
* @throws {RequiredError}
|
|
10719
10720
|
*/
|
|
10720
|
-
rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10721
|
+
rotateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10721
10722
|
/**
|
|
10722
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.
|
|
10723
10724
|
* @summary Stream app runtime logs (SSE)
|
|
@@ -10725,7 +10726,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10725
10726
|
* @param {*} [options] Override http request option.
|
|
10726
10727
|
* @throws {RequiredError}
|
|
10727
10728
|
*/
|
|
10728
|
-
streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10729
|
+
streamRuntimeLogs(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SseEmitter, any, {}>>;
|
|
10729
10730
|
/**
|
|
10730
10731
|
* Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO.
|
|
10731
10732
|
* @summary Submit a public app for review
|
|
@@ -10733,7 +10734,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10733
10734
|
* @param {*} [options] Override http request option.
|
|
10734
10735
|
* @throws {RequiredError}
|
|
10735
10736
|
*/
|
|
10736
|
-
submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10737
|
+
submitPublicApp(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10737
10738
|
/**
|
|
10738
10739
|
* Generates a test webhook payload for a specific record and event type. Uses the same payload generation logic as live webhook delivery.
|
|
10739
10740
|
* @summary Test a webhook for an app
|
|
@@ -10745,7 +10746,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10745
10746
|
* @param {*} [options] Override http request option.
|
|
10746
10747
|
* @throws {RequiredError}
|
|
10747
10748
|
*/
|
|
10748
|
-
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, {}>>;
|
|
10749
10750
|
/**
|
|
10750
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).
|
|
10751
10752
|
* @summary Test a webhook for an app (auto-resolve)
|
|
@@ -10754,7 +10755,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10754
10755
|
* @param {*} [options] Override http request option.
|
|
10755
10756
|
* @throws {RequiredError}
|
|
10756
10757
|
*/
|
|
10757
|
-
testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
10758
|
+
testAppWebhookAuto(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
10758
10759
|
/**
|
|
10759
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.
|
|
10760
10761
|
* @summary Test an unsaved webhook for an app
|
|
@@ -10763,7 +10764,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10763
10764
|
* @param {*} [options] Override http request option.
|
|
10764
10765
|
* @throws {RequiredError}
|
|
10765
10766
|
*/
|
|
10766
|
-
testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10767
|
+
testAppWebhookUnsaved(appUuid: string, testWebhookRequest: TestWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
10767
10768
|
/**
|
|
10768
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.
|
|
10769
10770
|
* @summary Uninstall an application
|
|
@@ -10772,7 +10773,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10772
10773
|
* @param {*} [options] Override http request option.
|
|
10773
10774
|
* @throws {RequiredError}
|
|
10774
10775
|
*/
|
|
10775
|
-
uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10776
|
+
uninstallApp(uuid: string, appRequest: AppRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10776
10777
|
/**
|
|
10777
10778
|
* Updates an existing webhook that belongs to the specified app and the authenticated user\'s selected company.
|
|
10778
10779
|
* @summary Update a webhook for an app
|
|
@@ -10782,7 +10783,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10782
10783
|
* @param {*} [options] Override http request option.
|
|
10783
10784
|
* @throws {RequiredError}
|
|
10784
10785
|
*/
|
|
10785
|
-
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, {}>>;
|
|
10786
10787
|
/**
|
|
10787
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.
|
|
10788
10789
|
* @summary Update a public app (creator edit)
|
|
@@ -10791,7 +10792,7 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10791
10792
|
* @param {*} [options] Override http request option.
|
|
10792
10793
|
* @throws {RequiredError}
|
|
10793
10794
|
*/
|
|
10794
|
-
updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<
|
|
10795
|
+
updatePublicApp(uuid: string, appDTO: AppDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAppDTO, any, {}>>;
|
|
10795
10796
|
}
|
|
10796
10797
|
/**
|
|
10797
10798
|
* AutomationsApi - axios parameter creator
|
|
@@ -10839,7 +10840,7 @@ export declare class AutomationsApi extends BaseAPI {
|
|
|
10839
10840
|
* @param {*} [options] Override http request option.
|
|
10840
10841
|
* @throws {RequiredError}
|
|
10841
10842
|
*/
|
|
10842
|
-
getToken(options?: RawAxiosRequestConfig): Promise<
|
|
10843
|
+
getToken(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
10843
10844
|
}
|
|
10844
10845
|
/**
|
|
10845
10846
|
* BillingApi - axios parameter creator
|
|
@@ -10908,14 +10909,14 @@ export declare class BillingApi extends BaseAPI {
|
|
|
10908
10909
|
* @param {*} [options] Override http request option.
|
|
10909
10910
|
* @throws {RequiredError}
|
|
10910
10911
|
*/
|
|
10911
|
-
getStatus(options?: RawAxiosRequestConfig): Promise<
|
|
10912
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseBillingStatusDTO, any, {}>>;
|
|
10912
10913
|
/**
|
|
10913
10914
|
* Triggers Jortt to email the linked customer a direct-debit authorization payment link.
|
|
10914
10915
|
* @summary Send billing setup email
|
|
10915
10916
|
* @param {*} [options] Override http request option.
|
|
10916
10917
|
* @throws {RequiredError}
|
|
10917
10918
|
*/
|
|
10918
|
-
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<
|
|
10919
|
+
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
|
|
10919
10920
|
}
|
|
10920
10921
|
/**
|
|
10921
10922
|
* CMSModulesApi - axios parameter creator
|
|
@@ -11033,7 +11034,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11033
11034
|
* @param {*} [options] Override http request option.
|
|
11034
11035
|
* @throws {RequiredError}
|
|
11035
11036
|
*/
|
|
11036
|
-
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11037
|
+
list(appUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11037
11038
|
/**
|
|
11038
11039
|
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
11039
11040
|
* @summary Publish an app\'s CMS module package
|
|
@@ -11044,7 +11045,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11044
11045
|
*/
|
|
11045
11046
|
publishPackage(appUuid: string, requestBody: {
|
|
11046
11047
|
[key: string]: any | null;
|
|
11047
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
11048
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11048
11049
|
/**
|
|
11049
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.
|
|
11050
11051
|
* @summary Replace an app\'s CMS module catalog
|
|
@@ -11055,7 +11056,7 @@ export declare class CMSModulesApi extends BaseAPI {
|
|
|
11055
11056
|
*/
|
|
11056
11057
|
upsert(appUuid: string, requestBody: {
|
|
11057
11058
|
[key: string]: any | null;
|
|
11058
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
11059
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
11059
11060
|
}
|
|
11060
11061
|
/**
|
|
11061
11062
|
* CMSV2EnvironmentsApi - axios parameter creator
|
|
@@ -11257,7 +11258,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11257
11258
|
* @param {*} [options] Override http request option.
|
|
11258
11259
|
* @throws {RequiredError}
|
|
11259
11260
|
*/
|
|
11260
|
-
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
11261
|
+
create3(cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
11261
11262
|
/**
|
|
11262
11263
|
*
|
|
11263
11264
|
* @summary Delete an environment except main
|
|
@@ -11265,7 +11266,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11265
11266
|
* @param {*} [options] Override http request option.
|
|
11266
11267
|
* @throws {RequiredError}
|
|
11267
11268
|
*/
|
|
11268
|
-
delete1(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
11269
|
+
delete1(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11269
11270
|
/**
|
|
11270
11271
|
*
|
|
11271
11272
|
* @summary Translation group for a record
|
|
@@ -11273,7 +11274,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11273
11274
|
* @param {*} [options] Override http request option.
|
|
11274
11275
|
* @throws {RequiredError}
|
|
11275
11276
|
*/
|
|
11276
|
-
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11277
|
+
group(recordUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
11277
11278
|
/**
|
|
11278
11279
|
*
|
|
11279
11280
|
* @summary Link two records as translations
|
|
@@ -11282,14 +11283,14 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11282
11283
|
* @param {*} [options] Override http request option.
|
|
11283
11284
|
* @throws {RequiredError}
|
|
11284
11285
|
*/
|
|
11285
|
-
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11286
|
+
link(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11286
11287
|
/**
|
|
11287
11288
|
*
|
|
11288
11289
|
* @summary List company environments
|
|
11289
11290
|
* @param {*} [options] Override http request option.
|
|
11290
11291
|
* @throws {RequiredError}
|
|
11291
11292
|
*/
|
|
11292
|
-
list2(options?: RawAxiosRequestConfig): Promise<
|
|
11293
|
+
list2(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsEnvironmentDTO, any, {}>>;
|
|
11293
11294
|
/**
|
|
11294
11295
|
*
|
|
11295
11296
|
* @summary Unlink a translation edge
|
|
@@ -11298,7 +11299,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11298
11299
|
* @param {*} [options] Override http request option.
|
|
11299
11300
|
* @throws {RequiredError}
|
|
11300
11301
|
*/
|
|
11301
|
-
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
11302
|
+
unlink(fromUuid: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
11302
11303
|
/**
|
|
11303
11304
|
*
|
|
11304
11305
|
* @summary Update routing, auth or htmlLang. Keys are immutable.
|
|
@@ -11307,7 +11308,7 @@ export declare class CMSV2EnvironmentsApi extends BaseAPI {
|
|
|
11307
11308
|
* @param {*} [options] Override http request option.
|
|
11308
11309
|
* @throws {RequiredError}
|
|
11309
11310
|
*/
|
|
11310
|
-
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
11311
|
+
update1(key: string, cmsEnvironmentDTO: CmsEnvironmentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsEnvironmentDTO, any, {}>>;
|
|
11311
11312
|
}
|
|
11312
11313
|
/**
|
|
11313
11314
|
* CMSV2PagesApi - axios parameter creator
|
|
@@ -12010,7 +12011,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12010
12011
|
*/
|
|
12011
12012
|
aiRewrite(recordUuid: string, requestBody: {
|
|
12012
12013
|
[key: string]: any | null;
|
|
12013
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12014
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12014
12015
|
/**
|
|
12015
12016
|
*
|
|
12016
12017
|
* @summary Create a translated sibling page for an environment
|
|
@@ -12019,7 +12020,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12019
12020
|
* @param {*} [options] Override http request option.
|
|
12020
12021
|
* @throws {RequiredError}
|
|
12021
12022
|
*/
|
|
12022
|
-
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12023
|
+
createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12023
12024
|
/**
|
|
12024
12025
|
*
|
|
12025
12026
|
* @summary Discard a Modify-this-module playground session
|
|
@@ -12028,14 +12029,14 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12028
12029
|
* @param {*} [options] Override http request option.
|
|
12029
12030
|
* @throws {RequiredError}
|
|
12030
12031
|
*/
|
|
12031
|
-
discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<
|
|
12032
|
+
discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12032
12033
|
/**
|
|
12033
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.
|
|
12034
12035
|
* @summary Create or reuse the custom 404 page
|
|
12035
12036
|
* @param {*} [options] Override http request option.
|
|
12036
12037
|
* @throws {RequiredError}
|
|
12037
12038
|
*/
|
|
12038
|
-
ensureNotFound(options?: RawAxiosRequestConfig): Promise<
|
|
12039
|
+
ensureNotFound(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12039
12040
|
/**
|
|
12040
12041
|
*
|
|
12041
12042
|
* @summary Environment coverage for the builder dropdown
|
|
@@ -12043,7 +12044,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12043
12044
|
* @param {*} [options] Override http request option.
|
|
12044
12045
|
* @throws {RequiredError}
|
|
12045
12046
|
*/
|
|
12046
|
-
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12047
|
+
environmentCoverage(recordUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12047
12048
|
/**
|
|
12048
12049
|
*
|
|
12049
12050
|
* @summary Load a page for the builder
|
|
@@ -12053,7 +12054,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12053
12054
|
* @param {*} [options] Override http request option.
|
|
12054
12055
|
* @throws {RequiredError}
|
|
12055
12056
|
*/
|
|
12056
|
-
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, {}>>;
|
|
12057
12058
|
/**
|
|
12058
12059
|
*
|
|
12059
12060
|
* @summary CMS v2 object template document
|
|
@@ -12062,7 +12063,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12062
12063
|
* @param {*} [options] Override http request option.
|
|
12063
12064
|
* @throws {RequiredError}
|
|
12064
12065
|
*/
|
|
12065
|
-
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12066
|
+
getTemplate(objectUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
|
|
12066
12067
|
/**
|
|
12067
12068
|
*
|
|
12068
12069
|
* @summary Draft snapshots for one locale
|
|
@@ -12071,7 +12072,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12071
12072
|
* @param {*} [options] Override http request option.
|
|
12072
12073
|
* @throws {RequiredError}
|
|
12073
12074
|
*/
|
|
12074
|
-
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12075
|
+
history(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListMapStringObject, any, {}>>;
|
|
12075
12076
|
/**
|
|
12076
12077
|
*
|
|
12077
12078
|
* @summary Host this page on another environment
|
|
@@ -12080,14 +12081,14 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12080
12081
|
* @param {*} [options] Override http request option.
|
|
12081
12082
|
* @throws {RequiredError}
|
|
12082
12083
|
*/
|
|
12083
|
-
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12084
|
+
hostOnEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12084
12085
|
/**
|
|
12085
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.
|
|
12086
12087
|
* @summary Modules available to this company
|
|
12087
12088
|
* @param {*} [options] Override http request option.
|
|
12088
12089
|
* @throws {RequiredError}
|
|
12089
12090
|
*/
|
|
12090
|
-
library(options?: RawAxiosRequestConfig): Promise<
|
|
12091
|
+
library(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListCmsModuleDTO, any, {}>>;
|
|
12091
12092
|
/**
|
|
12092
12093
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
12093
12094
|
* @summary Apply patches to a page draft
|
|
@@ -12096,7 +12097,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12096
12097
|
* @param {*} [options] Override http request option.
|
|
12097
12098
|
* @throws {RequiredError}
|
|
12098
12099
|
*/
|
|
12099
|
-
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12100
|
+
patch(recordUuid: string, cmsPagePatchRequest: CmsPagePatchRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12100
12101
|
/**
|
|
12101
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.
|
|
12102
12103
|
* @summary Signed preview URL for the builder iframe
|
|
@@ -12106,7 +12107,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12106
12107
|
* @param {*} [options] Override http request option.
|
|
12107
12108
|
* @throws {RequiredError}
|
|
12108
12109
|
*/
|
|
12109
|
-
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, {}>>;
|
|
12110
12111
|
/**
|
|
12111
12112
|
*
|
|
12112
12113
|
* @summary Rewrite forked module source from a prompt
|
|
@@ -12118,7 +12119,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12118
12119
|
*/
|
|
12119
12120
|
promptModuleFork(recordUuid: string, sessionId: string, requestBody: {
|
|
12120
12121
|
[key: string]: any | null;
|
|
12121
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12122
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12122
12123
|
/**
|
|
12123
12124
|
* Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
|
|
12124
12125
|
* @summary Publish one locale, or all of them
|
|
@@ -12128,7 +12129,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12128
12129
|
* @param {*} [options] Override http request option.
|
|
12129
12130
|
* @throws {RequiredError}
|
|
12130
12131
|
*/
|
|
12131
|
-
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, {}>>;
|
|
12132
12133
|
/**
|
|
12133
12134
|
*
|
|
12134
12135
|
* @summary Restore a draft snapshot
|
|
@@ -12138,7 +12139,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12138
12139
|
* @param {*} [options] Override http request option.
|
|
12139
12140
|
* @throws {RequiredError}
|
|
12140
12141
|
*/
|
|
12141
|
-
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, {}>>;
|
|
12142
12143
|
/**
|
|
12143
12144
|
*
|
|
12144
12145
|
* @summary Replace a page draft
|
|
@@ -12148,7 +12149,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12148
12149
|
* @param {*} [options] Override http request option.
|
|
12149
12150
|
* @throws {RequiredError}
|
|
12150
12151
|
*/
|
|
12151
|
-
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, {}>>;
|
|
12152
12153
|
/**
|
|
12153
12154
|
*
|
|
12154
12155
|
* @summary Update slug, title, excerpt, SEO and page scripts
|
|
@@ -12160,7 +12161,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12160
12161
|
*/
|
|
12161
12162
|
saveMeta(recordUuid: string, requestBody: {
|
|
12162
12163
|
[key: string]: any | null;
|
|
12163
|
-
}, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12164
|
+
}, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12164
12165
|
/**
|
|
12165
12166
|
* Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
|
|
12166
12167
|
* @summary Publish the forked module into a private app
|
|
@@ -12172,7 +12173,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12172
12173
|
*/
|
|
12173
12174
|
saveModuleFork(recordUuid: string, sessionId: string, requestBody: {
|
|
12174
12175
|
[key: string]: any | null;
|
|
12175
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12176
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12176
12177
|
/**
|
|
12177
12178
|
*
|
|
12178
12179
|
* @summary Replace a CMS v2 object template
|
|
@@ -12182,7 +12183,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12182
12183
|
* @param {*} [options] Override http request option.
|
|
12183
12184
|
* @throws {RequiredError}
|
|
12184
12185
|
*/
|
|
12185
|
-
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, {}>>;
|
|
12186
12187
|
/**
|
|
12187
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.
|
|
12188
12189
|
* @summary Start a Modify-this-module playground session
|
|
@@ -12193,7 +12194,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12193
12194
|
*/
|
|
12194
12195
|
startModuleFork(recordUuid: string, requestBody: {
|
|
12195
12196
|
[key: string]: any | null;
|
|
12196
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12197
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12197
12198
|
/**
|
|
12198
12199
|
*
|
|
12199
12200
|
* @summary Take one locale offline
|
|
@@ -12202,7 +12203,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12202
12203
|
* @param {*} [options] Override http request option.
|
|
12203
12204
|
* @throws {RequiredError}
|
|
12204
12205
|
*/
|
|
12205
|
-
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12206
|
+
unpublish(recordUuid: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12206
12207
|
/**
|
|
12207
12208
|
*
|
|
12208
12209
|
* @summary Remove an environment from this page only
|
|
@@ -12211,7 +12212,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12211
12212
|
* @param {*} [options] Override http request option.
|
|
12212
12213
|
* @throws {RequiredError}
|
|
12213
12214
|
*/
|
|
12214
|
-
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12215
|
+
unselectEnvironment(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
|
|
12215
12216
|
/**
|
|
12216
12217
|
* Writes test values into the playground session without changing the live page.
|
|
12217
12218
|
* @summary Preview field values on the forked module
|
|
@@ -12223,7 +12224,7 @@ export declare class CMSV2PagesApi extends BaseAPI {
|
|
|
12223
12224
|
*/
|
|
12224
12225
|
updateModuleForkFields(recordUuid: string, sessionId: string, requestBody: {
|
|
12225
12226
|
[key: string]: any | null;
|
|
12226
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12227
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12227
12228
|
}
|
|
12228
12229
|
/**
|
|
12229
12230
|
* CMSV2PublicApi - axios parameter creator
|
|
@@ -12687,7 +12688,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12687
12688
|
* @param {*} [options] Override http request option.
|
|
12688
12689
|
* @throws {RequiredError}
|
|
12689
12690
|
*/
|
|
12690
|
-
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<
|
|
12691
|
+
appSettings(xCaraerSubdomain: string, appName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12691
12692
|
/**
|
|
12692
12693
|
*
|
|
12693
12694
|
* @summary Redirect to a company file for the website runtime
|
|
@@ -12705,7 +12706,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12705
12706
|
* @param {*} [options] Override http request option.
|
|
12706
12707
|
* @throws {RequiredError}
|
|
12707
12708
|
*/
|
|
12708
|
-
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, {}>>;
|
|
12709
12710
|
/**
|
|
12710
12711
|
*
|
|
12711
12712
|
* @summary Installed apps and modules for a company\'s website build
|
|
@@ -12714,7 +12715,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12714
12715
|
* @param {*} [options] Override http request option.
|
|
12715
12716
|
* @throws {RequiredError}
|
|
12716
12717
|
*/
|
|
12717
|
-
buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12718
|
+
buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12718
12719
|
/**
|
|
12719
12720
|
*
|
|
12720
12721
|
* @summary Navigation menus for the header and footer
|
|
@@ -12724,7 +12725,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12724
12725
|
* @param {*} [options] Override http request option.
|
|
12725
12726
|
* @throws {RequiredError}
|
|
12726
12727
|
*/
|
|
12727
|
-
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, {}>>;
|
|
12728
12729
|
/**
|
|
12729
12730
|
*
|
|
12730
12731
|
* @summary A published page by URL path
|
|
@@ -12739,7 +12740,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12739
12740
|
* @param {*} [options] Override http request option.
|
|
12740
12741
|
* @throws {RequiredError}
|
|
12741
12742
|
*/
|
|
12742
|
-
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, {}>>;
|
|
12743
12744
|
/**
|
|
12744
12745
|
* Used by the builder preview, which addresses a page by uuid because a draft may not have a slug yet.
|
|
12745
12746
|
* @summary A page by record uuid
|
|
@@ -12757,7 +12758,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12757
12758
|
* @param {*} [options] Override http request option.
|
|
12758
12759
|
* @throws {RequiredError}
|
|
12759
12760
|
*/
|
|
12760
|
-
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, {}>>;
|
|
12761
12762
|
/**
|
|
12762
12763
|
*
|
|
12763
12764
|
* @summary Protection info for a path, without the page document
|
|
@@ -12768,7 +12769,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12768
12769
|
* @param {*} [options] Override http request option.
|
|
12769
12770
|
* @throws {RequiredError}
|
|
12770
12771
|
*/
|
|
12771
|
-
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, {}>>;
|
|
12772
12773
|
/**
|
|
12773
12774
|
*
|
|
12774
12775
|
* @summary Published paths per environment, for sitemaps and cache warming
|
|
@@ -12778,7 +12779,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12778
12779
|
* @param {*} [options] Override http request option.
|
|
12779
12780
|
* @throws {RequiredError}
|
|
12780
12781
|
*/
|
|
12781
|
-
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, {}>>;
|
|
12782
12783
|
/**
|
|
12783
12784
|
*
|
|
12784
12785
|
* @summary Public records visible in an environment
|
|
@@ -12791,7 +12792,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12791
12792
|
*/
|
|
12792
12793
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12793
12794
|
[key: string]: any | null;
|
|
12794
|
-
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12795
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12795
12796
|
/**
|
|
12796
12797
|
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12797
12798
|
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
@@ -12801,7 +12802,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12801
12802
|
* @param {*} [options] Override http request option.
|
|
12802
12803
|
* @throws {RequiredError}
|
|
12803
12804
|
*/
|
|
12804
|
-
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, {}>>;
|
|
12805
12806
|
/**
|
|
12806
12807
|
*
|
|
12807
12808
|
* @summary Company settings, branding and locales
|
|
@@ -12809,7 +12810,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12809
12810
|
* @param {*} [options] Override http request option.
|
|
12810
12811
|
* @throws {RequiredError}
|
|
12811
12812
|
*/
|
|
12812
|
-
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<
|
|
12813
|
+
settings(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12813
12814
|
/**
|
|
12814
12815
|
*
|
|
12815
12816
|
* @summary Unlock a password-protected CMS v2 page
|
|
@@ -12823,7 +12824,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12823
12824
|
*/
|
|
12824
12825
|
unlock(xCaraerSubdomain: string, uuid: string, requestBody: {
|
|
12825
12826
|
[key: string]: string;
|
|
12826
|
-
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12827
|
+
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
12827
12828
|
}
|
|
12828
12829
|
/**
|
|
12829
12830
|
* CMSV2TransferApi - axios parameter creator
|
|
@@ -12959,7 +12960,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12959
12960
|
*/
|
|
12960
12961
|
attach(companyUuid: string, requestBody: {
|
|
12961
12962
|
[key: string]: string;
|
|
12962
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12963
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12963
12964
|
/**
|
|
12964
12965
|
*
|
|
12965
12966
|
* @summary Switch the live site to CMS v2: schema, caraer-web repo, and hostname
|
|
@@ -12967,7 +12968,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12967
12968
|
* @param {*} [options] Override http request option.
|
|
12968
12969
|
* @throws {RequiredError}
|
|
12969
12970
|
*/
|
|
12970
|
-
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12971
|
+
cutover(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12971
12972
|
/**
|
|
12972
12973
|
*
|
|
12973
12974
|
* @summary Restore the live hostname to the stored v1 project
|
|
@@ -12975,7 +12976,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12975
12976
|
* @param {*} [options] Override http request option.
|
|
12976
12977
|
* @throws {RequiredError}
|
|
12977
12978
|
*/
|
|
12978
|
-
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12979
|
+
rollback(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
12979
12980
|
/**
|
|
12980
12981
|
*
|
|
12981
12982
|
* @summary Transfer status for one company
|
|
@@ -12983,7 +12984,7 @@ export declare class CMSV2TransferApi extends BaseAPI {
|
|
|
12983
12984
|
* @param {*} [options] Override http request option.
|
|
12984
12985
|
* @throws {RequiredError}
|
|
12985
12986
|
*/
|
|
12986
|
-
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
12987
|
+
status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12987
12988
|
}
|
|
12988
12989
|
/**
|
|
12989
12990
|
* CMSWebsiteUpdatesApi - axios parameter creator
|
|
@@ -13082,14 +13083,14 @@ export declare class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
|
13082
13083
|
* @param {*} [options] Override http request option.
|
|
13083
13084
|
* @throws {RequiredError}
|
|
13084
13085
|
*/
|
|
13085
|
-
pending(options?: RawAxiosRequestConfig): Promise<
|
|
13086
|
+
pending(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13086
13087
|
/**
|
|
13087
13088
|
*
|
|
13088
13089
|
* @summary Build a preview site with every pending module update
|
|
13089
13090
|
* @param {*} [options] Override http request option.
|
|
13090
13091
|
* @throws {RequiredError}
|
|
13091
13092
|
*/
|
|
13092
|
-
preview(options?: RawAxiosRequestConfig): Promise<
|
|
13093
|
+
preview(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13093
13094
|
/**
|
|
13094
13095
|
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
13095
13096
|
* @summary Promote a previewed module set to production
|
|
@@ -13099,7 +13100,7 @@ export declare class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
|
13099
13100
|
*/
|
|
13100
13101
|
promote(requestBody?: {
|
|
13101
13102
|
[key: string]: any | null;
|
|
13102
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
13103
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
13103
13104
|
}
|
|
13104
13105
|
/**
|
|
13105
13106
|
* CalendarsApi - axios parameter creator
|
|
@@ -13213,7 +13214,7 @@ export declare class CalendarsApi extends BaseAPI {
|
|
|
13213
13214
|
* @param {*} [options] Override http request option.
|
|
13214
13215
|
* @throws {RequiredError}
|
|
13215
13216
|
*/
|
|
13216
|
-
bootstrap(options?: RawAxiosRequestConfig): Promise<
|
|
13217
|
+
bootstrap(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCalendarBootstrapDTO, any, {}>>;
|
|
13217
13218
|
/**
|
|
13218
13219
|
*
|
|
13219
13220
|
* @summary Create a calendar owned by the current user
|
|
@@ -13221,21 +13222,21 @@ export declare class CalendarsApi extends BaseAPI {
|
|
|
13221
13222
|
* @param {*} [options] Override http request option.
|
|
13222
13223
|
* @throws {RequiredError}
|
|
13223
13224
|
*/
|
|
13224
|
-
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13225
|
+
create4(calendarCreateRequest: CalendarCreateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseCalendarRecordDTO, any, {}>>;
|
|
13225
13226
|
/**
|
|
13226
13227
|
*
|
|
13227
13228
|
* @summary List calendars visible to the current company
|
|
13228
13229
|
* @param {*} [options] Override http request option.
|
|
13229
13230
|
* @throws {RequiredError}
|
|
13230
13231
|
*/
|
|
13231
|
-
list3(options?: RawAxiosRequestConfig): Promise<
|
|
13232
|
+
list3(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCalendarRecordDTO, any, {}>>;
|
|
13232
13233
|
/**
|
|
13233
13234
|
*
|
|
13234
13235
|
* @summary List teams that can be linked to a calendar
|
|
13235
13236
|
* @param {*} [options] Override http request option.
|
|
13236
13237
|
* @throws {RequiredError}
|
|
13237
13238
|
*/
|
|
13238
|
-
listTeams(options?: RawAxiosRequestConfig): Promise<
|
|
13239
|
+
listTeams(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCalendarTeamOptionDTO, any, {}>>;
|
|
13239
13240
|
}
|
|
13240
13241
|
/**
|
|
13241
13242
|
* CompanyApi - axios parameter creator
|
|
@@ -13569,14 +13570,14 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13569
13570
|
* @param {*} [options] Override http request option.
|
|
13570
13571
|
* @throws {RequiredError}
|
|
13571
13572
|
*/
|
|
13572
|
-
createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13573
|
+
createCompany(createCompanyRequest: CreateCompanyRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCompanyDTO, any, {}>>;
|
|
13573
13574
|
/**
|
|
13574
13575
|
* Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope.
|
|
13575
13576
|
* @summary Get current company
|
|
13576
13577
|
* @param {*} [options] Override http request option.
|
|
13577
13578
|
* @throws {RequiredError}
|
|
13578
13579
|
*/
|
|
13579
|
-
getCompany(options?: RawAxiosRequestConfig): Promise<
|
|
13580
|
+
getCompany(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
13580
13581
|
/**
|
|
13581
13582
|
* Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope.
|
|
13582
13583
|
* @summary Get company by UUID
|
|
@@ -13584,14 +13585,14 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13584
13585
|
* @param {*} [options] Override http request option.
|
|
13585
13586
|
* @throws {RequiredError}
|
|
13586
13587
|
*/
|
|
13587
|
-
getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13588
|
+
getCompanyByUuid(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCompanyDTO, any, {}>>;
|
|
13588
13589
|
/**
|
|
13589
13590
|
* Returns the digital identity (branding) for the company currently selected by the logged-in user.
|
|
13590
13591
|
* @summary Get digital identity
|
|
13591
13592
|
* @param {*} [options] Override http request option.
|
|
13592
13593
|
* @throws {RequiredError}
|
|
13593
13594
|
*/
|
|
13594
|
-
getDigitalIdentity(options?: RawAxiosRequestConfig): Promise<
|
|
13595
|
+
getDigitalIdentity(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseDigitalIdentityDTO, any, {}>>;
|
|
13595
13596
|
/**
|
|
13596
13597
|
* Returns the home analytics dashboard for a suite. Empty dashboard when none is saved.
|
|
13597
13598
|
* @summary Get suite dashboard
|
|
@@ -13599,21 +13600,21 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13599
13600
|
* @param {*} [options] Override http request option.
|
|
13600
13601
|
* @throws {RequiredError}
|
|
13601
13602
|
*/
|
|
13602
|
-
getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise<
|
|
13603
|
+
getSuiteDashboard(suiteName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseAnalyticsDashboardConfig, any, {}>>;
|
|
13603
13604
|
/**
|
|
13604
13605
|
* Returns all home analytics dashboards keyed by suite name for the selected company.
|
|
13605
13606
|
* @summary List suite dashboards
|
|
13606
13607
|
* @param {*} [options] Override http request option.
|
|
13607
13608
|
* @throws {RequiredError}
|
|
13608
13609
|
*/
|
|
13609
|
-
getSuiteDashboards(options?: RawAxiosRequestConfig): Promise<
|
|
13610
|
+
getSuiteDashboards(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringAnalyticsDashboardConfig, any, {}>>;
|
|
13610
13611
|
/**
|
|
13611
13612
|
* Returns the website settings for the company currently selected by the logged-in user.
|
|
13612
13613
|
* @summary Get website settings
|
|
13613
13614
|
* @param {*} [options] Override http request option.
|
|
13614
13615
|
* @throws {RequiredError}
|
|
13615
13616
|
*/
|
|
13616
|
-
getWebsiteSettings(options?: RawAxiosRequestConfig): Promise<
|
|
13617
|
+
getWebsiteSettings(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebsiteSettingsDTO, any, {}>>;
|
|
13617
13618
|
/**
|
|
13618
13619
|
* Clears the per-company webhook circuit breaker so outbound deliveries resume immediately.
|
|
13619
13620
|
* @summary Resume webhook dispatch
|
|
@@ -13621,7 +13622,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13621
13622
|
* @param {*} [options] Override http request option.
|
|
13622
13623
|
* @throws {RequiredError}
|
|
13623
13624
|
*/
|
|
13624
|
-
resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13625
|
+
resumeWebhookDispatch(companyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringObject, any, {}>>;
|
|
13625
13626
|
/**
|
|
13626
13627
|
* Updates a company by UUID. Request body should contain the company fields to update.
|
|
13627
13628
|
* @summary Update company
|
|
@@ -13630,7 +13631,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13630
13631
|
* @param {*} [options] Override http request option.
|
|
13631
13632
|
* @throws {RequiredError}
|
|
13632
13633
|
*/
|
|
13633
|
-
updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13634
|
+
updateCompany(uuid: string, companyDTO: CompanyDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13634
13635
|
/**
|
|
13635
13636
|
* Updates the digital identity (branding) for the company currently selected by the logged-in user.
|
|
13636
13637
|
* @summary Update digital identity
|
|
@@ -13638,7 +13639,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13638
13639
|
* @param {*} [options] Override http request option.
|
|
13639
13640
|
* @throws {RequiredError}
|
|
13640
13641
|
*/
|
|
13641
|
-
updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13642
|
+
updateDigitalIdentity(digitalIdentityDTO: DigitalIdentityDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13642
13643
|
/**
|
|
13643
13644
|
* Creates or replaces the home analytics dashboard for a suite.
|
|
13644
13645
|
* @summary Update suite dashboard
|
|
@@ -13647,7 +13648,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13647
13648
|
* @param {*} [options] Override http request option.
|
|
13648
13649
|
* @throws {RequiredError}
|
|
13649
13650
|
*/
|
|
13650
|
-
updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise<
|
|
13651
|
+
updateSuiteDashboard(suiteName: string, analyticsDashboardConfig: AnalyticsDashboardConfig, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13651
13652
|
/**
|
|
13652
13653
|
* Updates the website settings for the company currently selected by the logged-in user.
|
|
13653
13654
|
* @summary Update website settings
|
|
@@ -13655,7 +13656,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13655
13656
|
* @param {*} [options] Override http request option.
|
|
13656
13657
|
* @throws {RequiredError}
|
|
13657
13658
|
*/
|
|
13658
|
-
updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise<
|
|
13659
|
+
updateWebsiteSettings(websiteSettingsDTO: WebsiteSettingsDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
13659
13660
|
/**
|
|
13660
13661
|
* Uploads a font file to S3 storage and returns the public URL.
|
|
13661
13662
|
* @summary Upload a font file
|
|
@@ -13663,7 +13664,7 @@ export declare class CompanyApi extends BaseAPI {
|
|
|
13663
13664
|
* @param {*} [options] Override http request option.
|
|
13664
13665
|
* @throws {RequiredError}
|
|
13665
13666
|
*/
|
|
13666
|
-
uploadFont(file: File, options?: RawAxiosRequestConfig): Promise<
|
|
13667
|
+
uploadFont(file: File, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
13667
13668
|
}
|
|
13668
13669
|
/**
|
|
13669
13670
|
* DeveloperProjectsApi - axios parameter creator
|
|
@@ -13895,7 +13896,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13895
13896
|
* @param {*} [options] Override http request option.
|
|
13896
13897
|
* @throws {RequiredError}
|
|
13897
13898
|
*/
|
|
13898
|
-
create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13899
|
+
create2(createDeveloperProjectRequest: CreateDeveloperProjectRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
13899
13900
|
/**
|
|
13900
13901
|
* Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build.
|
|
13901
13902
|
* @summary Upload a project build
|
|
@@ -13904,7 +13905,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13904
13905
|
* @param {*} [options] Override http request option.
|
|
13905
13906
|
* @throws {RequiredError}
|
|
13906
13907
|
*/
|
|
13907
|
-
createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise<
|
|
13908
|
+
createBuild(projectUuid: string, createProjectBuildRequest: CreateProjectBuildRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
13908
13909
|
/**
|
|
13909
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.
|
|
13910
13911
|
* @summary Deploy a project build
|
|
@@ -13914,7 +13915,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13914
13915
|
* @param {*} [options] Override http request option.
|
|
13915
13916
|
* @throws {RequiredError}
|
|
13916
13917
|
*/
|
|
13917
|
-
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, {}>>;
|
|
13918
13919
|
/**
|
|
13919
13920
|
* Returns the zip of the build currently deployed for this project. That archive is the source of truth for functions and CMS modules.
|
|
13920
13921
|
* @summary Download the deployed project source
|
|
@@ -13922,7 +13923,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13922
13923
|
* @param {*} [options] Override http request option.
|
|
13923
13924
|
* @throws {RequiredError}
|
|
13924
13925
|
*/
|
|
13925
|
-
deployedSource(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13926
|
+
deployedSource(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
13926
13927
|
/**
|
|
13927
13928
|
*
|
|
13928
13929
|
* @summary Get a project build
|
|
@@ -13931,7 +13932,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13931
13932
|
* @param {*} [options] Override http request option.
|
|
13932
13933
|
* @throws {RequiredError}
|
|
13933
13934
|
*/
|
|
13934
|
-
getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13935
|
+
getBuild(projectUuid: string, buildUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
13935
13936
|
/**
|
|
13936
13937
|
*
|
|
13937
13938
|
* @summary List project builds
|
|
@@ -13939,7 +13940,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13939
13940
|
* @param {*} [options] Override http request option.
|
|
13940
13941
|
* @throws {RequiredError}
|
|
13941
13942
|
*/
|
|
13942
|
-
listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13943
|
+
listBuilds(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListProjectBuildDTO, any, {}>>;
|
|
13943
13944
|
/**
|
|
13944
13945
|
*
|
|
13945
13946
|
* @summary List project deploys
|
|
@@ -13947,7 +13948,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13947
13948
|
* @param {*} [options] Override http request option.
|
|
13948
13949
|
* @throws {RequiredError}
|
|
13949
13950
|
*/
|
|
13950
|
-
listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13951
|
+
listDeploys(projectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListProjectDeployDTO, any, {}>>;
|
|
13951
13952
|
/**
|
|
13952
13953
|
*
|
|
13953
13954
|
* @summary Get a developer project
|
|
@@ -13955,7 +13956,7 @@ export declare class DeveloperProjectsApi extends BaseAPI {
|
|
|
13955
13956
|
* @param {*} [options] Override http request option.
|
|
13956
13957
|
* @throws {RequiredError}
|
|
13957
13958
|
*/
|
|
13958
|
-
show3(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
13959
|
+
show3(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseDeveloperProjectDTO, any, {}>>;
|
|
13959
13960
|
}
|
|
13960
13961
|
/**
|
|
13961
13962
|
* DeveloperSandboxesApi - axios parameter creator
|
|
@@ -14052,14 +14053,14 @@ export declare class DeveloperSandboxesApi extends BaseAPI {
|
|
|
14052
14053
|
* @param {*} [options] Override http request option.
|
|
14053
14054
|
* @throws {RequiredError}
|
|
14054
14055
|
*/
|
|
14055
|
-
create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14056
|
+
create1(createDeveloperSandboxRequest: CreateDeveloperSandboxRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14056
14057
|
/**
|
|
14057
14058
|
* Lists sandboxes owned by the caller\'s selected company.
|
|
14058
14059
|
* @summary List developer sandboxes
|
|
14059
14060
|
* @param {*} [options] Override http request option.
|
|
14060
14061
|
* @throws {RequiredError}
|
|
14061
14062
|
*/
|
|
14062
|
-
list1(options?: RawAxiosRequestConfig): Promise<
|
|
14063
|
+
list1(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListDeveloperSandboxDTO, any, {}>>;
|
|
14063
14064
|
/**
|
|
14064
14065
|
*
|
|
14065
14066
|
* @summary Get a developer sandbox
|
|
@@ -14067,7 +14068,7 @@ export declare class DeveloperSandboxesApi extends BaseAPI {
|
|
|
14067
14068
|
* @param {*} [options] Override http request option.
|
|
14068
14069
|
* @throws {RequiredError}
|
|
14069
14070
|
*/
|
|
14070
|
-
show2(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14071
|
+
show2(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
14071
14072
|
}
|
|
14072
14073
|
/**
|
|
14073
14074
|
* FeedsApi - axios parameter creator
|
|
@@ -14119,7 +14120,7 @@ export declare class FeedsApi extends BaseAPI {
|
|
|
14119
14120
|
* @param {*} [options] Override http request option.
|
|
14120
14121
|
* @throws {RequiredError}
|
|
14121
14122
|
*/
|
|
14122
|
-
index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14123
|
+
index1(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFeedDTO, any, {}>>;
|
|
14123
14124
|
}
|
|
14124
14125
|
/**
|
|
14125
14126
|
* FileManagementApi - axios parameter creator
|
|
@@ -14273,7 +14274,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14273
14274
|
* @param {*} [options] Override http request option.
|
|
14274
14275
|
* @throws {RequiredError}
|
|
14275
14276
|
*/
|
|
14276
|
-
deleteFile(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
14277
|
+
deleteFile(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
14277
14278
|
/**
|
|
14278
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.
|
|
14279
14280
|
* @summary Download file
|
|
@@ -14283,7 +14284,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14283
14284
|
* @param {*} [options] Override http request option.
|
|
14284
14285
|
* @throws {RequiredError}
|
|
14285
14286
|
*/
|
|
14286
|
-
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, {}>>;
|
|
14287
14288
|
/**
|
|
14288
14289
|
* Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record.
|
|
14289
14290
|
* @summary List files
|
|
@@ -14291,7 +14292,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14291
14292
|
* @param {*} [options] Override http request option.
|
|
14292
14293
|
* @throws {RequiredError}
|
|
14293
14294
|
*/
|
|
14294
|
-
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14295
|
+
listFiles(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
14295
14296
|
/**
|
|
14296
14297
|
*
|
|
14297
14298
|
* @summary List company files with metadata for the media library
|
|
@@ -14299,7 +14300,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14299
14300
|
* @param {*} [options] Override http request option.
|
|
14300
14301
|
* @throws {RequiredError}
|
|
14301
14302
|
*/
|
|
14302
|
-
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14303
|
+
listLibrary(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListFileListItemDTO, any, {}>>;
|
|
14303
14304
|
/**
|
|
14304
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.
|
|
14305
14306
|
* @summary Upload files
|
|
@@ -14307,7 +14308,7 @@ export declare class FileManagementApi extends BaseAPI {
|
|
|
14307
14308
|
* @param {*} [options] Override http request option.
|
|
14308
14309
|
* @throws {RequiredError}
|
|
14309
14310
|
*/
|
|
14310
|
-
uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
14311
|
+
uploadFile2(recordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
14311
14312
|
}
|
|
14312
14313
|
/**
|
|
14313
14314
|
* FilterApi - axios parameter creator
|
|
@@ -14461,7 +14462,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14461
14462
|
* @param {*} [options] Override http request option.
|
|
14462
14463
|
* @throws {RequiredError}
|
|
14463
14464
|
*/
|
|
14464
|
-
createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14465
|
+
createFilter(savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14465
14466
|
/**
|
|
14466
14467
|
* Soft deletes a saved filter identified by its UUID.
|
|
14467
14468
|
* @summary Delete a saved filter
|
|
@@ -14469,7 +14470,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14469
14470
|
* @param {*} [options] Override http request option.
|
|
14470
14471
|
* @throws {RequiredError}
|
|
14471
14472
|
*/
|
|
14472
|
-
deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14473
|
+
deleteFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
14473
14474
|
/**
|
|
14474
14475
|
* Retrieves details of a saved filter by its UUID.
|
|
14475
14476
|
* @summary Fetch a specific saved filter
|
|
@@ -14477,7 +14478,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14477
14478
|
* @param {*} [options] Override http request option.
|
|
14478
14479
|
* @throws {RequiredError}
|
|
14479
14480
|
*/
|
|
14480
|
-
getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14481
|
+
getFilter(filterUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseSavedFilterDTO, any, {}>>;
|
|
14481
14482
|
/**
|
|
14482
14483
|
* Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort.
|
|
14483
14484
|
* @summary Fetch paginated saved filters
|
|
@@ -14486,7 +14487,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14486
14487
|
* @param {*} [options] Override http request option.
|
|
14487
14488
|
* @throws {RequiredError}
|
|
14488
14489
|
*/
|
|
14489
|
-
getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14490
|
+
getFilters(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSavedFilterDTO, any, {}>>;
|
|
14490
14491
|
/**
|
|
14491
14492
|
* Updates an existing saved filter identified by its UUID.
|
|
14492
14493
|
* @summary Update an existing saved filter
|
|
@@ -14495,7 +14496,7 @@ export declare class FilterApi extends BaseAPI {
|
|
|
14495
14496
|
* @param {*} [options] Override http request option.
|
|
14496
14497
|
* @throws {RequiredError}
|
|
14497
14498
|
*/
|
|
14498
|
-
updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14499
|
+
updateFilter(filterUuid: string, savedFilterDTO: SavedFilterDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
14499
14500
|
}
|
|
14500
14501
|
/**
|
|
14501
14502
|
* FormsApi - axios parameter creator
|
|
@@ -14931,7 +14932,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14931
14932
|
* @param {*} [options] Override http request option.
|
|
14932
14933
|
* @throws {RequiredError}
|
|
14933
14934
|
*/
|
|
14934
|
-
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, {}>>;
|
|
14935
14936
|
/**
|
|
14936
14937
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14937
14938
|
* @summary AI form step (public)
|
|
@@ -14942,7 +14943,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14942
14943
|
* @param {*} [options] Override http request option.
|
|
14943
14944
|
* @throws {RequiredError}
|
|
14944
14945
|
*/
|
|
14945
|
-
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, {}>>;
|
|
14946
14947
|
/**
|
|
14947
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.
|
|
14948
14949
|
* @summary Create a new form
|
|
@@ -14950,7 +14951,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14950
14951
|
* @param {*} [options] Override http request option.
|
|
14951
14952
|
* @throws {RequiredError}
|
|
14952
14953
|
*/
|
|
14953
|
-
createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<
|
|
14954
|
+
createForm(formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
14954
14955
|
/**
|
|
14955
14956
|
* Deletes a form identified by its UUID. On success, returns the deleted form\'s data wrapped in a DeleteResponse.
|
|
14956
14957
|
* @summary Delete a form
|
|
@@ -14958,7 +14959,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14958
14959
|
* @param {*} [options] Override http request option.
|
|
14959
14960
|
* @throws {RequiredError}
|
|
14960
14961
|
*/
|
|
14961
|
-
deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14962
|
+
deleteForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
14962
14963
|
/**
|
|
14963
14964
|
* Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse.
|
|
14964
14965
|
* @summary Get form by UUID
|
|
@@ -14966,7 +14967,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14966
14967
|
* @param {*} [options] Override http request option.
|
|
14967
14968
|
* @throws {RequiredError}
|
|
14968
14969
|
*/
|
|
14969
|
-
getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14970
|
+
getForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseFormDTO, any, {}>>;
|
|
14970
14971
|
/**
|
|
14971
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.
|
|
14972
14973
|
* @summary Get form by UUID
|
|
@@ -14975,7 +14976,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14975
14976
|
* @param {*} [options] Override http request option.
|
|
14976
14977
|
* @throws {RequiredError}
|
|
14977
14978
|
*/
|
|
14978
|
-
getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
14979
|
+
getFormPublic(companyUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePublicFormDTO, any, {}>>;
|
|
14979
14980
|
/**
|
|
14980
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.
|
|
14981
14982
|
* @summary Get paginated list of forms
|
|
@@ -14983,7 +14984,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14983
14984
|
* @param {*} [options] Override http request option.
|
|
14984
14985
|
* @throws {RequiredError}
|
|
14985
14986
|
*/
|
|
14986
|
-
getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14987
|
+
getForms(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFormDTO, any, {}>>;
|
|
14987
14988
|
/**
|
|
14988
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.
|
|
14989
14990
|
* @summary Get forms by object UUID
|
|
@@ -14992,7 +14993,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
14992
14993
|
* @param {*} [options] Override http request option.
|
|
14993
14994
|
* @throws {RequiredError}
|
|
14994
14995
|
*/
|
|
14995
|
-
getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14996
|
+
getFormsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseFormDTO, any, {}>>;
|
|
14996
14997
|
/**
|
|
14997
14998
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
14998
14999
|
* @summary Get all forms for a company
|
|
@@ -15001,14 +15002,14 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15001
15002
|
* @param {*} [options] Override http request option.
|
|
15002
15003
|
* @throws {RequiredError}
|
|
15003
15004
|
*/
|
|
15004
|
-
getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15005
|
+
getFormsPublic(companyUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePublicFormDTO, any, {}>>;
|
|
15005
15006
|
/**
|
|
15006
15007
|
* Returns distinct custom objects that have at least one non-deleted form, ordered by object index.
|
|
15007
15008
|
* @summary List objects that have forms
|
|
15008
15009
|
* @param {*} [options] Override http request option.
|
|
15009
15010
|
* @throws {RequiredError}
|
|
15010
15011
|
*/
|
|
15011
|
-
getObjectsWithForms(options?: RawAxiosRequestConfig): Promise<
|
|
15012
|
+
getObjectsWithForms(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListFormObjectSummaryDTO, any, {}>>;
|
|
15012
15013
|
/**
|
|
15013
15014
|
* When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
|
|
15014
15015
|
* @summary Property options (public)
|
|
@@ -15018,7 +15019,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15018
15019
|
* @param {*} [options] Override http request option.
|
|
15019
15020
|
* @throws {RequiredError}
|
|
15020
15021
|
*/
|
|
15021
|
-
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, {}>>;
|
|
15022
15023
|
/**
|
|
15023
15024
|
* Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse.
|
|
15024
15025
|
* @summary Restore a deleted form
|
|
@@ -15026,7 +15027,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15026
15027
|
* @param {*} [options] Override http request option.
|
|
15027
15028
|
* @throws {RequiredError}
|
|
15028
15029
|
*/
|
|
15029
|
-
restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
15030
|
+
restoreForm(formUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
15030
15031
|
/**
|
|
15031
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.
|
|
15032
15033
|
* @summary Submit a form
|
|
@@ -15036,7 +15037,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15036
15037
|
* @param {*} [options] Override http request option.
|
|
15037
15038
|
* @throws {RequiredError}
|
|
15038
15039
|
*/
|
|
15039
|
-
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, {}>>;
|
|
15040
15041
|
/**
|
|
15041
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.
|
|
15042
15043
|
* @summary Update an existing form
|
|
@@ -15045,7 +15046,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15045
15046
|
* @param {*} [options] Override http request option.
|
|
15046
15047
|
* @throws {RequiredError}
|
|
15047
15048
|
*/
|
|
15048
|
-
updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15049
|
+
updateForm(formUuid: string, formDTO: FormDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15049
15050
|
/**
|
|
15050
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.
|
|
15051
15052
|
* @summary Submit a file
|
|
@@ -15055,7 +15056,7 @@ export declare class FormsApi extends BaseAPI {
|
|
|
15055
15056
|
* @param {*} [options] Override http request option.
|
|
15056
15057
|
* @throws {RequiredError}
|
|
15057
15058
|
*/
|
|
15058
|
-
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, {}>>;
|
|
15059
15060
|
}
|
|
15060
15061
|
/**
|
|
15061
15062
|
* ModuleApi - axios parameter creator
|
|
@@ -15329,7 +15330,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15329
15330
|
* @param {*} [options] Override http request option.
|
|
15330
15331
|
* @throws {RequiredError}
|
|
15331
15332
|
*/
|
|
15332
|
-
createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15333
|
+
createModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
15333
15334
|
/**
|
|
15334
15335
|
* Creates a module in the user\'s personal library.
|
|
15335
15336
|
* @summary Create a personal module
|
|
@@ -15337,7 +15338,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15337
15338
|
* @param {*} [options] Override http request option.
|
|
15338
15339
|
* @throws {RequiredError}
|
|
15339
15340
|
*/
|
|
15340
|
-
createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15341
|
+
createPersonalModule(pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
15341
15342
|
/**
|
|
15342
15343
|
* Deletes a module by its UUID.
|
|
15343
15344
|
* @summary Delete a module
|
|
@@ -15345,7 +15346,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15345
15346
|
* @param {*} [options] Override http request option.
|
|
15346
15347
|
* @throws {RequiredError}
|
|
15347
15348
|
*/
|
|
15348
|
-
deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15349
|
+
deleteModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
15349
15350
|
/**
|
|
15350
15351
|
* Deletes a personal module for the logged-in user.
|
|
15351
15352
|
* @summary Delete a personal module
|
|
@@ -15353,7 +15354,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15353
15354
|
* @param {*} [options] Override http request option.
|
|
15354
15355
|
* @throws {RequiredError}
|
|
15355
15356
|
*/
|
|
15356
|
-
deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15357
|
+
deletePersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
15357
15358
|
/**
|
|
15358
15359
|
* Retrieves details of a module by its UUID.
|
|
15359
15360
|
* @summary Fetch a specific module
|
|
@@ -15361,7 +15362,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15361
15362
|
* @param {*} [options] Override http request option.
|
|
15362
15363
|
* @throws {RequiredError}
|
|
15363
15364
|
*/
|
|
15364
|
-
getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15365
|
+
getModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePageContentDTO, any, {}>>;
|
|
15365
15366
|
/**
|
|
15366
15367
|
* Retrieves a paginated list of modules.
|
|
15367
15368
|
* @summary Fetch paginated modules
|
|
@@ -15369,7 +15370,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15369
15370
|
* @param {*} [options] Override http request option.
|
|
15370
15371
|
* @throws {RequiredError}
|
|
15371
15372
|
*/
|
|
15372
|
-
getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15373
|
+
getModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePageContentDTO, any, {}>>;
|
|
15373
15374
|
/**
|
|
15374
15375
|
* Retrieves a personal module by UUID for the logged-in user.
|
|
15375
15376
|
* @summary Fetch a personal module
|
|
@@ -15377,7 +15378,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15377
15378
|
* @param {*} [options] Override http request option.
|
|
15378
15379
|
* @throws {RequiredError}
|
|
15379
15380
|
*/
|
|
15380
|
-
getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15381
|
+
getPersonalModule(moduleId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePageContentDTO, any, {}>>;
|
|
15381
15382
|
/**
|
|
15382
15383
|
* Retrieves personal modules for the logged-in user.
|
|
15383
15384
|
* @summary Fetch paginated personal modules
|
|
@@ -15385,7 +15386,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15385
15386
|
* @param {*} [options] Override http request option.
|
|
15386
15387
|
* @throws {RequiredError}
|
|
15387
15388
|
*/
|
|
15388
|
-
getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15389
|
+
getPersonalModules(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePageContentDTO, any, {}>>;
|
|
15389
15390
|
/**
|
|
15390
15391
|
* Updates the details of an existing module.
|
|
15391
15392
|
* @summary Update an existing module
|
|
@@ -15394,7 +15395,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15394
15395
|
* @param {*} [options] Override http request option.
|
|
15395
15396
|
* @throws {RequiredError}
|
|
15396
15397
|
*/
|
|
15397
|
-
updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15398
|
+
updateModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15398
15399
|
/**
|
|
15399
15400
|
* Updates a personal module for the logged-in user.
|
|
15400
15401
|
* @summary Update a personal module
|
|
@@ -15403,7 +15404,7 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15403
15404
|
* @param {*} [options] Override http request option.
|
|
15404
15405
|
* @throws {RequiredError}
|
|
15405
15406
|
*/
|
|
15406
|
-
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<
|
|
15407
|
+
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15407
15408
|
}
|
|
15408
15409
|
/**
|
|
15409
15410
|
* NotificationsApi - axios parameter creator
|
|
@@ -15572,14 +15573,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15572
15573
|
* @param {*} [options] Override http request option.
|
|
15573
15574
|
* @throws {RequiredError}
|
|
15574
15575
|
*/
|
|
15575
|
-
dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15576
|
+
dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponseString, any, {}>>;
|
|
15576
15577
|
/**
|
|
15577
15578
|
*
|
|
15578
15579
|
* @summary Mint a Firebase custom token so the app can listen to its inbox
|
|
15579
15580
|
* @param {*} [options] Override http request option.
|
|
15580
15581
|
* @throws {RequiredError}
|
|
15581
15582
|
*/
|
|
15582
|
-
firebaseToken(options?: RawAxiosRequestConfig): Promise<
|
|
15583
|
+
firebaseToken(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
15583
15584
|
/**
|
|
15584
15585
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15585
15586
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15588,14 +15589,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15588
15589
|
* @param {*} [options] Override http request option.
|
|
15589
15590
|
* @throws {RequiredError}
|
|
15590
15591
|
*/
|
|
15591
|
-
listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
15592
|
+
listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
|
|
15592
15593
|
/**
|
|
15593
15594
|
*
|
|
15594
15595
|
* @summary Mark all notifications as read
|
|
15595
15596
|
* @param {*} [options] Override http request option.
|
|
15596
15597
|
* @throws {RequiredError}
|
|
15597
15598
|
*/
|
|
15598
|
-
markAllAsRead(options?: RawAxiosRequestConfig): Promise<
|
|
15599
|
+
markAllAsRead(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15599
15600
|
/**
|
|
15600
15601
|
*
|
|
15601
15602
|
* @summary Mark a notification as read
|
|
@@ -15603,7 +15604,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15603
15604
|
* @param {*} [options] Override http request option.
|
|
15604
15605
|
* @throws {RequiredError}
|
|
15605
15606
|
*/
|
|
15606
|
-
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
15607
|
+
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15607
15608
|
/**
|
|
15608
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.
|
|
15609
15610
|
* @summary Send a notification (app token)
|
|
@@ -15611,7 +15612,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15611
15612
|
* @param {*} [options] Override http request option.
|
|
15612
15613
|
* @throws {RequiredError}
|
|
15613
15614
|
*/
|
|
15614
|
-
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
15615
|
+
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseMapStringString, any, {}>>;
|
|
15615
15616
|
}
|
|
15616
15617
|
/**
|
|
15617
15618
|
* ObjectsApi - axios parameter creator
|
|
@@ -16071,7 +16072,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16071
16072
|
* @param {*} [options] Override http request option.
|
|
16072
16073
|
* @throws {RequiredError}
|
|
16073
16074
|
*/
|
|
16074
|
-
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, {}>>;
|
|
16075
16076
|
/**
|
|
16076
16077
|
* Deletes a specific object identified by its UUID.
|
|
16077
16078
|
* @summary Delete object by UUID
|
|
@@ -16079,14 +16080,14 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16079
16080
|
* @param {*} [options] Override http request option.
|
|
16080
16081
|
* @throws {RequiredError}
|
|
16081
16082
|
*/
|
|
16082
|
-
deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16083
|
+
deleteObject(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16083
16084
|
/**
|
|
16084
16085
|
* Returns all company users, teams, and installed apps that can receive record access on an object.
|
|
16085
16086
|
* @summary List access grant candidates
|
|
16086
16087
|
* @param {*} [options] Override http request option.
|
|
16087
16088
|
* @throws {RequiredError}
|
|
16088
16089
|
*/
|
|
16089
|
-
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<
|
|
16090
|
+
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObjectAccessGrantCandidatesDTO, any, {}>>;
|
|
16090
16091
|
/**
|
|
16091
16092
|
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16092
16093
|
* @summary Get object by UUID
|
|
@@ -16097,7 +16098,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16097
16098
|
* @param {*} [options] Override http request option.
|
|
16098
16099
|
* @throws {RequiredError}
|
|
16099
16100
|
*/
|
|
16100
|
-
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, {}>>;
|
|
16101
16102
|
/**
|
|
16102
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.
|
|
16103
16104
|
* @summary Fetch paginated objects
|
|
@@ -16108,7 +16109,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16108
16109
|
* @param {*} [options] Override http request option.
|
|
16109
16110
|
* @throws {RequiredError}
|
|
16110
16111
|
*/
|
|
16111
|
-
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, {}>>;
|
|
16112
16113
|
/**
|
|
16113
16114
|
* Fetches a preview for an object by the object\'s UUID and the preview name. Returns the preview data wrapped in a ShowResponse.
|
|
16114
16115
|
* @summary Get specific preview by name
|
|
@@ -16117,7 +16118,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16117
16118
|
* @param {*} [options] Override http request option.
|
|
16118
16119
|
* @throws {RequiredError}
|
|
16119
16120
|
*/
|
|
16120
|
-
getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise<
|
|
16121
|
+
getPreview(uuid: string, name: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
|
|
16121
16122
|
/**
|
|
16122
16123
|
* Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs.
|
|
16123
16124
|
* @summary Get all previews over all objects
|
|
@@ -16125,7 +16126,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16125
16126
|
* @param {*} [options] Override http request option.
|
|
16126
16127
|
* @throws {RequiredError}
|
|
16127
16128
|
*/
|
|
16128
|
-
getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16129
|
+
getPreviews(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
16129
16130
|
/**
|
|
16130
16131
|
* Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs.
|
|
16131
16132
|
* @summary Get all previews of an object
|
|
@@ -16134,7 +16135,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16134
16135
|
* @param {*} [options] Override http request option.
|
|
16135
16136
|
* @throws {RequiredError}
|
|
16136
16137
|
*/
|
|
16137
|
-
getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16138
|
+
getPreviews1(uuid: string, search?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePreviewDTO, any, {}>>;
|
|
16138
16139
|
/**
|
|
16139
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.
|
|
16140
16141
|
* @summary Grant object record access
|
|
@@ -16143,7 +16144,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16143
16144
|
* @param {*} [options] Override http request option.
|
|
16144
16145
|
* @throws {RequiredError}
|
|
16145
16146
|
*/
|
|
16146
|
-
grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16147
|
+
grantObjectAccess(objectUuid: string, objectAccessGrantRequestDTO: ObjectAccessGrantRequestDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseVoid, any, {}>>;
|
|
16147
16148
|
/**
|
|
16148
16149
|
* Hard-deletes a soft-deleted object. Only objects with deletedAt set can be removed.
|
|
16149
16150
|
* @summary Permanently delete archived object
|
|
@@ -16151,7 +16152,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16151
16152
|
* @param {*} [options] Override http request option.
|
|
16152
16153
|
* @throws {RequiredError}
|
|
16153
16154
|
*/
|
|
16154
|
-
permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16155
|
+
permanentlyDeleteArchivedObject(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16155
16156
|
/**
|
|
16156
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.
|
|
16157
16158
|
* @summary Save object preview
|
|
@@ -16161,7 +16162,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16161
16162
|
* @param {*} [options] Override http request option.
|
|
16162
16163
|
* @throws {RequiredError}
|
|
16163
16164
|
*/
|
|
16164
|
-
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, {}>>;
|
|
16165
16166
|
/**
|
|
16166
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.
|
|
16167
16168
|
* @summary Sync extended objects for existing records
|
|
@@ -16169,7 +16170,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16169
16170
|
* @param {*} [options] Override http request option.
|
|
16170
16171
|
* @throws {RequiredError}
|
|
16171
16172
|
*/
|
|
16172
|
-
syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16173
|
+
syncExtendedObjects(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseMapStringInteger, any, {}>>;
|
|
16173
16174
|
/**
|
|
16174
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.
|
|
16175
16176
|
* @summary Update object indices
|
|
@@ -16182,7 +16183,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16182
16183
|
*/
|
|
16183
16184
|
updateIndices3(requestBody: {
|
|
16184
16185
|
[key: string]: number;
|
|
16185
|
-
}, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<
|
|
16186
|
+
}, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListCaraerObjectDTO, any, {}>>;
|
|
16186
16187
|
/**
|
|
16187
16188
|
* Sets which properties on this object should generate lifecycle history records when their values change.
|
|
16188
16189
|
* @summary Configure lifecycle property tracking
|
|
@@ -16191,7 +16192,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16191
16192
|
* @param {*} [options] Override http request option.
|
|
16192
16193
|
* @throws {RequiredError}
|
|
16193
16194
|
*/
|
|
16194
|
-
updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16195
|
+
updateLifecycleProperties(objectUuid: string, updateLifecyclePropertiesDTO: UpdateLifecyclePropertiesDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16195
16196
|
/**
|
|
16196
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).
|
|
16197
16198
|
* @summary Update object by UUID
|
|
@@ -16203,7 +16204,7 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16203
16204
|
* @param {*} [options] Override http request option.
|
|
16204
16205
|
* @throws {RequiredError}
|
|
16205
16206
|
*/
|
|
16206
|
-
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, {}>>;
|
|
16207
16208
|
}
|
|
16208
16209
|
/**
|
|
16209
16210
|
* PropertyApi - axios parameter creator
|
|
@@ -16613,7 +16614,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16613
16614
|
* @param {*} [options] Override http request option.
|
|
16614
16615
|
* @throws {RequiredError}
|
|
16615
16616
|
*/
|
|
16616
|
-
copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16617
|
+
copyPropertiesToObject(objectUuid: string, copyPropertiesToObjectRequest: CopyPropertiesToObjectRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListPropertyDTO, any, {}>>;
|
|
16617
16618
|
/**
|
|
16618
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).
|
|
16619
16620
|
* @summary Create a new property
|
|
@@ -16622,7 +16623,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16622
16623
|
* @param {*} [options] Override http request option.
|
|
16623
16624
|
* @throws {RequiredError}
|
|
16624
16625
|
*/
|
|
16625
|
-
createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<
|
|
16626
|
+
createProperty(objectUuid: string, savePropertyDTO: SavePropertyDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
16626
16627
|
/**
|
|
16627
16628
|
* Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property\'s details.
|
|
16628
16629
|
* @summary Delete a property
|
|
@@ -16631,7 +16632,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16631
16632
|
* @param {*} [options] Override http request option.
|
|
16632
16633
|
* @throws {RequiredError}
|
|
16633
16634
|
*/
|
|
16634
|
-
deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16635
|
+
deleteProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16635
16636
|
/**
|
|
16636
16637
|
* Returns the calculation functions available for each property type (for example min/max on numbers).
|
|
16637
16638
|
* @summary Retrieve allowed calculation types per property type
|
|
@@ -16639,7 +16640,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16639
16640
|
* @param {*} [options] Override http request option.
|
|
16640
16641
|
* @throws {RequiredError}
|
|
16641
16642
|
*/
|
|
16642
|
-
getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16643
|
+
getCalculationTypes(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyCalculationTypeDTO, any, {}>>;
|
|
16643
16644
|
/**
|
|
16644
16645
|
* Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances.
|
|
16645
16646
|
* @summary Retrieve property formats
|
|
@@ -16647,7 +16648,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16647
16648
|
* @param {*} [options] Override http request option.
|
|
16648
16649
|
* @throws {RequiredError}
|
|
16649
16650
|
*/
|
|
16650
|
-
getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16651
|
+
getFormats(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyFormat, any, {}>>;
|
|
16651
16652
|
/**
|
|
16652
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.
|
|
16653
16654
|
* @summary Fetch paginated properties
|
|
@@ -16656,7 +16657,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16656
16657
|
* @param {*} [options] Override http request option.
|
|
16657
16658
|
* @throws {RequiredError}
|
|
16658
16659
|
*/
|
|
16659
|
-
getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
16660
|
+
getProperties(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponsePropertyDTO, any, {}>>;
|
|
16660
16661
|
/**
|
|
16661
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.
|
|
16662
16663
|
* @summary Fetch a specific property
|
|
@@ -16665,7 +16666,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16665
16666
|
* @param {*} [options] Override http request option.
|
|
16666
16667
|
* @throws {RequiredError}
|
|
16667
16668
|
*/
|
|
16668
|
-
getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16669
|
+
getProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponsePropertyDTO, any, {}>>;
|
|
16669
16670
|
/**
|
|
16670
16671
|
* Returns calculation functions supported for the property\'s type.
|
|
16671
16672
|
* @summary Retrieve allowed calculation types for a property
|
|
@@ -16674,7 +16675,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16674
16675
|
* @param {*} [options] Override http request option.
|
|
16675
16676
|
* @throws {RequiredError}
|
|
16676
16677
|
*/
|
|
16677
|
-
getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16678
|
+
getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
16678
16679
|
/**
|
|
16679
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.
|
|
16680
16681
|
* @summary Permanently remove archived property
|
|
@@ -16683,7 +16684,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16683
16684
|
* @param {*} [options] Override http request option.
|
|
16684
16685
|
* @throws {RequiredError}
|
|
16685
16686
|
*/
|
|
16686
|
-
permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16687
|
+
permanentlyDeleteArchivedProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
16687
16688
|
/**
|
|
16688
16689
|
* Pins the specified property for the logged-in user. Pinned properties appear at the top of record create and update forms.
|
|
16689
16690
|
* @summary Pin a property
|
|
@@ -16692,7 +16693,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16692
16693
|
* @param {*} [options] Override http request option.
|
|
16693
16694
|
* @throws {RequiredError}
|
|
16694
16695
|
*/
|
|
16695
|
-
pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16696
|
+
pinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16696
16697
|
/**
|
|
16697
16698
|
* Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details.
|
|
16698
16699
|
* @summary Restore a soft-deleted property
|
|
@@ -16701,7 +16702,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16701
16702
|
* @param {*} [options] Override http request option.
|
|
16702
16703
|
* @throws {RequiredError}
|
|
16703
16704
|
*/
|
|
16704
|
-
restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16705
|
+
restoreProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
16705
16706
|
/**
|
|
16706
16707
|
* Removes the pin for the specified property for the logged-in user.
|
|
16707
16708
|
* @summary Unpin a property
|
|
@@ -16710,7 +16711,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16710
16711
|
* @param {*} [options] Override http request option.
|
|
16711
16712
|
* @throws {RequiredError}
|
|
16712
16713
|
*/
|
|
16713
|
-
unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
16714
|
+
unpinProperty(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
16714
16715
|
/**
|
|
16715
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.
|
|
16716
16717
|
* @summary Update property indices
|
|
@@ -16721,7 +16722,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16721
16722
|
*/
|
|
16722
16723
|
updateIndices2(objectUuid: string, requestBody: {
|
|
16723
16724
|
[key: string]: number;
|
|
16724
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
16725
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListPropertyDTO, any, {}>>;
|
|
16725
16726
|
/**
|
|
16726
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).
|
|
16727
16728
|
* @summary Update an existing property
|
|
@@ -16731,7 +16732,7 @@ export declare class PropertyApi extends BaseAPI {
|
|
|
16731
16732
|
* @param {*} [options] Override http request option.
|
|
16732
16733
|
* @throws {RequiredError}
|
|
16733
16734
|
*/
|
|
16734
|
-
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, {}>>;
|
|
16735
16736
|
}
|
|
16736
16737
|
/**
|
|
16737
16738
|
* RecordsApi - axios parameter creator
|
|
@@ -17564,7 +17565,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17564
17565
|
* @param {*} [options] Override http request option.
|
|
17565
17566
|
* @throws {RequiredError}
|
|
17566
17567
|
*/
|
|
17567
|
-
_delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise<
|
|
17568
|
+
_delete(uuid: string, mode?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17568
17569
|
/**
|
|
17569
17570
|
* Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters.
|
|
17570
17571
|
* @summary Aggregate records for analytics charts
|
|
@@ -17572,7 +17573,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17572
17573
|
* @param {*} [options] Override http request option.
|
|
17573
17574
|
* @throws {RequiredError}
|
|
17574
17575
|
*/
|
|
17575
|
-
aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17576
|
+
aggregate(aggregateRequest: AggregateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseAggregateResponse, any, {}>>;
|
|
17576
17577
|
/**
|
|
17577
17578
|
* Runs multiple aggregation requests for dashboard widgets.
|
|
17578
17579
|
* @summary Batch aggregate records for analytics dashboards
|
|
@@ -17580,14 +17581,14 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17580
17581
|
* @param {*} [options] Override http request option.
|
|
17581
17582
|
* @throws {RequiredError}
|
|
17582
17583
|
*/
|
|
17583
|
-
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17584
|
+
aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListAggregateResponse, any, {}>>;
|
|
17584
17585
|
/**
|
|
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.
|
|
17586
17587
|
* @summary List objects with visible archived records
|
|
17587
17588
|
* @param {*} [options] Override http request option.
|
|
17588
17589
|
* @throws {RequiredError}
|
|
17589
17590
|
*/
|
|
17590
|
-
archivedObjects(options?: RawAxiosRequestConfig): Promise<
|
|
17591
|
+
archivedObjects(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListArchivedRecordObjectDTO, any, {}>>;
|
|
17591
17592
|
/**
|
|
17592
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.
|
|
17593
17594
|
* @summary Bulk delete records
|
|
@@ -17596,7 +17597,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17596
17597
|
* @param {*} [options] Override http request option.
|
|
17597
17598
|
* @throws {RequiredError}
|
|
17598
17599
|
*/
|
|
17599
|
-
bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17600
|
+
bulkDelete(objectName: string, bulkDeleteRecordsRequest: BulkDeleteRecordsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BulkDeleteRecordsResponse, any, {}>>;
|
|
17600
17601
|
/**
|
|
17601
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.
|
|
17602
17603
|
* @summary Bulk create or update records
|
|
@@ -17606,7 +17607,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17606
17607
|
* @param {*} [options] Override http request option.
|
|
17607
17608
|
* @throws {RequiredError}
|
|
17608
17609
|
*/
|
|
17609
|
-
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, {}>>;
|
|
17610
17611
|
/**
|
|
17611
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.
|
|
17612
17613
|
* @summary Create a new record
|
|
@@ -17618,7 +17619,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17618
17619
|
* @param {*} [options] Override http request option.
|
|
17619
17620
|
* @throws {RequiredError}
|
|
17620
17621
|
*/
|
|
17621
|
-
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, {}>>;
|
|
17622
17623
|
/**
|
|
17623
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.
|
|
17624
17625
|
* @summary Create or update a record
|
|
@@ -17630,7 +17631,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17630
17631
|
* @param {*} [options] Override http request option.
|
|
17631
17632
|
* @throws {RequiredError}
|
|
17632
17633
|
*/
|
|
17633
|
-
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, {}>>;
|
|
17634
17635
|
/**
|
|
17635
17636
|
* Creates a relation between two records identified by their UUIDs using the provided relation name.
|
|
17636
17637
|
* @summary Create a relation between records
|
|
@@ -17642,7 +17643,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17642
17643
|
* @param {*} [options] Override http request option.
|
|
17643
17644
|
* @throws {RequiredError}
|
|
17644
17645
|
*/
|
|
17645
|
-
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, {}>>;
|
|
17646
17647
|
/**
|
|
17647
17648
|
* Deletes a relation between two records identified by their UUIDs and the relation name.
|
|
17648
17649
|
* @summary Delete a relation between records
|
|
@@ -17652,7 +17653,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17652
17653
|
* @param {*} [options] Override http request option.
|
|
17653
17654
|
* @throws {RequiredError}
|
|
17654
17655
|
*/
|
|
17655
|
-
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, {}>>;
|
|
17656
17657
|
/**
|
|
17657
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.
|
|
17658
17659
|
* @summary Extend a record
|
|
@@ -17663,7 +17664,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17663
17664
|
* @param {*} [options] Override http request option.
|
|
17664
17665
|
* @throws {RequiredError}
|
|
17665
17666
|
*/
|
|
17666
|
-
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, {}>>;
|
|
17667
17668
|
/**
|
|
17668
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.
|
|
17669
17670
|
* @summary Fetch paginated records
|
|
@@ -17675,7 +17676,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17675
17676
|
* @param {*} [options] Override http request option.
|
|
17676
17677
|
* @throws {RequiredError}
|
|
17677
17678
|
*/
|
|
17678
|
-
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, {}>>;
|
|
17679
17680
|
/**
|
|
17680
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.
|
|
17681
17682
|
* @summary Fetch records for flow view
|
|
@@ -17685,7 +17686,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17685
17686
|
* @param {*} [options] Override http request option.
|
|
17686
17687
|
* @throws {RequiredError}
|
|
17687
17688
|
*/
|
|
17688
|
-
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, {}>>;
|
|
17689
17690
|
/**
|
|
17690
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.
|
|
17691
17692
|
* @summary Fetch records for page view
|
|
@@ -17698,7 +17699,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17698
17699
|
* @param {*} [options] Override http request option.
|
|
17699
17700
|
* @throws {RequiredError}
|
|
17700
17701
|
*/
|
|
17701
|
-
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, {}>>;
|
|
17702
17703
|
/**
|
|
17703
17704
|
* Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view.
|
|
17704
17705
|
* @summary Fetch records for table view
|
|
@@ -17707,7 +17708,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17707
17708
|
* @param {*} [options] Override http request option.
|
|
17708
17709
|
* @throws {RequiredError}
|
|
17709
17710
|
*/
|
|
17710
|
-
indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise<
|
|
17711
|
+
indexTable(recordPaginationRequest: RecordPaginationRequest, relatedRecordUuid?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseTable, any, {}>>;
|
|
17711
17712
|
/**
|
|
17712
17713
|
* Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data.
|
|
17713
17714
|
* @summary Get record preview
|
|
@@ -17718,7 +17719,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17718
17719
|
* @param {*} [options] Override http request option.
|
|
17719
17720
|
* @throws {RequiredError}
|
|
17720
17721
|
*/
|
|
17721
|
-
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, {}>>;
|
|
17722
17723
|
/**
|
|
17723
17724
|
* Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
|
|
17724
17725
|
* @summary Advanced graph-aware record query
|
|
@@ -17726,7 +17727,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17726
17727
|
* @param {*} [options] Override http request option.
|
|
17727
17728
|
* @throws {RequiredError}
|
|
17728
17729
|
*/
|
|
17729
|
-
query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17730
|
+
query(advancedRecordQueryRequest: AdvancedRecordQueryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AdvancedRecordQueryResponse, any, {}>>;
|
|
17730
17731
|
/**
|
|
17731
17732
|
* Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored.
|
|
17732
17733
|
* @summary Restore a deleted record
|
|
@@ -17734,7 +17735,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17734
17735
|
* @param {*} [options] Override http request option.
|
|
17735
17736
|
* @throws {RequiredError}
|
|
17736
17737
|
*/
|
|
17737
|
-
restore(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
17738
|
+
restore(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
17738
17739
|
/**
|
|
17739
17740
|
* Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records.
|
|
17740
17741
|
* @summary Search records
|
|
@@ -17745,7 +17746,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17745
17746
|
* @param {*} [options] Override http request option.
|
|
17746
17747
|
* @throws {RequiredError}
|
|
17747
17748
|
*/
|
|
17748
|
-
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, {}>>;
|
|
17749
17750
|
/**
|
|
17750
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.
|
|
17751
17752
|
* @summary Search records across objects
|
|
@@ -17755,7 +17756,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17755
17756
|
* @param {*} [options] Override http request option.
|
|
17756
17757
|
* @throws {RequiredError}
|
|
17757
17758
|
*/
|
|
17758
|
-
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, {}>>;
|
|
17759
17760
|
/**
|
|
17760
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.
|
|
17761
17762
|
* @summary Get record details
|
|
@@ -17767,7 +17768,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17767
17768
|
* @param {*} [options] Override http request option.
|
|
17768
17769
|
* @throws {RequiredError}
|
|
17769
17770
|
*/
|
|
17770
|
-
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, {}>>;
|
|
17771
17772
|
/**
|
|
17772
17773
|
* Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}.
|
|
17773
17774
|
* @summary Get record details by object
|
|
@@ -17778,7 +17779,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17778
17779
|
* @param {*} [options] Override http request option.
|
|
17779
17780
|
* @throws {RequiredError}
|
|
17780
17781
|
*/
|
|
17781
|
-
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, {}>>;
|
|
17782
17783
|
/**
|
|
17783
17784
|
* Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable.
|
|
17784
17785
|
* @summary Suggest analytics widgets with AI
|
|
@@ -17786,7 +17787,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17786
17787
|
* @param {*} [options] Override http request option.
|
|
17787
17788
|
* @throws {RequiredError}
|
|
17788
17789
|
*/
|
|
17789
|
-
suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
17790
|
+
suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseSuggestAnalyticsWidgetsResponse, any, {}>>;
|
|
17790
17791
|
/**
|
|
17791
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.
|
|
17792
17793
|
* @summary Update a record
|
|
@@ -17799,7 +17800,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17799
17800
|
* @param {*} [options] Override http request option.
|
|
17800
17801
|
* @throws {RequiredError}
|
|
17801
17802
|
*/
|
|
17802
|
-
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, {}>>;
|
|
17803
17804
|
/**
|
|
17804
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.
|
|
17805
17806
|
* @summary Update a record by UUID
|
|
@@ -17812,7 +17813,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17812
17813
|
* @param {*} [options] Override http request option.
|
|
17813
17814
|
* @throws {RequiredError}
|
|
17814
17815
|
*/
|
|
17815
|
-
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, {}>>;
|
|
17816
17817
|
/**
|
|
17817
17818
|
* Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key.
|
|
17818
17819
|
* @summary Update relation edge properties
|
|
@@ -17823,7 +17824,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17823
17824
|
* @param {*} [options] Override http request option.
|
|
17824
17825
|
* @throws {RequiredError}
|
|
17825
17826
|
*/
|
|
17826
|
-
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, {}>>;
|
|
17827
17828
|
}
|
|
17828
17829
|
export declare const CreateParseEnum: {
|
|
17829
17830
|
readonly Db: "DB";
|
|
@@ -18309,7 +18310,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18309
18310
|
* @param {*} [options] Override http request option.
|
|
18310
18311
|
* @throws {RequiredError}
|
|
18311
18312
|
*/
|
|
18312
|
-
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, {}>>;
|
|
18313
18314
|
/**
|
|
18314
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.
|
|
18315
18316
|
* @summary Create or update a relation
|
|
@@ -18318,7 +18319,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18318
18319
|
* @param {*} [options] Override http request option.
|
|
18319
18320
|
* @throws {RequiredError}
|
|
18320
18321
|
*/
|
|
18321
|
-
createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18322
|
+
createRelationOrUpdate(objectUuid: string, relationDTO: RelationDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
18322
18323
|
/**
|
|
18323
18324
|
* Deletes a connection between two objects for a given relation using the specified UUIDs.
|
|
18324
18325
|
* @summary Delete a connection from a relation
|
|
@@ -18328,7 +18329,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18328
18329
|
* @param {*} [options] Override http request option.
|
|
18329
18330
|
* @throws {RequiredError}
|
|
18330
18331
|
*/
|
|
18331
|
-
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, {}>>;
|
|
18332
18333
|
/**
|
|
18333
18334
|
* Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details.
|
|
18334
18335
|
* @summary Delete a relation
|
|
@@ -18336,7 +18337,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18336
18337
|
* @param {*} [options] Override http request option.
|
|
18337
18338
|
* @throws {RequiredError}
|
|
18338
18339
|
*/
|
|
18339
|
-
deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18340
|
+
deleteRelation1(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18340
18341
|
/**
|
|
18341
18342
|
* Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO.
|
|
18342
18343
|
* @summary Get relation details
|
|
@@ -18344,7 +18345,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18344
18345
|
* @param {*} [options] Override http request option.
|
|
18345
18346
|
* @throws {RequiredError}
|
|
18346
18347
|
*/
|
|
18347
|
-
getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18348
|
+
getRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseRelationDTO, any, {}>>;
|
|
18348
18349
|
/**
|
|
18349
18350
|
* Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object.
|
|
18350
18351
|
* @summary Get relation details for a specific object
|
|
@@ -18353,7 +18354,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18353
18354
|
* @param {*} [options] Override http request option.
|
|
18354
18355
|
* @throws {RequiredError}
|
|
18355
18356
|
*/
|
|
18356
|
-
getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18357
|
+
getRelationForObject(relationUuid: string, objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseRelationDTO, any, {}>>;
|
|
18357
18358
|
/**
|
|
18358
18359
|
* Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria.
|
|
18359
18360
|
* @summary Fetch paginated relations
|
|
@@ -18361,7 +18362,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18361
18362
|
* @param {*} [options] Override http request option.
|
|
18362
18363
|
* @throws {RequiredError}
|
|
18363
18364
|
*/
|
|
18364
|
-
getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18365
|
+
getRelations(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseRelationDTO, any, {}>>;
|
|
18365
18366
|
/**
|
|
18366
18367
|
* Retrieves all relations between two objects based on the provided object UUIDs.
|
|
18367
18368
|
* @summary Get all relations between two objects
|
|
@@ -18371,7 +18372,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18371
18372
|
* @param {*} [options] Override http request option.
|
|
18372
18373
|
* @throws {RequiredError}
|
|
18373
18374
|
*/
|
|
18374
|
-
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, {}>>;
|
|
18375
18376
|
/**
|
|
18376
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.
|
|
18377
18378
|
* @summary Fetch relations for a specific object
|
|
@@ -18380,7 +18381,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18380
18381
|
* @param {*} [options] Override http request option.
|
|
18381
18382
|
* @throws {RequiredError}
|
|
18382
18383
|
*/
|
|
18383
|
-
getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18384
|
+
getRelationsByObject(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseRelationDTO, any, {}>>;
|
|
18384
18385
|
/**
|
|
18385
18386
|
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
18386
18387
|
* @summary Permanently delete archived relation
|
|
@@ -18388,7 +18389,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18388
18389
|
* @param {*} [options] Override http request option.
|
|
18389
18390
|
* @throws {RequiredError}
|
|
18390
18391
|
*/
|
|
18391
|
-
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18392
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18392
18393
|
/**
|
|
18393
18394
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
18394
18395
|
* @summary Restore a deleted relation
|
|
@@ -18396,7 +18397,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18396
18397
|
* @param {*} [options] Override http request option.
|
|
18397
18398
|
* @throws {RequiredError}
|
|
18398
18399
|
*/
|
|
18399
|
-
restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18400
|
+
restoreRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
18400
18401
|
/**
|
|
18401
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.
|
|
18402
18403
|
* @summary Update relation indices
|
|
@@ -18406,7 +18407,7 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
18406
18407
|
*/
|
|
18407
18408
|
updateIndices(requestBody: {
|
|
18408
18409
|
[key: string]: number;
|
|
18409
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
18410
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseCollectionRelation, any, {}>>;
|
|
18410
18411
|
}
|
|
18411
18412
|
/**
|
|
18412
18413
|
* ServerlessFunctionsApi - axios parameter creator
|
|
@@ -18663,7 +18664,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18663
18664
|
* @param {*} [options] Override http request option.
|
|
18664
18665
|
* @throws {RequiredError}
|
|
18665
18666
|
*/
|
|
18666
|
-
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18667
|
+
create5(appUuid: string, serverlessFunctionDTO: ServerlessFunctionDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
18667
18668
|
/**
|
|
18668
18669
|
* Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
18669
18670
|
* @summary Delete a serverless function
|
|
@@ -18672,7 +18673,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18672
18673
|
* @param {*} [options] Override http request option.
|
|
18673
18674
|
* @throws {RequiredError}
|
|
18674
18675
|
*/
|
|
18675
|
-
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18676
|
+
delete2(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18676
18677
|
/**
|
|
18677
18678
|
* Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
18678
18679
|
* @summary List serverless functions for an app
|
|
@@ -18681,7 +18682,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18681
18682
|
* @param {*} [options] Override http request option.
|
|
18682
18683
|
* @throws {RequiredError}
|
|
18683
18684
|
*/
|
|
18684
|
-
index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18685
|
+
index2(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseServerlessFunctionDTO, any, {}>>;
|
|
18685
18686
|
/**
|
|
18686
18687
|
* Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function.
|
|
18687
18688
|
* @summary Get serverless function logs
|
|
@@ -18692,7 +18693,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18692
18693
|
* @param {*} [options] Override http request option.
|
|
18693
18694
|
* @throws {RequiredError}
|
|
18694
18695
|
*/
|
|
18695
|
-
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, {}>>;
|
|
18696
18697
|
/**
|
|
18697
18698
|
* Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything.
|
|
18698
18699
|
* @summary Generate a sample webhook payload
|
|
@@ -18701,7 +18702,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18701
18702
|
* @param {*} [options] Override http request option.
|
|
18702
18703
|
* @throws {RequiredError}
|
|
18703
18704
|
*/
|
|
18704
|
-
samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18705
|
+
samplePayload(appUuid: string, samplePayloadRequest: SamplePayloadRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseObject, any, {}>>;
|
|
18705
18706
|
/**
|
|
18706
18707
|
* Retrieves a serverless function by its UUID, ensuring it belongs to the specified app.
|
|
18707
18708
|
* @summary Get a serverless function
|
|
@@ -18710,7 +18711,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18710
18711
|
* @param {*} [options] Override http request option.
|
|
18711
18712
|
* @throws {RequiredError}
|
|
18712
18713
|
*/
|
|
18713
|
-
show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18714
|
+
show1(appUuid: string, uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseServerlessFunctionDTO, any, {}>>;
|
|
18714
18715
|
/**
|
|
18715
18716
|
* Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks.
|
|
18716
18717
|
* @summary Test a serverless function
|
|
@@ -18720,7 +18721,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18720
18721
|
* @param {*} [options] Override http request option.
|
|
18721
18722
|
* @throws {RequiredError}
|
|
18722
18723
|
*/
|
|
18723
|
-
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, {}>>;
|
|
18724
18725
|
/**
|
|
18725
18726
|
* Updates an existing serverless function\'s runtime and code, keeping it attached to the same app.
|
|
18726
18727
|
* @summary Update a serverless function
|
|
@@ -18730,7 +18731,7 @@ export declare class ServerlessFunctionsApi extends BaseAPI {
|
|
|
18730
18731
|
* @param {*} [options] Override http request option.
|
|
18731
18732
|
* @throws {RequiredError}
|
|
18732
18733
|
*/
|
|
18733
|
-
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, {}>>;
|
|
18734
18735
|
}
|
|
18735
18736
|
/**
|
|
18736
18737
|
* SyncApi - axios parameter creator
|
|
@@ -18911,7 +18912,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18911
18912
|
* @param {*} [options] Override http request option.
|
|
18912
18913
|
* @throws {RequiredError}
|
|
18913
18914
|
*/
|
|
18914
|
-
createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18915
|
+
createSync(syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
18915
18916
|
/**
|
|
18916
18917
|
* Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details.
|
|
18917
18918
|
* @summary Delete a sync
|
|
@@ -18920,7 +18921,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18920
18921
|
* @param {*} [options] Override http request option.
|
|
18921
18922
|
* @throws {RequiredError}
|
|
18922
18923
|
*/
|
|
18923
|
-
deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18924
|
+
deleteSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
18924
18925
|
/**
|
|
18925
18926
|
* Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details.
|
|
18926
18927
|
* @summary Get a sync
|
|
@@ -18929,7 +18930,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18929
18930
|
* @param {*} [options] Override http request option.
|
|
18930
18931
|
* @throws {RequiredError}
|
|
18931
18932
|
*/
|
|
18932
|
-
getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18933
|
+
getSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SyncDTO, any, {}>>;
|
|
18933
18934
|
/**
|
|
18934
18935
|
* Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria.
|
|
18935
18936
|
* @summary Fetch paginated syncs
|
|
@@ -18937,7 +18938,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18937
18938
|
* @param {*} [options] Override http request option.
|
|
18938
18939
|
* @throws {RequiredError}
|
|
18939
18940
|
*/
|
|
18940
|
-
getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
18941
|
+
getSyncs(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseSyncDTO, any, {}>>;
|
|
18941
18942
|
/**
|
|
18942
18943
|
* Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details.
|
|
18943
18944
|
* @summary Restore a deleted sync
|
|
@@ -18945,7 +18946,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18945
18946
|
* @param {*} [options] Override http request option.
|
|
18946
18947
|
* @throws {RequiredError}
|
|
18947
18948
|
*/
|
|
18948
|
-
restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
18949
|
+
restoreSync(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
18949
18950
|
/**
|
|
18950
18951
|
* Updates an existing sync. Returns a UpdateResponse containing the updated sync details.
|
|
18951
18952
|
* @summary Update a sync
|
|
@@ -18954,7 +18955,7 @@ export declare class SyncApi extends BaseAPI {
|
|
|
18954
18955
|
* @param {*} [options] Override http request option.
|
|
18955
18956
|
* @throws {RequiredError}
|
|
18956
18957
|
*/
|
|
18957
|
-
updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<
|
|
18958
|
+
updateSync(uuid: string, syncDTO: SyncDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
18958
18959
|
}
|
|
18959
18960
|
/**
|
|
18960
18961
|
* TraitsApi - axios parameter creator
|
|
@@ -19245,7 +19246,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19245
19246
|
* @param {*} [options] Override http request option.
|
|
19246
19247
|
* @throws {RequiredError}
|
|
19247
19248
|
*/
|
|
19248
|
-
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, {}>>;
|
|
19249
19250
|
/**
|
|
19250
19251
|
* Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed.
|
|
19251
19252
|
* @summary Delete a trait from an object
|
|
@@ -19254,7 +19255,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19254
19255
|
* @param {*} [options] Override http request option.
|
|
19255
19256
|
* @throws {RequiredError}
|
|
19256
19257
|
*/
|
|
19257
|
-
deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<
|
|
19258
|
+
deleteTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19258
19259
|
/**
|
|
19259
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.
|
|
19260
19261
|
* @summary Fetch a specific trait for an object
|
|
@@ -19263,7 +19264,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19263
19264
|
* @param {*} [options] Override http request option.
|
|
19264
19265
|
* @throws {RequiredError}
|
|
19265
19266
|
*/
|
|
19266
|
-
getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<
|
|
19267
|
+
getTrait(objectUuid: string, traitName: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseTraitDTO, any, {}>>;
|
|
19267
19268
|
/**
|
|
19268
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.
|
|
19269
19270
|
* @summary Fetch all traits for an object
|
|
@@ -19271,7 +19272,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19271
19272
|
* @param {*} [options] Override http request option.
|
|
19272
19273
|
* @throws {RequiredError}
|
|
19273
19274
|
*/
|
|
19274
|
-
getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19275
|
+
getTraits(objectUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseTraitDTO, any, {}>>;
|
|
19275
19276
|
/**
|
|
19276
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.
|
|
19277
19278
|
* @summary Respond to an event invitation (email link)
|
|
@@ -19284,7 +19285,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19284
19285
|
* @param {*} [options] Override http request option.
|
|
19285
19286
|
* @throws {RequiredError}
|
|
19286
19287
|
*/
|
|
19287
|
-
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, {}>>;
|
|
19288
19289
|
/**
|
|
19289
19290
|
*
|
|
19290
19291
|
* @summary Email/password login for RSVP
|
|
@@ -19298,7 +19299,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19298
19299
|
* @param {*} [options] Override http request option.
|
|
19299
19300
|
* @throws {RequiredError}
|
|
19300
19301
|
*/
|
|
19301
|
-
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, {}>>;
|
|
19302
19303
|
/**
|
|
19303
19304
|
*
|
|
19304
19305
|
* @summary Start social login for RSVP
|
|
@@ -19311,7 +19312,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19311
19312
|
* @param {*} [options] Override http request option.
|
|
19312
19313
|
* @throws {RequiredError}
|
|
19313
19314
|
*/
|
|
19314
|
-
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, {}>>;
|
|
19315
19316
|
/**
|
|
19316
19317
|
* Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules.
|
|
19317
19318
|
* @summary Update event RSVP (JSON)
|
|
@@ -19322,7 +19323,7 @@ export declare class TraitsApi extends BaseAPI {
|
|
|
19322
19323
|
* @param {*} [options] Override http request option.
|
|
19323
19324
|
* @throws {RequiredError}
|
|
19324
19325
|
*/
|
|
19325
|
-
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, {}>>;
|
|
19326
19327
|
}
|
|
19327
19328
|
/**
|
|
19328
19329
|
* ViewsApi - axios parameter creator
|
|
@@ -19549,7 +19550,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19549
19550
|
* @param {*} [options] Override http request option.
|
|
19550
19551
|
* @throws {RequiredError}
|
|
19551
19552
|
*/
|
|
19552
|
-
createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19553
|
+
createView(objectUuid: string, viewDTO: ViewDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
19553
19554
|
/**
|
|
19554
19555
|
* Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion.
|
|
19555
19556
|
* @summary Delete a view
|
|
@@ -19558,7 +19559,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19558
19559
|
* @param {*} [options] Override http request option.
|
|
19559
19560
|
* @throws {RequiredError}
|
|
19560
19561
|
*/
|
|
19561
|
-
deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19562
|
+
deleteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19562
19563
|
/**
|
|
19563
19564
|
* Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details.
|
|
19564
19565
|
* @summary Toggle view favorite status
|
|
@@ -19567,7 +19568,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19567
19568
|
* @param {*} [options] Override http request option.
|
|
19568
19569
|
* @throws {RequiredError}
|
|
19569
19570
|
*/
|
|
19570
|
-
favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19571
|
+
favoriteView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19571
19572
|
/**
|
|
19572
19573
|
* Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO.
|
|
19573
19574
|
* @summary Get view details
|
|
@@ -19576,7 +19577,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19576
19577
|
* @param {*} [options] Override http request option.
|
|
19577
19578
|
* @throws {RequiredError}
|
|
19578
19579
|
*/
|
|
19579
|
-
getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19580
|
+
getView(objectUuid: string, viewUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseViewDTO, any, {}>>;
|
|
19580
19581
|
/**
|
|
19581
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.
|
|
19582
19583
|
* @summary Fetch paginated views for an object
|
|
@@ -19585,7 +19586,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19585
19586
|
* @param {*} [options] Override http request option.
|
|
19586
19587
|
* @throws {RequiredError}
|
|
19587
19588
|
*/
|
|
19588
|
-
getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
19589
|
+
getViews(objectUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseViewDTO, any, {}>>;
|
|
19589
19590
|
/**
|
|
19590
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.
|
|
19591
19592
|
* @summary Update view indices
|
|
@@ -19596,7 +19597,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19596
19597
|
*/
|
|
19597
19598
|
updateIndices1(objectUuid: string, requestBody: {
|
|
19598
19599
|
[key: string]: number;
|
|
19599
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
19600
|
+
}, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
19600
19601
|
/**
|
|
19601
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.
|
|
19602
19603
|
* @summary Update an existing view
|
|
@@ -19606,7 +19607,7 @@ export declare class ViewsApi extends BaseAPI {
|
|
|
19606
19607
|
* @param {*} [options] Override http request option.
|
|
19607
19608
|
* @throws {RequiredError}
|
|
19608
19609
|
*/
|
|
19609
|
-
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, {}>>;
|
|
19610
19611
|
}
|
|
19611
19612
|
/**
|
|
19612
19613
|
* WebMenusApi - axios parameter creator
|
|
@@ -19781,7 +19782,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19781
19782
|
* @param {*} [options] Override http request option.
|
|
19782
19783
|
* @throws {RequiredError}
|
|
19783
19784
|
*/
|
|
19784
|
-
createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19785
|
+
createWebMenu(webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
19785
19786
|
/**
|
|
19786
19787
|
* Delete web menu
|
|
19787
19788
|
* @summary Delete web menu
|
|
@@ -19789,7 +19790,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19789
19790
|
* @param {*} [options] Override http request option.
|
|
19790
19791
|
* @throws {RequiredError}
|
|
19791
19792
|
*/
|
|
19792
|
-
deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19793
|
+
deleteWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteResponse, any, {}>>;
|
|
19793
19794
|
/**
|
|
19794
19795
|
* Show web menu
|
|
19795
19796
|
* @summary Show web menu
|
|
@@ -19797,7 +19798,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19797
19798
|
* @param {*} [options] Override http request option.
|
|
19798
19799
|
* @throws {RequiredError}
|
|
19799
19800
|
*/
|
|
19800
|
-
getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19801
|
+
getWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebMenuDTO, any, {}>>;
|
|
19801
19802
|
/**
|
|
19802
19803
|
* Index web menus
|
|
19803
19804
|
* @summary Index web menus
|
|
@@ -19805,7 +19806,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19805
19806
|
* @param {*} [options] Override http request option.
|
|
19806
19807
|
* @throws {RequiredError}
|
|
19807
19808
|
*/
|
|
19808
|
-
indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
19809
|
+
indexWebMenus(paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebMenuDTO, any, {}>>;
|
|
19809
19810
|
/**
|
|
19810
19811
|
* Restore a deleted web menu by its UUID
|
|
19811
19812
|
* @summary Restore deleted web menu
|
|
@@ -19813,7 +19814,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19813
19814
|
* @param {*} [options] Override http request option.
|
|
19814
19815
|
* @throws {RequiredError}
|
|
19815
19816
|
*/
|
|
19816
|
-
restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
19817
|
+
restoreWebMenu(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RestoreResponse, any, {}>>;
|
|
19817
19818
|
/**
|
|
19818
19819
|
* Update web menu
|
|
19819
19820
|
* @summary Update web menu
|
|
@@ -19822,7 +19823,7 @@ export declare class WebMenusApi extends BaseAPI {
|
|
|
19822
19823
|
* @param {*} [options] Override http request option.
|
|
19823
19824
|
* @throws {RequiredError}
|
|
19824
19825
|
*/
|
|
19825
|
-
updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<
|
|
19826
|
+
updateWebMenu(uuid: string, webMenuDTO: WebMenuDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
19826
19827
|
}
|
|
19827
19828
|
/**
|
|
19828
19829
|
* WebpagesApi - axios parameter creator
|
|
@@ -20988,7 +20989,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20988
20989
|
* @param {*} [options] Override http request option.
|
|
20989
20990
|
* @throws {RequiredError}
|
|
20990
20991
|
*/
|
|
20991
|
-
claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
20992
|
+
claimTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
20992
20993
|
/**
|
|
20993
20994
|
* Registers the current user as editing this webpage so other users are blocked from opening the builder.
|
|
20994
20995
|
* @summary Claim a webpage editing session
|
|
@@ -20997,7 +20998,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20997
20998
|
* @param {*} [options] Override http request option.
|
|
20998
20999
|
* @throws {RequiredError}
|
|
20999
21000
|
*/
|
|
21000
|
-
claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21001
|
+
claimWebpageEditingSession(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
21001
21002
|
/**
|
|
21002
21003
|
* Copies selected properties for the chosen environments (e.g. production_title → german_production_title).
|
|
21003
21004
|
* @summary Copy properties to environments
|
|
@@ -21005,7 +21006,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21005
21006
|
* @param {*} [options] Override http request option.
|
|
21006
21007
|
* @throws {RequiredError}
|
|
21007
21008
|
*/
|
|
21008
|
-
copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
21009
|
+
copyPropertyToEnvironments(copyPropertyToEnvironmentsRequest: CopyPropertyToEnvironmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListPropertyDTO, any, {}>>;
|
|
21009
21010
|
/**
|
|
21010
21011
|
* Copies a template webpage by object name from one environment to another. Returns a CreateResponse containing the copied template webpage as a TemplateWebpageDTO.
|
|
21011
21012
|
* @summary Copy a template webpage from one environment to another
|
|
@@ -21015,7 +21016,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21015
21016
|
* @param {*} [options] Override http request option.
|
|
21016
21017
|
* @throws {RequiredError}
|
|
21017
21018
|
*/
|
|
21018
|
-
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, {}>>;
|
|
21019
21020
|
/**
|
|
21020
21021
|
* Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO.
|
|
21021
21022
|
* @summary Copy a webpage from one environment to another
|
|
@@ -21025,7 +21026,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21025
21026
|
* @param {*} [options] Override http request option.
|
|
21026
21027
|
* @throws {RequiredError}
|
|
21027
21028
|
*/
|
|
21028
|
-
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, {}>>;
|
|
21029
21030
|
/**
|
|
21030
21031
|
* Creates an environment.
|
|
21031
21032
|
* @summary Create an environment
|
|
@@ -21033,7 +21034,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21033
21034
|
* @param {*} [options] Override http request option.
|
|
21034
21035
|
* @throws {RequiredError}
|
|
21035
21036
|
*/
|
|
21036
|
-
createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise<
|
|
21037
|
+
createEnvironments(createOrUpdateEnvironmentRequest: CreateOrUpdateEnvironmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21037
21038
|
/**
|
|
21038
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.
|
|
21039
21040
|
* @summary Create or update template webpage
|
|
@@ -21043,7 +21044,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21043
21044
|
* @param {*} [options] Override http request option.
|
|
21044
21045
|
* @throws {RequiredError}
|
|
21045
21046
|
*/
|
|
21046
|
-
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, {}>>;
|
|
21047
21048
|
/**
|
|
21048
21049
|
*
|
|
21049
21050
|
* @summary Generate signed URL for protected webpage
|
|
@@ -21053,7 +21054,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21053
21054
|
* @param {*} [options] Override http request option.
|
|
21054
21055
|
* @throws {RequiredError}
|
|
21055
21056
|
*/
|
|
21056
|
-
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, {}>>;
|
|
21057
21058
|
/**
|
|
21058
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.
|
|
21059
21060
|
* @summary Create a new webpage
|
|
@@ -21062,7 +21063,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21062
21063
|
* @param {*} [options] Override http request option.
|
|
21063
21064
|
* @throws {RequiredError}
|
|
21064
21065
|
*/
|
|
21065
|
-
createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21066
|
+
createWebpage(webpageDTO: WebpageDTO, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponse, any, {}>>;
|
|
21066
21067
|
/**
|
|
21067
21068
|
* Soft deletes an environment.
|
|
21068
21069
|
* @summary Delete an environment
|
|
@@ -21070,7 +21071,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21070
21071
|
* @param {*} [options] Override http request option.
|
|
21071
21072
|
* @throws {RequiredError}
|
|
21072
21073
|
*/
|
|
21073
|
-
deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21074
|
+
deleteEnvironment(environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21074
21075
|
/**
|
|
21075
21076
|
* Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects.
|
|
21076
21077
|
* @summary Get all public webpage slugs
|
|
@@ -21080,7 +21081,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21080
21081
|
* @param {*} [options] Override http request option.
|
|
21081
21082
|
* @throws {RequiredError}
|
|
21082
21083
|
*/
|
|
21083
|
-
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, {}>>;
|
|
21084
21085
|
/**
|
|
21085
21086
|
* Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details.
|
|
21086
21087
|
* @summary Fetch public company settings
|
|
@@ -21090,14 +21091,14 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21090
21091
|
* @param {*} [options] Override http request option.
|
|
21091
21092
|
* @throws {RequiredError}
|
|
21092
21093
|
*/
|
|
21093
|
-
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, {}>>;
|
|
21094
21095
|
/**
|
|
21095
21096
|
* Retrieves a list of all environments.
|
|
21096
21097
|
* @summary Get all environments
|
|
21097
21098
|
* @param {*} [options] Override http request option.
|
|
21098
21099
|
* @throws {RequiredError}
|
|
21099
21100
|
*/
|
|
21100
|
-
getEnvironments(options?: RawAxiosRequestConfig): Promise<
|
|
21101
|
+
getEnvironments(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListEnvironmentDTO, any, {}>>;
|
|
21101
21102
|
/**
|
|
21102
21103
|
* Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects.
|
|
21103
21104
|
* @summary Fetch public web menus
|
|
@@ -21107,7 +21108,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21107
21108
|
* @param {*} [options] Override http request option.
|
|
21108
21109
|
* @throws {RequiredError}
|
|
21109
21110
|
*/
|
|
21110
|
-
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, {}>>;
|
|
21111
21112
|
/**
|
|
21112
21113
|
* Resolves map markers for a public map component. Object-bound sources are filtered in Cypher before the 500-marker cap.
|
|
21113
21114
|
* @summary Get filtered map markers for a public webpage
|
|
@@ -21124,7 +21125,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21124
21125
|
* @param {*} [options] Override http request option.
|
|
21125
21126
|
* @throws {RequiredError}
|
|
21126
21127
|
*/
|
|
21127
|
-
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, {}>>;
|
|
21128
21129
|
/**
|
|
21129
21130
|
* Hydrates the hover preview selected on a bound map location for a published record.
|
|
21130
21131
|
* @summary Get a hydrated preview for one public map marker
|
|
@@ -21141,7 +21142,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21141
21142
|
* @param {*} [options] Override http request option.
|
|
21142
21143
|
* @throws {RequiredError}
|
|
21143
21144
|
*/
|
|
21144
|
-
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, {}>>;
|
|
21145
21146
|
/**
|
|
21146
21147
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
21147
21148
|
* @summary Get previews for a public webpage
|
|
@@ -21158,7 +21159,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21158
21159
|
* @param {*} [options] Override http request option.
|
|
21159
21160
|
* @throws {RequiredError}
|
|
21160
21161
|
*/
|
|
21161
|
-
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, {}>>;
|
|
21162
21163
|
/**
|
|
21163
21164
|
* Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data.
|
|
21164
21165
|
* @summary Get a public webpage by slug
|
|
@@ -21174,7 +21175,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21174
21175
|
* @param {*} [options] Override http request option.
|
|
21175
21176
|
* @throws {RequiredError}
|
|
21176
21177
|
*/
|
|
21177
|
-
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, {}>>;
|
|
21178
21179
|
/**
|
|
21179
21180
|
* Retrieves a published webpage based on its UUID. Returns a ShowResponse containing WebpageDTO data.
|
|
21180
21181
|
* @summary Get a public webpage by UUID
|
|
@@ -21189,7 +21190,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21189
21190
|
* @param {*} [options] Override http request option.
|
|
21190
21191
|
* @throws {RequiredError}
|
|
21191
21192
|
*/
|
|
21192
|
-
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, {}>>;
|
|
21193
21194
|
/**
|
|
21194
21195
|
* Returns protection requirements without page content.
|
|
21195
21196
|
* @summary Get webpage protection metadata
|
|
@@ -21200,7 +21201,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21200
21201
|
* @param {*} [options] Override http request option.
|
|
21201
21202
|
* @throws {RequiredError}
|
|
21202
21203
|
*/
|
|
21203
|
-
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, {}>>;
|
|
21204
21205
|
/**
|
|
21205
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.
|
|
21206
21207
|
* @summary Fetch public website module
|
|
@@ -21209,7 +21210,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21209
21210
|
* @param {*} [options] Override http request option.
|
|
21210
21211
|
* @throws {RequiredError}
|
|
21211
21212
|
*/
|
|
21212
|
-
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21213
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponse, any, {}>>;
|
|
21213
21214
|
/**
|
|
21214
21215
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
21215
21216
|
* @summary Get template webpage
|
|
@@ -21218,7 +21219,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21218
21219
|
* @param {*} [options] Override http request option.
|
|
21219
21220
|
* @throws {RequiredError}
|
|
21220
21221
|
*/
|
|
21221
|
-
getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21222
|
+
getTemplateWebpage(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseTemplateWebpageDTO, any, {}>>;
|
|
21222
21223
|
/**
|
|
21223
21224
|
* Returns whether another user is actively editing the template webpage for the given object and environment.
|
|
21224
21225
|
* @summary Check if a template webpage is being edited
|
|
@@ -21227,7 +21228,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21227
21228
|
* @param {*} [options] Override http request option.
|
|
21228
21229
|
* @throws {RequiredError}
|
|
21229
21230
|
*/
|
|
21230
|
-
getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21231
|
+
getTemplateWebpageEditingStatus(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
21231
21232
|
/**
|
|
21232
21233
|
* Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is \'smartened\' if the smartened parameter is true.
|
|
21233
21234
|
* @summary Get webpage details
|
|
@@ -21237,7 +21238,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21237
21238
|
* @param {*} [options] Override http request option.
|
|
21238
21239
|
* @throws {RequiredError}
|
|
21239
21240
|
*/
|
|
21240
|
-
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, {}>>;
|
|
21241
21242
|
/**
|
|
21242
21243
|
* Returns whether another user is actively editing this webpage (via an open builder session or collaborative WebSocket connection).
|
|
21243
21244
|
* @summary Check if a webpage is being edited
|
|
@@ -21246,7 +21247,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21246
21247
|
* @param {*} [options] Override http request option.
|
|
21247
21248
|
* @throws {RequiredError}
|
|
21248
21249
|
*/
|
|
21249
|
-
getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21250
|
+
getWebpageEditingStatus(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WebpageEditingStatusDTO, any, {}>>;
|
|
21250
21251
|
/**
|
|
21251
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.
|
|
21252
21253
|
* @summary List webpages for picker dropdowns
|
|
@@ -21256,7 +21257,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21256
21257
|
* @param {*} [options] Override http request option.
|
|
21257
21258
|
* @throws {RequiredError}
|
|
21258
21259
|
*/
|
|
21259
|
-
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, {}>>;
|
|
21260
21261
|
/**
|
|
21261
21262
|
*
|
|
21262
21263
|
* @summary List signed URL grants for a webpage
|
|
@@ -21265,7 +21266,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21265
21266
|
* @param {*} [options] Override http request option.
|
|
21266
21267
|
* @throws {RequiredError}
|
|
21267
21268
|
*/
|
|
21268
|
-
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<
|
|
21269
|
+
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
|
|
21269
21270
|
/**
|
|
21270
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.
|
|
21271
21272
|
* @summary Public URL for a library file
|
|
@@ -21273,7 +21274,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21273
21274
|
* @param {*} [options] Override http request option.
|
|
21274
21275
|
* @throws {RequiredError}
|
|
21275
21276
|
*/
|
|
21276
|
-
publishFile(key: string, options?: RawAxiosRequestConfig): Promise<
|
|
21277
|
+
publishFile(key: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21277
21278
|
/**
|
|
21278
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.
|
|
21279
21280
|
* @summary Publish a webpage
|
|
@@ -21283,7 +21284,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21283
21284
|
* @param {*} [options] Override http request option.
|
|
21284
21285
|
* @throws {RequiredError}
|
|
21285
21286
|
*/
|
|
21286
|
-
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, {}>>;
|
|
21287
21288
|
/**
|
|
21288
21289
|
* Releases the editing session held by the current user for this template webpage.
|
|
21289
21290
|
* @summary Release a template webpage editing session
|
|
@@ -21292,7 +21293,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21292
21293
|
* @param {*} [options] Override http request option.
|
|
21293
21294
|
* @throws {RequiredError}
|
|
21294
21295
|
*/
|
|
21295
|
-
releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<
|
|
21296
|
+
releaseTemplateWebpageEditingSession(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21296
21297
|
/**
|
|
21297
21298
|
* Releases the editing session held by the current user for this webpage.
|
|
21298
21299
|
* @summary Release a webpage editing session
|
|
@@ -21300,7 +21301,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21300
21301
|
* @param {*} [options] Override http request option.
|
|
21301
21302
|
* @throws {RequiredError}
|
|
21302
21303
|
*/
|
|
21303
|
-
releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21304
|
+
releaseWebpageEditingSession(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseString, any, {}>>;
|
|
21304
21305
|
/**
|
|
21305
21306
|
*
|
|
21306
21307
|
* @summary Revoke a signed URL grant
|
|
@@ -21310,7 +21311,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21310
21311
|
* @param {*} [options] Override http request option.
|
|
21311
21312
|
* @throws {RequiredError}
|
|
21312
21313
|
*/
|
|
21313
|
-
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, {}>>;
|
|
21314
21315
|
/**
|
|
21315
21316
|
* Validates password and returns a short-lived access token.
|
|
21316
21317
|
* @summary Unlock password-protected webpage
|
|
@@ -21322,7 +21323,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21322
21323
|
* @param {*} [options] Override http request option.
|
|
21323
21324
|
* @throws {RequiredError}
|
|
21324
21325
|
*/
|
|
21325
|
-
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, {}>>;
|
|
21326
21327
|
/**
|
|
21327
21328
|
* Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details.
|
|
21328
21329
|
* @summary Unpublish a webpage
|
|
@@ -21332,7 +21333,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21332
21333
|
* @param {*} [options] Override http request option.
|
|
21333
21334
|
* @throws {RequiredError}
|
|
21334
21335
|
*/
|
|
21335
|
-
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, {}>>;
|
|
21336
21337
|
/**
|
|
21337
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.
|
|
21338
21339
|
* @summary Update a webpage
|
|
@@ -21342,7 +21343,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21342
21343
|
* @param {*} [options] Override http request option.
|
|
21343
21344
|
* @throws {RequiredError}
|
|
21344
21345
|
*/
|
|
21345
|
-
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, {}>>;
|
|
21346
21347
|
/**
|
|
21347
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.
|
|
21348
21349
|
* @summary Upload a file for a webpage
|
|
@@ -21350,7 +21351,7 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21350
21351
|
* @param {*} [options] Override http request option.
|
|
21351
21352
|
* @throws {RequiredError}
|
|
21352
21353
|
*/
|
|
21353
|
-
uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise<
|
|
21354
|
+
uploadFile(uuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21354
21355
|
/**
|
|
21355
21356
|
* Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse.
|
|
21356
21357
|
* @summary Upload a file
|
|
@@ -21358,5 +21359,5 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21358
21359
|
* @param {*} [options] Override http request option.
|
|
21359
21360
|
* @throws {RequiredError}
|
|
21360
21361
|
*/
|
|
21361
|
-
uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise<
|
|
21362
|
+
uploadFile1(file: File, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
21362
21363
|
}
|