@caraer/client 2.0.602 → 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.
@@ -42,6 +42,7 @@ docs/AppRequest.md
42
42
  docs/AppScheduleDTO.md
43
43
  docs/AppSettingActionSource.md
44
44
  docs/AppSettingCondition.md
45
+ docs/AppSettingContentSource.md
45
46
  docs/AppSettingFieldMappingStructure.md
46
47
  docs/AppSettingFieldMappingStructureItem.md
47
48
  docs/AppSettingFieldSchema.md
package/api.ts CHANGED
@@ -950,6 +950,11 @@ export interface AppSettingCondition {
950
950
  'operator'?: string;
951
951
  'value'?: any;
952
952
  }
953
+ export interface AppSettingContentSource {
954
+ 'type'?: string;
955
+ 'serverlessFunctionUuid'?: string;
956
+ 'serverlessFunctionName'?: string;
957
+ }
953
958
  export interface AppSettingFieldMappingStructure {
954
959
  'objectName'?: string;
955
960
  'targetKind'?: string;
@@ -982,6 +987,8 @@ export interface AppSettingFieldSchema {
982
987
  'options'?: Array<SettingOption>;
983
988
  'optionsSource'?: AppSettingOptionsSource;
984
989
  'actionSource'?: AppSettingActionSource;
990
+ 'contentSource'?: AppSettingContentSource;
991
+ 'refreshIntervalSeconds'?: number;
985
992
  'defaultValue'?: any;
986
993
  'hidden'?: boolean;
987
994
  'advanced'?: boolean;
@@ -998,8 +1005,8 @@ export interface AppSettingFieldSchema {
998
1005
  'clearValue'?: boolean;
999
1006
  'mappingValue'?: AppSettingFieldMappingStructure;
1000
1007
  'valueScope'?: string;
1001
- 'action'?: boolean;
1002
1008
  'settingsGroup'?: boolean;
1009
+ 'action'?: boolean;
1003
1010
  'filterPropertyTypes'?: Array<string>;
1004
1011
  'filterPropertyFormats'?: Array<string>;
1005
1012
  }
@@ -2772,9 +2779,9 @@ export const EventRsvpRequestScopeEnum = {
2772
2779
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2773
2780
 
2774
2781
  export interface ExistingWidgetSummary {
2775
- 'ymetric'?: string;
2776
2782
  'xproperty'?: string;
2777
2783
  'yproperty'?: string;
2784
+ 'ymetric'?: string;
2778
2785
  'title'?: string;
2779
2786
  'chartType'?: string;
2780
2787
  'xProperty'?: string;
@@ -8999,6 +9006,48 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
8999
9006
  options: localVarRequestOptions,
9000
9007
  };
9001
9008
  },
9009
+ /**
9010
+ *
9011
+ * @summary Load read-only Markdown content for a setting
9012
+ * @param {string} appUuid
9013
+ * @param {string} fieldName
9014
+ * @param {*} [options] Override http request option.
9015
+ * @throws {RequiredError}
9016
+ */
9017
+ getSettingContent: async (appUuid: string, fieldName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9018
+ // verify required parameter 'appUuid' is not null or undefined
9019
+ assertParamExists('getSettingContent', 'appUuid', appUuid)
9020
+ // verify required parameter 'fieldName' is not null or undefined
9021
+ assertParamExists('getSettingContent', 'fieldName', fieldName)
9022
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/content`
9023
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
9024
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
9025
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9026
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9027
+ let baseOptions;
9028
+ if (configuration) {
9029
+ baseOptions = configuration.baseOptions;
9030
+ }
9031
+
9032
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9033
+ const localVarHeaderParameter = {} as any;
9034
+ const localVarQueryParameter = {} as any;
9035
+
9036
+ // authentication bearerAuth required
9037
+ // http bearer authentication required
9038
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9039
+
9040
+ localVarHeaderParameter['Accept'] = 'application/json';
9041
+
9042
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9043
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9044
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9045
+
9046
+ return {
9047
+ url: toPathString(localVarUrlObj),
9048
+ options: localVarRequestOptions,
9049
+ };
9050
+ },
9002
9051
  /**
9003
9052
  *
9004
9053
  * @summary Get installation state map
@@ -9669,6 +9718,20 @@ export const AppInstallationRuntimeApiFp = function(configuration?: Configuratio
9669
9718
  const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.getJob']?.[localVarOperationServerIndex]?.url;
9670
9719
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9671
9720
  },
9721
+ /**
9722
+ *
9723
+ * @summary Load read-only Markdown content for a setting
9724
+ * @param {string} appUuid
9725
+ * @param {string} fieldName
9726
+ * @param {*} [options] Override http request option.
9727
+ * @throws {RequiredError}
9728
+ */
9729
+ async getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>> {
9730
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingContent(appUuid, fieldName, options);
9731
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9732
+ const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.getSettingContent']?.[localVarOperationServerIndex]?.url;
9733
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9734
+ },
9672
9735
  /**
9673
9736
  *
9674
9737
  * @summary Get installation state map
@@ -9920,6 +9983,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration?: Config
9920
9983
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
9921
9984
  return localVarFp.getJob(appUuid, jobId, options).then((request) => request(axios, basePath));
9922
9985
  },
9986
+ /**
9987
+ *
9988
+ * @summary Load read-only Markdown content for a setting
9989
+ * @param {string} appUuid
9990
+ * @param {string} fieldName
9991
+ * @param {*} [options] Override http request option.
9992
+ * @throws {RequiredError}
9993
+ */
9994
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString> {
9995
+ return localVarFp.getSettingContent(appUuid, fieldName, options).then((request) => request(axios, basePath));
9996
+ },
9923
9997
  /**
9924
9998
  *
9925
9999
  * @summary Get installation state map
@@ -10131,6 +10205,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
10131
10205
  return AppInstallationRuntimeApiFp(this.configuration).getJob(appUuid, jobId, options).then((request) => request(this.axios, this.basePath));
10132
10206
  }
10133
10207
 
10208
+ /**
10209
+ *
10210
+ * @summary Load read-only Markdown content for a setting
10211
+ * @param {string} appUuid
10212
+ * @param {string} fieldName
10213
+ * @param {*} [options] Override http request option.
10214
+ * @throws {RequiredError}
10215
+ */
10216
+ public getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) {
10217
+ return AppInstallationRuntimeApiFp(this.configuration).getSettingContent(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
10218
+ }
10219
+
10134
10220
  /**
10135
10221
  *
10136
10222
  * @summary Get installation state map
package/dist/api.d.ts CHANGED
@@ -940,6 +940,11 @@ export interface AppSettingCondition {
940
940
  'operator'?: string;
941
941
  'value'?: any;
942
942
  }
943
+ export interface AppSettingContentSource {
944
+ 'type'?: string;
945
+ 'serverlessFunctionUuid'?: string;
946
+ 'serverlessFunctionName'?: string;
947
+ }
943
948
  export interface AppSettingFieldMappingStructure {
944
949
  'objectName'?: string;
945
950
  'targetKind'?: string;
@@ -972,6 +977,8 @@ export interface AppSettingFieldSchema {
972
977
  'options'?: Array<SettingOption>;
973
978
  'optionsSource'?: AppSettingOptionsSource;
974
979
  'actionSource'?: AppSettingActionSource;
980
+ 'contentSource'?: AppSettingContentSource;
981
+ 'refreshIntervalSeconds'?: number;
975
982
  'defaultValue'?: any;
976
983
  'hidden'?: boolean;
977
984
  'advanced'?: boolean;
@@ -988,8 +995,8 @@ export interface AppSettingFieldSchema {
988
995
  'clearValue'?: boolean;
989
996
  'mappingValue'?: AppSettingFieldMappingStructure;
990
997
  'valueScope'?: string;
991
- 'action'?: boolean;
992
998
  'settingsGroup'?: boolean;
999
+ 'action'?: boolean;
993
1000
  'filterPropertyTypes'?: Array<string>;
994
1001
  'filterPropertyFormats'?: Array<string>;
995
1002
  }
@@ -2765,9 +2772,9 @@ export declare const EventRsvpRequestScopeEnum: {
2765
2772
  };
2766
2773
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2767
2774
  export interface ExistingWidgetSummary {
2768
- 'ymetric'?: string;
2769
2775
  'xproperty'?: string;
2770
2776
  'yproperty'?: string;
2777
+ 'ymetric'?: string;
2771
2778
  'title'?: string;
2772
2779
  'chartType'?: string;
2773
2780
  'xProperty'?: string;
@@ -8784,6 +8791,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
8784
8791
  * @throws {RequiredError}
8785
8792
  */
8786
8793
  getJob: (appUuid: string, jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8794
+ /**
8795
+ *
8796
+ * @summary Load read-only Markdown content for a setting
8797
+ * @param {string} appUuid
8798
+ * @param {string} fieldName
8799
+ * @param {*} [options] Override http request option.
8800
+ * @throws {RequiredError}
8801
+ */
8802
+ getSettingContent: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8787
8803
  /**
8788
8804
  *
8789
8805
  * @summary Get installation state map
@@ -8963,6 +8979,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
8963
8979
  * @throws {RequiredError}
8964
8980
  */
8965
8981
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
8982
+ /**
8983
+ *
8984
+ * @summary Load read-only Markdown content for a setting
8985
+ * @param {string} appUuid
8986
+ * @param {string} fieldName
8987
+ * @param {*} [options] Override http request option.
8988
+ * @throws {RequiredError}
8989
+ */
8990
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
8966
8991
  /**
8967
8992
  *
8968
8993
  * @summary Get installation state map
@@ -9142,6 +9167,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
9142
9167
  * @throws {RequiredError}
9143
9168
  */
9144
9169
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
9170
+ /**
9171
+ *
9172
+ * @summary Load read-only Markdown content for a setting
9173
+ * @param {string} appUuid
9174
+ * @param {string} fieldName
9175
+ * @param {*} [options] Override http request option.
9176
+ * @throws {RequiredError}
9177
+ */
9178
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
9145
9179
  /**
9146
9180
  *
9147
9181
  * @summary Get installation state map
@@ -9321,6 +9355,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
9321
9355
  * @throws {RequiredError}
9322
9356
  */
9323
9357
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
9358
+ /**
9359
+ *
9360
+ * @summary Load read-only Markdown content for a setting
9361
+ * @param {string} appUuid
9362
+ * @param {string} fieldName
9363
+ * @param {*} [options] Override http request option.
9364
+ * @throws {RequiredError}
9365
+ */
9366
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
9324
9367
  /**
9325
9368
  *
9326
9369
  * @summary Get installation state map
package/dist/api.js CHANGED
@@ -674,6 +674,43 @@ const AppInstallationRuntimeApiAxiosParamCreator = function (configuration) {
674
674
  options: localVarRequestOptions,
675
675
  };
676
676
  }),
677
+ /**
678
+ *
679
+ * @summary Load read-only Markdown content for a setting
680
+ * @param {string} appUuid
681
+ * @param {string} fieldName
682
+ * @param {*} [options] Override http request option.
683
+ * @throws {RequiredError}
684
+ */
685
+ getSettingContent: (appUuid_1, fieldName_1, ...args_1) => __awaiter(this, [appUuid_1, fieldName_1, ...args_1], void 0, function* (appUuid, fieldName, options = {}) {
686
+ // verify required parameter 'appUuid' is not null or undefined
687
+ (0, common_1.assertParamExists)('getSettingContent', 'appUuid', appUuid);
688
+ // verify required parameter 'fieldName' is not null or undefined
689
+ (0, common_1.assertParamExists)('getSettingContent', 'fieldName', fieldName);
690
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/content`
691
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
692
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
693
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
694
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
695
+ let baseOptions;
696
+ if (configuration) {
697
+ baseOptions = configuration.baseOptions;
698
+ }
699
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
700
+ const localVarHeaderParameter = {};
701
+ const localVarQueryParameter = {};
702
+ // authentication bearerAuth required
703
+ // http bearer authentication required
704
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
705
+ localVarHeaderParameter['Accept'] = 'application/json';
706
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
707
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
708
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
709
+ return {
710
+ url: (0, common_1.toPathString)(localVarUrlObj),
711
+ options: localVarRequestOptions,
712
+ };
713
+ }),
677
714
  /**
678
715
  *
679
716
  * @summary Get installation state map
@@ -1284,6 +1321,23 @@ const AppInstallationRuntimeApiFp = function (configuration) {
1284
1321
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1285
1322
  });
1286
1323
  },
1324
+ /**
1325
+ *
1326
+ * @summary Load read-only Markdown content for a setting
1327
+ * @param {string} appUuid
1328
+ * @param {string} fieldName
1329
+ * @param {*} [options] Override http request option.
1330
+ * @throws {RequiredError}
1331
+ */
1332
+ getSettingContent(appUuid, fieldName, options) {
1333
+ return __awaiter(this, void 0, void 0, function* () {
1334
+ var _a, _b, _c;
1335
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettingContent(appUuid, fieldName, options);
1336
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1337
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AppInstallationRuntimeApi.getSettingContent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1338
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1339
+ });
1340
+ },
1287
1341
  /**
1288
1342
  *
1289
1343
  * @summary Get installation state map
@@ -1577,6 +1631,17 @@ const AppInstallationRuntimeApiFactory = function (configuration, basePath, axio
1577
1631
  getJob(appUuid, jobId, options) {
1578
1632
  return localVarFp.getJob(appUuid, jobId, options).then((request) => request(axios, basePath));
1579
1633
  },
1634
+ /**
1635
+ *
1636
+ * @summary Load read-only Markdown content for a setting
1637
+ * @param {string} appUuid
1638
+ * @param {string} fieldName
1639
+ * @param {*} [options] Override http request option.
1640
+ * @throws {RequiredError}
1641
+ */
1642
+ getSettingContent(appUuid, fieldName, options) {
1643
+ return localVarFp.getSettingContent(appUuid, fieldName, options).then((request) => request(axios, basePath));
1644
+ },
1580
1645
  /**
1581
1646
  *
1582
1647
  * @summary Get installation state map
@@ -1784,6 +1849,17 @@ class AppInstallationRuntimeApi extends base_1.BaseAPI {
1784
1849
  getJob(appUuid, jobId, options) {
1785
1850
  return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).getJob(appUuid, jobId, options).then((request) => request(this.axios, this.basePath));
1786
1851
  }
1852
+ /**
1853
+ *
1854
+ * @summary Load read-only Markdown content for a setting
1855
+ * @param {string} appUuid
1856
+ * @param {string} fieldName
1857
+ * @param {*} [options] Override http request option.
1858
+ * @throws {RequiredError}
1859
+ */
1860
+ getSettingContent(appUuid, fieldName, options) {
1861
+ return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).getSettingContent(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
1862
+ }
1787
1863
  /**
1788
1864
  *
1789
1865
  * @summary Get installation state map
package/dist/esm/api.d.ts CHANGED
@@ -940,6 +940,11 @@ export interface AppSettingCondition {
940
940
  'operator'?: string;
941
941
  'value'?: any;
942
942
  }
943
+ export interface AppSettingContentSource {
944
+ 'type'?: string;
945
+ 'serverlessFunctionUuid'?: string;
946
+ 'serverlessFunctionName'?: string;
947
+ }
943
948
  export interface AppSettingFieldMappingStructure {
944
949
  'objectName'?: string;
945
950
  'targetKind'?: string;
@@ -972,6 +977,8 @@ export interface AppSettingFieldSchema {
972
977
  'options'?: Array<SettingOption>;
973
978
  'optionsSource'?: AppSettingOptionsSource;
974
979
  'actionSource'?: AppSettingActionSource;
980
+ 'contentSource'?: AppSettingContentSource;
981
+ 'refreshIntervalSeconds'?: number;
975
982
  'defaultValue'?: any;
976
983
  'hidden'?: boolean;
977
984
  'advanced'?: boolean;
@@ -988,8 +995,8 @@ export interface AppSettingFieldSchema {
988
995
  'clearValue'?: boolean;
989
996
  'mappingValue'?: AppSettingFieldMappingStructure;
990
997
  'valueScope'?: string;
991
- 'action'?: boolean;
992
998
  'settingsGroup'?: boolean;
999
+ 'action'?: boolean;
993
1000
  'filterPropertyTypes'?: Array<string>;
994
1001
  'filterPropertyFormats'?: Array<string>;
995
1002
  }
@@ -2765,9 +2772,9 @@ export declare const EventRsvpRequestScopeEnum: {
2765
2772
  };
2766
2773
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2767
2774
  export interface ExistingWidgetSummary {
2768
- 'ymetric'?: string;
2769
2775
  'xproperty'?: string;
2770
2776
  'yproperty'?: string;
2777
+ 'ymetric'?: string;
2771
2778
  'title'?: string;
2772
2779
  'chartType'?: string;
2773
2780
  'xProperty'?: string;
@@ -8784,6 +8791,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
8784
8791
  * @throws {RequiredError}
8785
8792
  */
8786
8793
  getJob: (appUuid: string, jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8794
+ /**
8795
+ *
8796
+ * @summary Load read-only Markdown content for a setting
8797
+ * @param {string} appUuid
8798
+ * @param {string} fieldName
8799
+ * @param {*} [options] Override http request option.
8800
+ * @throws {RequiredError}
8801
+ */
8802
+ getSettingContent: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8787
8803
  /**
8788
8804
  *
8789
8805
  * @summary Get installation state map
@@ -8963,6 +8979,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
8963
8979
  * @throws {RequiredError}
8964
8980
  */
8965
8981
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
8982
+ /**
8983
+ *
8984
+ * @summary Load read-only Markdown content for a setting
8985
+ * @param {string} appUuid
8986
+ * @param {string} fieldName
8987
+ * @param {*} [options] Override http request option.
8988
+ * @throws {RequiredError}
8989
+ */
8990
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
8966
8991
  /**
8967
8992
  *
8968
8993
  * @summary Get installation state map
@@ -9142,6 +9167,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
9142
9167
  * @throws {RequiredError}
9143
9168
  */
9144
9169
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
9170
+ /**
9171
+ *
9172
+ * @summary Load read-only Markdown content for a setting
9173
+ * @param {string} appUuid
9174
+ * @param {string} fieldName
9175
+ * @param {*} [options] Override http request option.
9176
+ * @throws {RequiredError}
9177
+ */
9178
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
9145
9179
  /**
9146
9180
  *
9147
9181
  * @summary Get installation state map
@@ -9321,6 +9355,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
9321
9355
  * @throws {RequiredError}
9322
9356
  */
9323
9357
  getJob(appUuid: string, jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
9358
+ /**
9359
+ *
9360
+ * @summary Load read-only Markdown content for a setting
9361
+ * @param {string} appUuid
9362
+ * @param {string} fieldName
9363
+ * @param {*} [options] Override http request option.
9364
+ * @throws {RequiredError}
9365
+ */
9366
+ getSettingContent(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
9324
9367
  /**
9325
9368
  *
9326
9369
  * @summary Get installation state map
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
@@ -1269,6 +1306,23 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1269
1306
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1270
1307
  });
1271
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
+ },
1272
1326
  /**
1273
1327
  *
1274
1328
  * @summary Get installation state map
@@ -1561,6 +1615,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1561
1615
  getJob(appUuid, jobId, options) {
1562
1616
  return localVarFp.getJob(appUuid, jobId, options).then((request) => request(axios, basePath));
1563
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
+ },
1564
1629
  /**
1565
1630
  *
1566
1631
  * @summary Get installation state map
@@ -1767,6 +1832,17 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1767
1832
  getJob(appUuid, jobId, options) {
1768
1833
  return AppInstallationRuntimeApiFp(this.configuration).getJob(appUuid, jobId, options).then((request) => request(this.axios, this.basePath));
1769
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
+ }
1770
1846
  /**
1771
1847
  *
1772
1848
  * @summary Get installation state map
@@ -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|
@@ -240,6 +241,63 @@ const { status, data } = await apiInstance.getJob(
240
241
  - **Accept**: application/json
241
242
 
242
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
+
243
301
  ### HTTP response details
244
302
  | Status code | Description | Response headers |
245
303
  |-------------|-------------|------------------|
@@ -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&lt;SettingOption&gt;**](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&lt;string&gt;** | | [optional] [default to undefined]
37
39
  **filterPropertyFormats** | **Array&lt;string&gt;** | | [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
8
  **xproperty** | **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]
@@ -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
23
  xproperty,
25
24
  yproperty,
25
+ ymetric,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.602",
3
+ "version": "2.0.603",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {