Skip to content

Commit c0f51f5

Browse files
committed
regenerated ce/pe clients
1 parent 9506b99 commit c0f51f5

File tree

61 files changed

+5998
-6933
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+5998
-6933
lines changed

ce/docs/AdminControllerApi.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
| [**autoCommitSettingsExists**](#autoCommitSettingsExists) | **GET** /api/admin/autoCommitSettings/exists | Check auto commit settings exists (autoCommitSettingsExists) |
66
| [**checkRepositoryAccess**](#checkRepositoryAccess) | **POST** /api/admin/repositorySettings/checkAccess | Check repository access (checkRepositoryAccess) |
77
| [**checkUpdates**](#checkUpdates) | **GET** /api/admin/updates | Check for new Platform Releases (checkUpdates) |
8-
| [**codeProcessingUrl**](#codeProcessingUrl) | **GET** /api/admin/mail/oauth2/code | codeProcessingUrl |
98
| [**deleteAutoCommitSettings**](#deleteAutoCommitSettings) | **DELETE** /api/admin/autoCommitSettings | Delete auto commit settings (deleteAutoCommitSettings) |
109
| [**deleteRepositorySettings**](#deleteRepositorySettings) | **DELETE** /api/admin/repositorySettings | Delete repository settings (deleteRepositorySettings) |
1110
| [**getAdminSettings**](#getAdminSettings) | **GET** /api/admin/settings/{key} | Get the Administration Settings object using key (getAdminSettings) |
12-
| [**getAuthorizationUrl**](#getAuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
1311
| [**getAutoCommitSettings**](#getAutoCommitSettings) | **GET** /api/admin/autoCommitSettings | Get auto commit settings (getAutoCommitSettings) |
1412
| [**getFeaturesInfo**](#getFeaturesInfo) | **GET** /api/admin/featuresInfo | Get features info (getFeaturesInfo) |
1513
| [**getJwtSettings**](#getJwtSettings) | **GET** /api/admin/jwtSettings | Get the JWT Settings object (getJwtSettings) |
16-
| [**getMailProcessingUrl**](#getMailProcessingUrl) | **GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailProcessingUrl) |
14+
| [**getMailOAuth2AuthorizationUrl**](#getMailOAuth2AuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
15+
| [**getMailOAuth2RedirectUri**](#getMailOAuth2RedirectUri) | **GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailOAuth2RedirectUri) |
1716
| [**getRepositorySettings**](#getRepositorySettings) | **GET** /api/admin/repositorySettings | Get repository settings (getRepositorySettings) |
1817
| [**getRepositorySettingsInfo**](#getRepositorySettingsInfo) | **GET** /api/admin/repositorySettings/info | getRepositorySettingsInfo |
1918
| [**getSecuritySettings**](#getSecuritySettings) | **GET** /api/admin/securitySettings | Get the Security Settings object (getSecuritySettings) |
2019
| [**getSystemInfo**](#getSystemInfo) | **GET** /api/admin/systemInfo | Get system info (getSystemInfo) |
20+
| [**handleMailOAuth2Callback**](#handleMailOAuth2Callback) | **GET** /api/admin/mail/oauth2/code | handleMailOAuth2Callback |
2121
| [**repositorySettingsExists**](#repositorySettingsExists) | **GET** /api/admin/repositorySettings/exists | Check repository settings exists (repositorySettingsExists) |
2222
| [**saveAdminSettings**](#saveAdminSettings) | **POST** /api/admin/settings | Creates or Updates the Administration Settings (saveAdminSettings) |
2323
| [**saveAutoCommitSettings**](#saveAutoCommitSettings) | **POST** /api/admin/autoCommitSettings | Creates or Updates the auto commit settings (saveAutoCommitSettings) |
@@ -75,25 +75,6 @@ Check notifications about new platform releases. Available for users with 'SYS
7575
**UpdateMessage**
7676

7777

78-
## codeProcessingUrl
79-
80-
> codeProcessingUrl(code, state)
81-
82-
codeProcessingUrl
83-
84-
85-
### Parameters
86-
87-
| Name | Type | Description | Notes |
88-
|------------- | ------------- | ------------- | -------------|
89-
| **code** | **String** | | |
90-
| **state** | **String** | | |
91-
92-
### Return type
93-
94-
null (empty response body)
95-
96-
9778
## deleteAutoCommitSettings
9879

9980
> deleteAutoCommitSettings()
@@ -140,19 +121,6 @@ Get the Administration Settings object using specified string key. Referencing n
140121
**AdminSettings**
141122

142123

143-
## getAuthorizationUrl
144-
145-
> String getAuthorizationUrl()
146-
147-
Redirect user to mail provider login page.
148-
149-
After user logged in and provided accessprovider sends authorization code to specified redirect uri.)
150-
151-
### Return type
152-
153-
**String**
154-
155-
156124
## getAutoCommitSettings
157125

158126
> Map<String, AutoVersionCreateConfig> getAutoCommitSettings()
@@ -192,11 +160,24 @@ Get the JWT Settings object that contains JWT token policy, etc. Available for
192160
**JwtSettings**
193161

194162

195-
## getMailProcessingUrl
163+
## getMailOAuth2AuthorizationUrl
196164

197-
> String getMailProcessingUrl()
165+
> String getMailOAuth2AuthorizationUrl()
198166
199-
Get OAuth2 log in processing URL (getMailProcessingUrl)
167+
Redirect user to mail provider login page.
168+
169+
After user logged in and provided accessprovider sends authorization code to specified redirect uri.)
170+
171+
### Return type
172+
173+
**String**
174+
175+
176+
## getMailOAuth2RedirectUri
177+
178+
> String getMailOAuth2RedirectUri()
179+
180+
Get OAuth2 log in processing URL (getMailOAuth2RedirectUri)
200181

201182
Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider and user consent for requested scope, it makes a redirect to this path so that the platform can do further log in processing and generating access tokens. Available for users with 'SYS_ADMIN' authority.
202183

@@ -255,6 +236,25 @@ Get main information about system. Available for users with 'SYS_ADMIN' author
255236
**SystemInfo**
256237

257238

239+
## handleMailOAuth2Callback
240+
241+
> handleMailOAuth2Callback(code, state)
242+
243+
handleMailOAuth2Callback
244+
245+
246+
### Parameters
247+
248+
| Name | Type | Description | Notes |
249+
|------------- | ------------- | ------------- | -------------|
250+
| **code** | **String** | | |
251+
| **state** | **String** | | |
252+
253+
### Return type
254+
255+
null (empty response body)
256+
257+
258258
## repositorySettingsExists
259259

260260
> Boolean repositorySettingsExists()

ce/docs/AlarmControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| [**getAlarmById**](#getAlarmById) | **GET** /api/alarm/{alarmId} | Get Alarm (getAlarmById) |
1010
| [**getAlarmInfoById**](#getAlarmInfoById) | **GET** /api/alarm/info/{alarmId} | Get Alarm Info (getAlarmInfoById) |
1111
| [**getAlarmTypes**](#getAlarmTypes) | **GET** /api/alarm/types | Get Alarm Types (getAlarmTypes) |
12-
| [**getAlarms**](#getAlarms) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarms) |
12+
| [**getAlarmsByEntity**](#getAlarmsByEntity) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsByEntity) |
1313
| [**getAlarmsV2**](#getAlarmsV2) | **GET** /api/v2/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsV2) |
1414
| [**getAllAlarms**](#getAllAlarms) | **GET** /api/alarms | Get All Alarms (getAllAlarms) |
1515
| [**getAllAlarmsV2**](#getAllAlarmsV2) | **GET** /api/v2/alarms | Get All Alarms (getAllAlarmsV2) |
@@ -163,11 +163,11 @@ Returns a set of unique alarm types based on alarms that are either owned by the
163163
**PageDataEntitySubtype**
164164

165165

166-
## getAlarms
166+
## getAlarmsByEntity
167167

168-
> PageDataAlarmInfo getAlarms(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)
168+
> PageDataAlarmInfo getAlarmsByEntity(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)
169169
170-
Get Alarms (getAlarms)
170+
Get Alarms (getAlarmsByEntity)
171171

172172
Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
173173

ce/docs/AssetProfileControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| [**getAssetProfileInfos**](#getAssetProfileInfos) | **GET** /api/assetProfileInfos | Get Asset Profile infos (getAssetProfileInfos) |
99
| [**getAssetProfileNames**](#getAssetProfileNames) | **GET** /api/assetProfile/names | Get Asset Profile names (getAssetProfileNames) |
1010
| [**getAssetProfiles**](#getAssetProfiles) | **GET** /api/assetProfiles | Get Asset Profiles (getAssetProfiles) |
11-
| [**getAssetProfilesByIdsV2**](#getAssetProfilesByIdsV2) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIdsV2) |
11+
| [**getAssetProfilesByIds**](#getAssetProfilesByIds) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIds) |
1212
| [**getDefaultAssetProfileInfo**](#getDefaultAssetProfileInfo) | **GET** /api/assetProfileInfo/default | Get Default Asset Profile (getDefaultAssetProfileInfo) |
1313
| [**saveAssetProfile**](#saveAssetProfile) | **POST** /api/assetProfile | Create Or Update Asset Profile (saveAssetProfile) |
1414
| [**setDefaultAssetProfile**](#setDefaultAssetProfile) | **POST** /api/assetProfile/{assetProfileId}/default | Make Asset Profile Default (setDefaultAssetProfile) |
@@ -144,11 +144,11 @@ Returns a page of asset profile objects owned by tenant. You can specify paramet
144144
**PageDataAssetProfile**
145145

146146

147-
## getAssetProfilesByIdsV2
147+
## getAssetProfilesByIds
148148

149-
> List<AssetProfileInfo> getAssetProfilesByIdsV2(assetProfileIds)
149+
> List<AssetProfileInfo> getAssetProfilesByIds(assetProfileIds)
150150
151-
Get Asset Profiles By Ids (getAssetProfilesByIdsV2)
151+
Get Asset Profiles By Ids (getAssetProfilesByIds)
152152

153153
Requested asset profiles must be owned by tenant which is performing the request.
154154

ce/docs/CalculatedFieldControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| [**getCalculatedFieldById**](#getCalculatedFieldById) | **GET** /api/calculatedField/{calculatedFieldId} | Get Calculated Field (getCalculatedFieldById) |
77
| [**getCalculatedFieldNames**](#getCalculatedFieldNames) | **GET** /api/calculatedFields/names | Get calculated field names (getCalculatedFieldNames) |
88
| [**getCalculatedFields**](#getCalculatedFields) | **GET** /api/calculatedFields | Get calculated fields (getCalculatedFields) |
9-
| [**getCalculatedFieldsByEntityIdV2**](#getCalculatedFieldsByEntityIdV2) | **GET** /api/calculatedField/{entityType}/{entityId} | Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityIdV2) |
9+
| [**getCalculatedFieldsByEntityId**](#getCalculatedFieldsByEntityId) | **GET** /api/calculatedField/{entityType}/{entityId} | Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId) |
1010
| [**getLatestCalculatedFieldDebugEvent**](#getLatestCalculatedFieldDebugEvent) | **GET** /api/calculatedField/{calculatedFieldId}/debug | Get latest calculated field debug event (getLatestCalculatedFieldDebugEvent) |
1111
| [**saveCalculatedField**](#saveCalculatedField) | **POST** /api/calculatedField | Create Or Update Calculated Field (saveCalculatedField) |
1212
| [**testCalculatedFieldScript**](#testCalculatedFieldScript) | **POST** /api/calculatedField/testScript | Test Script expression |
@@ -105,11 +105,11 @@ Fetch tenant calculated fields based on the filter.
105105
**PageDataCalculatedFieldInfo**
106106

107107

108-
## getCalculatedFieldsByEntityIdV2
108+
## getCalculatedFieldsByEntityId
109109

110-
> PageDataCalculatedField getCalculatedFieldsByEntityIdV2(entityType, entityId, pageSize, page, type, textSearch, sortProperty, sortOrder)
110+
> PageDataCalculatedField getCalculatedFieldsByEntityId(entityType, entityId, pageSize, page, type, textSearch, sortProperty, sortOrder)
111111
112-
Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityIdV2)
112+
Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId)
113113

114114
Fetch the Calculated Fields based on the provided Entity Id.
115115

ce/docs/CustomerControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| [**getCustomerById**](#getCustomerById) | **GET** /api/customer/{customerId} | Get Customer (getCustomerById) |
77
| [**getCustomerTitleById**](#getCustomerTitleById) | **GET** /api/customer/{customerId}/title | Get Customer Title (getCustomerTitleById) |
88
| [**getCustomers**](#getCustomers) | **GET** /api/customers | Get Tenant Customers (getCustomers) |
9-
| [**getCustomersByIdsV2**](#getCustomersByIdsV2) | **GET** /api/customers/list | Get customers by Customer Ids (getCustomersByIdsV2) |
9+
| [**getCustomersByIds**](#getCustomersByIds) | **GET** /api/customers/list | Get customers by Customer Ids (getCustomersByIds) |
1010
| [**getShortCustomerInfoById**](#getShortCustomerInfoById) | **GET** /api/customer/{customerId}/shortInfo | Get short Customer info (getShortCustomerInfoById) |
1111
| [**getTenantCustomer**](#getTenantCustomer) | **GET** /api/tenant/customers | Get Tenant Customer by Customer title (getTenantCustomer) |
1212
| [**saveCustomer**](#saveCustomer) | **POST** /api/customer | Create or update Customer (saveCustomer) |
@@ -97,11 +97,11 @@ Returns a page of customers owned by tenant. You can specify parameters to filte
9797
**PageDataCustomer**
9898

9999

100-
## getCustomersByIdsV2
100+
## getCustomersByIds
101101

102-
> List<Customer> getCustomersByIdsV2(customerIds)
102+
> List<Customer> getCustomersByIds(customerIds)
103103
104-
Get customers by Customer Ids (getCustomersByIdsV2)
104+
Get customers by Customer Ids (getCustomersByIds)
105105

106106
Returns a list of Customer objects based on the provided ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
107107

ce/docs/DashboardControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| [**getCustomerDashboards**](#getCustomerDashboards) | **GET** /api/customer/{customerId}/dashboards | Get Customer Dashboards (getCustomerDashboards) |
1111
| [**getDashboardById**](#getDashboardById) | **GET** /api/dashboard/{dashboardId} | Get Dashboard (getDashboardById) |
1212
| [**getDashboardInfoById**](#getDashboardInfoById) | **GET** /api/dashboard/info/{dashboardId} | Get Dashboard Info (getDashboardInfoById) |
13-
| [**getDashboardsByIdsV2**](#getDashboardsByIdsV2) | **GET** /api/dashboards/list | Get dashboards by Dashboard Ids (getDashboardsByIdsV2) |
13+
| [**getDashboardsByIds**](#getDashboardsByIds) | **GET** /api/dashboards/list | Get dashboards by Dashboard Ids (getDashboardsByIds) |
1414
| [**getEdgeDashboards**](#getEdgeDashboards) | **GET** /api/edge/{edgeId}/dashboards | Get Edge Dashboards (getEdgeDashboards) |
1515
| [**getHomeDashboard**](#getHomeDashboard) | **GET** /api/dashboard/home | Get Home Dashboard (getHomeDashboard) |
1616
| [**getHomeDashboardInfo**](#getHomeDashboardInfo) | **GET** /api/dashboard/home/info | Get Home Dashboard Info (getHomeDashboardInfo) |
@@ -200,11 +200,11 @@ Get the information about the dashboard based on 'dashboardId' parameter. The Da
200200
**DashboardInfo**
201201

202202

203-
## getDashboardsByIdsV2
203+
## getDashboardsByIds
204204

205-
> List<DashboardInfo> getDashboardsByIdsV2(dashboardIds)
205+
> List<DashboardInfo> getDashboardsByIds(dashboardIds)
206206
207-
Get dashboards by Dashboard Ids (getDashboardsByIdsV2)
207+
Get dashboards by Dashboard Ids (getDashboardsByIds)
208208

209209
Returns a list of DashboardInfo objects based on the provided ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
210210

ce/docs/DeviceProfileControllerApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| [**getDeviceProfileById**](#getDeviceProfileById) | **GET** /api/deviceProfile/{deviceProfileId} | Get Device Profile (getDeviceProfileById) |
99
| [**getDeviceProfileInfoById**](#getDeviceProfileInfoById) | **GET** /api/deviceProfileInfo/{deviceProfileId} | Get Device Profile Info (getDeviceProfileInfoById) |
1010
| [**getDeviceProfileInfos**](#getDeviceProfileInfos) | **GET** /api/deviceProfileInfos | Get Device Profiles for transport type (getDeviceProfileInfos) |
11-
| [**getDeviceProfileInfosByIdsV2**](#getDeviceProfileInfosByIdsV2) | **GET** /api/deviceProfileInfos/list | Get Device Profile Infos By Ids (getDeviceProfileInfosByIdsV2) |
11+
| [**getDeviceProfileInfosByIds**](#getDeviceProfileInfosByIds) | **GET** /api/deviceProfileInfos/list | Get Device Profile Infos By Ids (getDeviceProfileInfosByIds) |
1212
| [**getDeviceProfileNames**](#getDeviceProfileNames) | **GET** /api/deviceProfile/names | Get Device Profile names (getDeviceProfileNames) |
1313
| [**getDeviceProfileTimeseriesKeys**](#getDeviceProfileTimeseriesKeys) | **GET** /api/deviceProfile/devices/keys/timeseries | Get time series keys (getDeviceProfileTimeseriesKeys) |
1414
| [**getDeviceProfiles**](#getDeviceProfiles) | **GET** /api/deviceProfiles | Get Device Profiles (getDeviceProfiles) |
@@ -136,11 +136,11 @@ Returns a page of devices profile info objects owned by tenant. You can specify
136136
**PageDataDeviceProfileInfo**
137137

138138

139-
## getDeviceProfileInfosByIdsV2
139+
## getDeviceProfileInfosByIds
140140

141-
> List<DeviceProfileInfo> getDeviceProfileInfosByIdsV2(deviceProfileIds)
141+
> List<DeviceProfileInfo> getDeviceProfileInfosByIds(deviceProfileIds)
142142
143-
Get Device Profile Infos By Ids (getDeviceProfileInfosByIdsV2)
143+
Get Device Profile Infos By Ids (getDeviceProfileInfosByIds)
144144

145145
Requested device profiles must be owned by tenant which is performing the request.
146146

0 commit comments

Comments
 (0)