@caraer/client 2.0.605 → 2.0.608

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.js CHANGED
@@ -2350,10 +2350,12 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
2350
2350
  * @param {PaginationRequest} paginationRequest
2351
2351
  * @param {string} [type]
2352
2352
  * @param {boolean} [installedOnly]
2353
+ * @param {string} [category]
2354
+ * @param {string} [subcategory]
2353
2355
  * @param {*} [options] Override http request option.
2354
2356
  * @throws {RequiredError}
2355
2357
  */
2356
- getApps: (paginationRequest_1, type_1, installedOnly_1, ...args_1) => __awaiter(this, [paginationRequest_1, type_1, installedOnly_1, ...args_1], void 0, function* (paginationRequest, type, installedOnly, options = {}) {
2358
+ getApps: (paginationRequest_1, type_1, installedOnly_1, category_1, subcategory_1, ...args_1) => __awaiter(this, [paginationRequest_1, type_1, installedOnly_1, category_1, subcategory_1, ...args_1], void 0, function* (paginationRequest, type, installedOnly, category, subcategory, options = {}) {
2357
2359
  // verify required parameter 'paginationRequest' is not null or undefined
2358
2360
  (0, common_1.assertParamExists)('getApps', 'paginationRequest', paginationRequest);
2359
2361
  const localVarPath = `/api/v2/apps/index`;
@@ -2375,6 +2377,12 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
2375
2377
  if (installedOnly !== undefined) {
2376
2378
  localVarQueryParameter['installedOnly'] = installedOnly;
2377
2379
  }
2380
+ if (category !== undefined) {
2381
+ localVarQueryParameter['category'] = category;
2382
+ }
2383
+ if (subcategory !== undefined) {
2384
+ localVarQueryParameter['subcategory'] = subcategory;
2385
+ }
2378
2386
  localVarHeaderParameter['Content-Type'] = 'application/json';
2379
2387
  localVarHeaderParameter['Accept'] = 'application/json';
2380
2388
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -2697,6 +2705,43 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
2697
2705
  options: localVarRequestOptions,
2698
2706
  };
2699
2707
  }),
2708
+ /**
2709
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
2710
+ * @summary List available app categories
2711
+ * @param {string} [type]
2712
+ * @param {boolean} [installedOnly]
2713
+ * @param {*} [options] Override http request option.
2714
+ * @throws {RequiredError}
2715
+ */
2716
+ listAvailableAppCategories: (type_1, installedOnly_1, ...args_1) => __awaiter(this, [type_1, installedOnly_1, ...args_1], void 0, function* (type, installedOnly, options = {}) {
2717
+ const localVarPath = `/api/v2/apps/categories/available`;
2718
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2719
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2720
+ let baseOptions;
2721
+ if (configuration) {
2722
+ baseOptions = configuration.baseOptions;
2723
+ }
2724
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2725
+ const localVarHeaderParameter = {};
2726
+ const localVarQueryParameter = {};
2727
+ // authentication bearerAuth required
2728
+ // http bearer authentication required
2729
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
2730
+ if (type !== undefined) {
2731
+ localVarQueryParameter['type'] = type;
2732
+ }
2733
+ if (installedOnly !== undefined) {
2734
+ localVarQueryParameter['installedOnly'] = installedOnly;
2735
+ }
2736
+ localVarHeaderParameter['Accept'] = 'application/json';
2737
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2738
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2739
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2740
+ return {
2741
+ url: (0, common_1.toPathString)(localVarUrlObj),
2742
+ options: localVarRequestOptions,
2743
+ };
2744
+ }),
2700
2745
  /**
2701
2746
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
2702
2747
  * @summary Load dynamic options for a setting select field
@@ -3314,13 +3359,15 @@ const ApplicationsApiFp = function (configuration) {
3314
3359
  * @param {PaginationRequest} paginationRequest
3315
3360
  * @param {string} [type]
3316
3361
  * @param {boolean} [installedOnly]
3362
+ * @param {string} [category]
3363
+ * @param {string} [subcategory]
3317
3364
  * @param {*} [options] Override http request option.
3318
3365
  * @throws {RequiredError}
3319
3366
  */
3320
- getApps(paginationRequest, type, installedOnly, options) {
3367
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
3321
3368
  return __awaiter(this, void 0, void 0, function* () {
3322
3369
  var _a, _b, _c;
3323
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, options);
3370
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, category, subcategory, options);
3324
3371
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3325
3372
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ApplicationsApi.getApps']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3326
3373
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3473,6 +3520,23 @@ const ApplicationsApiFp = function (configuration) {
3473
3520
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3474
3521
  });
3475
3522
  },
3523
+ /**
3524
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
3525
+ * @summary List available app categories
3526
+ * @param {string} [type]
3527
+ * @param {boolean} [installedOnly]
3528
+ * @param {*} [options] Override http request option.
3529
+ * @throws {RequiredError}
3530
+ */
3531
+ listAvailableAppCategories(type, installedOnly, options) {
3532
+ return __awaiter(this, void 0, void 0, function* () {
3533
+ var _a, _b, _c;
3534
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listAvailableAppCategories(type, installedOnly, options);
3535
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3536
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ApplicationsApi.listAvailableAppCategories']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3537
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3538
+ });
3539
+ },
3476
3540
  /**
3477
3541
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
3478
3542
  * @summary Load dynamic options for a setting select field
@@ -3788,11 +3852,13 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
3788
3852
  * @param {PaginationRequest} paginationRequest
3789
3853
  * @param {string} [type]
3790
3854
  * @param {boolean} [installedOnly]
3855
+ * @param {string} [category]
3856
+ * @param {string} [subcategory]
3791
3857
  * @param {*} [options] Override http request option.
3792
3858
  * @throws {RequiredError}
3793
3859
  */
3794
- getApps(paginationRequest, type, installedOnly, options) {
3795
- return localVarFp.getApps(paginationRequest, type, installedOnly, options).then((request) => request(axios, basePath));
3860
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
3861
+ return localVarFp.getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(axios, basePath));
3796
3862
  },
3797
3863
  /**
3798
3864
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
@@ -3887,6 +3953,17 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
3887
3953
  listAppCategories(options) {
3888
3954
  return localVarFp.listAppCategories(options).then((request) => request(axios, basePath));
3889
3955
  },
3956
+ /**
3957
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
3958
+ * @summary List available app categories
3959
+ * @param {string} [type]
3960
+ * @param {boolean} [installedOnly]
3961
+ * @param {*} [options] Override http request option.
3962
+ * @throws {RequiredError}
3963
+ */
3964
+ listAvailableAppCategories(type, installedOnly, options) {
3965
+ return localVarFp.listAvailableAppCategories(type, installedOnly, options).then((request) => request(axios, basePath));
3966
+ },
3890
3967
  /**
3891
3968
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
3892
3969
  * @summary Load dynamic options for a setting select field
@@ -4128,11 +4205,13 @@ class ApplicationsApi extends base_1.BaseAPI {
4128
4205
  * @param {PaginationRequest} paginationRequest
4129
4206
  * @param {string} [type]
4130
4207
  * @param {boolean} [installedOnly]
4208
+ * @param {string} [category]
4209
+ * @param {string} [subcategory]
4131
4210
  * @param {*} [options] Override http request option.
4132
4211
  * @throws {RequiredError}
4133
4212
  */
4134
- getApps(paginationRequest, type, installedOnly, options) {
4135
- return (0, exports.ApplicationsApiFp)(this.configuration).getApps(paginationRequest, type, installedOnly, options).then((request) => request(this.axios, this.basePath));
4213
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
4214
+ return (0, exports.ApplicationsApiFp)(this.configuration).getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(this.axios, this.basePath));
4136
4215
  }
4137
4216
  /**
4138
4217
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
@@ -4227,6 +4306,17 @@ class ApplicationsApi extends base_1.BaseAPI {
4227
4306
  listAppCategories(options) {
4228
4307
  return (0, exports.ApplicationsApiFp)(this.configuration).listAppCategories(options).then((request) => request(this.axios, this.basePath));
4229
4308
  }
4309
+ /**
4310
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
4311
+ * @summary List available app categories
4312
+ * @param {string} [type]
4313
+ * @param {boolean} [installedOnly]
4314
+ * @param {*} [options] Override http request option.
4315
+ * @throws {RequiredError}
4316
+ */
4317
+ listAvailableAppCategories(type, installedOnly, options) {
4318
+ return (0, exports.ApplicationsApiFp)(this.configuration).listAvailableAppCategories(type, installedOnly, options).then((request) => request(this.axios, this.basePath));
4319
+ }
4230
4320
  /**
4231
4321
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
4232
4322
  * @summary Load dynamic options for a setting select field
package/dist/esm/api.d.ts CHANGED
@@ -387,6 +387,27 @@ export interface AppBarVisibilityEntry {
387
387
  'suites'?: Array<string>;
388
388
  'traits'?: Array<string>;
389
389
  }
390
+ /**
391
+ * Predefined marketplace main category with subcategories
392
+ */
393
+ export interface AppCategoryDTO {
394
+ /**
395
+ * Stable main category key stored on AppDetails.category
396
+ */
397
+ 'key'?: string;
398
+ /**
399
+ * Human-readable main category label
400
+ */
401
+ 'label'?: string;
402
+ /**
403
+ * Subcategories available under this main category
404
+ */
405
+ 'subcategories'?: Array<AppSubcategoryDTO>;
406
+ /**
407
+ * Distinct visible apps in this category; provided by the available-category endpoint, independent of search and pagination
408
+ */
409
+ 'appCount'?: number;
410
+ }
390
411
  export interface AppConnectionStatusDTO {
391
412
  'id'?: string;
392
413
  'name'?: string;
@@ -1013,6 +1034,19 @@ export interface AppSettingsSection {
1013
1034
  'subtitle'?: string;
1014
1035
  'settings'?: Array<string>;
1015
1036
  }
1037
+ /**
1038
+ * Predefined marketplace subcategory
1039
+ */
1040
+ export interface AppSubcategoryDTO {
1041
+ /**
1042
+ * Stable subcategory key stored on AppDetails.subcategories
1043
+ */
1044
+ 'key'?: string;
1045
+ /**
1046
+ * Human-readable subcategory label
1047
+ */
1048
+ 'label'?: string;
1049
+ }
1016
1050
  /**
1017
1051
  * The billing settings of the company.
1018
1052
  */
@@ -2772,9 +2806,9 @@ export declare const EventRsvpRequestScopeEnum: {
2772
2806
  };
2773
2807
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2774
2808
  export interface ExistingWidgetSummary {
2809
+ 'yproperty'?: string;
2775
2810
  'ymetric'?: string;
2776
2811
  'xproperty'?: string;
2777
- 'yproperty'?: string;
2778
2812
  'title'?: string;
2779
2813
  'chartType'?: string;
2780
2814
  'xProperty'?: string;
@@ -3706,11 +3740,11 @@ export interface ModelRecord {
3706
3740
  'complete'?: boolean;
3707
3741
  'deleted'?: boolean;
3708
3742
  'uuid': string;
3709
- 'user'?: PublicUserDTO;
3710
3743
  'properties'?: Array<FilledProperty>;
3711
3744
  'objects'?: {
3712
3745
  [key: string]: any | null;
3713
3746
  };
3747
+ 'user'?: PublicUserDTO;
3714
3748
  }
3715
3749
  export interface MultiFile extends PropertyFormat {
3716
3750
  }
@@ -5957,8 +5991,8 @@ export interface SettingField {
5957
5991
  'hidden'?: boolean;
5958
5992
  'disabled'?: boolean;
5959
5993
  'options'?: Array<SettingOption>;
5960
- 'defaultValue'?: any;
5961
5994
  'value'?: any;
5995
+ 'defaultValue'?: any;
5962
5996
  }
5963
5997
  export declare const SettingFieldTypeEnum: {
5964
5998
  readonly String: "STRING";
@@ -9588,10 +9622,12 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
9588
9622
  * @param {PaginationRequest} paginationRequest
9589
9623
  * @param {string} [type]
9590
9624
  * @param {boolean} [installedOnly]
9625
+ * @param {string} [category]
9626
+ * @param {string} [subcategory]
9591
9627
  * @param {*} [options] Override http request option.
9592
9628
  * @throws {RequiredError}
9593
9629
  */
9594
- getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9630
+ getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9595
9631
  /**
9596
9632
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
9597
9633
  * @summary Get current user\'s company information
@@ -9667,6 +9703,15 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
9667
9703
  * @throws {RequiredError}
9668
9704
  */
9669
9705
  listAppCategories: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9706
+ /**
9707
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
9708
+ * @summary List available app categories
9709
+ * @param {string} [type]
9710
+ * @param {boolean} [installedOnly]
9711
+ * @param {*} [options] Override http request option.
9712
+ * @throws {RequiredError}
9713
+ */
9714
+ listAvailableAppCategories: (type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9670
9715
  /**
9671
9716
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
9672
9717
  * @summary Load dynamic options for a setting select field
@@ -9864,10 +9909,12 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
9864
9909
  * @param {PaginationRequest} paginationRequest
9865
9910
  * @param {string} [type]
9866
9911
  * @param {boolean} [installedOnly]
9912
+ * @param {string} [category]
9913
+ * @param {string} [subcategory]
9867
9914
  * @param {*} [options] Override http request option.
9868
9915
  * @throws {RequiredError}
9869
9916
  */
9870
- getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
9917
+ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
9871
9918
  /**
9872
9919
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
9873
9920
  * @summary Get current user\'s company information
@@ -9948,9 +9995,16 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
9948
9995
  * @param {*} [options] Override http request option.
9949
9996
  * @throws {RequiredError}
9950
9997
  */
9951
- listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{
9952
- [key: string]: any;
9953
- }>>>;
9998
+ listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
9999
+ /**
10000
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
10001
+ * @summary List available app categories
10002
+ * @param {string} [type]
10003
+ * @param {boolean} [installedOnly]
10004
+ * @param {*} [options] Override http request option.
10005
+ * @throws {RequiredError}
10006
+ */
10007
+ listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
9954
10008
  /**
9955
10009
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
9956
10010
  * @summary Load dynamic options for a setting select field
@@ -10148,10 +10202,12 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
10148
10202
  * @param {PaginationRequest} paginationRequest
10149
10203
  * @param {string} [type]
10150
10204
  * @param {boolean} [installedOnly]
10205
+ * @param {string} [category]
10206
+ * @param {string} [subcategory]
10151
10207
  * @param {*} [options] Override http request option.
10152
10208
  * @throws {RequiredError}
10153
10209
  */
10154
- getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
10210
+ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
10155
10211
  /**
10156
10212
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
10157
10213
  * @summary Get current user\'s company information
@@ -10232,9 +10288,16 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
10232
10288
  * @param {*} [options] Override http request option.
10233
10289
  * @throws {RequiredError}
10234
10290
  */
10235
- listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<{
10236
- [key: string]: any;
10237
- }>>;
10291
+ listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
10292
+ /**
10293
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
10294
+ * @summary List available app categories
10295
+ * @param {string} [type]
10296
+ * @param {boolean} [installedOnly]
10297
+ * @param {*} [options] Override http request option.
10298
+ * @throws {RequiredError}
10299
+ */
10300
+ listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
10238
10301
  /**
10239
10302
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
10240
10303
  * @summary Load dynamic options for a setting select field
@@ -10432,10 +10495,12 @@ export declare class ApplicationsApi extends BaseAPI {
10432
10495
  * @param {PaginationRequest} paginationRequest
10433
10496
  * @param {string} [type]
10434
10497
  * @param {boolean} [installedOnly]
10498
+ * @param {string} [category]
10499
+ * @param {string} [subcategory]
10435
10500
  * @param {*} [options] Override http request option.
10436
10501
  * @throws {RequiredError}
10437
10502
  */
10438
- getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
10503
+ getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
10439
10504
  /**
10440
10505
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
10441
10506
  * @summary Get current user\'s company information
@@ -10516,9 +10581,16 @@ export declare class ApplicationsApi extends BaseAPI {
10516
10581
  * @param {*} [options] Override http request option.
10517
10582
  * @throws {RequiredError}
10518
10583
  */
10519
- listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
10520
- [key: string]: any;
10521
- }[], any, {}>>;
10584
+ listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
10585
+ /**
10586
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
10587
+ * @summary List available app categories
10588
+ * @param {string} [type]
10589
+ * @param {boolean} [installedOnly]
10590
+ * @param {*} [options] Override http request option.
10591
+ * @throws {RequiredError}
10592
+ */
10593
+ listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
10522
10594
  /**
10523
10595
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
10524
10596
  * @summary Load dynamic options for a setting select field
package/dist/esm/api.js CHANGED
@@ -2332,10 +2332,12 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
2332
2332
  * @param {PaginationRequest} paginationRequest
2333
2333
  * @param {string} [type]
2334
2334
  * @param {boolean} [installedOnly]
2335
+ * @param {string} [category]
2336
+ * @param {string} [subcategory]
2335
2337
  * @param {*} [options] Override http request option.
2336
2338
  * @throws {RequiredError}
2337
2339
  */
2338
- getApps: (paginationRequest_1, type_1, installedOnly_1, ...args_1) => __awaiter(this, [paginationRequest_1, type_1, installedOnly_1, ...args_1], void 0, function* (paginationRequest, type, installedOnly, options = {}) {
2340
+ getApps: (paginationRequest_1, type_1, installedOnly_1, category_1, subcategory_1, ...args_1) => __awaiter(this, [paginationRequest_1, type_1, installedOnly_1, category_1, subcategory_1, ...args_1], void 0, function* (paginationRequest, type, installedOnly, category, subcategory, options = {}) {
2339
2341
  // verify required parameter 'paginationRequest' is not null or undefined
2340
2342
  assertParamExists('getApps', 'paginationRequest', paginationRequest);
2341
2343
  const localVarPath = `/api/v2/apps/index`;
@@ -2357,6 +2359,12 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
2357
2359
  if (installedOnly !== undefined) {
2358
2360
  localVarQueryParameter['installedOnly'] = installedOnly;
2359
2361
  }
2362
+ if (category !== undefined) {
2363
+ localVarQueryParameter['category'] = category;
2364
+ }
2365
+ if (subcategory !== undefined) {
2366
+ localVarQueryParameter['subcategory'] = subcategory;
2367
+ }
2360
2368
  localVarHeaderParameter['Content-Type'] = 'application/json';
2361
2369
  localVarHeaderParameter['Accept'] = 'application/json';
2362
2370
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -2679,6 +2687,43 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
2679
2687
  options: localVarRequestOptions,
2680
2688
  };
2681
2689
  }),
2690
+ /**
2691
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
2692
+ * @summary List available app categories
2693
+ * @param {string} [type]
2694
+ * @param {boolean} [installedOnly]
2695
+ * @param {*} [options] Override http request option.
2696
+ * @throws {RequiredError}
2697
+ */
2698
+ listAvailableAppCategories: (type_1, installedOnly_1, ...args_1) => __awaiter(this, [type_1, installedOnly_1, ...args_1], void 0, function* (type, installedOnly, options = {}) {
2699
+ const localVarPath = `/api/v2/apps/categories/available`;
2700
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2701
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2702
+ let baseOptions;
2703
+ if (configuration) {
2704
+ baseOptions = configuration.baseOptions;
2705
+ }
2706
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2707
+ const localVarHeaderParameter = {};
2708
+ const localVarQueryParameter = {};
2709
+ // authentication bearerAuth required
2710
+ // http bearer authentication required
2711
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
2712
+ if (type !== undefined) {
2713
+ localVarQueryParameter['type'] = type;
2714
+ }
2715
+ if (installedOnly !== undefined) {
2716
+ localVarQueryParameter['installedOnly'] = installedOnly;
2717
+ }
2718
+ localVarHeaderParameter['Accept'] = 'application/json';
2719
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2720
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2721
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2722
+ return {
2723
+ url: toPathString(localVarUrlObj),
2724
+ options: localVarRequestOptions,
2725
+ };
2726
+ }),
2682
2727
  /**
2683
2728
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
2684
2729
  * @summary Load dynamic options for a setting select field
@@ -3295,13 +3340,15 @@ export const ApplicationsApiFp = function (configuration) {
3295
3340
  * @param {PaginationRequest} paginationRequest
3296
3341
  * @param {string} [type]
3297
3342
  * @param {boolean} [installedOnly]
3343
+ * @param {string} [category]
3344
+ * @param {string} [subcategory]
3298
3345
  * @param {*} [options] Override http request option.
3299
3346
  * @throws {RequiredError}
3300
3347
  */
3301
- getApps(paginationRequest, type, installedOnly, options) {
3348
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
3302
3349
  return __awaiter(this, void 0, void 0, function* () {
3303
3350
  var _a, _b, _c;
3304
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, options);
3351
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, category, subcategory, options);
3305
3352
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3306
3353
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ApplicationsApi.getApps']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3307
3354
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3454,6 +3501,23 @@ export const ApplicationsApiFp = function (configuration) {
3454
3501
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3455
3502
  });
3456
3503
  },
3504
+ /**
3505
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
3506
+ * @summary List available app categories
3507
+ * @param {string} [type]
3508
+ * @param {boolean} [installedOnly]
3509
+ * @param {*} [options] Override http request option.
3510
+ * @throws {RequiredError}
3511
+ */
3512
+ listAvailableAppCategories(type, installedOnly, options) {
3513
+ return __awaiter(this, void 0, void 0, function* () {
3514
+ var _a, _b, _c;
3515
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listAvailableAppCategories(type, installedOnly, options);
3516
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3517
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ApplicationsApi.listAvailableAppCategories']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3518
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3519
+ });
3520
+ },
3457
3521
  /**
3458
3522
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
3459
3523
  * @summary Load dynamic options for a setting select field
@@ -3768,11 +3832,13 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
3768
3832
  * @param {PaginationRequest} paginationRequest
3769
3833
  * @param {string} [type]
3770
3834
  * @param {boolean} [installedOnly]
3835
+ * @param {string} [category]
3836
+ * @param {string} [subcategory]
3771
3837
  * @param {*} [options] Override http request option.
3772
3838
  * @throws {RequiredError}
3773
3839
  */
3774
- getApps(paginationRequest, type, installedOnly, options) {
3775
- return localVarFp.getApps(paginationRequest, type, installedOnly, options).then((request) => request(axios, basePath));
3840
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
3841
+ return localVarFp.getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(axios, basePath));
3776
3842
  },
3777
3843
  /**
3778
3844
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
@@ -3867,6 +3933,17 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
3867
3933
  listAppCategories(options) {
3868
3934
  return localVarFp.listAppCategories(options).then((request) => request(axios, basePath));
3869
3935
  },
3936
+ /**
3937
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
3938
+ * @summary List available app categories
3939
+ * @param {string} [type]
3940
+ * @param {boolean} [installedOnly]
3941
+ * @param {*} [options] Override http request option.
3942
+ * @throws {RequiredError}
3943
+ */
3944
+ listAvailableAppCategories(type, installedOnly, options) {
3945
+ return localVarFp.listAvailableAppCategories(type, installedOnly, options).then((request) => request(axios, basePath));
3946
+ },
3870
3947
  /**
3871
3948
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
3872
3949
  * @summary Load dynamic options for a setting select field
@@ -4107,11 +4184,13 @@ export class ApplicationsApi extends BaseAPI {
4107
4184
  * @param {PaginationRequest} paginationRequest
4108
4185
  * @param {string} [type]
4109
4186
  * @param {boolean} [installedOnly]
4187
+ * @param {string} [category]
4188
+ * @param {string} [subcategory]
4110
4189
  * @param {*} [options] Override http request option.
4111
4190
  * @throws {RequiredError}
4112
4191
  */
4113
- getApps(paginationRequest, type, installedOnly, options) {
4114
- return ApplicationsApiFp(this.configuration).getApps(paginationRequest, type, installedOnly, options).then((request) => request(this.axios, this.basePath));
4192
+ getApps(paginationRequest, type, installedOnly, category, subcategory, options) {
4193
+ return ApplicationsApiFp(this.configuration).getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(this.axios, this.basePath));
4115
4194
  }
4116
4195
  /**
4117
4196
  * Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
@@ -4206,6 +4285,17 @@ export class ApplicationsApi extends BaseAPI {
4206
4285
  listAppCategories(options) {
4207
4286
  return ApplicationsApiFp(this.configuration).listAppCategories(options).then((request) => request(this.axios, this.basePath));
4208
4287
  }
4288
+ /**
4289
+ * Returns only categories and subcategories containing apps visible to the selected company. Uses the same type, installedOnly, publication and creator visibility rules as the app index. Independent of search and pagination.
4290
+ * @summary List available app categories
4291
+ * @param {string} [type]
4292
+ * @param {boolean} [installedOnly]
4293
+ * @param {*} [options] Override http request option.
4294
+ * @throws {RequiredError}
4295
+ */
4296
+ listAvailableAppCategories(type, installedOnly, options) {
4297
+ return ApplicationsApiFp(this.configuration).listAvailableAppCategories(type, installedOnly, options).then((request) => request(this.axios, this.basePath));
4298
+ }
4209
4299
  /**
4210
4300
  * Invokes the app serverless function configured on the field\'s optionsSource and returns options for SINGLE_SELECT / MULTI_SELECT fields. Uses the draft settingsSchema from the installer UI so credentials entered in other fields are available to the loader.
4211
4301
  * @summary Load dynamic options for a setting select field
@@ -0,0 +1,27 @@
1
+ # AppCategoryDTO
2
+
3
+ Predefined marketplace main category with subcategories
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **key** | **string** | Stable main category key stored on AppDetails.category | [optional] [default to undefined]
10
+ **label** | **string** | Human-readable main category label | [optional] [default to undefined]
11
+ **subcategories** | [**Array&lt;AppSubcategoryDTO&gt;**](AppSubcategoryDTO.md) | Subcategories available under this main category | [optional] [default to undefined]
12
+ **appCount** | **number** | Distinct visible apps in this category; provided by the available-category endpoint, independent of search and pagination | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { AppCategoryDTO } from '@caraer/client';
18
+
19
+ const instance: AppCategoryDTO = {
20
+ key,
21
+ label,
22
+ subcategories,
23
+ appCount,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # AppSubcategoryDTO
2
+
3
+ Predefined marketplace subcategory
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **key** | **string** | Stable subcategory key stored on AppDetails.subcategories | [optional] [default to undefined]
10
+ **label** | **string** | Human-readable subcategory label | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AppSubcategoryDTO } from '@caraer/client';
16
+
17
+ const instance: AppSubcategoryDTO = {
18
+ key,
19
+ label,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)