@caraer/client 2.0.454 → 2.0.455

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.
@@ -40,6 +40,7 @@ docs/AppOAuthStartResponseDTO.md
40
40
  docs/AppPublishDTO.md
41
41
  docs/AppRequest.md
42
42
  docs/AppScheduleDTO.md
43
+ docs/AppSettingActionSource.md
43
44
  docs/AppSettingCondition.md
44
45
  docs/AppSettingFieldMappingStructure.md
45
46
  docs/AppSettingFieldMappingStructureItem.md
package/api.ts CHANGED
@@ -938,6 +938,12 @@ export interface AppScheduleDTO {
938
938
  'payloadTemplate'?: string;
939
939
  'serverlessFunction'?: ServerlessFunctionRefDTO;
940
940
  }
941
+ export interface AppSettingActionSource {
942
+ 'type'?: string;
943
+ 'serverlessFunctionUuid'?: string;
944
+ 'serverlessFunctionName'?: string;
945
+ 'enqueue'?: boolean;
946
+ }
941
947
  export interface AppSettingCondition {
942
948
  'field'?: string;
943
949
  'operator'?: string;
@@ -964,6 +970,7 @@ export interface AppSettingFieldSchema {
964
970
  'helpText'?: string;
965
971
  'options'?: Array<SettingOption>;
966
972
  'optionsSource'?: AppSettingOptionsSource;
973
+ 'actionSource'?: AppSettingActionSource;
967
974
  'defaultValue'?: any;
968
975
  'hidden'?: boolean;
969
976
  'visibleWhen'?: Array<AppSettingCondition>;
@@ -971,6 +978,7 @@ export interface AppSettingFieldSchema {
971
978
  'hasValue'?: boolean;
972
979
  'mappingValue'?: AppSettingFieldMappingStructure;
973
980
  'valueScope'?: string;
981
+ 'action'?: boolean;
974
982
  }
975
983
  export interface AppSettingOptionsSource {
976
984
  'type'?: string;
@@ -5161,8 +5169,8 @@ export interface SettingField {
5161
5169
  'hidden'?: boolean;
5162
5170
  'disabled'?: boolean;
5163
5171
  'options'?: Array<SettingOption>;
5164
- 'defaultValue'?: any;
5165
5172
  'value'?: any;
5173
+ 'defaultValue'?: any;
5166
5174
  }
5167
5175
 
5168
5176
  export const SettingFieldTypeEnum = {
@@ -8451,6 +8459,48 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
8451
8459
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8452
8460
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
8453
8461
 
8462
+ return {
8463
+ url: toPathString(localVarUrlObj),
8464
+ options: localVarRequestOptions,
8465
+ };
8466
+ },
8467
+ /**
8468
+ *
8469
+ * @summary Trigger an ACTION setting without saving settings
8470
+ * @param {string} appUuid
8471
+ * @param {string} fieldName
8472
+ * @param {*} [options] Override http request option.
8473
+ * @throws {RequiredError}
8474
+ */
8475
+ triggerSettingAction: async (appUuid: string, fieldName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8476
+ // verify required parameter 'appUuid' is not null or undefined
8477
+ assertParamExists('triggerSettingAction', 'appUuid', appUuid)
8478
+ // verify required parameter 'fieldName' is not null or undefined
8479
+ assertParamExists('triggerSettingAction', 'fieldName', fieldName)
8480
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger`
8481
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
8482
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
8483
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8484
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8485
+ let baseOptions;
8486
+ if (configuration) {
8487
+ baseOptions = configuration.baseOptions;
8488
+ }
8489
+
8490
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
8491
+ const localVarHeaderParameter = {} as any;
8492
+ const localVarQueryParameter = {} as any;
8493
+
8494
+ // authentication bearerAuth required
8495
+ // http bearer authentication required
8496
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
8497
+
8498
+ localVarHeaderParameter['Accept'] = 'application/json';
8499
+
8500
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8501
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8502
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
8503
+
8454
8504
  return {
8455
8505
  url: toPathString(localVarUrlObj),
8456
8506
  options: localVarRequestOptions,
@@ -8675,6 +8725,20 @@ export const AppInstallationRuntimeApiFp = function(configuration?: Configuratio
8675
8725
  const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.startOAuth']?.[localVarOperationServerIndex]?.url;
8676
8726
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8677
8727
  },
8728
+ /**
8729
+ *
8730
+ * @summary Trigger an ACTION setting without saving settings
8731
+ * @param {string} appUuid
8732
+ * @param {string} fieldName
8733
+ * @param {*} [options] Override http request option.
8734
+ * @throws {RequiredError}
8735
+ */
8736
+ async triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
8737
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerSettingAction(appUuid, fieldName, options);
8738
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8739
+ const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.triggerSettingAction']?.[localVarOperationServerIndex]?.url;
8740
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8741
+ },
8678
8742
  }
8679
8743
  };
8680
8744
 
@@ -8849,6 +8913,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration?: Config
8849
8913
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppOAuthStartResponseDTO> {
8850
8914
  return localVarFp.startOAuth(appUuid, provider, redirectUri, options).then((request) => request(axios, basePath));
8851
8915
  },
8916
+ /**
8917
+ *
8918
+ * @summary Trigger an ACTION setting without saving settings
8919
+ * @param {string} appUuid
8920
+ * @param {string} fieldName
8921
+ * @param {*} [options] Override http request option.
8922
+ * @throws {RequiredError}
8923
+ */
8924
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
8925
+ return localVarFp.triggerSettingAction(appUuid, fieldName, options).then((request) => request(axios, basePath));
8926
+ },
8852
8927
  };
8853
8928
  };
8854
8929
 
@@ -9035,6 +9110,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
9035
9110
  public startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) {
9036
9111
  return AppInstallationRuntimeApiFp(this.configuration).startOAuth(appUuid, provider, redirectUri, options).then((request) => request(this.axios, this.basePath));
9037
9112
  }
9113
+
9114
+ /**
9115
+ *
9116
+ * @summary Trigger an ACTION setting without saving settings
9117
+ * @param {string} appUuid
9118
+ * @param {string} fieldName
9119
+ * @param {*} [options] Override http request option.
9120
+ * @throws {RequiredError}
9121
+ */
9122
+ public triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) {
9123
+ return AppInstallationRuntimeApiFp(this.configuration).triggerSettingAction(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
9124
+ }
9038
9125
  }
9039
9126
 
9040
9127
 
package/dist/api.d.ts CHANGED
@@ -928,6 +928,12 @@ export interface AppScheduleDTO {
928
928
  'payloadTemplate'?: string;
929
929
  'serverlessFunction'?: ServerlessFunctionRefDTO;
930
930
  }
931
+ export interface AppSettingActionSource {
932
+ 'type'?: string;
933
+ 'serverlessFunctionUuid'?: string;
934
+ 'serverlessFunctionName'?: string;
935
+ 'enqueue'?: boolean;
936
+ }
931
937
  export interface AppSettingCondition {
932
938
  'field'?: string;
933
939
  'operator'?: string;
@@ -954,6 +960,7 @@ export interface AppSettingFieldSchema {
954
960
  'helpText'?: string;
955
961
  'options'?: Array<SettingOption>;
956
962
  'optionsSource'?: AppSettingOptionsSource;
963
+ 'actionSource'?: AppSettingActionSource;
957
964
  'defaultValue'?: any;
958
965
  'hidden'?: boolean;
959
966
  'visibleWhen'?: Array<AppSettingCondition>;
@@ -961,6 +968,7 @@ export interface AppSettingFieldSchema {
961
968
  'hasValue'?: boolean;
962
969
  'mappingValue'?: AppSettingFieldMappingStructure;
963
970
  'valueScope'?: string;
971
+ 'action'?: boolean;
964
972
  }
965
973
  export interface AppSettingOptionsSource {
966
974
  'type'?: string;
@@ -5191,8 +5199,8 @@ export interface SettingField {
5191
5199
  'hidden'?: boolean;
5192
5200
  'disabled'?: boolean;
5193
5201
  'options'?: Array<SettingOption>;
5194
- 'defaultValue'?: any;
5195
5202
  'value'?: any;
5203
+ 'defaultValue'?: any;
5196
5204
  }
5197
5205
  export declare const SettingFieldTypeEnum: {
5198
5206
  readonly String: "STRING";
@@ -7859,6 +7867,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
7859
7867
  * @throws {RequiredError}
7860
7868
  */
7861
7869
  startOAuth: (appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7870
+ /**
7871
+ *
7872
+ * @summary Trigger an ACTION setting without saving settings
7873
+ * @param {string} appUuid
7874
+ * @param {string} fieldName
7875
+ * @param {*} [options] Override http request option.
7876
+ * @throws {RequiredError}
7877
+ */
7878
+ triggerSettingAction: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7862
7879
  };
7863
7880
  /**
7864
7881
  * AppInstallationRuntimeApi - functional programming interface
@@ -8005,6 +8022,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
8005
8022
  * @throws {RequiredError}
8006
8023
  */
8007
8024
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppOAuthStartResponseDTO>>;
8025
+ /**
8026
+ *
8027
+ * @summary Trigger an ACTION setting without saving settings
8028
+ * @param {string} appUuid
8029
+ * @param {string} fieldName
8030
+ * @param {*} [options] Override http request option.
8031
+ * @throws {RequiredError}
8032
+ */
8033
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
8008
8034
  };
8009
8035
  /**
8010
8036
  * AppInstallationRuntimeApi - factory interface
@@ -8151,6 +8177,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
8151
8177
  * @throws {RequiredError}
8152
8178
  */
8153
8179
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppOAuthStartResponseDTO>;
8180
+ /**
8181
+ *
8182
+ * @summary Trigger an ACTION setting without saving settings
8183
+ * @param {string} appUuid
8184
+ * @param {string} fieldName
8185
+ * @param {*} [options] Override http request option.
8186
+ * @throws {RequiredError}
8187
+ */
8188
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
8154
8189
  };
8155
8190
  /**
8156
8191
  * AppInstallationRuntimeApi - object-oriented interface
@@ -8297,6 +8332,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
8297
8332
  * @throws {RequiredError}
8298
8333
  */
8299
8334
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppOAuthStartResponseDTO, any, {}>>;
8335
+ /**
8336
+ *
8337
+ * @summary Trigger an ACTION setting without saving settings
8338
+ * @param {string} appUuid
8339
+ * @param {string} fieldName
8340
+ * @param {*} [options] Override http request option.
8341
+ * @throws {RequiredError}
8342
+ */
8343
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
8300
8344
  }
8301
8345
  /**
8302
8346
  * ApplicationsApi - axios parameter creator
package/dist/api.js CHANGED
@@ -1080,6 +1080,43 @@ const AppInstallationRuntimeApiAxiosParamCreator = function (configuration) {
1080
1080
  options: localVarRequestOptions,
1081
1081
  };
1082
1082
  }),
1083
+ /**
1084
+ *
1085
+ * @summary Trigger an ACTION setting without saving settings
1086
+ * @param {string} appUuid
1087
+ * @param {string} fieldName
1088
+ * @param {*} [options] Override http request option.
1089
+ * @throws {RequiredError}
1090
+ */
1091
+ triggerSettingAction: (appUuid_1, fieldName_1, ...args_1) => __awaiter(this, [appUuid_1, fieldName_1, ...args_1], void 0, function* (appUuid, fieldName, options = {}) {
1092
+ // verify required parameter 'appUuid' is not null or undefined
1093
+ (0, common_1.assertParamExists)('triggerSettingAction', 'appUuid', appUuid);
1094
+ // verify required parameter 'fieldName' is not null or undefined
1095
+ (0, common_1.assertParamExists)('triggerSettingAction', 'fieldName', fieldName);
1096
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger`
1097
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
1098
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
1099
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1100
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1101
+ let baseOptions;
1102
+ if (configuration) {
1103
+ baseOptions = configuration.baseOptions;
1104
+ }
1105
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1106
+ const localVarHeaderParameter = {};
1107
+ const localVarQueryParameter = {};
1108
+ // authentication bearerAuth required
1109
+ // http bearer authentication required
1110
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
1111
+ localVarHeaderParameter['Accept'] = 'application/json';
1112
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1113
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1114
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1115
+ return {
1116
+ url: (0, common_1.toPathString)(localVarUrlObj),
1117
+ options: localVarRequestOptions,
1118
+ };
1119
+ }),
1083
1120
  };
1084
1121
  };
1085
1122
  exports.AppInstallationRuntimeApiAxiosParamCreator = AppInstallationRuntimeApiAxiosParamCreator;
@@ -1344,6 +1381,23 @@ const AppInstallationRuntimeApiFp = function (configuration) {
1344
1381
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1345
1382
  });
1346
1383
  },
1384
+ /**
1385
+ *
1386
+ * @summary Trigger an ACTION setting without saving settings
1387
+ * @param {string} appUuid
1388
+ * @param {string} fieldName
1389
+ * @param {*} [options] Override http request option.
1390
+ * @throws {RequiredError}
1391
+ */
1392
+ triggerSettingAction(appUuid, fieldName, options) {
1393
+ return __awaiter(this, void 0, void 0, function* () {
1394
+ var _a, _b, _c;
1395
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.triggerSettingAction(appUuid, fieldName, options);
1396
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1397
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AppInstallationRuntimeApi.triggerSettingAction']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1398
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1399
+ });
1400
+ },
1347
1401
  };
1348
1402
  };
1349
1403
  exports.AppInstallationRuntimeApiFp = AppInstallationRuntimeApiFp;
@@ -1518,6 +1572,17 @@ const AppInstallationRuntimeApiFactory = function (configuration, basePath, axio
1518
1572
  startOAuth(appUuid, provider, redirectUri, options) {
1519
1573
  return localVarFp.startOAuth(appUuid, provider, redirectUri, options).then((request) => request(axios, basePath));
1520
1574
  },
1575
+ /**
1576
+ *
1577
+ * @summary Trigger an ACTION setting without saving settings
1578
+ * @param {string} appUuid
1579
+ * @param {string} fieldName
1580
+ * @param {*} [options] Override http request option.
1581
+ * @throws {RequiredError}
1582
+ */
1583
+ triggerSettingAction(appUuid, fieldName, options) {
1584
+ return localVarFp.triggerSettingAction(appUuid, fieldName, options).then((request) => request(axios, basePath));
1585
+ },
1521
1586
  };
1522
1587
  };
1523
1588
  exports.AppInstallationRuntimeApiFactory = AppInstallationRuntimeApiFactory;
@@ -1690,6 +1755,17 @@ class AppInstallationRuntimeApi extends base_1.BaseAPI {
1690
1755
  startOAuth(appUuid, provider, redirectUri, options) {
1691
1756
  return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).startOAuth(appUuid, provider, redirectUri, options).then((request) => request(this.axios, this.basePath));
1692
1757
  }
1758
+ /**
1759
+ *
1760
+ * @summary Trigger an ACTION setting without saving settings
1761
+ * @param {string} appUuid
1762
+ * @param {string} fieldName
1763
+ * @param {*} [options] Override http request option.
1764
+ * @throws {RequiredError}
1765
+ */
1766
+ triggerSettingAction(appUuid, fieldName, options) {
1767
+ return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).triggerSettingAction(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
1768
+ }
1693
1769
  }
1694
1770
  exports.AppInstallationRuntimeApi = AppInstallationRuntimeApi;
1695
1771
  /**
package/dist/esm/api.d.ts CHANGED
@@ -928,6 +928,12 @@ export interface AppScheduleDTO {
928
928
  'payloadTemplate'?: string;
929
929
  'serverlessFunction'?: ServerlessFunctionRefDTO;
930
930
  }
931
+ export interface AppSettingActionSource {
932
+ 'type'?: string;
933
+ 'serverlessFunctionUuid'?: string;
934
+ 'serverlessFunctionName'?: string;
935
+ 'enqueue'?: boolean;
936
+ }
931
937
  export interface AppSettingCondition {
932
938
  'field'?: string;
933
939
  'operator'?: string;
@@ -954,6 +960,7 @@ export interface AppSettingFieldSchema {
954
960
  'helpText'?: string;
955
961
  'options'?: Array<SettingOption>;
956
962
  'optionsSource'?: AppSettingOptionsSource;
963
+ 'actionSource'?: AppSettingActionSource;
957
964
  'defaultValue'?: any;
958
965
  'hidden'?: boolean;
959
966
  'visibleWhen'?: Array<AppSettingCondition>;
@@ -961,6 +968,7 @@ export interface AppSettingFieldSchema {
961
968
  'hasValue'?: boolean;
962
969
  'mappingValue'?: AppSettingFieldMappingStructure;
963
970
  'valueScope'?: string;
971
+ 'action'?: boolean;
964
972
  }
965
973
  export interface AppSettingOptionsSource {
966
974
  'type'?: string;
@@ -5191,8 +5199,8 @@ export interface SettingField {
5191
5199
  'hidden'?: boolean;
5192
5200
  'disabled'?: boolean;
5193
5201
  'options'?: Array<SettingOption>;
5194
- 'defaultValue'?: any;
5195
5202
  'value'?: any;
5203
+ 'defaultValue'?: any;
5196
5204
  }
5197
5205
  export declare const SettingFieldTypeEnum: {
5198
5206
  readonly String: "STRING";
@@ -7859,6 +7867,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
7859
7867
  * @throws {RequiredError}
7860
7868
  */
7861
7869
  startOAuth: (appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7870
+ /**
7871
+ *
7872
+ * @summary Trigger an ACTION setting without saving settings
7873
+ * @param {string} appUuid
7874
+ * @param {string} fieldName
7875
+ * @param {*} [options] Override http request option.
7876
+ * @throws {RequiredError}
7877
+ */
7878
+ triggerSettingAction: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7862
7879
  };
7863
7880
  /**
7864
7881
  * AppInstallationRuntimeApi - functional programming interface
@@ -8005,6 +8022,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
8005
8022
  * @throws {RequiredError}
8006
8023
  */
8007
8024
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppOAuthStartResponseDTO>>;
8025
+ /**
8026
+ *
8027
+ * @summary Trigger an ACTION setting without saving settings
8028
+ * @param {string} appUuid
8029
+ * @param {string} fieldName
8030
+ * @param {*} [options] Override http request option.
8031
+ * @throws {RequiredError}
8032
+ */
8033
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
8008
8034
  };
8009
8035
  /**
8010
8036
  * AppInstallationRuntimeApi - factory interface
@@ -8151,6 +8177,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
8151
8177
  * @throws {RequiredError}
8152
8178
  */
8153
8179
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppOAuthStartResponseDTO>;
8180
+ /**
8181
+ *
8182
+ * @summary Trigger an ACTION setting without saving settings
8183
+ * @param {string} appUuid
8184
+ * @param {string} fieldName
8185
+ * @param {*} [options] Override http request option.
8186
+ * @throws {RequiredError}
8187
+ */
8188
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
8154
8189
  };
8155
8190
  /**
8156
8191
  * AppInstallationRuntimeApi - object-oriented interface
@@ -8297,6 +8332,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
8297
8332
  * @throws {RequiredError}
8298
8333
  */
8299
8334
  startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppOAuthStartResponseDTO, any, {}>>;
8335
+ /**
8336
+ *
8337
+ * @summary Trigger an ACTION setting without saving settings
8338
+ * @param {string} appUuid
8339
+ * @param {string} fieldName
8340
+ * @param {*} [options] Override http request option.
8341
+ * @throws {RequiredError}
8342
+ */
8343
+ triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
8300
8344
  }
8301
8345
  /**
8302
8346
  * ApplicationsApi - axios parameter creator
package/dist/esm/api.js CHANGED
@@ -1067,6 +1067,43 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
1067
1067
  options: localVarRequestOptions,
1068
1068
  };
1069
1069
  }),
1070
+ /**
1071
+ *
1072
+ * @summary Trigger an ACTION setting without saving settings
1073
+ * @param {string} appUuid
1074
+ * @param {string} fieldName
1075
+ * @param {*} [options] Override http request option.
1076
+ * @throws {RequiredError}
1077
+ */
1078
+ triggerSettingAction: (appUuid_1, fieldName_1, ...args_1) => __awaiter(this, [appUuid_1, fieldName_1, ...args_1], void 0, function* (appUuid, fieldName, options = {}) {
1079
+ // verify required parameter 'appUuid' is not null or undefined
1080
+ assertParamExists('triggerSettingAction', 'appUuid', appUuid);
1081
+ // verify required parameter 'fieldName' is not null or undefined
1082
+ assertParamExists('triggerSettingAction', 'fieldName', fieldName);
1083
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger`
1084
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)))
1085
+ .replace('{fieldName}', encodeURIComponent(String(fieldName)));
1086
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1087
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1088
+ let baseOptions;
1089
+ if (configuration) {
1090
+ baseOptions = configuration.baseOptions;
1091
+ }
1092
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1093
+ const localVarHeaderParameter = {};
1094
+ const localVarQueryParameter = {};
1095
+ // authentication bearerAuth required
1096
+ // http bearer authentication required
1097
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
1098
+ localVarHeaderParameter['Accept'] = 'application/json';
1099
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1100
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1101
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1102
+ return {
1103
+ url: toPathString(localVarUrlObj),
1104
+ options: localVarRequestOptions,
1105
+ };
1106
+ }),
1070
1107
  };
1071
1108
  };
1072
1109
  /**
@@ -1330,6 +1367,23 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1330
1367
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1331
1368
  });
1332
1369
  },
1370
+ /**
1371
+ *
1372
+ * @summary Trigger an ACTION setting without saving settings
1373
+ * @param {string} appUuid
1374
+ * @param {string} fieldName
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ triggerSettingAction(appUuid, fieldName, options) {
1379
+ return __awaiter(this, void 0, void 0, function* () {
1380
+ var _a, _b, _c;
1381
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.triggerSettingAction(appUuid, fieldName, options);
1382
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1383
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.triggerSettingAction']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1384
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1385
+ });
1386
+ },
1333
1387
  };
1334
1388
  };
1335
1389
  /**
@@ -1503,6 +1557,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1503
1557
  startOAuth(appUuid, provider, redirectUri, options) {
1504
1558
  return localVarFp.startOAuth(appUuid, provider, redirectUri, options).then((request) => request(axios, basePath));
1505
1559
  },
1560
+ /**
1561
+ *
1562
+ * @summary Trigger an ACTION setting without saving settings
1563
+ * @param {string} appUuid
1564
+ * @param {string} fieldName
1565
+ * @param {*} [options] Override http request option.
1566
+ * @throws {RequiredError}
1567
+ */
1568
+ triggerSettingAction(appUuid, fieldName, options) {
1569
+ return localVarFp.triggerSettingAction(appUuid, fieldName, options).then((request) => request(axios, basePath));
1570
+ },
1506
1571
  };
1507
1572
  };
1508
1573
  /**
@@ -1674,6 +1739,17 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1674
1739
  startOAuth(appUuid, provider, redirectUri, options) {
1675
1740
  return AppInstallationRuntimeApiFp(this.configuration).startOAuth(appUuid, provider, redirectUri, options).then((request) => request(this.axios, this.basePath));
1676
1741
  }
1742
+ /**
1743
+ *
1744
+ * @summary Trigger an ACTION setting without saving settings
1745
+ * @param {string} appUuid
1746
+ * @param {string} fieldName
1747
+ * @param {*} [options] Override http request option.
1748
+ * @throws {RequiredError}
1749
+ */
1750
+ triggerSettingAction(appUuid, fieldName, options) {
1751
+ return AppInstallationRuntimeApiFp(this.configuration).triggerSettingAction(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
1752
+ }
1677
1753
  }
1678
1754
  /**
1679
1755
  * ApplicationsApi - axios parameter creator
@@ -19,6 +19,7 @@ All URIs are relative to *https://v2.api.caraer.com*
19
19
  |[**revokeConnection**](#revokeconnection) | **DELETE** /api/v2/apps/{appUuid}/installation/connections/{providerOrConnectionId} | Revoke external OAuth connection tokens by connection id or provider name|
20
20
  |[**saveUserSettings**](#saveusersettings) | **PUT** /api/v2/apps/{appUuid}/installation/settings/user | Save USER-scoped installation settings for the current user|
21
21
  |[**startOAuth**](#startoauth) | **POST** /api/v2/apps/{appUuid}/installation/oauth/{provider}/start | Start external OAuth authorize (returns provider authorize URL)|
22
+ |[**triggerSettingAction**](#triggersettingaction) | **POST** /api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger | Trigger an ACTION setting without saving settings|
22
23
 
23
24
  # **deleteSecret**
24
25
  > DeleteResponseVoid deleteSecret()
@@ -875,3 +876,61 @@ const { status, data } = await apiInstance.startOAuth(
875
876
 
876
877
  [[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)
877
878
 
879
+ # **triggerSettingAction**
880
+ > ShowResponseMapStringObject triggerSettingAction()
881
+
882
+
883
+ ### Example
884
+
885
+ ```typescript
886
+ import {
887
+ AppInstallationRuntimeApi,
888
+ Configuration
889
+ } from '@caraer/client';
890
+
891
+ const configuration = new Configuration();
892
+ const apiInstance = new AppInstallationRuntimeApi(configuration);
893
+
894
+ let appUuid: string; // (default to undefined)
895
+ let fieldName: string; // (default to undefined)
896
+
897
+ const { status, data } = await apiInstance.triggerSettingAction(
898
+ appUuid,
899
+ fieldName
900
+ );
901
+ ```
902
+
903
+ ### Parameters
904
+
905
+ |Name | Type | Description | Notes|
906
+ |------------- | ------------- | ------------- | -------------|
907
+ | **appUuid** | [**string**] | | defaults to undefined|
908
+ | **fieldName** | [**string**] | | defaults to undefined|
909
+
910
+
911
+ ### Return type
912
+
913
+ **ShowResponseMapStringObject**
914
+
915
+ ### Authorization
916
+
917
+ [bearerAuth](../README.md#bearerAuth)
918
+
919
+ ### HTTP request headers
920
+
921
+ - **Content-Type**: Not defined
922
+ - **Accept**: application/json
923
+
924
+
925
+ ### HTTP response details
926
+ | Status code | Description | Response headers |
927
+ |-------------|-------------|------------------|
928
+ |**202** | Action started | - |
929
+ |**400** | Bad Request | - |
930
+ |**404** | Not Found | - |
931
+ |**401** | Authentication is required or the token is invalid. | - |
932
+ |**403** | The caller is missing a required role or scope. | - |
933
+ |**500** | An internal server error occurred. | - |
934
+
935
+ [[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)
936
+
@@ -0,0 +1,26 @@
1
+ # AppSettingActionSource
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
+ **enqueue** | **boolean** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AppSettingActionSource } from '@caraer/client';
17
+
18
+ const instance: AppSettingActionSource = {
19
+ type,
20
+ serverlessFunctionUuid,
21
+ serverlessFunctionName,
22
+ enqueue,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **helpText** | **string** | | [optional] [default to undefined]
13
13
  **_options** | [**Array&lt;SettingOption&gt;**](SettingOption.md) | | [optional] [default to undefined]
14
14
  **optionsSource** | [**AppSettingOptionsSource**](AppSettingOptionsSource.md) | | [optional] [default to undefined]
15
+ **actionSource** | [**AppSettingActionSource**](AppSettingActionSource.md) | | [optional] [default to undefined]
15
16
  **defaultValue** | **any** | | [optional] [default to undefined]
16
17
  **hidden** | **boolean** | | [optional] [default to undefined]
17
18
  **visibleWhen** | [**Array&lt;AppSettingCondition&gt;**](AppSettingCondition.md) | | [optional] [default to undefined]
@@ -19,6 +20,7 @@ Name | Type | Description | Notes
19
20
  **hasValue** | **boolean** | | [optional] [default to undefined]
20
21
  **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
21
22
  **valueScope** | **string** | | [optional] [default to undefined]
23
+ **action** | **boolean** | | [optional] [default to undefined]
22
24
 
23
25
  ## Example
24
26
 
@@ -33,6 +35,7 @@ const instance: AppSettingFieldSchema = {
33
35
  helpText,
34
36
  _options,
35
37
  optionsSource,
38
+ actionSource,
36
39
  defaultValue,
37
40
  hidden,
38
41
  visibleWhen,
@@ -40,6 +43,7 @@ const instance: AppSettingFieldSchema = {
40
43
  hasValue,
41
44
  mappingValue,
42
45
  valueScope,
46
+ action,
43
47
  };
44
48
  ```
45
49
 
@@ -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&lt;SettingOption&gt;**](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.454",
3
+ "version": "2.0.455",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {