@caraer/client 2.0.601 → 2.0.603

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/dist/esm/api.js CHANGED
@@ -660,6 +660,43 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
660
660
  options: localVarRequestOptions,
661
661
  };
662
662
  }),
663
+ /**
664
+ *
665
+ * @summary Load read-only Markdown content for a setting
666
+ * @param {string} appUuid
667
+ * @param {string} fieldName
668
+ * @param {*} [options] Override http request option.
669
+ * @throws {RequiredError}
670
+ */
671
+ getSettingContent: (appUuid_1, fieldName_1, ...args_1) => __awaiter(this, [appUuid_1, fieldName_1, ...args_1], void 0, function* (appUuid, fieldName, options = {}) {
672
+ // verify required parameter 'appUuid' is not null or undefined
673
+ assertParamExists('getSettingContent', 'appUuid', appUuid);
674
+ // verify required parameter 'fieldName' is not null or undefined
675
+ assertParamExists('getSettingContent', 'fieldName', fieldName);
676
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/content`
677
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
678
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
679
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
680
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
681
+ let baseOptions;
682
+ if (configuration) {
683
+ baseOptions = configuration.baseOptions;
684
+ }
685
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
686
+ const localVarHeaderParameter = {};
687
+ const localVarQueryParameter = {};
688
+ // authentication bearerAuth required
689
+ // http bearer authentication required
690
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
691
+ localVarHeaderParameter['Accept'] = 'application/json';
692
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
693
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
694
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
695
+ return {
696
+ url: toPathString(localVarUrlObj),
697
+ options: localVarRequestOptions,
698
+ };
699
+ }),
663
700
  /**
664
701
  *
665
702
  * @summary Get installation state map
@@ -1075,10 +1112,11 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
1075
1112
  * @param {string} appUuid
1076
1113
  * @param {string} provider
1077
1114
  * @param {string} [redirectUri]
1115
+ * @param {string} [connectionId]
1078
1116
  * @param {*} [options] Override http request option.
1079
1117
  * @throws {RequiredError}
1080
1118
  */
1081
- startOAuth: (appUuid_1, provider_1, redirectUri_1, ...args_1) => __awaiter(this, [appUuid_1, provider_1, redirectUri_1, ...args_1], void 0, function* (appUuid, provider, redirectUri, options = {}) {
1119
+ startOAuth: (appUuid_1, provider_1, redirectUri_1, connectionId_1, ...args_1) => __awaiter(this, [appUuid_1, provider_1, redirectUri_1, connectionId_1, ...args_1], void 0, function* (appUuid, provider, redirectUri, connectionId, options = {}) {
1082
1120
  // verify required parameter 'appUuid' is not null or undefined
1083
1121
  assertParamExists('startOAuth', 'appUuid', appUuid);
1084
1122
  // verify required parameter 'provider' is not null or undefined
@@ -1101,6 +1139,9 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
1101
1139
  if (redirectUri !== undefined) {
1102
1140
  localVarQueryParameter['redirectUri'] = redirectUri;
1103
1141
  }
1142
+ if (connectionId !== undefined) {
1143
+ localVarQueryParameter['connectionId'] = connectionId;
1144
+ }
1104
1145
  localVarHeaderParameter['Accept'] = 'application/json';
1105
1146
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1106
1147
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1147,6 +1188,48 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
1147
1188
  options: localVarRequestOptions,
1148
1189
  };
1149
1190
  }),
1191
+ /**
1192
+ *
1193
+ * @summary Update an external OAuth connection display label
1194
+ * @param {string} appUuid
1195
+ * @param {string} connectionId
1196
+ * @param {{ [key: string]: string; }} requestBody
1197
+ * @param {*} [options] Override http request option.
1198
+ * @throws {RequiredError}
1199
+ */
1200
+ updateConnectionLabel: (appUuid_1, connectionId_1, requestBody_1, ...args_1) => __awaiter(this, [appUuid_1, connectionId_1, requestBody_1, ...args_1], void 0, function* (appUuid, connectionId, requestBody, options = {}) {
1201
+ // verify required parameter 'appUuid' is not null or undefined
1202
+ assertParamExists('updateConnectionLabel', 'appUuid', appUuid);
1203
+ // verify required parameter 'connectionId' is not null or undefined
1204
+ assertParamExists('updateConnectionLabel', 'connectionId', connectionId);
1205
+ // verify required parameter 'requestBody' is not null or undefined
1206
+ assertParamExists('updateConnectionLabel', 'requestBody', requestBody);
1207
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/connections/{connectionId}`
1208
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
1209
+ .replace('{connectionId}', encodeURIComponent(String(connectionId)));
1210
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1211
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1212
+ let baseOptions;
1213
+ if (configuration) {
1214
+ baseOptions = configuration.baseOptions;
1215
+ }
1216
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
1217
+ const localVarHeaderParameter = {};
1218
+ const localVarQueryParameter = {};
1219
+ // authentication bearerAuth required
1220
+ // http bearer authentication required
1221
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
1222
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1223
+ localVarHeaderParameter['Accept'] = 'application/json';
1224
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1225
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1226
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1227
+ localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
1228
+ return {
1229
+ url: toPathString(localVarUrlObj),
1230
+ options: localVarRequestOptions,
1231
+ };
1232
+ }),
1150
1233
  };
1151
1234
  };
1152
1235
  /**
@@ -1223,6 +1306,23 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1223
1306
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1224
1307
  });
1225
1308
  },
1309
+ /**
1310
+ *
1311
+ * @summary Load read-only Markdown content for a setting
1312
+ * @param {string} appUuid
1313
+ * @param {string} fieldName
1314
+ * @param {*} [options] Override http request option.
1315
+ * @throws {RequiredError}
1316
+ */
1317
+ getSettingContent(appUuid, fieldName, options) {
1318
+ return __awaiter(this, void 0, void 0, function* () {
1319
+ var _a, _b, _c;
1320
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettingContent(appUuid, fieldName, options);
1321
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1322
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.getSettingContent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1323
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1324
+ });
1325
+ },
1226
1326
  /**
1227
1327
  *
1228
1328
  * @summary Get installation state map
@@ -1415,13 +1515,14 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1415
1515
  * @param {string} appUuid
1416
1516
  * @param {string} provider
1417
1517
  * @param {string} [redirectUri]
1518
+ * @param {string} [connectionId]
1418
1519
  * @param {*} [options] Override http request option.
1419
1520
  * @throws {RequiredError}
1420
1521
  */
1421
- startOAuth(appUuid, provider, redirectUri, options) {
1522
+ startOAuth(appUuid, provider, redirectUri, connectionId, options) {
1422
1523
  return __awaiter(this, void 0, void 0, function* () {
1423
1524
  var _a, _b, _c;
1424
- const localVarAxiosArgs = yield localVarAxiosParamCreator.startOAuth(appUuid, provider, redirectUri, options);
1525
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.startOAuth(appUuid, provider, redirectUri, connectionId, options);
1425
1526
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1426
1527
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.startOAuth']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1427
1528
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1444,6 +1545,24 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1444
1545
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1445
1546
  });
1446
1547
  },
1548
+ /**
1549
+ *
1550
+ * @summary Update an external OAuth connection display label
1551
+ * @param {string} appUuid
1552
+ * @param {string} connectionId
1553
+ * @param {{ [key: string]: string; }} requestBody
1554
+ * @param {*} [options] Override http request option.
1555
+ * @throws {RequiredError}
1556
+ */
1557
+ updateConnectionLabel(appUuid, connectionId, requestBody, options) {
1558
+ return __awaiter(this, void 0, void 0, function* () {
1559
+ var _a, _b, _c;
1560
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateConnectionLabel(appUuid, connectionId, requestBody, options);
1561
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1562
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.updateConnectionLabel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1563
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1564
+ });
1565
+ },
1447
1566
  };
1448
1567
  };
1449
1568
  /**
@@ -1496,6 +1615,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1496
1615
  getJob(appUuid, jobId, options) {
1497
1616
  return localVarFp.getJob(appUuid, jobId, options).then((request) => request(axios, basePath));
1498
1617
  },
1618
+ /**
1619
+ *
1620
+ * @summary Load read-only Markdown content for a setting
1621
+ * @param {string} appUuid
1622
+ * @param {string} fieldName
1623
+ * @param {*} [options] Override http request option.
1624
+ * @throws {RequiredError}
1625
+ */
1626
+ getSettingContent(appUuid, fieldName, options) {
1627
+ return localVarFp.getSettingContent(appUuid, fieldName, options).then((request) => request(axios, basePath));
1628
+ },
1499
1629
  /**
1500
1630
  *
1501
1631
  * @summary Get installation state map
@@ -1622,11 +1752,12 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1622
1752
  * @param {string} appUuid
1623
1753
  * @param {string} provider
1624
1754
  * @param {string} [redirectUri]
1755
+ * @param {string} [connectionId]
1625
1756
  * @param {*} [options] Override http request option.
1626
1757
  * @throws {RequiredError}
1627
1758
  */
1628
- startOAuth(appUuid, provider, redirectUri, options) {
1629
- return localVarFp.startOAuth(appUuid, provider, redirectUri, options).then((request) => request(axios, basePath));
1759
+ startOAuth(appUuid, provider, redirectUri, connectionId, options) {
1760
+ return localVarFp.startOAuth(appUuid, provider, redirectUri, connectionId, options).then((request) => request(axios, basePath));
1630
1761
  },
1631
1762
  /**
1632
1763
  *
@@ -1639,6 +1770,18 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1639
1770
  triggerSettingAction(appUuid, fieldName, options) {
1640
1771
  return localVarFp.triggerSettingAction(appUuid, fieldName, options).then((request) => request(axios, basePath));
1641
1772
  },
1773
+ /**
1774
+ *
1775
+ * @summary Update an external OAuth connection display label
1776
+ * @param {string} appUuid
1777
+ * @param {string} connectionId
1778
+ * @param {{ [key: string]: string; }} requestBody
1779
+ * @param {*} [options] Override http request option.
1780
+ * @throws {RequiredError}
1781
+ */
1782
+ updateConnectionLabel(appUuid, connectionId, requestBody, options) {
1783
+ return localVarFp.updateConnectionLabel(appUuid, connectionId, requestBody, options).then((request) => request(axios, basePath));
1784
+ },
1642
1785
  };
1643
1786
  };
1644
1787
  /**
@@ -1689,6 +1832,17 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1689
1832
  getJob(appUuid, jobId, options) {
1690
1833
  return AppInstallationRuntimeApiFp(this.configuration).getJob(appUuid, jobId, options).then((request) => request(this.axios, this.basePath));
1691
1834
  }
1835
+ /**
1836
+ *
1837
+ * @summary Load read-only Markdown content for a setting
1838
+ * @param {string} appUuid
1839
+ * @param {string} fieldName
1840
+ * @param {*} [options] Override http request option.
1841
+ * @throws {RequiredError}
1842
+ */
1843
+ getSettingContent(appUuid, fieldName, options) {
1844
+ return AppInstallationRuntimeApiFp(this.configuration).getSettingContent(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
1845
+ }
1692
1846
  /**
1693
1847
  *
1694
1848
  * @summary Get installation state map
@@ -1815,11 +1969,12 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1815
1969
  * @param {string} appUuid
1816
1970
  * @param {string} provider
1817
1971
  * @param {string} [redirectUri]
1972
+ * @param {string} [connectionId]
1818
1973
  * @param {*} [options] Override http request option.
1819
1974
  * @throws {RequiredError}
1820
1975
  */
1821
- startOAuth(appUuid, provider, redirectUri, options) {
1822
- return AppInstallationRuntimeApiFp(this.configuration).startOAuth(appUuid, provider, redirectUri, options).then((request) => request(this.axios, this.basePath));
1976
+ startOAuth(appUuid, provider, redirectUri, connectionId, options) {
1977
+ return AppInstallationRuntimeApiFp(this.configuration).startOAuth(appUuid, provider, redirectUri, connectionId, options).then((request) => request(this.axios, this.basePath));
1823
1978
  }
1824
1979
  /**
1825
1980
  *
@@ -1832,6 +1987,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1832
1987
  triggerSettingAction(appUuid, fieldName, options) {
1833
1988
  return AppInstallationRuntimeApiFp(this.configuration).triggerSettingAction(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
1834
1989
  }
1990
+ /**
1991
+ *
1992
+ * @summary Update an external OAuth connection display label
1993
+ * @param {string} appUuid
1994
+ * @param {string} connectionId
1995
+ * @param {{ [key: string]: string; }} requestBody
1996
+ * @param {*} [options] Override http request option.
1997
+ * @throws {RequiredError}
1998
+ */
1999
+ updateConnectionLabel(appUuid, connectionId, requestBody, options) {
2000
+ return AppInstallationRuntimeApiFp(this.configuration).updateConnectionLabel(appUuid, connectionId, requestBody, options).then((request) => request(this.axios, this.basePath));
2001
+ }
1835
2002
  }
1836
2003
  /**
1837
2004
  * ApplicationsApi - axios parameter creator
@@ -8,6 +8,7 @@ All URIs are relative to *https://v2.api.caraer.com*
8
8
  |[**deleteStateKey**](#deletestatekey) | **DELETE** /api/v2/apps/{appUuid}/installation/state/{key} | Delete a state key|
9
9
  |[**enqueueJob**](#enqueuejob) | **POST** /api/v2/apps/{appUuid}/installation/jobs | Enqueue an async serverless function job|
10
10
  |[**getJob**](#getjob) | **GET** /api/v2/apps/{appUuid}/installation/jobs/{jobId} | Get async job status|
11
+ |[**getSettingContent**](#getsettingcontent) | **GET** /api/v2/apps/{appUuid}/installation/settings/{fieldName}/content | Load read-only Markdown content for a setting|
11
12
  |[**getState**](#getstate) | **GET** /api/v2/apps/{appUuid}/installation/state | Get installation state map|
12
13
  |[**getStateKey**](#getstatekey) | **GET** /api/v2/apps/{appUuid}/installation/state/{key} | Get a single state key|
13
14
  |[**listConnections**](#listconnections) | **GET** /api/v2/apps/{appUuid}/installation/connections | List external OAuth connection status|
@@ -21,6 +22,7 @@ All URIs are relative to *https://v2.api.caraer.com*
21
22
  |[**saveUserSettings**](#saveusersettings) | **PUT** /api/v2/apps/{appUuid}/installation/settings/user | Save USER-scoped installation settings for the current user|
22
23
  |[**startOAuth**](#startoauth) | **POST** /api/v2/apps/{appUuid}/installation/oauth/{provider}/start | Start external OAuth authorize (returns provider authorize URL)|
23
24
  |[**triggerSettingAction**](#triggersettingaction) | **POST** /api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger | Trigger an ACTION setting without saving settings|
25
+ |[**updateConnectionLabel**](#updateconnectionlabel) | **PATCH** /api/v2/apps/{appUuid}/installation/connections/{connectionId} | Update an external OAuth connection display label|
24
26
 
25
27
  # **deleteSecret**
26
28
  > DeleteResponseVoid deleteSecret()
@@ -239,6 +241,63 @@ const { status, data } = await apiInstance.getJob(
239
241
  - **Accept**: application/json
240
242
 
241
243
 
244
+ ### HTTP response details
245
+ | Status code | Description | Response headers |
246
+ |-------------|-------------|------------------|
247
+ |**200** | OK | - |
248
+ |**401** | Authentication is required or the token is invalid. | - |
249
+ |**403** | The caller is missing a required role or scope. | - |
250
+ |**404** | The requested resource was not found. | - |
251
+ |**500** | An internal server error occurred. | - |
252
+
253
+ [[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)
254
+
255
+ # **getSettingContent**
256
+ > ShowResponseMapStringString getSettingContent()
257
+
258
+
259
+ ### Example
260
+
261
+ ```typescript
262
+ import {
263
+ AppInstallationRuntimeApi,
264
+ Configuration
265
+ } from '@caraer/client';
266
+
267
+ const configuration = new Configuration();
268
+ const apiInstance = new AppInstallationRuntimeApi(configuration);
269
+
270
+ let appUuid: string; // (default to undefined)
271
+ let fieldName: string; // (default to undefined)
272
+
273
+ const { status, data } = await apiInstance.getSettingContent(
274
+ appUuid,
275
+ fieldName
276
+ );
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ |Name | Type | Description | Notes|
282
+ |------------- | ------------- | ------------- | -------------|
283
+ | **appUuid** | [**string**] | | defaults to undefined|
284
+ | **fieldName** | [**string**] | | defaults to undefined|
285
+
286
+
287
+ ### Return type
288
+
289
+ **ShowResponseMapStringString**
290
+
291
+ ### Authorization
292
+
293
+ [bearerAuth](../README.md#bearerAuth)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: Not defined
298
+ - **Accept**: application/json
299
+
300
+
242
301
  ### HTTP response details
243
302
  | Status code | Description | Response headers |
244
303
  |-------------|-------------|------------------|
@@ -892,11 +951,13 @@ const apiInstance = new AppInstallationRuntimeApi(configuration);
892
951
  let appUuid: string; // (default to undefined)
893
952
  let provider: string; // (default to undefined)
894
953
  let redirectUri: string; // (optional) (default to undefined)
954
+ let connectionId: string; // (optional) (default to undefined)
895
955
 
896
956
  const { status, data } = await apiInstance.startOAuth(
897
957
  appUuid,
898
958
  provider,
899
- redirectUri
959
+ redirectUri,
960
+ connectionId
900
961
  );
901
962
  ```
902
963
 
@@ -907,6 +968,7 @@ const { status, data } = await apiInstance.startOAuth(
907
968
  | **appUuid** | [**string**] | | defaults to undefined|
908
969
  | **provider** | [**string**] | | defaults to undefined|
909
970
  | **redirectUri** | [**string**] | | (optional) defaults to undefined|
971
+ | **connectionId** | [**string**] | | (optional) defaults to undefined|
910
972
 
911
973
 
912
974
  ### Return type
@@ -983,7 +1045,8 @@ const { status, data } = await apiInstance.triggerSettingAction(
983
1045
  ### HTTP response details
984
1046
  | Status code | Description | Response headers |
985
1047
  |-------------|-------------|------------------|
986
- |**202** | Action started | - |
1048
+ |**200** | Action completed; data.result contains the function response | - |
1049
+ |**202** | Action queued | - |
987
1050
  |**400** | Bad Request | - |
988
1051
  |**404** | Not Found | - |
989
1052
  |**401** | Authentication is required or the token is invalid. | - |
@@ -992,3 +1055,63 @@ const { status, data } = await apiInstance.triggerSettingAction(
992
1055
 
993
1056
  [[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)
994
1057
 
1058
+ # **updateConnectionLabel**
1059
+ > SuccessResponseVoid updateConnectionLabel(requestBody)
1060
+
1061
+
1062
+ ### Example
1063
+
1064
+ ```typescript
1065
+ import {
1066
+ AppInstallationRuntimeApi,
1067
+ Configuration
1068
+ } from '@caraer/client';
1069
+
1070
+ const configuration = new Configuration();
1071
+ const apiInstance = new AppInstallationRuntimeApi(configuration);
1072
+
1073
+ let appUuid: string; // (default to undefined)
1074
+ let connectionId: string; // (default to undefined)
1075
+ let requestBody: { [key: string]: string; }; //
1076
+
1077
+ const { status, data } = await apiInstance.updateConnectionLabel(
1078
+ appUuid,
1079
+ connectionId,
1080
+ requestBody
1081
+ );
1082
+ ```
1083
+
1084
+ ### Parameters
1085
+
1086
+ |Name | Type | Description | Notes|
1087
+ |------------- | ------------- | ------------- | -------------|
1088
+ | **requestBody** | **{ [key: string]: string; }**| | |
1089
+ | **appUuid** | [**string**] | | defaults to undefined|
1090
+ | **connectionId** | [**string**] | | defaults to undefined|
1091
+
1092
+
1093
+ ### Return type
1094
+
1095
+ **SuccessResponseVoid**
1096
+
1097
+ ### Authorization
1098
+
1099
+ [bearerAuth](../README.md#bearerAuth)
1100
+
1101
+ ### HTTP request headers
1102
+
1103
+ - **Content-Type**: application/json
1104
+ - **Accept**: application/json
1105
+
1106
+
1107
+ ### HTTP response details
1108
+ | Status code | Description | Response headers |
1109
+ |-------------|-------------|------------------|
1110
+ |**200** | OK | - |
1111
+ |**401** | Authentication is required or the token is invalid. | - |
1112
+ |**403** | The caller is missing a required role or scope. | - |
1113
+ |**404** | The requested resource was not found. | - |
1114
+ |**500** | An internal server error occurred. | - |
1115
+
1116
+ [[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)
1117
+
@@ -0,0 +1,24 @@
1
+ # AppSettingContentSource
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | **string** | | [optional] [default to undefined]
9
+ **serverlessFunctionUuid** | **string** | | [optional] [default to undefined]
10
+ **serverlessFunctionName** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AppSettingContentSource } from '@caraer/client';
16
+
17
+ const instance: AppSettingContentSource = {
18
+ type,
19
+ serverlessFunctionUuid,
20
+ serverlessFunctionName,
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)
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
15
15
  **_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
16
16
  **optionsSource** | [**AppSettingOptionsSource**](AppSettingOptionsSource.md) | | [optional] [default to undefined]
17
17
  **actionSource** | [**AppSettingActionSource**](AppSettingActionSource.md) | | [optional] [default to undefined]
18
+ **contentSource** | [**AppSettingContentSource**](AppSettingContentSource.md) | | [optional] [default to undefined]
19
+ **refreshIntervalSeconds** | **number** | | [optional] [default to undefined]
18
20
  **defaultValue** | **any** | | [optional] [default to undefined]
19
21
  **hidden** | **boolean** | | [optional] [default to undefined]
20
22
  **advanced** | **boolean** | | [optional] [default to undefined]
@@ -31,8 +33,8 @@ Name | Type | Description | Notes
31
33
  **clearValue** | **boolean** | | [optional] [default to undefined]
32
34
  **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
33
35
  **valueScope** | **string** | | [optional] [default to undefined]
34
- **action** | **boolean** | | [optional] [default to undefined]
35
36
  **settingsGroup** | **boolean** | | [optional] [default to undefined]
37
+ **action** | **boolean** | | [optional] [default to undefined]
36
38
  **filterPropertyTypes** | **Array<string>** | | [optional] [default to undefined]
37
39
  **filterPropertyFormats** | **Array<string>** | | [optional] [default to undefined]
38
40
 
@@ -52,6 +54,8 @@ const instance: AppSettingFieldSchema = {
52
54
  _options,
53
55
  optionsSource,
54
56
  actionSource,
57
+ contentSource,
58
+ refreshIntervalSeconds,
55
59
  defaultValue,
56
60
  hidden,
57
61
  advanced,
@@ -68,8 +72,8 @@ const instance: AppSettingFieldSchema = {
68
72
  clearValue,
69
73
  mappingValue,
70
74
  valueScope,
71
- action,
72
75
  settingsGroup,
76
+ action,
73
77
  filterPropertyTypes,
74
78
  filterPropertyFormats,
75
79
  };
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **ymetric** | **string** | | [optional] [default to undefined]
9
- **yproperty** | **string** | | [optional] [default to undefined]
10
8
  **xproperty** | **string** | | [optional] [default to undefined]
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]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
20
20
  import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
- ymetric,
24
- yproperty,
25
23
  xproperty,
24
+ yproperty,
25
+ ymetric,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
@@ -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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.601",
3
+ "version": "2.0.603",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {