@caraer/client 2.0.536 → 2.0.540
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/api.ts +94 -8
- package/dist/api.d.ts +47 -5
- package/dist/api.js +83 -7
- package/dist/esm/api.d.ts +47 -5
- package/dist/esm/api.js +83 -7
- package/docs/AppBarsApi.md +4 -1
- package/docs/ApplicationsApi.md +57 -0
- package/docs/CmsModuleComponent.md +24 -0
- package/docs/CmsModuleDTO.md +2 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/api.ts
CHANGED
|
@@ -1397,6 +1397,11 @@ export interface CmsEnvironmentDTO {
|
|
|
1397
1397
|
'htmlLang'?: string;
|
|
1398
1398
|
'default'?: boolean;
|
|
1399
1399
|
}
|
|
1400
|
+
export interface CmsModuleComponent {
|
|
1401
|
+
'name'?: string;
|
|
1402
|
+
'label'?: string;
|
|
1403
|
+
'fields'?: Array<string>;
|
|
1404
|
+
}
|
|
1400
1405
|
export interface CmsModuleDTO {
|
|
1401
1406
|
'uuid'?: string;
|
|
1402
1407
|
'name'?: string;
|
|
@@ -1414,6 +1419,7 @@ export interface CmsModuleDTO {
|
|
|
1414
1419
|
'version'?: string;
|
|
1415
1420
|
'retired'?: boolean;
|
|
1416
1421
|
'fields'?: Array<AppSettingFieldSchema>;
|
|
1422
|
+
'components'?: Array<CmsModuleComponent>;
|
|
1417
1423
|
'frameworks'?: { [key: string]: string; };
|
|
1418
1424
|
}
|
|
1419
1425
|
export interface CmsPageDTO {
|
|
@@ -2583,9 +2589,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2583
2589
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2584
2590
|
|
|
2585
2591
|
export interface ExistingWidgetSummary {
|
|
2592
|
+
'xproperty'?: string;
|
|
2586
2593
|
'ymetric'?: string;
|
|
2587
2594
|
'yproperty'?: string;
|
|
2588
|
-
'xproperty'?: string;
|
|
2589
2595
|
'title'?: string;
|
|
2590
2596
|
'chartType'?: string;
|
|
2591
2597
|
'xProperty'?: string;
|
|
@@ -8496,10 +8502,11 @@ export const AppBarsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
8496
8502
|
* @param {string} [recordUuid] Record UUID in context
|
|
8497
8503
|
* @param {string} [viewId] View ID in context
|
|
8498
8504
|
* @param {string} [trait] Trait name in context
|
|
8505
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8499
8506
|
* @param {*} [options] Override http request option.
|
|
8500
8507
|
* @throws {RequiredError}
|
|
8501
8508
|
*/
|
|
8502
|
-
listAppBars: async (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8509
|
+
listAppBars: async (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8503
8510
|
// verify required parameter 'location' is not null or undefined
|
|
8504
8511
|
assertParamExists('listAppBars', 'location', location)
|
|
8505
8512
|
const localVarPath = `/api/v2/app-bars`;
|
|
@@ -8538,6 +8545,10 @@ export const AppBarsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
8538
8545
|
localVarQueryParameter['trait'] = trait;
|
|
8539
8546
|
}
|
|
8540
8547
|
|
|
8548
|
+
if (suite !== undefined) {
|
|
8549
|
+
localVarQueryParameter['suite'] = suite;
|
|
8550
|
+
}
|
|
8551
|
+
|
|
8541
8552
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8542
8553
|
|
|
8543
8554
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -8607,11 +8618,12 @@ export const AppBarsApiFp = function(configuration?: Configuration) {
|
|
|
8607
8618
|
* @param {string} [recordUuid] Record UUID in context
|
|
8608
8619
|
* @param {string} [viewId] View ID in context
|
|
8609
8620
|
* @param {string} [trait] Trait name in context
|
|
8621
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8610
8622
|
* @param {*} [options] Override http request option.
|
|
8611
8623
|
* @throws {RequiredError}
|
|
8612
8624
|
*/
|
|
8613
|
-
async listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>> {
|
|
8614
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, options);
|
|
8625
|
+
async listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>> {
|
|
8626
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, options);
|
|
8615
8627
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8616
8628
|
const localVarOperationServerBasePath = operationServerMap['AppBarsApi.listAppBars']?.[localVarOperationServerIndex]?.url;
|
|
8617
8629
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8647,11 +8659,12 @@ export const AppBarsApiFactory = function (configuration?: Configuration, basePa
|
|
|
8647
8659
|
* @param {string} [recordUuid] Record UUID in context
|
|
8648
8660
|
* @param {string} [viewId] View ID in context
|
|
8649
8661
|
* @param {string} [trait] Trait name in context
|
|
8662
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8650
8663
|
* @param {*} [options] Override http request option.
|
|
8651
8664
|
* @throws {RequiredError}
|
|
8652
8665
|
*/
|
|
8653
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO> {
|
|
8654
|
-
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(axios, basePath));
|
|
8666
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO> {
|
|
8667
|
+
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(axios, basePath));
|
|
8655
8668
|
},
|
|
8656
8669
|
/**
|
|
8657
8670
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -8679,11 +8692,12 @@ export class AppBarsApi extends BaseAPI {
|
|
|
8679
8692
|
* @param {string} [recordUuid] Record UUID in context
|
|
8680
8693
|
* @param {string} [viewId] View ID in context
|
|
8681
8694
|
* @param {string} [trait] Trait name in context
|
|
8695
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8682
8696
|
* @param {*} [options] Override http request option.
|
|
8683
8697
|
* @throws {RequiredError}
|
|
8684
8698
|
*/
|
|
8685
|
-
public listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig) {
|
|
8686
|
-
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(this.axios, this.basePath));
|
|
8699
|
+
public listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig) {
|
|
8700
|
+
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(this.axios, this.basePath));
|
|
8687
8701
|
}
|
|
8688
8702
|
|
|
8689
8703
|
/**
|
|
@@ -10262,6 +10276,44 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
10262
10276
|
options: localVarRequestOptions,
|
|
10263
10277
|
};
|
|
10264
10278
|
},
|
|
10279
|
+
/**
|
|
10280
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
10281
|
+
* @summary Delete a private app
|
|
10282
|
+
* @param {string} uuid UUID of the private app to delete
|
|
10283
|
+
* @param {*} [options] Override http request option.
|
|
10284
|
+
* @throws {RequiredError}
|
|
10285
|
+
*/
|
|
10286
|
+
deletePrivateApp: async (uuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10287
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
10288
|
+
assertParamExists('deletePrivateApp', 'uuid', uuid)
|
|
10289
|
+
const localVarPath = `/api/v2/apps/private/{uuid}`
|
|
10290
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
10291
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10292
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10293
|
+
let baseOptions;
|
|
10294
|
+
if (configuration) {
|
|
10295
|
+
baseOptions = configuration.baseOptions;
|
|
10296
|
+
}
|
|
10297
|
+
|
|
10298
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
10299
|
+
const localVarHeaderParameter = {} as any;
|
|
10300
|
+
const localVarQueryParameter = {} as any;
|
|
10301
|
+
|
|
10302
|
+
// authentication bearerAuth required
|
|
10303
|
+
// http bearer authentication required
|
|
10304
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10305
|
+
|
|
10306
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
10307
|
+
|
|
10308
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10309
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10310
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10311
|
+
|
|
10312
|
+
return {
|
|
10313
|
+
url: toPathString(localVarUrlObj),
|
|
10314
|
+
options: localVarRequestOptions,
|
|
10315
|
+
};
|
|
10316
|
+
},
|
|
10265
10317
|
/**
|
|
10266
10318
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10267
10319
|
* @summary Retrieve application details by UUID
|
|
@@ -11412,6 +11464,19 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
|
|
|
11412
11464
|
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.deleteAppWebhook']?.[localVarOperationServerIndex]?.url;
|
|
11413
11465
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11414
11466
|
},
|
|
11467
|
+
/**
|
|
11468
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
11469
|
+
* @summary Delete a private app
|
|
11470
|
+
* @param {string} uuid UUID of the private app to delete
|
|
11471
|
+
* @param {*} [options] Override http request option.
|
|
11472
|
+
* @throws {RequiredError}
|
|
11473
|
+
*/
|
|
11474
|
+
async deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>> {
|
|
11475
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePrivateApp(uuid, options);
|
|
11476
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11477
|
+
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.deletePrivateApp']?.[localVarOperationServerIndex]?.url;
|
|
11478
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11479
|
+
},
|
|
11415
11480
|
/**
|
|
11416
11481
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
11417
11482
|
* @summary Retrieve application details by UUID
|
|
@@ -11822,6 +11887,16 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
|
|
|
11822
11887
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse> {
|
|
11823
11888
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
11824
11889
|
},
|
|
11890
|
+
/**
|
|
11891
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
11892
|
+
* @summary Delete a private app
|
|
11893
|
+
* @param {string} uuid UUID of the private app to delete
|
|
11894
|
+
* @param {*} [options] Override http request option.
|
|
11895
|
+
* @throws {RequiredError}
|
|
11896
|
+
*/
|
|
11897
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse> {
|
|
11898
|
+
return localVarFp.deletePrivateApp(uuid, options).then((request) => request(axios, basePath));
|
|
11899
|
+
},
|
|
11825
11900
|
/**
|
|
11826
11901
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
11827
11902
|
* @summary Retrieve application details by UUID
|
|
@@ -12156,6 +12231,17 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
12156
12231
|
return ApplicationsApiFp(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
12157
12232
|
}
|
|
12158
12233
|
|
|
12234
|
+
/**
|
|
12235
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
12236
|
+
* @summary Delete a private app
|
|
12237
|
+
* @param {string} uuid UUID of the private app to delete
|
|
12238
|
+
* @param {*} [options] Override http request option.
|
|
12239
|
+
* @throws {RequiredError}
|
|
12240
|
+
*/
|
|
12241
|
+
public deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig) {
|
|
12242
|
+
return ApplicationsApiFp(this.configuration).deletePrivateApp(uuid, options).then((request) => request(this.axios, this.basePath));
|
|
12243
|
+
}
|
|
12244
|
+
|
|
12159
12245
|
/**
|
|
12160
12246
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
12161
12247
|
* @summary Retrieve application details by UUID
|
package/dist/api.d.ts
CHANGED
|
@@ -1383,6 +1383,11 @@ export interface CmsEnvironmentDTO {
|
|
|
1383
1383
|
'htmlLang'?: string;
|
|
1384
1384
|
'default'?: boolean;
|
|
1385
1385
|
}
|
|
1386
|
+
export interface CmsModuleComponent {
|
|
1387
|
+
'name'?: string;
|
|
1388
|
+
'label'?: string;
|
|
1389
|
+
'fields'?: Array<string>;
|
|
1390
|
+
}
|
|
1386
1391
|
export interface CmsModuleDTO {
|
|
1387
1392
|
'uuid'?: string;
|
|
1388
1393
|
'name'?: string;
|
|
@@ -1400,6 +1405,7 @@ export interface CmsModuleDTO {
|
|
|
1400
1405
|
'version'?: string;
|
|
1401
1406
|
'retired'?: boolean;
|
|
1402
1407
|
'fields'?: Array<AppSettingFieldSchema>;
|
|
1408
|
+
'components'?: Array<CmsModuleComponent>;
|
|
1403
1409
|
'frameworks'?: {
|
|
1404
1410
|
[key: string]: string;
|
|
1405
1411
|
};
|
|
@@ -2573,9 +2579,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2573
2579
|
};
|
|
2574
2580
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2581
|
export interface ExistingWidgetSummary {
|
|
2582
|
+
'xproperty'?: string;
|
|
2576
2583
|
'ymetric'?: string;
|
|
2577
2584
|
'yproperty'?: string;
|
|
2578
|
-
'xproperty'?: string;
|
|
2579
2585
|
'title'?: string;
|
|
2580
2586
|
'chartType'?: string;
|
|
2581
2587
|
'xProperty'?: string;
|
|
@@ -8529,10 +8535,11 @@ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8529
8535
|
* @param {string} [recordUuid] Record UUID in context
|
|
8530
8536
|
* @param {string} [viewId] View ID in context
|
|
8531
8537
|
* @param {string} [trait] Trait name in context
|
|
8538
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8532
8539
|
* @param {*} [options] Override http request option.
|
|
8533
8540
|
* @throws {RequiredError}
|
|
8534
8541
|
*/
|
|
8535
|
-
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8542
|
+
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8536
8543
|
/**
|
|
8537
8544
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8538
8545
|
* @summary Trigger an action-based app bar
|
|
@@ -8555,10 +8562,11 @@ export declare const AppBarsApiFp: (configuration?: Configuration) => {
|
|
|
8555
8562
|
* @param {string} [recordUuid] Record UUID in context
|
|
8556
8563
|
* @param {string} [viewId] View ID in context
|
|
8557
8564
|
* @param {string} [trait] Trait name in context
|
|
8565
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8558
8566
|
* @param {*} [options] Override http request option.
|
|
8559
8567
|
* @throws {RequiredError}
|
|
8560
8568
|
*/
|
|
8561
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
8569
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
8562
8570
|
/**
|
|
8563
8571
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8564
8572
|
* @summary Trigger an action-based app bar
|
|
@@ -8581,10 +8589,11 @@ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath
|
|
|
8581
8589
|
* @param {string} [recordUuid] Record UUID in context
|
|
8582
8590
|
* @param {string} [viewId] View ID in context
|
|
8583
8591
|
* @param {string} [trait] Trait name in context
|
|
8592
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8584
8593
|
* @param {*} [options] Override http request option.
|
|
8585
8594
|
* @throws {RequiredError}
|
|
8586
8595
|
*/
|
|
8587
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
8596
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
8588
8597
|
/**
|
|
8589
8598
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8590
8599
|
* @summary Trigger an action-based app bar
|
|
@@ -8607,10 +8616,11 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8607
8616
|
* @param {string} [recordUuid] Record UUID in context
|
|
8608
8617
|
* @param {string} [viewId] View ID in context
|
|
8609
8618
|
* @param {string} [trait] Trait name in context
|
|
8619
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8610
8620
|
* @param {*} [options] Override http request option.
|
|
8611
8621
|
* @throws {RequiredError}
|
|
8612
8622
|
*/
|
|
8613
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8623
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8614
8624
|
/**
|
|
8615
8625
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8616
8626
|
* @summary Trigger an action-based app bar
|
|
@@ -9332,6 +9342,14 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9332
9342
|
* @throws {RequiredError}
|
|
9333
9343
|
*/
|
|
9334
9344
|
deleteAppWebhook: (appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9345
|
+
/**
|
|
9346
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9347
|
+
* @summary Delete a private app
|
|
9348
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9349
|
+
* @param {*} [options] Override http request option.
|
|
9350
|
+
* @throws {RequiredError}
|
|
9351
|
+
*/
|
|
9352
|
+
deletePrivateApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9335
9353
|
/**
|
|
9336
9354
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9337
9355
|
* @summary Retrieve application details by UUID
|
|
@@ -9600,6 +9618,14 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9600
9618
|
* @throws {RequiredError}
|
|
9601
9619
|
*/
|
|
9602
9620
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
9621
|
+
/**
|
|
9622
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9623
|
+
* @summary Delete a private app
|
|
9624
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9625
|
+
* @param {*} [options] Override http request option.
|
|
9626
|
+
* @throws {RequiredError}
|
|
9627
|
+
*/
|
|
9628
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
9603
9629
|
/**
|
|
9604
9630
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9605
9631
|
* @summary Retrieve application details by UUID
|
|
@@ -9876,6 +9902,14 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
9876
9902
|
* @throws {RequiredError}
|
|
9877
9903
|
*/
|
|
9878
9904
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
9905
|
+
/**
|
|
9906
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9907
|
+
* @summary Delete a private app
|
|
9908
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9909
|
+
* @param {*} [options] Override http request option.
|
|
9910
|
+
* @throws {RequiredError}
|
|
9911
|
+
*/
|
|
9912
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
9879
9913
|
/**
|
|
9880
9914
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9881
9915
|
* @summary Retrieve application details by UUID
|
|
@@ -10152,6 +10186,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10152
10186
|
* @throws {RequiredError}
|
|
10153
10187
|
*/
|
|
10154
10188
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
10189
|
+
/**
|
|
10190
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
10191
|
+
* @summary Delete a private app
|
|
10192
|
+
* @param {string} uuid UUID of the private app to delete
|
|
10193
|
+
* @param {*} [options] Override http request option.
|
|
10194
|
+
* @throws {RequiredError}
|
|
10195
|
+
*/
|
|
10196
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
10155
10197
|
/**
|
|
10156
10198
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10157
10199
|
* @summary Retrieve application details by UUID
|
package/dist/api.js
CHANGED
|
@@ -314,10 +314,11 @@ const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
314
314
|
* @param {string} [recordUuid] Record UUID in context
|
|
315
315
|
* @param {string} [viewId] View ID in context
|
|
316
316
|
* @param {string} [trait] Trait name in context
|
|
317
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
317
318
|
* @param {*} [options] Override http request option.
|
|
318
319
|
* @throws {RequiredError}
|
|
319
320
|
*/
|
|
320
|
-
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, options = {}) {
|
|
321
|
+
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, suite, options = {}) {
|
|
321
322
|
// verify required parameter 'location' is not null or undefined
|
|
322
323
|
(0, common_1.assertParamExists)('listAppBars', 'location', location);
|
|
323
324
|
const localVarPath = `/api/v2/app-bars`;
|
|
@@ -348,6 +349,9 @@ const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
348
349
|
if (trait !== undefined) {
|
|
349
350
|
localVarQueryParameter['trait'] = trait;
|
|
350
351
|
}
|
|
352
|
+
if (suite !== undefined) {
|
|
353
|
+
localVarQueryParameter['suite'] = suite;
|
|
354
|
+
}
|
|
351
355
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
352
356
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
353
357
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -410,13 +414,14 @@ const AppBarsApiFp = function (configuration) {
|
|
|
410
414
|
* @param {string} [recordUuid] Record UUID in context
|
|
411
415
|
* @param {string} [viewId] View ID in context
|
|
412
416
|
* @param {string} [trait] Trait name in context
|
|
417
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
413
418
|
* @param {*} [options] Override http request option.
|
|
414
419
|
* @throws {RequiredError}
|
|
415
420
|
*/
|
|
416
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
421
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
417
422
|
return __awaiter(this, void 0, void 0, function* () {
|
|
418
423
|
var _a, _b, _c;
|
|
419
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, options);
|
|
424
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, options);
|
|
420
425
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
421
426
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AppBarsApi.listAppBars']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
422
427
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -456,11 +461,12 @@ const AppBarsApiFactory = function (configuration, basePath, axios) {
|
|
|
456
461
|
* @param {string} [recordUuid] Record UUID in context
|
|
457
462
|
* @param {string} [viewId] View ID in context
|
|
458
463
|
* @param {string} [trait] Trait name in context
|
|
464
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
459
465
|
* @param {*} [options] Override http request option.
|
|
460
466
|
* @throws {RequiredError}
|
|
461
467
|
*/
|
|
462
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
463
|
-
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(axios, basePath));
|
|
468
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
469
|
+
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(axios, basePath));
|
|
464
470
|
},
|
|
465
471
|
/**
|
|
466
472
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -488,11 +494,12 @@ class AppBarsApi extends base_1.BaseAPI {
|
|
|
488
494
|
* @param {string} [recordUuid] Record UUID in context
|
|
489
495
|
* @param {string} [viewId] View ID in context
|
|
490
496
|
* @param {string} [trait] Trait name in context
|
|
497
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
491
498
|
* @param {*} [options] Override http request option.
|
|
492
499
|
* @throws {RequiredError}
|
|
493
500
|
*/
|
|
494
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
495
|
-
return (0, exports.AppBarsApiFp)(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(this.axios, this.basePath));
|
|
501
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
502
|
+
return (0, exports.AppBarsApiFp)(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(this.axios, this.basePath));
|
|
496
503
|
}
|
|
497
504
|
/**
|
|
498
505
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -1994,6 +2001,39 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
1994
2001
|
options: localVarRequestOptions,
|
|
1995
2002
|
};
|
|
1996
2003
|
}),
|
|
2004
|
+
/**
|
|
2005
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
2006
|
+
* @summary Delete a private app
|
|
2007
|
+
* @param {string} uuid UUID of the private app to delete
|
|
2008
|
+
* @param {*} [options] Override http request option.
|
|
2009
|
+
* @throws {RequiredError}
|
|
2010
|
+
*/
|
|
2011
|
+
deletePrivateApp: (uuid_1, ...args_1) => __awaiter(this, [uuid_1, ...args_1], void 0, function* (uuid, options = {}) {
|
|
2012
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
2013
|
+
(0, common_1.assertParamExists)('deletePrivateApp', 'uuid', uuid);
|
|
2014
|
+
const localVarPath = `/api/v2/apps/private/{uuid}`
|
|
2015
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
2016
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2017
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2018
|
+
let baseOptions;
|
|
2019
|
+
if (configuration) {
|
|
2020
|
+
baseOptions = configuration.baseOptions;
|
|
2021
|
+
}
|
|
2022
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2023
|
+
const localVarHeaderParameter = {};
|
|
2024
|
+
const localVarQueryParameter = {};
|
|
2025
|
+
// authentication bearerAuth required
|
|
2026
|
+
// http bearer authentication required
|
|
2027
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2028
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2029
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2030
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2031
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2032
|
+
return {
|
|
2033
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2034
|
+
options: localVarRequestOptions,
|
|
2035
|
+
};
|
|
2036
|
+
}),
|
|
1997
2037
|
/**
|
|
1998
2038
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
1999
2039
|
* @summary Retrieve application details by UUID
|
|
@@ -3020,6 +3060,22 @@ const ApplicationsApiFp = function (configuration) {
|
|
|
3020
3060
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3021
3061
|
});
|
|
3022
3062
|
},
|
|
3063
|
+
/**
|
|
3064
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3065
|
+
* @summary Delete a private app
|
|
3066
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3067
|
+
* @param {*} [options] Override http request option.
|
|
3068
|
+
* @throws {RequiredError}
|
|
3069
|
+
*/
|
|
3070
|
+
deletePrivateApp(uuid, options) {
|
|
3071
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3072
|
+
var _a, _b, _c;
|
|
3073
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePrivateApp(uuid, options);
|
|
3074
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3075
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ApplicationsApi.deletePrivateApp']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3076
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3077
|
+
});
|
|
3078
|
+
},
|
|
3023
3079
|
/**
|
|
3024
3080
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3025
3081
|
* @summary Retrieve application details by UUID
|
|
@@ -3508,6 +3564,16 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
|
|
|
3508
3564
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3509
3565
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
3510
3566
|
},
|
|
3567
|
+
/**
|
|
3568
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3569
|
+
* @summary Delete a private app
|
|
3570
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3571
|
+
* @param {*} [options] Override http request option.
|
|
3572
|
+
* @throws {RequiredError}
|
|
3573
|
+
*/
|
|
3574
|
+
deletePrivateApp(uuid, options) {
|
|
3575
|
+
return localVarFp.deletePrivateApp(uuid, options).then((request) => request(axios, basePath));
|
|
3576
|
+
},
|
|
3511
3577
|
/**
|
|
3512
3578
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3513
3579
|
* @summary Retrieve application details by UUID
|
|
@@ -3838,6 +3904,16 @@ class ApplicationsApi extends base_1.BaseAPI {
|
|
|
3838
3904
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3839
3905
|
return (0, exports.ApplicationsApiFp)(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
3840
3906
|
}
|
|
3907
|
+
/**
|
|
3908
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3909
|
+
* @summary Delete a private app
|
|
3910
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3911
|
+
* @param {*} [options] Override http request option.
|
|
3912
|
+
* @throws {RequiredError}
|
|
3913
|
+
*/
|
|
3914
|
+
deletePrivateApp(uuid, options) {
|
|
3915
|
+
return (0, exports.ApplicationsApiFp)(this.configuration).deletePrivateApp(uuid, options).then((request) => request(this.axios, this.basePath));
|
|
3916
|
+
}
|
|
3841
3917
|
/**
|
|
3842
3918
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3843
3919
|
* @summary Retrieve application details by UUID
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1383,6 +1383,11 @@ export interface CmsEnvironmentDTO {
|
|
|
1383
1383
|
'htmlLang'?: string;
|
|
1384
1384
|
'default'?: boolean;
|
|
1385
1385
|
}
|
|
1386
|
+
export interface CmsModuleComponent {
|
|
1387
|
+
'name'?: string;
|
|
1388
|
+
'label'?: string;
|
|
1389
|
+
'fields'?: Array<string>;
|
|
1390
|
+
}
|
|
1386
1391
|
export interface CmsModuleDTO {
|
|
1387
1392
|
'uuid'?: string;
|
|
1388
1393
|
'name'?: string;
|
|
@@ -1400,6 +1405,7 @@ export interface CmsModuleDTO {
|
|
|
1400
1405
|
'version'?: string;
|
|
1401
1406
|
'retired'?: boolean;
|
|
1402
1407
|
'fields'?: Array<AppSettingFieldSchema>;
|
|
1408
|
+
'components'?: Array<CmsModuleComponent>;
|
|
1403
1409
|
'frameworks'?: {
|
|
1404
1410
|
[key: string]: string;
|
|
1405
1411
|
};
|
|
@@ -2573,9 +2579,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2573
2579
|
};
|
|
2574
2580
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2581
|
export interface ExistingWidgetSummary {
|
|
2582
|
+
'xproperty'?: string;
|
|
2576
2583
|
'ymetric'?: string;
|
|
2577
2584
|
'yproperty'?: string;
|
|
2578
|
-
'xproperty'?: string;
|
|
2579
2585
|
'title'?: string;
|
|
2580
2586
|
'chartType'?: string;
|
|
2581
2587
|
'xProperty'?: string;
|
|
@@ -8529,10 +8535,11 @@ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8529
8535
|
* @param {string} [recordUuid] Record UUID in context
|
|
8530
8536
|
* @param {string} [viewId] View ID in context
|
|
8531
8537
|
* @param {string} [trait] Trait name in context
|
|
8538
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8532
8539
|
* @param {*} [options] Override http request option.
|
|
8533
8540
|
* @throws {RequiredError}
|
|
8534
8541
|
*/
|
|
8535
|
-
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8542
|
+
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8536
8543
|
/**
|
|
8537
8544
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8538
8545
|
* @summary Trigger an action-based app bar
|
|
@@ -8555,10 +8562,11 @@ export declare const AppBarsApiFp: (configuration?: Configuration) => {
|
|
|
8555
8562
|
* @param {string} [recordUuid] Record UUID in context
|
|
8556
8563
|
* @param {string} [viewId] View ID in context
|
|
8557
8564
|
* @param {string} [trait] Trait name in context
|
|
8565
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8558
8566
|
* @param {*} [options] Override http request option.
|
|
8559
8567
|
* @throws {RequiredError}
|
|
8560
8568
|
*/
|
|
8561
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
8569
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
8562
8570
|
/**
|
|
8563
8571
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8564
8572
|
* @summary Trigger an action-based app bar
|
|
@@ -8581,10 +8589,11 @@ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath
|
|
|
8581
8589
|
* @param {string} [recordUuid] Record UUID in context
|
|
8582
8590
|
* @param {string} [viewId] View ID in context
|
|
8583
8591
|
* @param {string} [trait] Trait name in context
|
|
8592
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8584
8593
|
* @param {*} [options] Override http request option.
|
|
8585
8594
|
* @throws {RequiredError}
|
|
8586
8595
|
*/
|
|
8587
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
8596
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
8588
8597
|
/**
|
|
8589
8598
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8590
8599
|
* @summary Trigger an action-based app bar
|
|
@@ -8607,10 +8616,11 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8607
8616
|
* @param {string} [recordUuid] Record UUID in context
|
|
8608
8617
|
* @param {string} [viewId] View ID in context
|
|
8609
8618
|
* @param {string} [trait] Trait name in context
|
|
8619
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
8610
8620
|
* @param {*} [options] Override http request option.
|
|
8611
8621
|
* @throws {RequiredError}
|
|
8612
8622
|
*/
|
|
8613
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8623
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8614
8624
|
/**
|
|
8615
8625
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8616
8626
|
* @summary Trigger an action-based app bar
|
|
@@ -9332,6 +9342,14 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9332
9342
|
* @throws {RequiredError}
|
|
9333
9343
|
*/
|
|
9334
9344
|
deleteAppWebhook: (appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9345
|
+
/**
|
|
9346
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9347
|
+
* @summary Delete a private app
|
|
9348
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9349
|
+
* @param {*} [options] Override http request option.
|
|
9350
|
+
* @throws {RequiredError}
|
|
9351
|
+
*/
|
|
9352
|
+
deletePrivateApp: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9335
9353
|
/**
|
|
9336
9354
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9337
9355
|
* @summary Retrieve application details by UUID
|
|
@@ -9600,6 +9618,14 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9600
9618
|
* @throws {RequiredError}
|
|
9601
9619
|
*/
|
|
9602
9620
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
9621
|
+
/**
|
|
9622
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9623
|
+
* @summary Delete a private app
|
|
9624
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9625
|
+
* @param {*} [options] Override http request option.
|
|
9626
|
+
* @throws {RequiredError}
|
|
9627
|
+
*/
|
|
9628
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
9603
9629
|
/**
|
|
9604
9630
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9605
9631
|
* @summary Retrieve application details by UUID
|
|
@@ -9876,6 +9902,14 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
9876
9902
|
* @throws {RequiredError}
|
|
9877
9903
|
*/
|
|
9878
9904
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
9905
|
+
/**
|
|
9906
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
9907
|
+
* @summary Delete a private app
|
|
9908
|
+
* @param {string} uuid UUID of the private app to delete
|
|
9909
|
+
* @param {*} [options] Override http request option.
|
|
9910
|
+
* @throws {RequiredError}
|
|
9911
|
+
*/
|
|
9912
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
9879
9913
|
/**
|
|
9880
9914
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9881
9915
|
* @summary Retrieve application details by UUID
|
|
@@ -10152,6 +10186,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10152
10186
|
* @throws {RequiredError}
|
|
10153
10187
|
*/
|
|
10154
10188
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
10189
|
+
/**
|
|
10190
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
10191
|
+
* @summary Delete a private app
|
|
10192
|
+
* @param {string} uuid UUID of the private app to delete
|
|
10193
|
+
* @param {*} [options] Override http request option.
|
|
10194
|
+
* @throws {RequiredError}
|
|
10195
|
+
*/
|
|
10196
|
+
deletePrivateApp(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
10155
10197
|
/**
|
|
10156
10198
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10157
10199
|
* @summary Retrieve application details by UUID
|
package/dist/esm/api.js
CHANGED
|
@@ -304,10 +304,11 @@ export const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
304
304
|
* @param {string} [recordUuid] Record UUID in context
|
|
305
305
|
* @param {string} [viewId] View ID in context
|
|
306
306
|
* @param {string} [trait] Trait name in context
|
|
307
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
307
308
|
* @param {*} [options] Override http request option.
|
|
308
309
|
* @throws {RequiredError}
|
|
309
310
|
*/
|
|
310
|
-
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, options = {}) {
|
|
311
|
+
listAppBars: (location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1) => __awaiter(this, [location_1, object_1, recordUuid_1, viewId_1, trait_1, suite_1, ...args_1], void 0, function* (location, object, recordUuid, viewId, trait, suite, options = {}) {
|
|
311
312
|
// verify required parameter 'location' is not null or undefined
|
|
312
313
|
assertParamExists('listAppBars', 'location', location);
|
|
313
314
|
const localVarPath = `/api/v2/app-bars`;
|
|
@@ -338,6 +339,9 @@ export const AppBarsApiAxiosParamCreator = function (configuration) {
|
|
|
338
339
|
if (trait !== undefined) {
|
|
339
340
|
localVarQueryParameter['trait'] = trait;
|
|
340
341
|
}
|
|
342
|
+
if (suite !== undefined) {
|
|
343
|
+
localVarQueryParameter['suite'] = suite;
|
|
344
|
+
}
|
|
341
345
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
342
346
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
343
347
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -399,13 +403,14 @@ export const AppBarsApiFp = function (configuration) {
|
|
|
399
403
|
* @param {string} [recordUuid] Record UUID in context
|
|
400
404
|
* @param {string} [viewId] View ID in context
|
|
401
405
|
* @param {string} [trait] Trait name in context
|
|
406
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
402
407
|
* @param {*} [options] Override http request option.
|
|
403
408
|
* @throws {RequiredError}
|
|
404
409
|
*/
|
|
405
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
410
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
406
411
|
return __awaiter(this, void 0, void 0, function* () {
|
|
407
412
|
var _a, _b, _c;
|
|
408
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, options);
|
|
413
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, options);
|
|
409
414
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
410
415
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppBarsApi.listAppBars']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
411
416
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -444,11 +449,12 @@ export const AppBarsApiFactory = function (configuration, basePath, axios) {
|
|
|
444
449
|
* @param {string} [recordUuid] Record UUID in context
|
|
445
450
|
* @param {string} [viewId] View ID in context
|
|
446
451
|
* @param {string} [trait] Trait name in context
|
|
452
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
447
453
|
* @param {*} [options] Override http request option.
|
|
448
454
|
* @throws {RequiredError}
|
|
449
455
|
*/
|
|
450
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
451
|
-
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(axios, basePath));
|
|
456
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
457
|
+
return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(axios, basePath));
|
|
452
458
|
},
|
|
453
459
|
/**
|
|
454
460
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -475,11 +481,12 @@ export class AppBarsApi extends BaseAPI {
|
|
|
475
481
|
* @param {string} [recordUuid] Record UUID in context
|
|
476
482
|
* @param {string} [viewId] View ID in context
|
|
477
483
|
* @param {string} [trait] Trait name in context
|
|
484
|
+
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
478
485
|
* @param {*} [options] Override http request option.
|
|
479
486
|
* @throws {RequiredError}
|
|
480
487
|
*/
|
|
481
|
-
listAppBars(location, object, recordUuid, viewId, trait, options) {
|
|
482
|
-
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, options).then((request) => request(this.axios, this.basePath));
|
|
488
|
+
listAppBars(location, object, recordUuid, viewId, trait, suite, options) {
|
|
489
|
+
return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(this.axios, this.basePath));
|
|
483
490
|
}
|
|
484
491
|
/**
|
|
485
492
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
@@ -1976,6 +1983,39 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
1976
1983
|
options: localVarRequestOptions,
|
|
1977
1984
|
};
|
|
1978
1985
|
}),
|
|
1986
|
+
/**
|
|
1987
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
1988
|
+
* @summary Delete a private app
|
|
1989
|
+
* @param {string} uuid UUID of the private app to delete
|
|
1990
|
+
* @param {*} [options] Override http request option.
|
|
1991
|
+
* @throws {RequiredError}
|
|
1992
|
+
*/
|
|
1993
|
+
deletePrivateApp: (uuid_1, ...args_1) => __awaiter(this, [uuid_1, ...args_1], void 0, function* (uuid, options = {}) {
|
|
1994
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
1995
|
+
assertParamExists('deletePrivateApp', 'uuid', uuid);
|
|
1996
|
+
const localVarPath = `/api/v2/apps/private/{uuid}`
|
|
1997
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
1998
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1999
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2000
|
+
let baseOptions;
|
|
2001
|
+
if (configuration) {
|
|
2002
|
+
baseOptions = configuration.baseOptions;
|
|
2003
|
+
}
|
|
2004
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2005
|
+
const localVarHeaderParameter = {};
|
|
2006
|
+
const localVarQueryParameter = {};
|
|
2007
|
+
// authentication bearerAuth required
|
|
2008
|
+
// http bearer authentication required
|
|
2009
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2010
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2013
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2014
|
+
return {
|
|
2015
|
+
url: toPathString(localVarUrlObj),
|
|
2016
|
+
options: localVarRequestOptions,
|
|
2017
|
+
};
|
|
2018
|
+
}),
|
|
1979
2019
|
/**
|
|
1980
2020
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
1981
2021
|
* @summary Retrieve application details by UUID
|
|
@@ -3001,6 +3041,22 @@ export const ApplicationsApiFp = function (configuration) {
|
|
|
3001
3041
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3002
3042
|
});
|
|
3003
3043
|
},
|
|
3044
|
+
/**
|
|
3045
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3046
|
+
* @summary Delete a private app
|
|
3047
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3048
|
+
* @param {*} [options] Override http request option.
|
|
3049
|
+
* @throws {RequiredError}
|
|
3050
|
+
*/
|
|
3051
|
+
deletePrivateApp(uuid, options) {
|
|
3052
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3053
|
+
var _a, _b, _c;
|
|
3054
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePrivateApp(uuid, options);
|
|
3055
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3056
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ApplicationsApi.deletePrivateApp']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3057
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3058
|
+
});
|
|
3059
|
+
},
|
|
3004
3060
|
/**
|
|
3005
3061
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3006
3062
|
* @summary Retrieve application details by UUID
|
|
@@ -3488,6 +3544,16 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
|
|
|
3488
3544
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3489
3545
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
3490
3546
|
},
|
|
3547
|
+
/**
|
|
3548
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3549
|
+
* @summary Delete a private app
|
|
3550
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3551
|
+
* @param {*} [options] Override http request option.
|
|
3552
|
+
* @throws {RequiredError}
|
|
3553
|
+
*/
|
|
3554
|
+
deletePrivateApp(uuid, options) {
|
|
3555
|
+
return localVarFp.deletePrivateApp(uuid, options).then((request) => request(axios, basePath));
|
|
3556
|
+
},
|
|
3491
3557
|
/**
|
|
3492
3558
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3493
3559
|
* @summary Retrieve application details by UUID
|
|
@@ -3817,6 +3883,16 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
3817
3883
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3818
3884
|
return ApplicationsApiFp(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
3819
3885
|
}
|
|
3886
|
+
/**
|
|
3887
|
+
* Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
3888
|
+
* @summary Delete a private app
|
|
3889
|
+
* @param {string} uuid UUID of the private app to delete
|
|
3890
|
+
* @param {*} [options] Override http request option.
|
|
3891
|
+
* @throws {RequiredError}
|
|
3892
|
+
*/
|
|
3893
|
+
deletePrivateApp(uuid, options) {
|
|
3894
|
+
return ApplicationsApiFp(this.configuration).deletePrivateApp(uuid, options).then((request) => request(this.axios, this.basePath));
|
|
3895
|
+
}
|
|
3820
3896
|
/**
|
|
3821
3897
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3822
3898
|
* @summary Retrieve application details by UUID
|
package/docs/AppBarsApi.md
CHANGED
|
@@ -28,13 +28,15 @@ let object: string; //Object name in context (optional) (default to undefined)
|
|
|
28
28
|
let recordUuid: string; //Record UUID in context (optional) (default to undefined)
|
|
29
29
|
let viewId: string; //View ID in context (optional) (default to undefined)
|
|
30
30
|
let trait: string; //Trait name in context (optional) (default to undefined)
|
|
31
|
+
let suite: string; //Suite selected in the UI. A tool bar is included when this suite is saved on the bar. (optional) (default to undefined)
|
|
31
32
|
|
|
32
33
|
const { status, data } = await apiInstance.listAppBars(
|
|
33
34
|
location,
|
|
34
35
|
object,
|
|
35
36
|
recordUuid,
|
|
36
37
|
viewId,
|
|
37
|
-
trait
|
|
38
|
+
trait,
|
|
39
|
+
suite
|
|
38
40
|
);
|
|
39
41
|
```
|
|
40
42
|
|
|
@@ -47,6 +49,7 @@ const { status, data } = await apiInstance.listAppBars(
|
|
|
47
49
|
| **recordUuid** | [**string**] | Record UUID in context | (optional) defaults to undefined|
|
|
48
50
|
| **viewId** | [**string**] | View ID in context | (optional) defaults to undefined|
|
|
49
51
|
| **trait** | [**string**] | Trait name in context | (optional) defaults to undefined|
|
|
52
|
+
| **suite** | [**string**] | Suite selected in the UI. A tool bar is included when this suite is saved on the bar. | (optional) defaults to undefined|
|
|
50
53
|
|
|
51
54
|
|
|
52
55
|
### Return type
|
package/docs/ApplicationsApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
8
8
|
|[**createPrivateApp**](#createprivateapp) | **POST** /api/v2/apps/private | Create a private app|
|
|
9
9
|
|[**createPublicApp**](#createpublicapp) | **POST** /api/v2/apps/public | Create a public app|
|
|
10
10
|
|[**deleteAppWebhook**](#deleteappwebhook) | **DELETE** /api/v2/apps/{appUuid}/webhooks/{webhookUuid} | Delete a webhook for an app|
|
|
11
|
+
|[**deletePrivateApp**](#deleteprivateapp) | **DELETE** /api/v2/apps/private/{uuid} | Delete a private app|
|
|
11
12
|
|[**getApp**](#getapp) | **GET** /api/v2/apps/{uuid} | Retrieve application details by UUID|
|
|
12
13
|
|[**getAppWebhook**](#getappwebhook) | **GET** /api/v2/apps/{appUuid}/webhooks/{webhookUuid} | Get a webhook for an app|
|
|
13
14
|
|[**getAppWebhookDeliveries**](#getappwebhookdeliveries) | **GET** /api/v2/apps/{appUuid}/webhooks/{webhookUuid}/deliveries | Recent webhook delivery decisions|
|
|
@@ -267,6 +268,62 @@ const { status, data } = await apiInstance.deleteAppWebhook(
|
|
|
267
268
|
|
|
268
269
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
269
270
|
|
|
271
|
+
# **deletePrivateApp**
|
|
272
|
+
> DeleteResponse deletePrivateApp()
|
|
273
|
+
|
|
274
|
+
Deletes a private app owned by the current company. An active installation is uninstalled first. The app then disappears from the company.
|
|
275
|
+
|
|
276
|
+
### Example
|
|
277
|
+
|
|
278
|
+
```typescript
|
|
279
|
+
import {
|
|
280
|
+
ApplicationsApi,
|
|
281
|
+
Configuration
|
|
282
|
+
} from '@caraer/client';
|
|
283
|
+
|
|
284
|
+
const configuration = new Configuration();
|
|
285
|
+
const apiInstance = new ApplicationsApi(configuration);
|
|
286
|
+
|
|
287
|
+
let uuid: string; //UUID of the private app to delete (default to undefined)
|
|
288
|
+
|
|
289
|
+
const { status, data } = await apiInstance.deletePrivateApp(
|
|
290
|
+
uuid
|
|
291
|
+
);
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Parameters
|
|
295
|
+
|
|
296
|
+
|Name | Type | Description | Notes|
|
|
297
|
+
|------------- | ------------- | ------------- | -------------|
|
|
298
|
+
| **uuid** | [**string**] | UUID of the private app to delete | defaults to undefined|
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
### Return type
|
|
302
|
+
|
|
303
|
+
**DeleteResponse**
|
|
304
|
+
|
|
305
|
+
### Authorization
|
|
306
|
+
|
|
307
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
308
|
+
|
|
309
|
+
### HTTP request headers
|
|
310
|
+
|
|
311
|
+
- **Content-Type**: Not defined
|
|
312
|
+
- **Accept**: application/json
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### HTTP response details
|
|
316
|
+
| Status code | Description | Response headers |
|
|
317
|
+
|-------------|-------------|------------------|
|
|
318
|
+
|**200** | Private app deleted | - |
|
|
319
|
+
|**400** | The app is not private | - |
|
|
320
|
+
|**403** | Only the creator company can delete the app | - |
|
|
321
|
+
|**404** | Application not found | - |
|
|
322
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
323
|
+
|**500** | An internal server error occurred. | - |
|
|
324
|
+
|
|
325
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
326
|
+
|
|
270
327
|
# **getApp**
|
|
271
328
|
> ShowResponseAppDTO getApp()
|
|
272
329
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CmsModuleComponent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**label** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**fields** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CmsModuleComponent } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: CmsModuleComponent = {
|
|
18
|
+
name,
|
|
19
|
+
label,
|
|
20
|
+
fields,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/CmsModuleDTO.md
CHANGED
|
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**version** | **string** | | [optional] [default to undefined]
|
|
22
22
|
**retired** | **boolean** | | [optional] [default to undefined]
|
|
23
23
|
**fields** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | | [optional] [default to undefined]
|
|
24
|
+
**components** | [**Array<CmsModuleComponent>**](CmsModuleComponent.md) | | [optional] [default to undefined]
|
|
24
25
|
**frameworks** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
|
25
26
|
|
|
26
27
|
## Example
|
|
@@ -45,6 +46,7 @@ const instance: CmsModuleDTO = {
|
|
|
45
46
|
version,
|
|
46
47
|
retired,
|
|
47
48
|
fields,
|
|
49
|
+
components,
|
|
48
50
|
frameworks,
|
|
49
51
|
};
|
|
50
52
|
```
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
10
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
+
xproperty,
|
|
23
24
|
ymetric,
|
|
24
25
|
yproperty,
|
|
25
|
-
xproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|