@caraer/client 2.0.398 → 2.0.399

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.
@@ -46,6 +46,7 @@ docs/AppSettingFieldMappingStructure.md
46
46
  docs/AppSettingFieldMappingStructureItem.md
47
47
  docs/AppSettingFieldSchema.md
48
48
  docs/AppSettingOptionsSource.md
49
+ docs/AppSettingsSection.md
49
50
  docs/AppTierDTO.md
50
51
  docs/ApplicationsApi.md
51
52
  docs/AutomationsApi.md
package/api.ts CHANGED
@@ -492,6 +492,10 @@ export interface AppDTO {
492
492
  * JSON array of AppSettingFieldSchema (app-level setting field definitions)
493
493
  */
494
494
  'settingsSchema'?: Array<AppSettingFieldSchema>;
495
+ /**
496
+ * Optional UI grouping of settingsSchema fields into installer cards
497
+ */
498
+ 'settingsSections'?: Array<AppSettingsSection>;
495
499
  /**
496
500
  * External OAuth providers installers can Connect (name/logo only; no secrets)
497
501
  */
@@ -1059,6 +1063,11 @@ export interface AppSettingOptionsSource {
1059
1063
  'searchable'?: boolean;
1060
1064
  'minQueryLength'?: number;
1061
1065
  }
1066
+ export interface AppSettingsSection {
1067
+ 'title'?: string;
1068
+ 'subtitle'?: string;
1069
+ 'settings'?: Array<string>;
1070
+ }
1062
1071
  /**
1063
1072
  * Data transfer object for a pricing tier (plan) within tiered app pricing
1064
1073
  */
@@ -2227,9 +2236,9 @@ export const EventRsvpRequestScopeEnum = {
2227
2236
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2228
2237
 
2229
2238
  export interface ExistingWidgetSummary {
2239
+ 'xproperty'?: string;
2230
2240
  'ymetric'?: string;
2231
2241
  'yproperty'?: string;
2232
- 'xproperty'?: string;
2233
2242
  'title'?: string;
2234
2243
  'chartType'?: string;
2235
2244
  'xProperty'?: string;
@@ -2973,9 +2982,9 @@ export interface ModelRecord {
2973
2982
  'deleted'?: boolean;
2974
2983
  'complete'?: boolean;
2975
2984
  'uuid': string;
2985
+ 'user'?: PublicUserDTO;
2976
2986
  'properties'?: Array<FilledProperty>;
2977
2987
  'objects'?: { [key: string]: any | null; };
2978
- 'user'?: PublicUserDTO;
2979
2988
  }
2980
2989
  export interface MultiLine extends PropertyFormat {
2981
2990
  }
@@ -4488,8 +4497,8 @@ export interface SettingField {
4488
4497
  'hidden'?: boolean;
4489
4498
  'disabled'?: boolean;
4490
4499
  'options'?: Array<SettingOption>;
4491
- 'value'?: any;
4492
4500
  'defaultValue'?: any;
4501
+ 'value'?: any;
4493
4502
  }
4494
4503
 
4495
4504
  export const SettingFieldTypeEnum = {
@@ -7030,6 +7039,49 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
7030
7039
  options: localVarRequestOptions,
7031
7040
  };
7032
7041
  },
7042
+ /**
7043
+ *
7044
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7045
+ * @param {string} appUuid
7046
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7047
+ * @param {*} [options] Override http request option.
7048
+ * @throws {RequiredError}
7049
+ */
7050
+ mergeCompanySettings: async (appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
7051
+ // verify required parameter 'appUuid' is not null or undefined
7052
+ assertParamExists('mergeCompanySettings', 'appUuid', appUuid)
7053
+ // verify required parameter 'appSettingFieldSchema' is not null or undefined
7054
+ assertParamExists('mergeCompanySettings', 'appSettingFieldSchema', appSettingFieldSchema)
7055
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings`
7056
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)));
7057
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7058
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7059
+ let baseOptions;
7060
+ if (configuration) {
7061
+ baseOptions = configuration.baseOptions;
7062
+ }
7063
+
7064
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
7065
+ const localVarHeaderParameter = {} as any;
7066
+ const localVarQueryParameter = {} as any;
7067
+
7068
+ // authentication bearerAuth required
7069
+ // http bearer authentication required
7070
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
7071
+
7072
+ localVarHeaderParameter['Content-Type'] = 'application/json';
7073
+ localVarHeaderParameter['Accept'] = 'application/json';
7074
+
7075
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7076
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7077
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7078
+ localVarRequestOptions.data = serializeDataIfNeeded(appSettingFieldSchema, localVarRequestOptions, configuration)
7079
+
7080
+ return {
7081
+ url: toPathString(localVarUrlObj),
7082
+ options: localVarRequestOptions,
7083
+ };
7084
+ },
7033
7085
  /**
7034
7086
  *
7035
7087
  * @summary Set an encrypted secret
@@ -7417,6 +7469,20 @@ export const AppInstallationRuntimeApiFp = function(configuration?: Configuratio
7417
7469
  const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.listSecrets']?.[localVarOperationServerIndex]?.url;
7418
7470
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7419
7471
  },
7472
+ /**
7473
+ *
7474
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7475
+ * @param {string} appUuid
7476
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7477
+ * @param {*} [options] Override http request option.
7478
+ * @throws {RequiredError}
7479
+ */
7480
+ async mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
7481
+ const localVarAxiosArgs = await localVarAxiosParamCreator.mergeCompanySettings(appUuid, appSettingFieldSchema, options);
7482
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7483
+ const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.mergeCompanySettings']?.[localVarOperationServerIndex]?.url;
7484
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7485
+ },
7420
7486
  /**
7421
7487
  *
7422
7488
  * @summary Set an encrypted secret
@@ -7598,6 +7664,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration?: Config
7598
7664
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListString> {
7599
7665
  return localVarFp.listSecrets(appUuid, options).then((request) => request(axios, basePath));
7600
7666
  },
7667
+ /**
7668
+ *
7669
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7670
+ * @param {string} appUuid
7671
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7672
+ * @param {*} [options] Override http request option.
7673
+ * @throws {RequiredError}
7674
+ */
7675
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
7676
+ return localVarFp.mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(axios, basePath));
7677
+ },
7601
7678
  /**
7602
7679
  *
7603
7680
  * @summary Set an encrypted secret
@@ -7767,6 +7844,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
7767
7844
  return AppInstallationRuntimeApiFp(this.configuration).listSecrets(appUuid, options).then((request) => request(this.axios, this.basePath));
7768
7845
  }
7769
7846
 
7847
+ /**
7848
+ *
7849
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7850
+ * @param {string} appUuid
7851
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7852
+ * @param {*} [options] Override http request option.
7853
+ * @throws {RequiredError}
7854
+ */
7855
+ public mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig) {
7856
+ return AppInstallationRuntimeApiFp(this.configuration).mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(this.axios, this.basePath));
7857
+ }
7858
+
7770
7859
  /**
7771
7860
  *
7772
7861
  * @summary Set an encrypted secret
package/dist/api.d.ts CHANGED
@@ -485,6 +485,10 @@ export interface AppDTO {
485
485
  * JSON array of AppSettingFieldSchema (app-level setting field definitions)
486
486
  */
487
487
  'settingsSchema'?: Array<AppSettingFieldSchema>;
488
+ /**
489
+ * Optional UI grouping of settingsSchema fields into installer cards
490
+ */
491
+ 'settingsSections'?: Array<AppSettingsSection>;
488
492
  /**
489
493
  * External OAuth providers installers can Connect (name/logo only; no secrets)
490
494
  */
@@ -1049,6 +1053,11 @@ export interface AppSettingOptionsSource {
1049
1053
  'searchable'?: boolean;
1050
1054
  'minQueryLength'?: number;
1051
1055
  }
1056
+ export interface AppSettingsSection {
1057
+ 'title'?: string;
1058
+ 'subtitle'?: string;
1059
+ 'settings'?: Array<string>;
1060
+ }
1052
1061
  /**
1053
1062
  * Data transfer object for a pricing tier (plan) within tiered app pricing
1054
1063
  */
@@ -2206,9 +2215,9 @@ export declare const EventRsvpRequestScopeEnum: {
2206
2215
  };
2207
2216
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2208
2217
  export interface ExistingWidgetSummary {
2218
+ 'xproperty'?: string;
2209
2219
  'ymetric'?: string;
2210
2220
  'yproperty'?: string;
2211
- 'xproperty'?: string;
2212
2221
  'title'?: string;
2213
2222
  'chartType'?: string;
2214
2223
  'xProperty'?: string;
@@ -2966,11 +2975,11 @@ export interface ModelRecord {
2966
2975
  'deleted'?: boolean;
2967
2976
  'complete'?: boolean;
2968
2977
  'uuid': string;
2978
+ 'user'?: PublicUserDTO;
2969
2979
  'properties'?: Array<FilledProperty>;
2970
2980
  'objects'?: {
2971
2981
  [key: string]: any | null;
2972
2982
  };
2973
- 'user'?: PublicUserDTO;
2974
2983
  }
2975
2984
  export interface MultiLine extends PropertyFormat {
2976
2985
  }
@@ -4511,8 +4520,8 @@ export interface SettingField {
4511
4520
  'hidden'?: boolean;
4512
4521
  'disabled'?: boolean;
4513
4522
  'options'?: Array<SettingOption>;
4514
- 'value'?: any;
4515
4523
  'defaultValue'?: any;
4524
+ 'value'?: any;
4516
4525
  }
4517
4526
  export declare const SettingFieldTypeEnum: {
4518
4527
  readonly String: "STRING";
@@ -6600,6 +6609,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
6600
6609
  * @throws {RequiredError}
6601
6610
  */
6602
6611
  listSecrets: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6612
+ /**
6613
+ *
6614
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6615
+ * @param {string} appUuid
6616
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6617
+ * @param {*} [options] Override http request option.
6618
+ * @throws {RequiredError}
6619
+ */
6620
+ mergeCompanySettings: (appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6603
6621
  /**
6604
6622
  *
6605
6623
  * @summary Set an encrypted secret
@@ -6737,6 +6755,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
6737
6755
  * @throws {RequiredError}
6738
6756
  */
6739
6757
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListString>>;
6758
+ /**
6759
+ *
6760
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6761
+ * @param {string} appUuid
6762
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6763
+ * @param {*} [options] Override http request option.
6764
+ * @throws {RequiredError}
6765
+ */
6766
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
6740
6767
  /**
6741
6768
  *
6742
6769
  * @summary Set an encrypted secret
@@ -6874,6 +6901,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
6874
6901
  * @throws {RequiredError}
6875
6902
  */
6876
6903
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListString>;
6904
+ /**
6905
+ *
6906
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6907
+ * @param {string} appUuid
6908
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6909
+ * @param {*} [options] Override http request option.
6910
+ * @throws {RequiredError}
6911
+ */
6912
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
6877
6913
  /**
6878
6914
  *
6879
6915
  * @summary Set an encrypted secret
@@ -7011,6 +7047,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
7011
7047
  * @throws {RequiredError}
7012
7048
  */
7013
7049
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListString, any, {}>>;
7050
+ /**
7051
+ *
7052
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7053
+ * @param {string} appUuid
7054
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7055
+ * @param {*} [options] Override http request option.
7056
+ * @throws {RequiredError}
7057
+ */
7058
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
7014
7059
  /**
7015
7060
  *
7016
7061
  * @summary Set an encrypted secret
package/dist/api.js CHANGED
@@ -798,6 +798,44 @@ const AppInstallationRuntimeApiAxiosParamCreator = function (configuration) {
798
798
  options: localVarRequestOptions,
799
799
  };
800
800
  }),
801
+ /**
802
+ *
803
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
804
+ * @param {string} appUuid
805
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
806
+ * @param {*} [options] Override http request option.
807
+ * @throws {RequiredError}
808
+ */
809
+ mergeCompanySettings: (appUuid_1, appSettingFieldSchema_1, ...args_1) => __awaiter(this, [appUuid_1, appSettingFieldSchema_1, ...args_1], void 0, function* (appUuid, appSettingFieldSchema, options = {}) {
810
+ // verify required parameter 'appUuid' is not null or undefined
811
+ (0, common_1.assertParamExists)('mergeCompanySettings', 'appUuid', appUuid);
812
+ // verify required parameter 'appSettingFieldSchema' is not null or undefined
813
+ (0, common_1.assertParamExists)('mergeCompanySettings', 'appSettingFieldSchema', appSettingFieldSchema);
814
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings`
815
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)));
816
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
817
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
818
+ let baseOptions;
819
+ if (configuration) {
820
+ baseOptions = configuration.baseOptions;
821
+ }
822
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
823
+ const localVarHeaderParameter = {};
824
+ const localVarQueryParameter = {};
825
+ // authentication bearerAuth required
826
+ // http bearer authentication required
827
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
828
+ localVarHeaderParameter['Content-Type'] = 'application/json';
829
+ localVarHeaderParameter['Accept'] = 'application/json';
830
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
831
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
832
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
833
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(appSettingFieldSchema, localVarRequestOptions, configuration);
834
+ return {
835
+ url: (0, common_1.toPathString)(localVarUrlObj),
836
+ options: localVarRequestOptions,
837
+ };
838
+ }),
801
839
  /**
802
840
  *
803
841
  * @summary Set an encrypted secret
@@ -1178,6 +1216,23 @@ const AppInstallationRuntimeApiFp = function (configuration) {
1178
1216
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1179
1217
  });
1180
1218
  },
1219
+ /**
1220
+ *
1221
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1222
+ * @param {string} appUuid
1223
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1224
+ * @param {*} [options] Override http request option.
1225
+ * @throws {RequiredError}
1226
+ */
1227
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1228
+ return __awaiter(this, void 0, void 0, function* () {
1229
+ var _a, _b, _c;
1230
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.mergeCompanySettings(appUuid, appSettingFieldSchema, options);
1231
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1232
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AppInstallationRuntimeApi.mergeCompanySettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1233
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1234
+ });
1235
+ },
1181
1236
  /**
1182
1237
  *
1183
1238
  * @summary Set an encrypted secret
@@ -1377,6 +1432,17 @@ const AppInstallationRuntimeApiFactory = function (configuration, basePath, axio
1377
1432
  listSecrets(appUuid, options) {
1378
1433
  return localVarFp.listSecrets(appUuid, options).then((request) => request(axios, basePath));
1379
1434
  },
1435
+ /**
1436
+ *
1437
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1438
+ * @param {string} appUuid
1439
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1440
+ * @param {*} [options] Override http request option.
1441
+ * @throws {RequiredError}
1442
+ */
1443
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1444
+ return localVarFp.mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(axios, basePath));
1445
+ },
1380
1446
  /**
1381
1447
  *
1382
1448
  * @summary Set an encrypted secret
@@ -1538,6 +1604,17 @@ class AppInstallationRuntimeApi extends base_1.BaseAPI {
1538
1604
  listSecrets(appUuid, options) {
1539
1605
  return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).listSecrets(appUuid, options).then((request) => request(this.axios, this.basePath));
1540
1606
  }
1607
+ /**
1608
+ *
1609
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1610
+ * @param {string} appUuid
1611
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1612
+ * @param {*} [options] Override http request option.
1613
+ * @throws {RequiredError}
1614
+ */
1615
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1616
+ return (0, exports.AppInstallationRuntimeApiFp)(this.configuration).mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(this.axios, this.basePath));
1617
+ }
1541
1618
  /**
1542
1619
  *
1543
1620
  * @summary Set an encrypted secret
package/dist/esm/api.d.ts CHANGED
@@ -485,6 +485,10 @@ export interface AppDTO {
485
485
  * JSON array of AppSettingFieldSchema (app-level setting field definitions)
486
486
  */
487
487
  'settingsSchema'?: Array<AppSettingFieldSchema>;
488
+ /**
489
+ * Optional UI grouping of settingsSchema fields into installer cards
490
+ */
491
+ 'settingsSections'?: Array<AppSettingsSection>;
488
492
  /**
489
493
  * External OAuth providers installers can Connect (name/logo only; no secrets)
490
494
  */
@@ -1049,6 +1053,11 @@ export interface AppSettingOptionsSource {
1049
1053
  'searchable'?: boolean;
1050
1054
  'minQueryLength'?: number;
1051
1055
  }
1056
+ export interface AppSettingsSection {
1057
+ 'title'?: string;
1058
+ 'subtitle'?: string;
1059
+ 'settings'?: Array<string>;
1060
+ }
1052
1061
  /**
1053
1062
  * Data transfer object for a pricing tier (plan) within tiered app pricing
1054
1063
  */
@@ -2206,9 +2215,9 @@ export declare const EventRsvpRequestScopeEnum: {
2206
2215
  };
2207
2216
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2208
2217
  export interface ExistingWidgetSummary {
2218
+ 'xproperty'?: string;
2209
2219
  'ymetric'?: string;
2210
2220
  'yproperty'?: string;
2211
- 'xproperty'?: string;
2212
2221
  'title'?: string;
2213
2222
  'chartType'?: string;
2214
2223
  'xProperty'?: string;
@@ -2966,11 +2975,11 @@ export interface ModelRecord {
2966
2975
  'deleted'?: boolean;
2967
2976
  'complete'?: boolean;
2968
2977
  'uuid': string;
2978
+ 'user'?: PublicUserDTO;
2969
2979
  'properties'?: Array<FilledProperty>;
2970
2980
  'objects'?: {
2971
2981
  [key: string]: any | null;
2972
2982
  };
2973
- 'user'?: PublicUserDTO;
2974
2983
  }
2975
2984
  export interface MultiLine extends PropertyFormat {
2976
2985
  }
@@ -4511,8 +4520,8 @@ export interface SettingField {
4511
4520
  'hidden'?: boolean;
4512
4521
  'disabled'?: boolean;
4513
4522
  'options'?: Array<SettingOption>;
4514
- 'value'?: any;
4515
4523
  'defaultValue'?: any;
4524
+ 'value'?: any;
4516
4525
  }
4517
4526
  export declare const SettingFieldTypeEnum: {
4518
4527
  readonly String: "STRING";
@@ -6600,6 +6609,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
6600
6609
  * @throws {RequiredError}
6601
6610
  */
6602
6611
  listSecrets: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6612
+ /**
6613
+ *
6614
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6615
+ * @param {string} appUuid
6616
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6617
+ * @param {*} [options] Override http request option.
6618
+ * @throws {RequiredError}
6619
+ */
6620
+ mergeCompanySettings: (appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6603
6621
  /**
6604
6622
  *
6605
6623
  * @summary Set an encrypted secret
@@ -6737,6 +6755,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
6737
6755
  * @throws {RequiredError}
6738
6756
  */
6739
6757
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListString>>;
6758
+ /**
6759
+ *
6760
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6761
+ * @param {string} appUuid
6762
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6763
+ * @param {*} [options] Override http request option.
6764
+ * @throws {RequiredError}
6765
+ */
6766
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
6740
6767
  /**
6741
6768
  *
6742
6769
  * @summary Set an encrypted secret
@@ -6874,6 +6901,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
6874
6901
  * @throws {RequiredError}
6875
6902
  */
6876
6903
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListString>;
6904
+ /**
6905
+ *
6906
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
6907
+ * @param {string} appUuid
6908
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
6909
+ * @param {*} [options] Override http request option.
6910
+ * @throws {RequiredError}
6911
+ */
6912
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
6877
6913
  /**
6878
6914
  *
6879
6915
  * @summary Set an encrypted secret
@@ -7011,6 +7047,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
7011
7047
  * @throws {RequiredError}
7012
7048
  */
7013
7049
  listSecrets(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListString, any, {}>>;
7050
+ /**
7051
+ *
7052
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
7053
+ * @param {string} appUuid
7054
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
7055
+ * @param {*} [options] Override http request option.
7056
+ * @throws {RequiredError}
7057
+ */
7058
+ mergeCompanySettings(appUuid: string, appSettingFieldSchema: Array<AppSettingFieldSchema>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
7014
7059
  /**
7015
7060
  *
7016
7061
  * @summary Set an encrypted secret
package/dist/esm/api.js CHANGED
@@ -785,6 +785,44 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
785
785
  options: localVarRequestOptions,
786
786
  };
787
787
  }),
788
+ /**
789
+ *
790
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
791
+ * @param {string} appUuid
792
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
793
+ * @param {*} [options] Override http request option.
794
+ * @throws {RequiredError}
795
+ */
796
+ mergeCompanySettings: (appUuid_1, appSettingFieldSchema_1, ...args_1) => __awaiter(this, [appUuid_1, appSettingFieldSchema_1, ...args_1], void 0, function* (appUuid, appSettingFieldSchema, options = {}) {
797
+ // verify required parameter 'appUuid' is not null or undefined
798
+ assertParamExists('mergeCompanySettings', 'appUuid', appUuid);
799
+ // verify required parameter 'appSettingFieldSchema' is not null or undefined
800
+ assertParamExists('mergeCompanySettings', 'appSettingFieldSchema', appSettingFieldSchema);
801
+ const localVarPath = `/api/v2/apps/{appUuid}/installation/settings`
802
+ .replace('{appUuid}', encodeURIComponent(String(appUuid)));
803
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
804
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
805
+ let baseOptions;
806
+ if (configuration) {
807
+ baseOptions = configuration.baseOptions;
808
+ }
809
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
810
+ const localVarHeaderParameter = {};
811
+ const localVarQueryParameter = {};
812
+ // authentication bearerAuth required
813
+ // http bearer authentication required
814
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
815
+ localVarHeaderParameter['Content-Type'] = 'application/json';
816
+ localVarHeaderParameter['Accept'] = 'application/json';
817
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
818
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
819
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
820
+ localVarRequestOptions.data = serializeDataIfNeeded(appSettingFieldSchema, localVarRequestOptions, configuration);
821
+ return {
822
+ url: toPathString(localVarUrlObj),
823
+ options: localVarRequestOptions,
824
+ };
825
+ }),
788
826
  /**
789
827
  *
790
828
  * @summary Set an encrypted secret
@@ -1164,6 +1202,23 @@ export const AppInstallationRuntimeApiFp = function (configuration) {
1164
1202
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1165
1203
  });
1166
1204
  },
1205
+ /**
1206
+ *
1207
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1208
+ * @param {string} appUuid
1209
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1210
+ * @param {*} [options] Override http request option.
1211
+ * @throws {RequiredError}
1212
+ */
1213
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1214
+ return __awaiter(this, void 0, void 0, function* () {
1215
+ var _a, _b, _c;
1216
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.mergeCompanySettings(appUuid, appSettingFieldSchema, options);
1217
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1218
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AppInstallationRuntimeApi.mergeCompanySettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1219
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1220
+ });
1221
+ },
1167
1222
  /**
1168
1223
  *
1169
1224
  * @summary Set an encrypted secret
@@ -1362,6 +1417,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration, basePat
1362
1417
  listSecrets(appUuid, options) {
1363
1418
  return localVarFp.listSecrets(appUuid, options).then((request) => request(axios, basePath));
1364
1419
  },
1420
+ /**
1421
+ *
1422
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1423
+ * @param {string} appUuid
1424
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1425
+ * @param {*} [options] Override http request option.
1426
+ * @throws {RequiredError}
1427
+ */
1428
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1429
+ return localVarFp.mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(axios, basePath));
1430
+ },
1365
1431
  /**
1366
1432
  *
1367
1433
  * @summary Set an encrypted secret
@@ -1522,6 +1588,17 @@ export class AppInstallationRuntimeApi extends BaseAPI {
1522
1588
  listSecrets(appUuid, options) {
1523
1589
  return AppInstallationRuntimeApiFp(this.configuration).listSecrets(appUuid, options).then((request) => request(this.axios, this.basePath));
1524
1590
  }
1591
+ /**
1592
+ *
1593
+ * @summary Merge COMPANY-scoped installation settings from the app runtime
1594
+ * @param {string} appUuid
1595
+ * @param {Array<AppSettingFieldSchema>} appSettingFieldSchema
1596
+ * @param {*} [options] Override http request option.
1597
+ * @throws {RequiredError}
1598
+ */
1599
+ mergeCompanySettings(appUuid, appSettingFieldSchema, options) {
1600
+ return AppInstallationRuntimeApiFp(this.configuration).mergeCompanySettings(appUuid, appSettingFieldSchema, options).then((request) => request(this.axios, this.basePath));
1601
+ }
1525
1602
  /**
1526
1603
  *
1527
1604
  * @summary Set an encrypted secret
package/docs/AppDTO.md CHANGED
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
27
27
  **rotateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app installation token is rotated | [optional] [default to undefined]
28
28
  **updateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when an already installed app is saved again | [optional] [default to undefined]
29
29
  **settingsSchema** | [**Array&lt;AppSettingFieldSchema&gt;**](AppSettingFieldSchema.md) | JSON array of AppSettingFieldSchema (app-level setting field definitions) | [optional] [default to undefined]
30
+ **settingsSections** | [**Array&lt;AppSettingsSection&gt;**](AppSettingsSection.md) | Optional UI grouping of settingsSchema fields into installer cards | [optional] [default to undefined]
30
31
  **externalOAuthProviders** | [**Array&lt;AppExternalOAuthProviderSummaryDTO&gt;**](AppExternalOAuthProviderSummaryDTO.md) | External OAuth providers installers can Connect (name/logo only; no secrets) | [optional] [default to undefined]
31
32
  **webhookRateLimitPerMinute** | **number** | Webhook rate limit per minute | [optional] [default to undefined]
32
33
  **jobRateLimitPerMinute** | **number** | App job enqueue rate limit per minute per installation | [optional] [default to undefined]
@@ -84,6 +85,7 @@ const instance: AppDTO = {
84
85
  rotateWebhook,
85
86
  updateWebhook,
86
87
  settingsSchema,
88
+ settingsSections,
87
89
  externalOAuthProviders,
88
90
  webhookRateLimitPerMinute,
89
91
  jobRateLimitPerMinute,
@@ -12,6 +12,7 @@ All URIs are relative to *https://v2.api.caraer.com*
12
12
  |[**getStateKey**](#getstatekey) | **GET** /api/v2/apps/{appUuid}/installation/state/{key} | Get a single state key|
13
13
  |[**listConnections**](#listconnections) | **GET** /api/v2/apps/{appUuid}/installation/connections | List external OAuth connection status|
14
14
  |[**listSecrets**](#listsecrets) | **GET** /api/v2/apps/{appUuid}/installation/secrets | List secret names (no values)|
15
+ |[**mergeCompanySettings**](#mergecompanysettings) | **PUT** /api/v2/apps/{appUuid}/installation/settings | Merge COMPANY-scoped installation settings from the app runtime|
15
16
  |[**putSecret**](#putsecret) | **PUT** /api/v2/apps/{appUuid}/installation/secrets/{name} | Set an encrypted secret|
16
17
  |[**putState**](#putstate) | **PUT** /api/v2/apps/{appUuid}/installation/state | Replace/merge installation state (shallow merge)|
17
18
  |[**putStateKey**](#putstatekey) | **PUT** /api/v2/apps/{appUuid}/installation/state/{key} | Put a single state key|
@@ -435,6 +436,60 @@ const { status, data } = await apiInstance.listSecrets(
435
436
 
436
437
  [[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)
437
438
 
439
+ # **mergeCompanySettings**
440
+ > ShowResponseMapStringObject mergeCompanySettings(appSettingFieldSchema)
441
+
442
+
443
+ ### Example
444
+
445
+ ```typescript
446
+ import {
447
+ AppInstallationRuntimeApi,
448
+ Configuration
449
+ } from '@caraer/client';
450
+
451
+ const configuration = new Configuration();
452
+ const apiInstance = new AppInstallationRuntimeApi(configuration);
453
+
454
+ let appUuid: string; // (default to undefined)
455
+ let appSettingFieldSchema: Array<AppSettingFieldSchema>; //
456
+
457
+ const { status, data } = await apiInstance.mergeCompanySettings(
458
+ appUuid,
459
+ appSettingFieldSchema
460
+ );
461
+ ```
462
+
463
+ ### Parameters
464
+
465
+ |Name | Type | Description | Notes|
466
+ |------------- | ------------- | ------------- | -------------|
467
+ | **appSettingFieldSchema** | **Array<AppSettingFieldSchema>**| | |
468
+ | **appUuid** | [**string**] | | defaults to undefined|
469
+
470
+
471
+ ### Return type
472
+
473
+ **ShowResponseMapStringObject**
474
+
475
+ ### Authorization
476
+
477
+ [bearerAuth](../README.md#bearerAuth)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: application/json
482
+ - **Accept**: application/json
483
+
484
+
485
+ ### HTTP response details
486
+ | Status code | Description | Response headers |
487
+ |-------------|-------------|------------------|
488
+ |**200** | Merged settings map | - |
489
+ |**403** | Forbidden | - |
490
+
491
+ [[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)
492
+
438
493
  # **putSecret**
439
494
  > SuccessResponseVoid putSecret(requestBody)
440
495
 
@@ -0,0 +1,24 @@
1
+ # AppSettingsSection
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **title** | **string** | | [optional] [default to undefined]
9
+ **subtitle** | **string** | | [optional] [default to undefined]
10
+ **settings** | **Array&lt;string&gt;** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AppSettingsSection } from '@caraer/client';
16
+
17
+ const instance: AppSettingsSection = {
18
+ title,
19
+ subtitle,
20
+ settings,
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)
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **xproperty** | **string** | | [optional] [default to undefined]
8
9
  **ymetric** | **string** | | [optional] [default to undefined]
9
10
  **yproperty** | **string** | | [optional] [default to undefined]
10
- **xproperty** | **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
+ xproperty,
23
24
  ymetric,
24
25
  yproperty,
25
- xproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
package/docs/Record.md CHANGED
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **deleted** | **boolean** | | [optional] [default to undefined]
18
18
  **complete** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
+ **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
20
21
  **properties** | [**Array&lt;FilledProperty&gt;**](FilledProperty.md) | | [optional] [default to undefined]
21
22
  **objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
22
- **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
23
23
 
24
24
  ## Example
25
25
 
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
39
39
  deleted,
40
40
  complete,
41
41
  uuid,
42
+ user,
42
43
  properties,
43
44
  objects,
44
- user,
45
45
  };
46
46
  ```
47
47
 
@@ -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
- **value** | **any** | | [optional] [default to undefined]
18
17
  **defaultValue** | **any** | | [optional] [default to undefined]
18
+ **value** | **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
- value,
36
35
  defaultValue,
36
+ value,
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.398",
3
+ "version": "2.0.399",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {