@caraer/client 2.0.537 → 2.0.541
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 +79 -1
- package/dist/api.d.ts +39 -1
- package/dist/api.js +69 -0
- package/dist/esm/api.d.ts +39 -1
- package/dist/esm/api.js +69 -0
- 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,8 +2589,8 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2583
2589
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2584
2590
|
|
|
2585
2591
|
export interface ExistingWidgetSummary {
|
|
2586
|
-
'ymetric'?: string;
|
|
2587
2592
|
'yproperty'?: string;
|
|
2593
|
+
'ymetric'?: string;
|
|
2588
2594
|
'xproperty'?: string;
|
|
2589
2595
|
'title'?: string;
|
|
2590
2596
|
'chartType'?: string;
|
|
@@ -10270,6 +10276,44 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
10270
10276
|
options: localVarRequestOptions,
|
|
10271
10277
|
};
|
|
10272
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
|
+
},
|
|
10273
10317
|
/**
|
|
10274
10318
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10275
10319
|
* @summary Retrieve application details by UUID
|
|
@@ -11420,6 +11464,19 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
|
|
|
11420
11464
|
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.deleteAppWebhook']?.[localVarOperationServerIndex]?.url;
|
|
11421
11465
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11422
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
|
+
},
|
|
11423
11480
|
/**
|
|
11424
11481
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
11425
11482
|
* @summary Retrieve application details by UUID
|
|
@@ -11830,6 +11887,16 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
|
|
|
11830
11887
|
deleteAppWebhook(appUuid: string, webhookUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse> {
|
|
11831
11888
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
11832
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
|
+
},
|
|
11833
11900
|
/**
|
|
11834
11901
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
11835
11902
|
* @summary Retrieve application details by UUID
|
|
@@ -12164,6 +12231,17 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
12164
12231
|
return ApplicationsApiFp(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
12165
12232
|
}
|
|
12166
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
|
+
|
|
12167
12245
|
/**
|
|
12168
12246
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
12169
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,8 +2579,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2573
2579
|
};
|
|
2574
2580
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2581
|
export interface ExistingWidgetSummary {
|
|
2576
|
-
'ymetric'?: string;
|
|
2577
2582
|
'yproperty'?: string;
|
|
2583
|
+
'ymetric'?: string;
|
|
2578
2584
|
'xproperty'?: string;
|
|
2579
2585
|
'title'?: string;
|
|
2580
2586
|
'chartType'?: string;
|
|
@@ -9336,6 +9342,14 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9336
9342
|
* @throws {RequiredError}
|
|
9337
9343
|
*/
|
|
9338
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>;
|
|
9339
9353
|
/**
|
|
9340
9354
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9341
9355
|
* @summary Retrieve application details by UUID
|
|
@@ -9604,6 +9618,14 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9604
9618
|
* @throws {RequiredError}
|
|
9605
9619
|
*/
|
|
9606
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>>;
|
|
9607
9629
|
/**
|
|
9608
9630
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9609
9631
|
* @summary Retrieve application details by UUID
|
|
@@ -9880,6 +9902,14 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
9880
9902
|
* @throws {RequiredError}
|
|
9881
9903
|
*/
|
|
9882
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>;
|
|
9883
9913
|
/**
|
|
9884
9914
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9885
9915
|
* @summary Retrieve application details by UUID
|
|
@@ -10156,6 +10186,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10156
10186
|
* @throws {RequiredError}
|
|
10157
10187
|
*/
|
|
10158
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, {}>>;
|
|
10159
10197
|
/**
|
|
10160
10198
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10161
10199
|
* @summary Retrieve application details by UUID
|
package/dist/api.js
CHANGED
|
@@ -2001,6 +2001,39 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
2001
2001
|
options: localVarRequestOptions,
|
|
2002
2002
|
};
|
|
2003
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
|
+
}),
|
|
2004
2037
|
/**
|
|
2005
2038
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
2006
2039
|
* @summary Retrieve application details by UUID
|
|
@@ -3027,6 +3060,22 @@ const ApplicationsApiFp = function (configuration) {
|
|
|
3027
3060
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3028
3061
|
});
|
|
3029
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
|
+
},
|
|
3030
3079
|
/**
|
|
3031
3080
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3032
3081
|
* @summary Retrieve application details by UUID
|
|
@@ -3515,6 +3564,16 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
|
|
|
3515
3564
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3516
3565
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
3517
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
|
+
},
|
|
3518
3577
|
/**
|
|
3519
3578
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3520
3579
|
* @summary Retrieve application details by UUID
|
|
@@ -3845,6 +3904,16 @@ class ApplicationsApi extends base_1.BaseAPI {
|
|
|
3845
3904
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3846
3905
|
return (0, exports.ApplicationsApiFp)(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
3847
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
|
+
}
|
|
3848
3917
|
/**
|
|
3849
3918
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3850
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,8 +2579,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2573
2579
|
};
|
|
2574
2580
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2581
|
export interface ExistingWidgetSummary {
|
|
2576
|
-
'ymetric'?: string;
|
|
2577
2582
|
'yproperty'?: string;
|
|
2583
|
+
'ymetric'?: string;
|
|
2578
2584
|
'xproperty'?: string;
|
|
2579
2585
|
'title'?: string;
|
|
2580
2586
|
'chartType'?: string;
|
|
@@ -9336,6 +9342,14 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9336
9342
|
* @throws {RequiredError}
|
|
9337
9343
|
*/
|
|
9338
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>;
|
|
9339
9353
|
/**
|
|
9340
9354
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9341
9355
|
* @summary Retrieve application details by UUID
|
|
@@ -9604,6 +9618,14 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9604
9618
|
* @throws {RequiredError}
|
|
9605
9619
|
*/
|
|
9606
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>>;
|
|
9607
9629
|
/**
|
|
9608
9630
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9609
9631
|
* @summary Retrieve application details by UUID
|
|
@@ -9880,6 +9902,14 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
9880
9902
|
* @throws {RequiredError}
|
|
9881
9903
|
*/
|
|
9882
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>;
|
|
9883
9913
|
/**
|
|
9884
9914
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
9885
9915
|
* @summary Retrieve application details by UUID
|
|
@@ -10156,6 +10186,14 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10156
10186
|
* @throws {RequiredError}
|
|
10157
10187
|
*/
|
|
10158
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, {}>>;
|
|
10159
10197
|
/**
|
|
10160
10198
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
10161
10199
|
* @summary Retrieve application details by UUID
|
package/dist/esm/api.js
CHANGED
|
@@ -1983,6 +1983,39 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
1983
1983
|
options: localVarRequestOptions,
|
|
1984
1984
|
};
|
|
1985
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
|
+
}),
|
|
1986
2019
|
/**
|
|
1987
2020
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
1988
2021
|
* @summary Retrieve application details by UUID
|
|
@@ -3008,6 +3041,22 @@ export const ApplicationsApiFp = function (configuration) {
|
|
|
3008
3041
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3009
3042
|
});
|
|
3010
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
|
+
},
|
|
3011
3060
|
/**
|
|
3012
3061
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3013
3062
|
* @summary Retrieve application details by UUID
|
|
@@ -3495,6 +3544,16 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
|
|
|
3495
3544
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3496
3545
|
return localVarFp.deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(axios, basePath));
|
|
3497
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
|
+
},
|
|
3498
3557
|
/**
|
|
3499
3558
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3500
3559
|
* @summary Retrieve application details by UUID
|
|
@@ -3824,6 +3883,16 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
3824
3883
|
deleteAppWebhook(appUuid, webhookUuid, options) {
|
|
3825
3884
|
return ApplicationsApiFp(this.configuration).deleteAppWebhook(appUuid, webhookUuid, options).then((request) => request(this.axios, this.basePath));
|
|
3826
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
|
+
}
|
|
3827
3896
|
/**
|
|
3828
3897
|
* Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO.
|
|
3829
3898
|
* @summary Retrieve application details by UUID
|
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,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
@@ -20,8 +20,8 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
ymetric,
|
|
24
23
|
yproperty,
|
|
24
|
+
ymetric,
|
|
25
25
|
xproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|