@caraer/client 2.0.531 → 2.0.533
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/api.ts +82 -2
- package/dist/api.d.ts +46 -2
- package/dist/api.js +77 -0
- package/dist/esm/api.d.ts +46 -2
- package/dist/esm/api.js +77 -0
- package/docs/AppInstallationRuntimeApi.md +58 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/SettingField.md +2 -2
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -2584,8 +2584,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
|
|
|
2584
2584
|
|
|
2585
2585
|
export interface ExistingWidgetSummary {
|
|
2586
2586
|
'xproperty'?: string;
|
|
2587
|
-
'ymetric'?: string;
|
|
2588
2587
|
'yproperty'?: string;
|
|
2588
|
+
'ymetric'?: string;
|
|
2589
2589
|
'title'?: string;
|
|
2590
2590
|
'chartType'?: string;
|
|
2591
2591
|
'xProperty'?: string;
|
|
@@ -5767,8 +5767,8 @@ export interface SettingField {
|
|
|
5767
5767
|
'hidden'?: boolean;
|
|
5768
5768
|
'disabled'?: boolean;
|
|
5769
5769
|
'options'?: Array<SettingOption>;
|
|
5770
|
-
'defaultValue'?: any;
|
|
5771
5770
|
'value'?: any;
|
|
5771
|
+
'defaultValue'?: any;
|
|
5772
5772
|
}
|
|
5773
5773
|
|
|
5774
5774
|
export const SettingFieldTypeEnum = {
|
|
@@ -9255,6 +9255,49 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
|
|
|
9255
9255
|
options: localVarRequestOptions,
|
|
9256
9256
|
};
|
|
9257
9257
|
},
|
|
9258
|
+
/**
|
|
9259
|
+
*
|
|
9260
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9261
|
+
* @param {string} appUuid
|
|
9262
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9263
|
+
* @param {*} [options] Override http request option.
|
|
9264
|
+
* @throws {RequiredError}
|
|
9265
|
+
*/
|
|
9266
|
+
runInstallationSql: async (appUuid: string, requestBody: { [key: string]: any | null; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9267
|
+
// verify required parameter 'appUuid' is not null or undefined
|
|
9268
|
+
assertParamExists('runInstallationSql', 'appUuid', appUuid)
|
|
9269
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
9270
|
+
assertParamExists('runInstallationSql', 'requestBody', requestBody)
|
|
9271
|
+
const localVarPath = `/api/v2/apps/{appUuid}/installation/db`
|
|
9272
|
+
.replace('{appUuid}', encodeURIComponent(String(appUuid)));
|
|
9273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9274
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9275
|
+
let baseOptions;
|
|
9276
|
+
if (configuration) {
|
|
9277
|
+
baseOptions = configuration.baseOptions;
|
|
9278
|
+
}
|
|
9279
|
+
|
|
9280
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
9281
|
+
const localVarHeaderParameter = {} as any;
|
|
9282
|
+
const localVarQueryParameter = {} as any;
|
|
9283
|
+
|
|
9284
|
+
// authentication bearerAuth required
|
|
9285
|
+
// http bearer authentication required
|
|
9286
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
9287
|
+
|
|
9288
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9289
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
9290
|
+
|
|
9291
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9293
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9294
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
|
|
9295
|
+
|
|
9296
|
+
return {
|
|
9297
|
+
url: toPathString(localVarUrlObj),
|
|
9298
|
+
options: localVarRequestOptions,
|
|
9299
|
+
};
|
|
9300
|
+
},
|
|
9258
9301
|
/**
|
|
9259
9302
|
*
|
|
9260
9303
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9577,6 +9620,20 @@ export const AppInstallationRuntimeApiFp = function(configuration?: Configuratio
|
|
|
9577
9620
|
const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.revokeConnection']?.[localVarOperationServerIndex]?.url;
|
|
9578
9621
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9579
9622
|
},
|
|
9623
|
+
/**
|
|
9624
|
+
*
|
|
9625
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9626
|
+
* @param {string} appUuid
|
|
9627
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9628
|
+
* @param {*} [options] Override http request option.
|
|
9629
|
+
* @throws {RequiredError}
|
|
9630
|
+
*/
|
|
9631
|
+
async runInstallationSql(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
9632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.runInstallationSql(appUuid, requestBody, options);
|
|
9633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9634
|
+
const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.runInstallationSql']?.[localVarOperationServerIndex]?.url;
|
|
9635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9636
|
+
},
|
|
9580
9637
|
/**
|
|
9581
9638
|
*
|
|
9582
9639
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9771,6 +9828,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration?: Config
|
|
|
9771
9828
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseVoid> {
|
|
9772
9829
|
return localVarFp.revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(axios, basePath));
|
|
9773
9830
|
},
|
|
9831
|
+
/**
|
|
9832
|
+
*
|
|
9833
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9834
|
+
* @param {string} appUuid
|
|
9835
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9836
|
+
* @param {*} [options] Override http request option.
|
|
9837
|
+
* @throws {RequiredError}
|
|
9838
|
+
*/
|
|
9839
|
+
runInstallationSql(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
9840
|
+
return localVarFp.runInstallationSql(appUuid, requestBody, options).then((request) => request(axios, basePath));
|
|
9841
|
+
},
|
|
9774
9842
|
/**
|
|
9775
9843
|
*
|
|
9776
9844
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9967,6 +10035,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9967
10035
|
return AppInstallationRuntimeApiFp(this.configuration).revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(this.axios, this.basePath));
|
|
9968
10036
|
}
|
|
9969
10037
|
|
|
10038
|
+
/**
|
|
10039
|
+
*
|
|
10040
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
10041
|
+
* @param {string} appUuid
|
|
10042
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
10043
|
+
* @param {*} [options] Override http request option.
|
|
10044
|
+
* @throws {RequiredError}
|
|
10045
|
+
*/
|
|
10046
|
+
public runInstallationSql(appUuid: string, requestBody: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) {
|
|
10047
|
+
return AppInstallationRuntimeApiFp(this.configuration).runInstallationSql(appUuid, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
10048
|
+
}
|
|
10049
|
+
|
|
9970
10050
|
/**
|
|
9971
10051
|
*
|
|
9972
10052
|
* @summary Save USER-scoped installation settings for the current user
|
package/dist/api.d.ts
CHANGED
|
@@ -2574,8 +2574,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2574
2574
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2575
|
export interface ExistingWidgetSummary {
|
|
2576
2576
|
'xproperty'?: string;
|
|
2577
|
-
'ymetric'?: string;
|
|
2578
2577
|
'yproperty'?: string;
|
|
2578
|
+
'ymetric'?: string;
|
|
2579
2579
|
'title'?: string;
|
|
2580
2580
|
'chartType'?: string;
|
|
2581
2581
|
'xProperty'?: string;
|
|
@@ -5819,8 +5819,8 @@ export interface SettingField {
|
|
|
5819
5819
|
'hidden'?: boolean;
|
|
5820
5820
|
'disabled'?: boolean;
|
|
5821
5821
|
'options'?: Array<SettingOption>;
|
|
5822
|
-
'defaultValue'?: any;
|
|
5823
5822
|
'value'?: any;
|
|
5823
|
+
'defaultValue'?: any;
|
|
5824
5824
|
}
|
|
5825
5825
|
export declare const SettingFieldTypeEnum: {
|
|
5826
5826
|
readonly String: "STRING";
|
|
@@ -8749,6 +8749,17 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
|
|
|
8749
8749
|
* @throws {RequiredError}
|
|
8750
8750
|
*/
|
|
8751
8751
|
revokeConnection: (appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8752
|
+
/**
|
|
8753
|
+
*
|
|
8754
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
8755
|
+
* @param {string} appUuid
|
|
8756
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
8757
|
+
* @param {*} [options] Override http request option.
|
|
8758
|
+
* @throws {RequiredError}
|
|
8759
|
+
*/
|
|
8760
|
+
runInstallationSql: (appUuid: string, requestBody: {
|
|
8761
|
+
[key: string]: any | null;
|
|
8762
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8752
8763
|
/**
|
|
8753
8764
|
*
|
|
8754
8765
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -8904,6 +8915,17 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
|
|
|
8904
8915
|
* @throws {RequiredError}
|
|
8905
8916
|
*/
|
|
8906
8917
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseVoid>>;
|
|
8918
|
+
/**
|
|
8919
|
+
*
|
|
8920
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
8921
|
+
* @param {string} appUuid
|
|
8922
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
8923
|
+
* @param {*} [options] Override http request option.
|
|
8924
|
+
* @throws {RequiredError}
|
|
8925
|
+
*/
|
|
8926
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
8927
|
+
[key: string]: any | null;
|
|
8928
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
8907
8929
|
/**
|
|
8908
8930
|
*
|
|
8909
8931
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9059,6 +9081,17 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
|
|
|
9059
9081
|
* @throws {RequiredError}
|
|
9060
9082
|
*/
|
|
9061
9083
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseVoid>;
|
|
9084
|
+
/**
|
|
9085
|
+
*
|
|
9086
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9087
|
+
* @param {string} appUuid
|
|
9088
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9089
|
+
* @param {*} [options] Override http request option.
|
|
9090
|
+
* @throws {RequiredError}
|
|
9091
|
+
*/
|
|
9092
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
9093
|
+
[key: string]: any | null;
|
|
9094
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
9062
9095
|
/**
|
|
9063
9096
|
*
|
|
9064
9097
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9214,6 +9247,17 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9214
9247
|
* @throws {RequiredError}
|
|
9215
9248
|
*/
|
|
9216
9249
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9250
|
+
/**
|
|
9251
|
+
*
|
|
9252
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9253
|
+
* @param {string} appUuid
|
|
9254
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9255
|
+
* @param {*} [options] Override http request option.
|
|
9256
|
+
* @throws {RequiredError}
|
|
9257
|
+
*/
|
|
9258
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
9259
|
+
[key: string]: any | null;
|
|
9260
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9217
9261
|
/**
|
|
9218
9262
|
*
|
|
9219
9263
|
* @summary Save USER-scoped installation settings for the current user
|
package/dist/api.js
CHANGED
|
@@ -1002,6 +1002,44 @@ const AppInstallationRuntimeApiAxiosParamCreator = function (configuration) {
|
|
|
1002
1002
|
options: localVarRequestOptions,
|
|
1003
1003
|
};
|
|
1004
1004
|
}),
|
|
1005
|
+
/**
|
|
1006
|
+
*
|
|
1007
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1008
|
+
* @param {string} appUuid
|
|
1009
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1010
|
+
* @param {*} [options] Override http request option.
|
|
1011
|
+
* @throws {RequiredError}
|
|
1012
|
+
*/
|
|
1013
|
+
runInstallationSql: (appUuid_1, requestBody_1, ...args_1) => __awaiter(this, [appUuid_1, requestBody_1, ...args_1], void 0, function* (appUuid, requestBody, options = {}) {
|
|
1014
|
+
// verify required parameter 'appUuid' is not null or undefined
|
|
1015
|
+
(0, common_1.assertParamExists)('runInstallationSql', 'appUuid', appUuid);
|
|
1016
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
1017
|
+
(0, common_1.assertParamExists)('runInstallationSql', 'requestBody', requestBody);
|
|
1018
|
+
const localVarPath = `/api/v2/apps/{appUuid}/installation/db`
|
|
1019
|
+
.replace('{appUuid}', encodeURIComponent(String(appUuid)));
|
|
1020
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1021
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1022
|
+
let baseOptions;
|
|
1023
|
+
if (configuration) {
|
|
1024
|
+
baseOptions = configuration.baseOptions;
|
|
1025
|
+
}
|
|
1026
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1027
|
+
const localVarHeaderParameter = {};
|
|
1028
|
+
const localVarQueryParameter = {};
|
|
1029
|
+
// authentication bearerAuth required
|
|
1030
|
+
// http bearer authentication required
|
|
1031
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1032
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1033
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1034
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1035
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1036
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1037
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(requestBody, localVarRequestOptions, configuration);
|
|
1038
|
+
return {
|
|
1039
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1040
|
+
options: localVarRequestOptions,
|
|
1041
|
+
};
|
|
1042
|
+
}),
|
|
1005
1043
|
/**
|
|
1006
1044
|
*
|
|
1007
1045
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1347,6 +1385,23 @@ const AppInstallationRuntimeApiFp = function (configuration) {
|
|
|
1347
1385
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1348
1386
|
});
|
|
1349
1387
|
},
|
|
1388
|
+
/**
|
|
1389
|
+
*
|
|
1390
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1391
|
+
* @param {string} appUuid
|
|
1392
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1393
|
+
* @param {*} [options] Override http request option.
|
|
1394
|
+
* @throws {RequiredError}
|
|
1395
|
+
*/
|
|
1396
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1397
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1398
|
+
var _a, _b, _c;
|
|
1399
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.runInstallationSql(appUuid, requestBody, options);
|
|
1400
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1401
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AppInstallationRuntimeApi.runInstallationSql']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1402
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1403
|
+
});
|
|
1404
|
+
},
|
|
1350
1405
|
/**
|
|
1351
1406
|
*
|
|
1352
1407
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1550,6 +1605,17 @@ const AppInstallationRuntimeApiFactory = function (configuration, basePath, axio
|
|
|
1550
1605
|
revokeConnection(appUuid, providerOrConnectionId, options) {
|
|
1551
1606
|
return localVarFp.revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(axios, basePath));
|
|
1552
1607
|
},
|
|
1608
|
+
/**
|
|
1609
|
+
*
|
|
1610
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1611
|
+
* @param {string} appUuid
|
|
1612
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1613
|
+
* @param {*} [options] Override http request option.
|
|
1614
|
+
* @throws {RequiredError}
|
|
1615
|
+
*/
|
|
1616
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1617
|
+
return localVarFp.runInstallationSql(appUuid, requestBody, options).then((request) => request(axios, basePath));
|
|
1618
|
+
},
|
|
1553
1619
|
/**
|
|
1554
1620
|
*
|
|
1555
1621
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1733,6 +1799,17 @@ class AppInstallationRuntimeApi extends base_1.BaseAPI {
|
|
|
1733
1799
|
revokeConnection(appUuid, providerOrConnectionId, options) {
|
|
1734
1800
|
return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(this.axios, this.basePath));
|
|
1735
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
*
|
|
1804
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1805
|
+
* @param {string} appUuid
|
|
1806
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1807
|
+
* @param {*} [options] Override http request option.
|
|
1808
|
+
* @throws {RequiredError}
|
|
1809
|
+
*/
|
|
1810
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1811
|
+
return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).runInstallationSql(appUuid, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
1812
|
+
}
|
|
1736
1813
|
/**
|
|
1737
1814
|
*
|
|
1738
1815
|
* @summary Save USER-scoped installation settings for the current user
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2574,8 +2574,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2574
2574
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2575
2575
|
export interface ExistingWidgetSummary {
|
|
2576
2576
|
'xproperty'?: string;
|
|
2577
|
-
'ymetric'?: string;
|
|
2578
2577
|
'yproperty'?: string;
|
|
2578
|
+
'ymetric'?: string;
|
|
2579
2579
|
'title'?: string;
|
|
2580
2580
|
'chartType'?: string;
|
|
2581
2581
|
'xProperty'?: string;
|
|
@@ -5819,8 +5819,8 @@ export interface SettingField {
|
|
|
5819
5819
|
'hidden'?: boolean;
|
|
5820
5820
|
'disabled'?: boolean;
|
|
5821
5821
|
'options'?: Array<SettingOption>;
|
|
5822
|
-
'defaultValue'?: any;
|
|
5823
5822
|
'value'?: any;
|
|
5823
|
+
'defaultValue'?: any;
|
|
5824
5824
|
}
|
|
5825
5825
|
export declare const SettingFieldTypeEnum: {
|
|
5826
5826
|
readonly String: "STRING";
|
|
@@ -8749,6 +8749,17 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
|
|
|
8749
8749
|
* @throws {RequiredError}
|
|
8750
8750
|
*/
|
|
8751
8751
|
revokeConnection: (appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8752
|
+
/**
|
|
8753
|
+
*
|
|
8754
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
8755
|
+
* @param {string} appUuid
|
|
8756
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
8757
|
+
* @param {*} [options] Override http request option.
|
|
8758
|
+
* @throws {RequiredError}
|
|
8759
|
+
*/
|
|
8760
|
+
runInstallationSql: (appUuid: string, requestBody: {
|
|
8761
|
+
[key: string]: any | null;
|
|
8762
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8752
8763
|
/**
|
|
8753
8764
|
*
|
|
8754
8765
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -8904,6 +8915,17 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
|
|
|
8904
8915
|
* @throws {RequiredError}
|
|
8905
8916
|
*/
|
|
8906
8917
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseVoid>>;
|
|
8918
|
+
/**
|
|
8919
|
+
*
|
|
8920
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
8921
|
+
* @param {string} appUuid
|
|
8922
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
8923
|
+
* @param {*} [options] Override http request option.
|
|
8924
|
+
* @throws {RequiredError}
|
|
8925
|
+
*/
|
|
8926
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
8927
|
+
[key: string]: any | null;
|
|
8928
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
8907
8929
|
/**
|
|
8908
8930
|
*
|
|
8909
8931
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9059,6 +9081,17 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
|
|
|
9059
9081
|
* @throws {RequiredError}
|
|
9060
9082
|
*/
|
|
9061
9083
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseVoid>;
|
|
9084
|
+
/**
|
|
9085
|
+
*
|
|
9086
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9087
|
+
* @param {string} appUuid
|
|
9088
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9089
|
+
* @param {*} [options] Override http request option.
|
|
9090
|
+
* @throws {RequiredError}
|
|
9091
|
+
*/
|
|
9092
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
9093
|
+
[key: string]: any | null;
|
|
9094
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
9062
9095
|
/**
|
|
9063
9096
|
*
|
|
9064
9097
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -9214,6 +9247,17 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
9214
9247
|
* @throws {RequiredError}
|
|
9215
9248
|
*/
|
|
9216
9249
|
revokeConnection(appUuid: string, providerOrConnectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseVoid, any, {}>>;
|
|
9250
|
+
/**
|
|
9251
|
+
*
|
|
9252
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
9253
|
+
* @param {string} appUuid
|
|
9254
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
9255
|
+
* @param {*} [options] Override http request option.
|
|
9256
|
+
* @throws {RequiredError}
|
|
9257
|
+
*/
|
|
9258
|
+
runInstallationSql(appUuid: string, requestBody: {
|
|
9259
|
+
[key: string]: any | null;
|
|
9260
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
9217
9261
|
/**
|
|
9218
9262
|
*
|
|
9219
9263
|
* @summary Save USER-scoped installation settings for the current user
|
package/dist/esm/api.js
CHANGED
|
@@ -988,6 +988,44 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
|
|
|
988
988
|
options: localVarRequestOptions,
|
|
989
989
|
};
|
|
990
990
|
}),
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
994
|
+
* @param {string} appUuid
|
|
995
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
996
|
+
* @param {*} [options] Override http request option.
|
|
997
|
+
* @throws {RequiredError}
|
|
998
|
+
*/
|
|
999
|
+
runInstallationSql: (appUuid_1, requestBody_1, ...args_1) => __awaiter(this, [appUuid_1, requestBody_1, ...args_1], void 0, function* (appUuid, requestBody, options = {}) {
|
|
1000
|
+
// verify required parameter 'appUuid' is not null or undefined
|
|
1001
|
+
assertParamExists('runInstallationSql', 'appUuid', appUuid);
|
|
1002
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
1003
|
+
assertParamExists('runInstallationSql', 'requestBody', requestBody);
|
|
1004
|
+
const localVarPath = `/api/v2/apps/{appUuid}/installation/db`
|
|
1005
|
+
.replace('{appUuid}', encodeURIComponent(String(appUuid)));
|
|
1006
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1007
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1008
|
+
let baseOptions;
|
|
1009
|
+
if (configuration) {
|
|
1010
|
+
baseOptions = configuration.baseOptions;
|
|
1011
|
+
}
|
|
1012
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1013
|
+
const localVarHeaderParameter = {};
|
|
1014
|
+
const localVarQueryParameter = {};
|
|
1015
|
+
// authentication bearerAuth required
|
|
1016
|
+
// http bearer authentication required
|
|
1017
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1018
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1019
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1020
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1021
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1022
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1023
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
|
|
1024
|
+
return {
|
|
1025
|
+
url: toPathString(localVarUrlObj),
|
|
1026
|
+
options: localVarRequestOptions,
|
|
1027
|
+
};
|
|
1028
|
+
}),
|
|
991
1029
|
/**
|
|
992
1030
|
*
|
|
993
1031
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1332,6 +1370,23 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
|
|
|
1332
1370
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1333
1371
|
});
|
|
1334
1372
|
},
|
|
1373
|
+
/**
|
|
1374
|
+
*
|
|
1375
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1376
|
+
* @param {string} appUuid
|
|
1377
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1378
|
+
* @param {*} [options] Override http request option.
|
|
1379
|
+
* @throws {RequiredError}
|
|
1380
|
+
*/
|
|
1381
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1382
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1383
|
+
var _a, _b, _c;
|
|
1384
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.runInstallationSql(appUuid, requestBody, options);
|
|
1385
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1386
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.runInstallationSql']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1387
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1388
|
+
});
|
|
1389
|
+
},
|
|
1335
1390
|
/**
|
|
1336
1391
|
*
|
|
1337
1392
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1534,6 +1589,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
|
|
|
1534
1589
|
revokeConnection(appUuid, providerOrConnectionId, options) {
|
|
1535
1590
|
return localVarFp.revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(axios, basePath));
|
|
1536
1591
|
},
|
|
1592
|
+
/**
|
|
1593
|
+
*
|
|
1594
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1595
|
+
* @param {string} appUuid
|
|
1596
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1597
|
+
* @param {*} [options] Override http request option.
|
|
1598
|
+
* @throws {RequiredError}
|
|
1599
|
+
*/
|
|
1600
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1601
|
+
return localVarFp.runInstallationSql(appUuid, requestBody, options).then((request) => request(axios, basePath));
|
|
1602
|
+
},
|
|
1537
1603
|
/**
|
|
1538
1604
|
*
|
|
1539
1605
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -1716,6 +1782,17 @@ export class AppInstallationRuntimeApi extends BaseAPI {
|
|
|
1716
1782
|
revokeConnection(appUuid, providerOrConnectionId, options) {
|
|
1717
1783
|
return AppInstallationRuntimeApiFp(this.configuration).revokeConnection(appUuid, providerOrConnectionId, options).then((request) => request(this.axios, this.basePath));
|
|
1718
1784
|
}
|
|
1785
|
+
/**
|
|
1786
|
+
*
|
|
1787
|
+
* @summary Run SQL in this installation\'s Postgres schema
|
|
1788
|
+
* @param {string} appUuid
|
|
1789
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
1790
|
+
* @param {*} [options] Override http request option.
|
|
1791
|
+
* @throws {RequiredError}
|
|
1792
|
+
*/
|
|
1793
|
+
runInstallationSql(appUuid, requestBody, options) {
|
|
1794
|
+
return AppInstallationRuntimeApiFp(this.configuration).runInstallationSql(appUuid, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
1795
|
+
}
|
|
1719
1796
|
/**
|
|
1720
1797
|
*
|
|
1721
1798
|
* @summary Save USER-scoped installation settings for the current user
|
|
@@ -17,6 +17,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
17
17
|
|[**putState**](#putstate) | **PUT** /api/v2/apps/{appUuid}/installation/state | Replace/merge installation state (shallow merge)|
|
|
18
18
|
|[**putStateKey**](#putstatekey) | **PUT** /api/v2/apps/{appUuid}/installation/state/{key} | Put a single state key|
|
|
19
19
|
|[**revokeConnection**](#revokeconnection) | **DELETE** /api/v2/apps/{appUuid}/installation/connections/{providerOrConnectionId} | Revoke external OAuth connection tokens by connection id or provider name|
|
|
20
|
+
|[**runInstallationSql**](#runinstallationsql) | **POST** /api/v2/apps/{appUuid}/installation/db | Run SQL in this installation\'s Postgres schema|
|
|
20
21
|
|[**saveUserSettings**](#saveusersettings) | **PUT** /api/v2/apps/{appUuid}/installation/settings/user | Save USER-scoped installation settings for the current user|
|
|
21
22
|
|[**startOAuth**](#startoauth) | **POST** /api/v2/apps/{appUuid}/installation/oauth/{provider}/start | Start external OAuth authorize (returns provider authorize URL)|
|
|
22
23
|
|[**triggerSettingAction**](#triggersettingaction) | **POST** /api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger | Trigger an ACTION setting without saving settings|
|
|
@@ -748,6 +749,63 @@ const { status, data } = await apiInstance.revokeConnection(
|
|
|
748
749
|
- **Accept**: application/json
|
|
749
750
|
|
|
750
751
|
|
|
752
|
+
### HTTP response details
|
|
753
|
+
| Status code | Description | Response headers |
|
|
754
|
+
|-------------|-------------|------------------|
|
|
755
|
+
|**200** | OK | - |
|
|
756
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
757
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
758
|
+
|**404** | The requested resource was not found. | - |
|
|
759
|
+
|**500** | An internal server error occurred. | - |
|
|
760
|
+
|
|
761
|
+
[[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)
|
|
762
|
+
|
|
763
|
+
# **runInstallationSql**
|
|
764
|
+
> ShowResponseMapStringObject runInstallationSql(requestBody)
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
### Example
|
|
768
|
+
|
|
769
|
+
```typescript
|
|
770
|
+
import {
|
|
771
|
+
AppInstallationRuntimeApi,
|
|
772
|
+
Configuration
|
|
773
|
+
} from '@caraer/client';
|
|
774
|
+
|
|
775
|
+
const configuration = new Configuration();
|
|
776
|
+
const apiInstance = new AppInstallationRuntimeApi(configuration);
|
|
777
|
+
|
|
778
|
+
let appUuid: string; // (default to undefined)
|
|
779
|
+
let requestBody: { [key: string]: any | null; }; //
|
|
780
|
+
|
|
781
|
+
const { status, data } = await apiInstance.runInstallationSql(
|
|
782
|
+
appUuid,
|
|
783
|
+
requestBody
|
|
784
|
+
);
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
### Parameters
|
|
788
|
+
|
|
789
|
+
|Name | Type | Description | Notes|
|
|
790
|
+
|------------- | ------------- | ------------- | -------------|
|
|
791
|
+
| **requestBody** | **{ [key: string]: any | null; }**| | |
|
|
792
|
+
| **appUuid** | [**string**] | | defaults to undefined|
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
### Return type
|
|
796
|
+
|
|
797
|
+
**ShowResponseMapStringObject**
|
|
798
|
+
|
|
799
|
+
### Authorization
|
|
800
|
+
|
|
801
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
802
|
+
|
|
803
|
+
### HTTP request headers
|
|
804
|
+
|
|
805
|
+
- **Content-Type**: application/json
|
|
806
|
+
- **Accept**: application/json
|
|
807
|
+
|
|
808
|
+
|
|
751
809
|
### HTTP response details
|
|
752
810
|
| Status code | Description | Response headers |
|
|
753
811
|
|-------------|-------------|------------------|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**ymetric** | **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]
|
|
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
|
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
23
|
xproperty,
|
|
24
|
-
ymetric,
|
|
25
24
|
yproperty,
|
|
25
|
+
ymetric,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**value** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
defaultValue,
|
|
36
35
|
value,
|
|
36
|
+
defaultValue,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|