@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.
@@ -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<{ [key: string]: any; }> listAppCategories()
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<{ [key: string]: any; }>**
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
+ **yproperty** | **string** | | [optional] [default to undefined]
8
9
  **ymetric** | **string** | | [optional] [default to undefined]
9
10
  **xproperty** | **string** | | [optional] [default to undefined]
10
- **yproperty** | **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
+ yproperty,
23
24
  ymetric,
24
25
  xproperty,
25
- yproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
package/docs/Record.md CHANGED
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **complete** | **boolean** | | [optional] [default to undefined]
18
18
  **deleted** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
- **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
21
20
  **properties** | [**Array&lt;FilledProperty&gt;**](FilledProperty.md) | | [optional] [default to undefined]
22
21
  **objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
22
+ **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
23
23
 
24
24
  ## Example
25
25
 
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
39
39
  complete,
40
40
  deleted,
41
41
  uuid,
42
- user,
43
42
  properties,
44
43
  objects,
44
+ user,
45
45
  };
46
46
  ```
47
47
 
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
14
14
  **hidden** | **boolean** | | [optional] [default to undefined]
15
15
  **disabled** | **boolean** | | [optional] [default to undefined]
16
16
  **_options** | [**Array&lt;SettingOption&gt;**](SettingOption.md) | | [optional] [default to undefined]
17
- **defaultValue** | **any** | | [optional] [default to undefined]
18
17
  **value** | **any** | | [optional] [default to undefined]
18
+ **defaultValue** | **any** | | [optional] [default to undefined]
19
19
 
20
20
  ## Example
21
21
 
@@ -32,8 +32,8 @@ const instance: SettingField = {
32
32
  hidden,
33
33
  disabled,
34
34
  _options,
35
- defaultValue,
36
35
  value,
36
+ defaultValue,
37
37
  };
38
38
  ```
39
39
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.605",
3
+ "version": "2.0.608",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {