@caraer/client 2.0.605 → 2.0.607
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/.openapi-generator/FILES +2 -0
- package/api.ts +139 -12
- package/dist/api.d.ts +84 -16
- package/dist/api.js +97 -7
- package/dist/esm/api.d.ts +84 -16
- package/dist/esm/api.js +97 -7
- package/docs/AppCategoryDTO.md +25 -0
- package/docs/AppSubcategoryDTO.md +23 -0
- package/docs/ApplicationsApi.md +68 -3
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/SettingField.md +2 -2
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -29,6 +29,7 @@ docs/AppBarIframeSessionsApi.md
|
|
|
29
29
|
docs/AppBarTriggerRequest.md
|
|
30
30
|
docs/AppBarVisibilityEntry.md
|
|
31
31
|
docs/AppBarsApi.md
|
|
32
|
+
docs/AppCategoryDTO.md
|
|
32
33
|
docs/AppConnectionStatusDTO.md
|
|
33
34
|
docs/AppDTO.md
|
|
34
35
|
docs/AppDetailsDTO.md
|
|
@@ -48,6 +49,7 @@ docs/AppSettingFieldMappingStructureItem.md
|
|
|
48
49
|
docs/AppSettingFieldSchema.md
|
|
49
50
|
docs/AppSettingOptionsSource.md
|
|
50
51
|
docs/AppSettingsSection.md
|
|
52
|
+
docs/AppSubcategoryDTO.md
|
|
51
53
|
docs/ApplicationsApi.md
|
|
52
54
|
docs/AutomationsApi.md
|
|
53
55
|
docs/BillingApi.md
|
package/api.ts
CHANGED
|
@@ -394,6 +394,23 @@ export interface AppBarVisibilityEntry {
|
|
|
394
394
|
'suites'?: Array<string>;
|
|
395
395
|
'traits'?: Array<string>;
|
|
396
396
|
}
|
|
397
|
+
/**
|
|
398
|
+
* Predefined marketplace main category with subcategories
|
|
399
|
+
*/
|
|
400
|
+
export interface AppCategoryDTO {
|
|
401
|
+
/**
|
|
402
|
+
* Stable main category key stored on AppDetails.category
|
|
403
|
+
*/
|
|
404
|
+
'key'?: string;
|
|
405
|
+
/**
|
|
406
|
+
* Human-readable main category label
|
|
407
|
+
*/
|
|
408
|
+
'label'?: string;
|
|
409
|
+
/**
|
|
410
|
+
* Subcategories available under this main category
|
|
411
|
+
*/
|
|
412
|
+
'subcategories'?: Array<AppSubcategoryDTO>;
|
|
413
|
+
}
|
|
397
414
|
export interface AppConnectionStatusDTO {
|
|
398
415
|
'id'?: string;
|
|
399
416
|
'name'?: string;
|
|
@@ -1023,6 +1040,19 @@ export interface AppSettingsSection {
|
|
|
1023
1040
|
'subtitle'?: string;
|
|
1024
1041
|
'settings'?: Array<string>;
|
|
1025
1042
|
}
|
|
1043
|
+
/**
|
|
1044
|
+
* Predefined marketplace subcategory
|
|
1045
|
+
*/
|
|
1046
|
+
export interface AppSubcategoryDTO {
|
|
1047
|
+
/**
|
|
1048
|
+
* Stable subcategory key stored on AppDetails.subcategories
|
|
1049
|
+
*/
|
|
1050
|
+
'key'?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Human-readable subcategory label
|
|
1053
|
+
*/
|
|
1054
|
+
'label'?: string;
|
|
1055
|
+
}
|
|
1026
1056
|
/**
|
|
1027
1057
|
* The billing settings of the company.
|
|
1028
1058
|
*/
|
|
@@ -2779,9 +2809,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2779
2809
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2780
2810
|
|
|
2781
2811
|
export interface ExistingWidgetSummary {
|
|
2782
|
-
'ymetric'?: string;
|
|
2783
|
-
'xproperty'?: string;
|
|
2784
2812
|
'yproperty'?: string;
|
|
2813
|
+
'xproperty'?: string;
|
|
2814
|
+
'ymetric'?: string;
|
|
2785
2815
|
'title'?: string;
|
|
2786
2816
|
'chartType'?: string;
|
|
2787
2817
|
'xProperty'?: string;
|
|
@@ -5904,8 +5934,8 @@ export interface SettingField {
|
|
|
5904
5934
|
'hidden'?: boolean;
|
|
5905
5935
|
'disabled'?: boolean;
|
|
5906
5936
|
'options'?: Array<SettingOption>;
|
|
5907
|
-
'defaultValue'?: any;
|
|
5908
5937
|
'value'?: any;
|
|
5938
|
+
'defaultValue'?: any;
|
|
5909
5939
|
}
|
|
5910
5940
|
|
|
5911
5941
|
export const SettingFieldTypeEnum = {
|
|
@@ -10767,10 +10797,12 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
10767
10797
|
* @param {PaginationRequest} paginationRequest
|
|
10768
10798
|
* @param {string} [type]
|
|
10769
10799
|
* @param {boolean} [installedOnly]
|
|
10800
|
+
* @param {string} [category]
|
|
10801
|
+
* @param {string} [subcategory]
|
|
10770
10802
|
* @param {*} [options] Override http request option.
|
|
10771
10803
|
* @throws {RequiredError}
|
|
10772
10804
|
*/
|
|
10773
|
-
getApps: async (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10805
|
+
getApps: async (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10774
10806
|
// verify required parameter 'paginationRequest' is not null or undefined
|
|
10775
10807
|
assertParamExists('getApps', 'paginationRequest', paginationRequest)
|
|
10776
10808
|
const localVarPath = `/api/v2/apps/index`;
|
|
@@ -10797,6 +10829,14 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
10797
10829
|
localVarQueryParameter['installedOnly'] = installedOnly;
|
|
10798
10830
|
}
|
|
10799
10831
|
|
|
10832
|
+
if (category !== undefined) {
|
|
10833
|
+
localVarQueryParameter['category'] = category;
|
|
10834
|
+
}
|
|
10835
|
+
|
|
10836
|
+
if (subcategory !== undefined) {
|
|
10837
|
+
localVarQueryParameter['subcategory'] = subcategory;
|
|
10838
|
+
}
|
|
10839
|
+
|
|
10800
10840
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10801
10841
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
10802
10842
|
|
|
@@ -11169,6 +11209,50 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
11169
11209
|
options: localVarRequestOptions,
|
|
11170
11210
|
};
|
|
11171
11211
|
},
|
|
11212
|
+
/**
|
|
11213
|
+
* 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.
|
|
11214
|
+
* @summary List available app categories
|
|
11215
|
+
* @param {string} [type]
|
|
11216
|
+
* @param {boolean} [installedOnly]
|
|
11217
|
+
* @param {*} [options] Override http request option.
|
|
11218
|
+
* @throws {RequiredError}
|
|
11219
|
+
*/
|
|
11220
|
+
listAvailableAppCategories: async (type?: string, installedOnly?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11221
|
+
const localVarPath = `/api/v2/apps/categories/available`;
|
|
11222
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11223
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11224
|
+
let baseOptions;
|
|
11225
|
+
if (configuration) {
|
|
11226
|
+
baseOptions = configuration.baseOptions;
|
|
11227
|
+
}
|
|
11228
|
+
|
|
11229
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11230
|
+
const localVarHeaderParameter = {} as any;
|
|
11231
|
+
const localVarQueryParameter = {} as any;
|
|
11232
|
+
|
|
11233
|
+
// authentication bearerAuth required
|
|
11234
|
+
// http bearer authentication required
|
|
11235
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11236
|
+
|
|
11237
|
+
if (type !== undefined) {
|
|
11238
|
+
localVarQueryParameter['type'] = type;
|
|
11239
|
+
}
|
|
11240
|
+
|
|
11241
|
+
if (installedOnly !== undefined) {
|
|
11242
|
+
localVarQueryParameter['installedOnly'] = installedOnly;
|
|
11243
|
+
}
|
|
11244
|
+
|
|
11245
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11246
|
+
|
|
11247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11249
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11250
|
+
|
|
11251
|
+
return {
|
|
11252
|
+
url: toPathString(localVarUrlObj),
|
|
11253
|
+
options: localVarRequestOptions,
|
|
11254
|
+
};
|
|
11255
|
+
},
|
|
11172
11256
|
/**
|
|
11173
11257
|
* 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.
|
|
11174
11258
|
* @summary Load dynamic options for a setting select field
|
|
@@ -11820,11 +11904,13 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
|
|
|
11820
11904
|
* @param {PaginationRequest} paginationRequest
|
|
11821
11905
|
* @param {string} [type]
|
|
11822
11906
|
* @param {boolean} [installedOnly]
|
|
11907
|
+
* @param {string} [category]
|
|
11908
|
+
* @param {string} [subcategory]
|
|
11823
11909
|
* @param {*} [options] Override http request option.
|
|
11824
11910
|
* @throws {RequiredError}
|
|
11825
11911
|
*/
|
|
11826
|
-
async getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>> {
|
|
11827
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, options);
|
|
11912
|
+
async getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>> {
|
|
11913
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getApps(paginationRequest, type, installedOnly, category, subcategory, options);
|
|
11828
11914
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11829
11915
|
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.getApps']?.[localVarOperationServerIndex]?.url;
|
|
11830
11916
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11943,12 +12029,26 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
|
|
|
11943
12029
|
* @param {*} [options] Override http request option.
|
|
11944
12030
|
* @throws {RequiredError}
|
|
11945
12031
|
*/
|
|
11946
|
-
async listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
12032
|
+
async listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>> {
|
|
11947
12033
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listAppCategories(options);
|
|
11948
12034
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11949
12035
|
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.listAppCategories']?.[localVarOperationServerIndex]?.url;
|
|
11950
12036
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11951
12037
|
},
|
|
12038
|
+
/**
|
|
12039
|
+
* 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.
|
|
12040
|
+
* @summary List available app categories
|
|
12041
|
+
* @param {string} [type]
|
|
12042
|
+
* @param {boolean} [installedOnly]
|
|
12043
|
+
* @param {*} [options] Override http request option.
|
|
12044
|
+
* @throws {RequiredError}
|
|
12045
|
+
*/
|
|
12046
|
+
async listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>> {
|
|
12047
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAppCategories(type, installedOnly, options);
|
|
12048
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12049
|
+
const localVarOperationServerBasePath = operationServerMap['ApplicationsApi.listAvailableAppCategories']?.[localVarOperationServerIndex]?.url;
|
|
12050
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12051
|
+
},
|
|
11952
12052
|
/**
|
|
11953
12053
|
* 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.
|
|
11954
12054
|
* @summary Load dynamic options for a setting select field
|
|
@@ -12228,11 +12328,13 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
|
|
|
12228
12328
|
* @param {PaginationRequest} paginationRequest
|
|
12229
12329
|
* @param {string} [type]
|
|
12230
12330
|
* @param {boolean} [installedOnly]
|
|
12331
|
+
* @param {string} [category]
|
|
12332
|
+
* @param {string} [subcategory]
|
|
12231
12333
|
* @param {*} [options] Override http request option.
|
|
12232
12334
|
* @throws {RequiredError}
|
|
12233
12335
|
*/
|
|
12234
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO> {
|
|
12235
|
-
return localVarFp.getApps(paginationRequest, type, installedOnly, options).then((request) => request(axios, basePath));
|
|
12336
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO> {
|
|
12337
|
+
return localVarFp.getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(axios, basePath));
|
|
12236
12338
|
},
|
|
12237
12339
|
/**
|
|
12238
12340
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
@@ -12324,9 +12426,20 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
|
|
|
12324
12426
|
* @param {*} [options] Override http request option.
|
|
12325
12427
|
* @throws {RequiredError}
|
|
12326
12428
|
*/
|
|
12327
|
-
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
12429
|
+
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>> {
|
|
12328
12430
|
return localVarFp.listAppCategories(options).then((request) => request(axios, basePath));
|
|
12329
12431
|
},
|
|
12432
|
+
/**
|
|
12433
|
+
* 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.
|
|
12434
|
+
* @summary List available app categories
|
|
12435
|
+
* @param {string} [type]
|
|
12436
|
+
* @param {boolean} [installedOnly]
|
|
12437
|
+
* @param {*} [options] Override http request option.
|
|
12438
|
+
* @throws {RequiredError}
|
|
12439
|
+
*/
|
|
12440
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>> {
|
|
12441
|
+
return localVarFp.listAvailableAppCategories(type, installedOnly, options).then((request) => request(axios, basePath));
|
|
12442
|
+
},
|
|
12330
12443
|
/**
|
|
12331
12444
|
* 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.
|
|
12332
12445
|
* @summary Load dynamic options for a setting select field
|
|
@@ -12577,11 +12690,13 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
12577
12690
|
* @param {PaginationRequest} paginationRequest
|
|
12578
12691
|
* @param {string} [type]
|
|
12579
12692
|
* @param {boolean} [installedOnly]
|
|
12693
|
+
* @param {string} [category]
|
|
12694
|
+
* @param {string} [subcategory]
|
|
12580
12695
|
* @param {*} [options] Override http request option.
|
|
12581
12696
|
* @throws {RequiredError}
|
|
12582
12697
|
*/
|
|
12583
|
-
public getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) {
|
|
12584
|
-
return ApplicationsApiFp(this.configuration).getApps(paginationRequest, type, installedOnly, options).then((request) => request(this.axios, this.basePath));
|
|
12698
|
+
public getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig) {
|
|
12699
|
+
return ApplicationsApiFp(this.configuration).getApps(paginationRequest, type, installedOnly, category, subcategory, options).then((request) => request(this.axios, this.basePath));
|
|
12585
12700
|
}
|
|
12586
12701
|
|
|
12587
12702
|
/**
|
|
@@ -12686,6 +12801,18 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
12686
12801
|
return ApplicationsApiFp(this.configuration).listAppCategories(options).then((request) => request(this.axios, this.basePath));
|
|
12687
12802
|
}
|
|
12688
12803
|
|
|
12804
|
+
/**
|
|
12805
|
+
* 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.
|
|
12806
|
+
* @summary List available app categories
|
|
12807
|
+
* @param {string} [type]
|
|
12808
|
+
* @param {boolean} [installedOnly]
|
|
12809
|
+
* @param {*} [options] Override http request option.
|
|
12810
|
+
* @throws {RequiredError}
|
|
12811
|
+
*/
|
|
12812
|
+
public listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) {
|
|
12813
|
+
return ApplicationsApiFp(this.configuration).listAvailableAppCategories(type, installedOnly, options).then((request) => request(this.axios, this.basePath));
|
|
12814
|
+
}
|
|
12815
|
+
|
|
12689
12816
|
/**
|
|
12690
12817
|
* 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.
|
|
12691
12818
|
* @summary Load dynamic options for a setting select field
|
package/dist/api.d.ts
CHANGED
|
@@ -387,6 +387,23 @@ 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
|
+
}
|
|
390
407
|
export interface AppConnectionStatusDTO {
|
|
391
408
|
'id'?: string;
|
|
392
409
|
'name'?: string;
|
|
@@ -1013,6 +1030,19 @@ export interface AppSettingsSection {
|
|
|
1013
1030
|
'subtitle'?: string;
|
|
1014
1031
|
'settings'?: Array<string>;
|
|
1015
1032
|
}
|
|
1033
|
+
/**
|
|
1034
|
+
* Predefined marketplace subcategory
|
|
1035
|
+
*/
|
|
1036
|
+
export interface AppSubcategoryDTO {
|
|
1037
|
+
/**
|
|
1038
|
+
* Stable subcategory key stored on AppDetails.subcategories
|
|
1039
|
+
*/
|
|
1040
|
+
'key'?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Human-readable subcategory label
|
|
1043
|
+
*/
|
|
1044
|
+
'label'?: string;
|
|
1045
|
+
}
|
|
1016
1046
|
/**
|
|
1017
1047
|
* The billing settings of the company.
|
|
1018
1048
|
*/
|
|
@@ -2772,9 +2802,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2772
2802
|
};
|
|
2773
2803
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2774
2804
|
export interface ExistingWidgetSummary {
|
|
2775
|
-
'ymetric'?: string;
|
|
2776
|
-
'xproperty'?: string;
|
|
2777
2805
|
'yproperty'?: string;
|
|
2806
|
+
'xproperty'?: string;
|
|
2807
|
+
'ymetric'?: string;
|
|
2778
2808
|
'title'?: string;
|
|
2779
2809
|
'chartType'?: string;
|
|
2780
2810
|
'xProperty'?: string;
|
|
@@ -5957,8 +5987,8 @@ export interface SettingField {
|
|
|
5957
5987
|
'hidden'?: boolean;
|
|
5958
5988
|
'disabled'?: boolean;
|
|
5959
5989
|
'options'?: Array<SettingOption>;
|
|
5960
|
-
'defaultValue'?: any;
|
|
5961
5990
|
'value'?: any;
|
|
5991
|
+
'defaultValue'?: any;
|
|
5962
5992
|
}
|
|
5963
5993
|
export declare const SettingFieldTypeEnum: {
|
|
5964
5994
|
readonly String: "STRING";
|
|
@@ -9588,10 +9618,12 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9588
9618
|
* @param {PaginationRequest} paginationRequest
|
|
9589
9619
|
* @param {string} [type]
|
|
9590
9620
|
* @param {boolean} [installedOnly]
|
|
9621
|
+
* @param {string} [category]
|
|
9622
|
+
* @param {string} [subcategory]
|
|
9591
9623
|
* @param {*} [options] Override http request option.
|
|
9592
9624
|
* @throws {RequiredError}
|
|
9593
9625
|
*/
|
|
9594
|
-
getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9626
|
+
getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9595
9627
|
/**
|
|
9596
9628
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
9597
9629
|
* @summary Get current user\'s company information
|
|
@@ -9667,6 +9699,15 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9667
9699
|
* @throws {RequiredError}
|
|
9668
9700
|
*/
|
|
9669
9701
|
listAppCategories: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9702
|
+
/**
|
|
9703
|
+
* 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.
|
|
9704
|
+
* @summary List available app categories
|
|
9705
|
+
* @param {string} [type]
|
|
9706
|
+
* @param {boolean} [installedOnly]
|
|
9707
|
+
* @param {*} [options] Override http request option.
|
|
9708
|
+
* @throws {RequiredError}
|
|
9709
|
+
*/
|
|
9710
|
+
listAvailableAppCategories: (type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9670
9711
|
/**
|
|
9671
9712
|
* 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
9713
|
* @summary Load dynamic options for a setting select field
|
|
@@ -9864,10 +9905,12 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9864
9905
|
* @param {PaginationRequest} paginationRequest
|
|
9865
9906
|
* @param {string} [type]
|
|
9866
9907
|
* @param {boolean} [installedOnly]
|
|
9908
|
+
* @param {string} [category]
|
|
9909
|
+
* @param {string} [subcategory]
|
|
9867
9910
|
* @param {*} [options] Override http request option.
|
|
9868
9911
|
* @throws {RequiredError}
|
|
9869
9912
|
*/
|
|
9870
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
|
|
9913
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
|
|
9871
9914
|
/**
|
|
9872
9915
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
9873
9916
|
* @summary Get current user\'s company information
|
|
@@ -9948,9 +9991,16 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9948
9991
|
* @param {*} [options] Override http request option.
|
|
9949
9992
|
* @throws {RequiredError}
|
|
9950
9993
|
*/
|
|
9951
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
9952
|
-
|
|
9953
|
-
|
|
9994
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
|
|
9995
|
+
/**
|
|
9996
|
+
* 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.
|
|
9997
|
+
* @summary List available app categories
|
|
9998
|
+
* @param {string} [type]
|
|
9999
|
+
* @param {boolean} [installedOnly]
|
|
10000
|
+
* @param {*} [options] Override http request option.
|
|
10001
|
+
* @throws {RequiredError}
|
|
10002
|
+
*/
|
|
10003
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
|
|
9954
10004
|
/**
|
|
9955
10005
|
* 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
10006
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10148,10 +10198,12 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
10148
10198
|
* @param {PaginationRequest} paginationRequest
|
|
10149
10199
|
* @param {string} [type]
|
|
10150
10200
|
* @param {boolean} [installedOnly]
|
|
10201
|
+
* @param {string} [category]
|
|
10202
|
+
* @param {string} [subcategory]
|
|
10151
10203
|
* @param {*} [options] Override http request option.
|
|
10152
10204
|
* @throws {RequiredError}
|
|
10153
10205
|
*/
|
|
10154
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
|
|
10206
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
|
|
10155
10207
|
/**
|
|
10156
10208
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10157
10209
|
* @summary Get current user\'s company information
|
|
@@ -10232,9 +10284,16 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
10232
10284
|
* @param {*} [options] Override http request option.
|
|
10233
10285
|
* @throws {RequiredError}
|
|
10234
10286
|
*/
|
|
10235
|
-
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
10236
|
-
|
|
10237
|
-
|
|
10287
|
+
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
|
|
10288
|
+
/**
|
|
10289
|
+
* 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.
|
|
10290
|
+
* @summary List available app categories
|
|
10291
|
+
* @param {string} [type]
|
|
10292
|
+
* @param {boolean} [installedOnly]
|
|
10293
|
+
* @param {*} [options] Override http request option.
|
|
10294
|
+
* @throws {RequiredError}
|
|
10295
|
+
*/
|
|
10296
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
|
|
10238
10297
|
/**
|
|
10239
10298
|
* 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
10299
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10432,10 +10491,12 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10432
10491
|
* @param {PaginationRequest} paginationRequest
|
|
10433
10492
|
* @param {string} [type]
|
|
10434
10493
|
* @param {boolean} [installedOnly]
|
|
10494
|
+
* @param {string} [category]
|
|
10495
|
+
* @param {string} [subcategory]
|
|
10435
10496
|
* @param {*} [options] Override http request option.
|
|
10436
10497
|
* @throws {RequiredError}
|
|
10437
10498
|
*/
|
|
10438
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10499
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10439
10500
|
/**
|
|
10440
10501
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10441
10502
|
* @summary Get current user\'s company information
|
|
@@ -10516,9 +10577,16 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10516
10577
|
* @param {*} [options] Override http request option.
|
|
10517
10578
|
* @throws {RequiredError}
|
|
10518
10579
|
*/
|
|
10519
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
10520
|
-
|
|
10521
|
-
|
|
10580
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10581
|
+
/**
|
|
10582
|
+
* 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.
|
|
10583
|
+
* @summary List available app categories
|
|
10584
|
+
* @param {string} [type]
|
|
10585
|
+
* @param {boolean} [installedOnly]
|
|
10586
|
+
* @param {*} [options] Override http request option.
|
|
10587
|
+
* @throws {RequiredError}
|
|
10588
|
+
*/
|
|
10589
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10522
10590
|
/**
|
|
10523
10591
|
* 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
10592
|
* @summary Load dynamic options for a setting select field
|
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,23 @@ 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
|
+
}
|
|
390
407
|
export interface AppConnectionStatusDTO {
|
|
391
408
|
'id'?: string;
|
|
392
409
|
'name'?: string;
|
|
@@ -1013,6 +1030,19 @@ export interface AppSettingsSection {
|
|
|
1013
1030
|
'subtitle'?: string;
|
|
1014
1031
|
'settings'?: Array<string>;
|
|
1015
1032
|
}
|
|
1033
|
+
/**
|
|
1034
|
+
* Predefined marketplace subcategory
|
|
1035
|
+
*/
|
|
1036
|
+
export interface AppSubcategoryDTO {
|
|
1037
|
+
/**
|
|
1038
|
+
* Stable subcategory key stored on AppDetails.subcategories
|
|
1039
|
+
*/
|
|
1040
|
+
'key'?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Human-readable subcategory label
|
|
1043
|
+
*/
|
|
1044
|
+
'label'?: string;
|
|
1045
|
+
}
|
|
1016
1046
|
/**
|
|
1017
1047
|
* The billing settings of the company.
|
|
1018
1048
|
*/
|
|
@@ -2772,9 +2802,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2772
2802
|
};
|
|
2773
2803
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2774
2804
|
export interface ExistingWidgetSummary {
|
|
2775
|
-
'ymetric'?: string;
|
|
2776
|
-
'xproperty'?: string;
|
|
2777
2805
|
'yproperty'?: string;
|
|
2806
|
+
'xproperty'?: string;
|
|
2807
|
+
'ymetric'?: string;
|
|
2778
2808
|
'title'?: string;
|
|
2779
2809
|
'chartType'?: string;
|
|
2780
2810
|
'xProperty'?: string;
|
|
@@ -5957,8 +5987,8 @@ export interface SettingField {
|
|
|
5957
5987
|
'hidden'?: boolean;
|
|
5958
5988
|
'disabled'?: boolean;
|
|
5959
5989
|
'options'?: Array<SettingOption>;
|
|
5960
|
-
'defaultValue'?: any;
|
|
5961
5990
|
'value'?: any;
|
|
5991
|
+
'defaultValue'?: any;
|
|
5962
5992
|
}
|
|
5963
5993
|
export declare const SettingFieldTypeEnum: {
|
|
5964
5994
|
readonly String: "STRING";
|
|
@@ -9588,10 +9618,12 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9588
9618
|
* @param {PaginationRequest} paginationRequest
|
|
9589
9619
|
* @param {string} [type]
|
|
9590
9620
|
* @param {boolean} [installedOnly]
|
|
9621
|
+
* @param {string} [category]
|
|
9622
|
+
* @param {string} [subcategory]
|
|
9591
9623
|
* @param {*} [options] Override http request option.
|
|
9592
9624
|
* @throws {RequiredError}
|
|
9593
9625
|
*/
|
|
9594
|
-
getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9626
|
+
getApps: (paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9595
9627
|
/**
|
|
9596
9628
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
9597
9629
|
* @summary Get current user\'s company information
|
|
@@ -9667,6 +9699,15 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
9667
9699
|
* @throws {RequiredError}
|
|
9668
9700
|
*/
|
|
9669
9701
|
listAppCategories: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9702
|
+
/**
|
|
9703
|
+
* 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.
|
|
9704
|
+
* @summary List available app categories
|
|
9705
|
+
* @param {string} [type]
|
|
9706
|
+
* @param {boolean} [installedOnly]
|
|
9707
|
+
* @param {*} [options] Override http request option.
|
|
9708
|
+
* @throws {RequiredError}
|
|
9709
|
+
*/
|
|
9710
|
+
listAvailableAppCategories: (type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9670
9711
|
/**
|
|
9671
9712
|
* 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
9713
|
* @summary Load dynamic options for a setting select field
|
|
@@ -9864,10 +9905,12 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9864
9905
|
* @param {PaginationRequest} paginationRequest
|
|
9865
9906
|
* @param {string} [type]
|
|
9866
9907
|
* @param {boolean} [installedOnly]
|
|
9908
|
+
* @param {string} [category]
|
|
9909
|
+
* @param {string} [subcategory]
|
|
9867
9910
|
* @param {*} [options] Override http request option.
|
|
9868
9911
|
* @throws {RequiredError}
|
|
9869
9912
|
*/
|
|
9870
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
|
|
9913
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAppDTO>>;
|
|
9871
9914
|
/**
|
|
9872
9915
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
9873
9916
|
* @summary Get current user\'s company information
|
|
@@ -9948,9 +9991,16 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
|
|
|
9948
9991
|
* @param {*} [options] Override http request option.
|
|
9949
9992
|
* @throws {RequiredError}
|
|
9950
9993
|
*/
|
|
9951
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
9952
|
-
|
|
9953
|
-
|
|
9994
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
|
|
9995
|
+
/**
|
|
9996
|
+
* 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.
|
|
9997
|
+
* @summary List available app categories
|
|
9998
|
+
* @param {string} [type]
|
|
9999
|
+
* @param {boolean} [installedOnly]
|
|
10000
|
+
* @param {*} [options] Override http request option.
|
|
10001
|
+
* @throws {RequiredError}
|
|
10002
|
+
*/
|
|
10003
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppCategoryDTO>>>;
|
|
9954
10004
|
/**
|
|
9955
10005
|
* 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
10006
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10148,10 +10198,12 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
10148
10198
|
* @param {PaginationRequest} paginationRequest
|
|
10149
10199
|
* @param {string} [type]
|
|
10150
10200
|
* @param {boolean} [installedOnly]
|
|
10201
|
+
* @param {string} [category]
|
|
10202
|
+
* @param {string} [subcategory]
|
|
10151
10203
|
* @param {*} [options] Override http request option.
|
|
10152
10204
|
* @throws {RequiredError}
|
|
10153
10205
|
*/
|
|
10154
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
|
|
10206
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAppDTO>;
|
|
10155
10207
|
/**
|
|
10156
10208
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10157
10209
|
* @summary Get current user\'s company information
|
|
@@ -10232,9 +10284,16 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
|
|
|
10232
10284
|
* @param {*} [options] Override http request option.
|
|
10233
10285
|
* @throws {RequiredError}
|
|
10234
10286
|
*/
|
|
10235
|
-
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
10236
|
-
|
|
10237
|
-
|
|
10287
|
+
listAppCategories(options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
|
|
10288
|
+
/**
|
|
10289
|
+
* 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.
|
|
10290
|
+
* @summary List available app categories
|
|
10291
|
+
* @param {string} [type]
|
|
10292
|
+
* @param {boolean} [installedOnly]
|
|
10293
|
+
* @param {*} [options] Override http request option.
|
|
10294
|
+
* @throws {RequiredError}
|
|
10295
|
+
*/
|
|
10296
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<AppCategoryDTO>>;
|
|
10238
10297
|
/**
|
|
10239
10298
|
* 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
10299
|
* @summary Load dynamic options for a setting select field
|
|
@@ -10432,10 +10491,12 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10432
10491
|
* @param {PaginationRequest} paginationRequest
|
|
10433
10492
|
* @param {string} [type]
|
|
10434
10493
|
* @param {boolean} [installedOnly]
|
|
10494
|
+
* @param {string} [category]
|
|
10495
|
+
* @param {string} [subcategory]
|
|
10435
10496
|
* @param {*} [options] Override http request option.
|
|
10436
10497
|
* @throws {RequiredError}
|
|
10437
10498
|
*/
|
|
10438
|
-
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10499
|
+
getApps(paginationRequest: PaginationRequest, type?: string, installedOnly?: boolean, category?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAppDTO, any, {}>>;
|
|
10439
10500
|
/**
|
|
10440
10501
|
* Retrieves the company information of the authenticated user. The response includes public details of the user\'s selected company.
|
|
10441
10502
|
* @summary Get current user\'s company information
|
|
@@ -10516,9 +10577,16 @@ export declare class ApplicationsApi extends BaseAPI {
|
|
|
10516
10577
|
* @param {*} [options] Override http request option.
|
|
10517
10578
|
* @throws {RequiredError}
|
|
10518
10579
|
*/
|
|
10519
|
-
listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
10520
|
-
|
|
10521
|
-
|
|
10580
|
+
listAppCategories(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10581
|
+
/**
|
|
10582
|
+
* 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.
|
|
10583
|
+
* @summary List available app categories
|
|
10584
|
+
* @param {string} [type]
|
|
10585
|
+
* @param {boolean} [installedOnly]
|
|
10586
|
+
* @param {*} [options] Override http request option.
|
|
10587
|
+
* @throws {RequiredError}
|
|
10588
|
+
*/
|
|
10589
|
+
listAvailableAppCategories(type?: string, installedOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppCategoryDTO[], any, {}>>;
|
|
10522
10590
|
/**
|
|
10523
10591
|
* 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
10592
|
* @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,25 @@
|
|
|
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<AppSubcategoryDTO>**](AppSubcategoryDTO.md) | Subcategories available under this main category | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AppCategoryDTO } from '@caraer/client';
|
|
17
|
+
|
|
18
|
+
const instance: AppCategoryDTO = {
|
|
19
|
+
key,
|
|
20
|
+
label,
|
|
21
|
+
subcategories,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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)
|
package/docs/ApplicationsApi.md
CHANGED
|
@@ -23,6 +23,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
23
23
|
|[**getWebhookPropertyTopics**](#getwebhookpropertytopics) | **GET** /api/v2/apps/{appUuid}/webhooks/property-topics | Get webhook property topic options|
|
|
24
24
|
|[**installApp**](#installapp) | **POST** /api/v2/apps/{uuid}/install | Install an application|
|
|
25
25
|
|[**listAppCategories**](#listappcategories) | **GET** /api/v2/apps/categories | List predefined marketplace app categories|
|
|
26
|
+
|[**listAvailableAppCategories**](#listavailableappcategories) | **GET** /api/v2/apps/categories/available | List available app categories|
|
|
26
27
|
|[**loadSettingOptions**](#loadsettingoptions) | **POST** /api/v2/apps/{uuid}/settings-schema/options | Load dynamic options for a setting select field|
|
|
27
28
|
|[**migrateToV2**](#migratetov2) | **POST** /api/v2/apps/{uuid}/migrate-v2 | Migrate an app from platform V1 to V2|
|
|
28
29
|
|[**reviewPublicApp**](#reviewpublicapp) | **POST** /api/v2/apps/public/{uuid}/review | Review a public app|
|
|
@@ -575,11 +576,15 @@ const apiInstance = new ApplicationsApi(configuration);
|
|
|
575
576
|
let paginationRequest: PaginationRequest; //
|
|
576
577
|
let type: string; // (optional) (default to '')
|
|
577
578
|
let installedOnly: boolean; // (optional) (default to false)
|
|
579
|
+
let category: string; // (optional) (default to undefined)
|
|
580
|
+
let subcategory: string; // (optional) (default to undefined)
|
|
578
581
|
|
|
579
582
|
const { status, data } = await apiInstance.getApps(
|
|
580
583
|
paginationRequest,
|
|
581
584
|
type,
|
|
582
|
-
installedOnly
|
|
585
|
+
installedOnly,
|
|
586
|
+
category,
|
|
587
|
+
subcategory
|
|
583
588
|
);
|
|
584
589
|
```
|
|
585
590
|
|
|
@@ -590,6 +595,8 @@ const { status, data } = await apiInstance.getApps(
|
|
|
590
595
|
| **paginationRequest** | **PaginationRequest**| | |
|
|
591
596
|
| **type** | [**string**] | | (optional) defaults to ''|
|
|
592
597
|
| **installedOnly** | [**boolean**] | | (optional) defaults to false|
|
|
598
|
+
| **category** | [**string**] | | (optional) defaults to undefined|
|
|
599
|
+
| **subcategory** | [**string**] | | (optional) defaults to undefined|
|
|
593
600
|
|
|
594
601
|
|
|
595
602
|
### Return type
|
|
@@ -1074,7 +1081,7 @@ const { status, data } = await apiInstance.installApp(
|
|
|
1074
1081
|
[[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)
|
|
1075
1082
|
|
|
1076
1083
|
# **listAppCategories**
|
|
1077
|
-
> Array<
|
|
1084
|
+
> Array<AppCategoryDTO> listAppCategories()
|
|
1078
1085
|
|
|
1079
1086
|
Returns the allowed category keys and labels for public app marketplace listings.
|
|
1080
1087
|
|
|
@@ -1098,7 +1105,7 @@ This endpoint does not have any parameters.
|
|
|
1098
1105
|
|
|
1099
1106
|
### Return type
|
|
1100
1107
|
|
|
1101
|
-
**Array<
|
|
1108
|
+
**Array<AppCategoryDTO>**
|
|
1102
1109
|
|
|
1103
1110
|
### Authorization
|
|
1104
1111
|
|
|
@@ -1121,6 +1128,64 @@ This endpoint does not have any parameters.
|
|
|
1121
1128
|
|
|
1122
1129
|
[[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)
|
|
1123
1130
|
|
|
1131
|
+
# **listAvailableAppCategories**
|
|
1132
|
+
> Array<AppCategoryDTO> listAvailableAppCategories()
|
|
1133
|
+
|
|
1134
|
+
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.
|
|
1135
|
+
|
|
1136
|
+
### Example
|
|
1137
|
+
|
|
1138
|
+
```typescript
|
|
1139
|
+
import {
|
|
1140
|
+
ApplicationsApi,
|
|
1141
|
+
Configuration
|
|
1142
|
+
} from '@caraer/client';
|
|
1143
|
+
|
|
1144
|
+
const configuration = new Configuration();
|
|
1145
|
+
const apiInstance = new ApplicationsApi(configuration);
|
|
1146
|
+
|
|
1147
|
+
let type: string; // (optional) (default to '')
|
|
1148
|
+
let installedOnly: boolean; // (optional) (default to false)
|
|
1149
|
+
|
|
1150
|
+
const { status, data } = await apiInstance.listAvailableAppCategories(
|
|
1151
|
+
type,
|
|
1152
|
+
installedOnly
|
|
1153
|
+
);
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
### Parameters
|
|
1157
|
+
|
|
1158
|
+
|Name | Type | Description | Notes|
|
|
1159
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1160
|
+
| **type** | [**string**] | | (optional) defaults to ''|
|
|
1161
|
+
| **installedOnly** | [**boolean**] | | (optional) defaults to false|
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
### Return type
|
|
1165
|
+
|
|
1166
|
+
**Array<AppCategoryDTO>**
|
|
1167
|
+
|
|
1168
|
+
### Authorization
|
|
1169
|
+
|
|
1170
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1171
|
+
|
|
1172
|
+
### HTTP request headers
|
|
1173
|
+
|
|
1174
|
+
- **Content-Type**: Not defined
|
|
1175
|
+
- **Accept**: application/json
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
### HTTP response details
|
|
1179
|
+
| Status code | Description | Response headers |
|
|
1180
|
+
|-------------|-------------|------------------|
|
|
1181
|
+
|**200** | OK | - |
|
|
1182
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1183
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1184
|
+
|**404** | The requested resource was not found. | - |
|
|
1185
|
+
|**500** | An internal server error occurred. | - |
|
|
1186
|
+
|
|
1187
|
+
[[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)
|
|
1188
|
+
|
|
1124
1189
|
# **loadSettingOptions**
|
|
1125
1190
|
> ShowResponseLoadAppSettingOptionsResponse loadSettingOptions(loadAppSettingOptionsRequest)
|
|
1126
1191
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
8
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**ymetric** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
ymetric,
|
|
24
|
-
xproperty,
|
|
25
23
|
yproperty,
|
|
24
|
+
xproperty,
|
|
25
|
+
ymetric,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**value** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
defaultValue,
|
|
36
35
|
value,
|
|
36
|
+
defaultValue,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|