diff --git a/build-jar.gradle b/build-jar.gradle index 91d9122..7a8f937 100644 --- a/build-jar.gradle +++ b/build-jar.gradle @@ -6,7 +6,7 @@ plugins { jar { archiveBaseName = 'cumulocity-clients-kotlin' - archiveVersion = '10.18.0-270' + archiveVersion = '10.18.0-271' } repositories { @@ -18,7 +18,7 @@ publishing { maven(MavenPublication) { groupId = 'com.cumulocity' artifactId = 'cumulocity-clients-kotlin' - version = '10.18.0-270' + version = '10.18.0-271' from components.java } } diff --git a/build.gradle b/build.gradle index 9f3940b..48786bd 100644 --- a/build.gradle +++ b/build.gradle @@ -26,7 +26,7 @@ android { defaultConfig { minSdkVersion 19 targetSdkVersion 33 - versionCode 270 + versionCode 271 versionName "10.18.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index 9618d8d..0000000 --- a/gradlew.bat +++ /dev/null @@ -1,100 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/src/main/java/com/cumulocity/client/api/AlarmsApi.kt b/src/main/java/com/cumulocity/client/api/AlarmsApi.kt index ebc5234..df129ed 100644 --- a/src/main/java/com/cumulocity/client/api/AlarmsApi.kt +++ b/src/main/java/com/cumulocity/client/api/AlarmsApi.kt @@ -153,7 +153,7 @@ interface AlarmsApi { * * HTTP 202 An alarm collection is being updated in background. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -235,7 +235,7 @@ interface AlarmsApi { * * HTTP 201 An alarm was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -254,7 +254,7 @@ interface AlarmsApi { * * Remove alarm collections specified by query parameters. * - * > **⚠️ Important:** Note that it is possible to call this endpoint without providing any parameter - it will result in deleting all alarms and it is not recommended.Also note that DELETE requests are not synchronous. The response could be returned before the delete request has been completed. + * > **������ Important:** Note that it is possible to call this endpoint without providing any parameter - it will result in deleting all alarms and it is not recommended.Also note that DELETE requests are not synchronous. The response could be returned before the delete request has been completed. * * ##### Required roles * @@ -349,7 +349,7 @@ interface AlarmsApi { * * Update a specific alarm by a given ID.Only text, status, severity and custom properties can be modified. A request will be rejected when non-modifiable properties are provided in the request body. * - * > **ⓘ Info:** Changes to alarms will generate a new audit record. The audit record will include the username and application that triggered the update, if applicable. If the update operation doesn’t change anything (that is, the request body contains data that is identical to the already present in the database), there will be no audit record added and no notifications will be sent. + * > **ⓘ Info:** Changes to alarms will generate a new audit record. The audit record will include the username and application that triggered the update, if applicable. If the update operation doesn���t change anything (that is, the request body contains data that is identical to the already present in the database), there will be no audit record added and no notifications will be sent. * * ##### Required roles * @@ -363,7 +363,7 @@ interface AlarmsApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. * * HTTP 404 Alarm not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id diff --git a/src/main/java/com/cumulocity/client/api/ApplicationBinariesApi.kt b/src/main/java/com/cumulocity/client/api/ApplicationBinariesApi.kt index 56a0f09..f5703e8 100644 --- a/src/main/java/com/cumulocity/client/api/ApplicationBinariesApi.kt +++ b/src/main/java/com/cumulocity/client/api/ApplicationBinariesApi.kt @@ -75,7 +75,7 @@ interface ApplicationBinariesApi { * * Upload an application attachment (by a given application ID). * - * For the applications of type “microservice” and “web application” to be available for Cumulocity IoT platform users, an attachment ZIP file must be uploaded. + * For the applications of type ���microservice��� and ���web application��� to be available for Cumulocity IoT platform users, an attachment ZIP file must be uploaded. * * For a microservice application, the ZIP file must consist of: * diff --git a/src/main/java/com/cumulocity/client/api/ApplicationsApi.kt b/src/main/java/com/cumulocity/client/api/ApplicationsApi.kt index ded6090..95cde25 100644 --- a/src/main/java/com/cumulocity/client/api/ApplicationsApi.kt +++ b/src/main/java/com/cumulocity/client/api/ApplicationsApi.kt @@ -24,7 +24,7 @@ import com.cumulocity.client.model.ApplicationCollection /** * API methods to retrieve, create, update and delete applications. * - * ### Application names + * ###��Application names * * For each tenant, Cumulocity IoT manages the subscribed applications and provides a number of applications of various types.In case you want to subscribe a tenant to an application using an API, you must use the application name in the argument (as name). * @@ -130,7 +130,7 @@ interface ApplicationsApi { * * HTTP 201 An application was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 409 Duplicate key/name. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -209,7 +209,7 @@ interface ApplicationsApi { * * Delete an application (by a given ID).This method is not supported by microservice applications. * - * > **ⓘ Info:** With regards to a hosted application, there is a caching mechanism in place that keeps the information about the placement of application files (html, javascript, css, fonts, etc.). Removing a hosted application, in normal circumstances, will cause the subsequent requests for application files to fail with an HTTP 404 error because the application is removed synchronously, its files are immediately removed on the node serving the request and at the same time the information is propagated to other nodes – but in rare cases there might be a delay with this propagation. In such situations, the files of the removed application can be served from those nodes up until the aforementioned cache expires. For the same reason, the cache can also cause HTTP 404 errors when the application is updated as it will keep the path to the files of the old version of the application. The cache is filled on demand, so there should not be issues if application files were not accessed prior to the delete request. The expiration delay of the cache can differ, but should not take more than one minute. + * > **ⓘ Info:** With regards to a hosted application, there is a caching mechanism in place that keeps the information about the placement of application files (html, javascript, css, fonts, etc.). Removing a hosted application, in normal circumstances, will cause the subsequent requests for application files to fail with an HTTP 404 error because the application is removed synchronously, its files are immediately removed on the node serving the request and at the same time the information is propagated to other nodes ��� but in rare cases there might be a delay with this propagation. In such situations, the files of the removed application can be served from those nodes up until the aforementioned cache expires. For the same reason, the cache can also cause HTTP 404 errors when the application is updated as it will keep the path to the files of the old version of the application. The cache is filled on demand, so there should not be issues if application files were not accessed prior to the delete request. The expiration delay of the cache can differ, but should not take more than one minute. * * ##### Required roles * @@ -265,7 +265,7 @@ interface ApplicationsApi { * * * HTTP 201 An application was copied. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – method not supported + * * HTTP 422 Unprocessable Entity ��� method not supported * * @param id * Unique identifier of the application. diff --git a/src/main/java/com/cumulocity/client/api/BinariesApi.kt b/src/main/java/com/cumulocity/client/api/BinariesApi.kt index 8035303..62f48ea 100644 --- a/src/main/java/com/cumulocity/client/api/BinariesApi.kt +++ b/src/main/java/com/cumulocity/client/api/BinariesApi.kt @@ -106,8 +106,8 @@ interface BinariesApi { * * Uploading a file (binary) requires providing the following properties: * - * * `object` – In JSON format, it contains information about the file. - * * `file` – Contains the file to be uploaded. + * * `object` ��� In JSON format, it contains information about the file. + * * `file` ��� Contains the file to be uploaded. * * After the file has been uploaded, the corresponding managed object will contain the fragment `c8y_IsBinary`. * @@ -121,7 +121,7 @@ interface BinariesApi { * The following table gives an overview of the possible response codes and their meanings: * * * HTTP 201 A file was uploaded. - * * HTTP 400 Unprocessable Entity – invalid payload. + * * HTTP 400 Unprocessable Entity ��� invalid payload. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. * diff --git a/src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt b/src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt index b1de715..b7acac4 100644 --- a/src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt +++ b/src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt @@ -225,7 +225,7 @@ interface ChildOperationsApi { * * HTTP 204 Child additions were removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Managed object not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id @@ -481,7 +481,7 @@ interface ChildOperationsApi { * * HTTP 204 Child assets were removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Managed object not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id @@ -737,7 +737,7 @@ interface ChildOperationsApi { * * HTTP 204 Child devices were removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Managed object not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id diff --git a/src/main/java/com/cumulocity/client/api/CurrentUserApi.kt b/src/main/java/com/cumulocity/client/api/CurrentUserApi.kt index 2c0dec1..f337356 100644 --- a/src/main/java/com/cumulocity/client/api/CurrentUserApi.kt +++ b/src/main/java/com/cumulocity/client/api/CurrentUserApi.kt @@ -57,6 +57,8 @@ interface CurrentUserApi { * * ROLE_USER_MANAGEMENT_OWN_READ *OR* ROLE_SYSTEM * + * Users with ROLE_SYSTEM are not allowed to query with Accept header `application/vnd.com.nsn.cumulocity.user+json` + * * ##### Response Codes * * The following table gives an overview of the possible response codes and their meanings: @@ -64,7 +66,7 @@ interface CurrentUserApi { * * HTTP 200 The request has succeeded and the current user is sent in the response. * * HTTP 401 Authentication information is missing or invalid. */ - @Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.currentuser+json") + @Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.currentuser+json, application/vnd.com.nsn.cumulocity.user+json") @GET("/user/currentUser") fun getCurrentUser( ): Call @@ -85,7 +87,7 @@ interface CurrentUserApi { * * * HTTP 200 The current user was updated. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -101,7 +103,7 @@ interface CurrentUserApi { * * Update the current user's password. * - * > **⚠️ Important:** If the tenant uses OAI-Secure authentication, the current user will not be logged out. Instead, a new cookie will be set with a new token, and the previous token will expire within a minute. + * > **������ Important:** If the tenant uses OAI-Secure authentication, the current user will not be logged out. Instead, a new cookie will be set with a new token, and the previous token will expire within a minute. * * ##### Required roles * @@ -113,7 +115,7 @@ interface CurrentUserApi { * * * HTTP 200 The current user password was updated. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -217,7 +219,7 @@ interface CurrentUserApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Invalid verification code. * * HTTP 404 Cannot validate TFA TOTP code - user's TFA TOTP secret does not exist. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ diff --git a/src/main/java/com/cumulocity/client/api/DeviceCredentialsApi.kt b/src/main/java/com/cumulocity/client/api/DeviceCredentialsApi.kt index d407bf9..5a64f0a 100644 --- a/src/main/java/com/cumulocity/client/api/DeviceCredentialsApi.kt +++ b/src/main/java/com/cumulocity/client/api/DeviceCredentialsApi.kt @@ -22,7 +22,7 @@ import com.cumulocity.client.model.BulkNewDeviceRequest * * Device credentials can be enquired by devices that do not have credentials for accessing a tenant yet.Since the device does not have credentials yet, a set of fixed credentials is used for this API.The credentials can be obtained by [contacting support](https://cumulocity.com/guides/about-doc/contacting-support/). * - * > **⚠️ Important:** Do not use your tenant credentials with this API. + * > **������ Important:** Do not use your tenant credentials with this API. * > **ⓘ Info:** The Accept header should be provided in all POST requests, otherwise an empty response body will be returned. */ interface DeviceCredentialsApi { @@ -91,7 +91,7 @@ interface DeviceCredentialsApi { * * A separator is automatically obtained from the CSV file. Valid separator values are: `\t` (tabulation mark), `;` (semicolon) and `,` (comma). * - * > **⚠️ Important:** The CSV file needs the "com_cumulocity_model_Agent.active" header with a value of "true" to be added to the request. + * > **������ Important:** The CSV file needs the "com_cumulocity_model_Agent.active" header with a value of "true" to be added to the request. * > **ⓘ Info:** A bulk registration creates an elementary representation of the device. Then, the device needs to update it to a full representation with its own status. The device is ready to use only after it is updated to the full representation. Also see [credentials upload](https://cumulocity.com/guides/users-guide/device-management/#creds-upload) and [device integration](https://cumulocity.com/guides/device-sdk/rest/#device-integration). * A CSV file can appear in many forms (with regard to the optional tenant column and the occurrence of device information): * diff --git a/src/main/java/com/cumulocity/client/api/DevicePermissionsApi.kt b/src/main/java/com/cumulocity/client/api/DevicePermissionsApi.kt index 509189f..ed1b351 100644 --- a/src/main/java/com/cumulocity/client/api/DevicePermissionsApi.kt +++ b/src/main/java/com/cumulocity/client/api/DevicePermissionsApi.kt @@ -35,7 +35,7 @@ import com.cumulocity.client.model.DevicePermissionOwners * * The wildcard "*" enables you to access every API and stored object regardless of the fragments that are inside it. * - * > **⚠️ Important:** If there is no fragment in an object, for example, to read the object, you must use the wildcard "*" for the **fragment_name** part of the device permission (see the structure above). For example: `"10200":["MEASUREMENT:*:READ"]`. + * > **������ Important:** If there is no fragment in an object, for example, to read the object, you must use the wildcard "*" for the **fragment_name** part of the device permission (see the structure above). For example: `"10200":["MEASUREMENT:*:READ"]`. */ interface DevicePermissionsApi { diff --git a/src/main/java/com/cumulocity/client/api/EventsApi.kt b/src/main/java/com/cumulocity/client/api/EventsApi.kt index fb3e227..086fe1c 100644 --- a/src/main/java/com/cumulocity/client/api/EventsApi.kt +++ b/src/main/java/com/cumulocity/client/api/EventsApi.kt @@ -53,7 +53,7 @@ interface EventsApi { * * Retrieve all events on your tenant. * - * In case of executing [range queries](https://en.wikipedia.org/wiki/Range_query_(database)) between an upper and lower boundary, for example, querying using `dateFrom`–`dateTo` or `createdFrom`–`createdTo`, the newest registered events are returned first. It is possible to change the order using the query parameter `revert=true`. + * In case of executing [range queries](https://en.wikipedia.org/wiki/Range_query_(database)) between an upper and lower boundary, for example, querying using `dateFrom`���`dateTo` or `createdFrom`���`createdTo`, the newest registered events are returned first. It is possible to change the order using the query parameter `revert=true`. * * * ##### Required roles @@ -82,7 +82,7 @@ interface EventsApi { * @param fragmentValue * Allows filtering events by the fragment's value, but only when provided together with `fragmentType`. * - * **⚠️ Important:** Only fragments with a string value are supported. + * **������ Important:** Only fragments with a string value are supported. * @param lastUpdatedFrom * Start date or date and time of the last update made. * @param lastUpdatedTo @@ -149,7 +149,7 @@ interface EventsApi { * * HTTP 201 An event was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -170,7 +170,7 @@ interface EventsApi { * * DELETE requests are not synchronous. The response could be returned before the delete request has been completed. This may happen especially when the deleted event has a lot of associated data. After sending the request, the platform starts deleting the associated data in an asynchronous way. Finally, the requested event is deleted after all associated data has been deleted. * - * > **⚠️ Important:** Note that it is possible to call this endpoint without providing any parameter - it will result in deleting all events and it is not recommended. + * > **������ Important:** Note that it is possible to call this endpoint without providing any parameter - it will result in deleting all events and it is not recommended. * * ##### Required roles * @@ -258,7 +258,7 @@ interface EventsApi { * * HTTP 200 An event was updated. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Event not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id diff --git a/src/main/java/com/cumulocity/client/api/ExternalIDsApi.kt b/src/main/java/com/cumulocity/client/api/ExternalIDsApi.kt index 687d37a..4f7e6ed 100644 --- a/src/main/java/com/cumulocity/client/api/ExternalIDsApi.kt +++ b/src/main/java/com/cumulocity/client/api/ExternalIDsApi.kt @@ -87,7 +87,7 @@ interface ExternalIDsApi { * * * HTTP 201 An external ID was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 409 Duplicate – Identity already bound to a different Global ID. + * * HTTP 409 Duplicate ��� Identity already bound to a different Global ID. * * @param body * @param id diff --git a/src/main/java/com/cumulocity/client/api/GroupsApi.kt b/src/main/java/com/cumulocity/client/api/GroupsApi.kt index 0ac46ea..7fe5043 100644 --- a/src/main/java/com/cumulocity/client/api/GroupsApi.kt +++ b/src/main/java/com/cumulocity/client/api/GroupsApi.kt @@ -24,7 +24,7 @@ import com.cumulocity.client.model.GroupReferenceCollection /** * API methods to create, retrieve, update and delete user groups. * - * > **⚠️ Important:** In the Cumulocity IoT user interface, user groups are referred to as "global roles". Global roles are not to be confused with user roles. + * > **������ Important:** In the Cumulocity IoT user interface, user groups are referred to as "global roles". Global roles are not to be confused with user roles. * > **ⓘ Info:** The Accept header should be provided in all POST/PUT requests, otherwise an empty response body will be returned. */ interface GroupsApi { @@ -105,8 +105,8 @@ interface GroupsApi { * * HTTP 201 A user group was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. - * * HTTP 409 Duplicate – Group name already exists. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 409 Duplicate ��� Group name already exists. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -169,7 +169,7 @@ interface GroupsApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 Group not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/api/InventoryRolesApi.kt b/src/main/java/com/cumulocity/client/api/InventoryRolesApi.kt index 71c3391..a7f3dd7 100644 --- a/src/main/java/com/cumulocity/client/api/InventoryRolesApi.kt +++ b/src/main/java/com/cumulocity/client/api/InventoryRolesApi.kt @@ -98,8 +98,8 @@ interface InventoryRolesApi { * * * HTTP 201 An inventory role was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 409 Duplicate – The inventory role already exists. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 409 Duplicate ��� The inventory role already exists. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -154,7 +154,7 @@ interface InventoryRolesApi { * * HTTP 200 An inventory role was updated. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Role not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id @@ -247,7 +247,7 @@ interface InventoryRolesApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 User not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -318,7 +318,7 @@ interface InventoryRolesApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 Role not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/api/LoginOptionsApi.kt b/src/main/java/com/cumulocity/client/api/LoginOptionsApi.kt index 9b9a433..e02a8c7 100644 --- a/src/main/java/com/cumulocity/client/api/LoginOptionsApi.kt +++ b/src/main/java/com/cumulocity/client/api/LoginOptionsApi.kt @@ -61,7 +61,7 @@ interface LoginOptionsApi { * The following table gives an overview of the possible response codes and their meanings: * * * HTTP 200 The request has succeeded and the login options are sent in the response. - * * HTTP 400 Bad request – invalid parameters. + * * HTTP 400 Bad request ��� invalid parameters. * * @param management * If this is set to `true`, the management tenant login options will be returned. @@ -92,9 +92,9 @@ interface LoginOptionsApi { * The following table gives an overview of the possible response codes and their meanings: * * * HTTP 200 A login option was created. - * * HTTP 400 Duplicated – The login option already exists. + * * HTTP 400 Duplicated ��� The login option already exists. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ diff --git a/src/main/java/com/cumulocity/client/api/ManagedObjectsApi.kt b/src/main/java/com/cumulocity/client/api/ManagedObjectsApi.kt index 0367833..f5ff26b 100644 --- a/src/main/java/com/cumulocity/client/api/ManagedObjectsApi.kt +++ b/src/main/java/com/cumulocity/client/api/ManagedObjectsApi.kt @@ -26,7 +26,7 @@ import com.cumulocity.client.model.SupportedMeasurements import com.cumulocity.client.model.SupportedSeries /** - * The inventory stores devices and other assets relevant to your IoT solution. We refer to them as managed objects and such can be “smart objects”, for example, smart electricity meters, home automation gateways or GPS devices. + * The inventory stores devices and other assets relevant to your IoT solution. We refer to them as managed objects and such can be ���smart objects���, for example, smart electricity meters, home automation gateways or GPS devices. * * > **ⓘ Info:** The Accept header should be provided in all POST/PUT requests, otherwise an empty response body will be returned. */ @@ -160,7 +160,7 @@ interface ManagedObjectsApi { * * * HTTP 201 A managed object was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -269,7 +269,7 @@ interface ManagedObjectsApi { * * HTTP 204 A managed object was removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Managed object not found. - * * HTTP 409 Conflict – The managed object is associated to other objects, for example child devices. + * * HTTP 409 Conflict ��� The managed object is associated to other objects, for example child devices. * * @param id * Unique identifier of the managed object. diff --git a/src/main/java/com/cumulocity/client/api/MeasurementsApi.kt b/src/main/java/com/cumulocity/client/api/MeasurementsApi.kt index c88bd36..7e85e7d 100644 --- a/src/main/java/com/cumulocity/client/api/MeasurementsApi.kt +++ b/src/main/java/com/cumulocity/client/api/MeasurementsApi.kt @@ -54,7 +54,7 @@ interface MeasurementsApi { * * Retrieve all measurements on your tenant, or a specific subset based on queries. * - * In case of executing [range queries](https://en.wikipedia.org/wiki/Range_query_(database)) between an upper and lower boundary, for example, querying using `dateFrom`–`dateTo`, the oldest registered measurements are returned first. It is possible to change the order using the query parameter `revert=true`. + * In case of executing [range queries](https://en.wikipedia.org/wiki/Range_query_(database)) between an upper and lower boundary, for example, querying using `dateFrom`���`dateTo`, the oldest registered measurements are returned first. It is possible to change the order using the query parameter `revert=true`. * * For large measurement collections, querying older records without filters can be slow as the server needs to scan from the beginning of the input results set before beginning to return the results. For cases when older measurements should be retrieved, it is recommended to narrow the scope by using range queries based on the time stamp reported by a device. The scope of query can also be reduced significantly when a source device is provided. * @@ -125,7 +125,7 @@ interface MeasurementsApi { * * The example below uses `c8y_Steam` in the request body to illustrate a fragment for recording temperature measurements. * - * > **⚠️ Important:** Property names used for fragment and series must not contain whitespaces nor the special characters `. , * [ ] ( ) @ $`. This is required to ensure a correct processing and visualization of measurement series on UI graphs. + * > **������ Important:** Property names used for fragment and series must not contain whitespaces nor the special characters `. , * [ ] ( ) @ $`. This is required to ensure a correct processing and visualization of measurement series on UI graphs. * ### Create multiple measurements * * It is also possible to create multiple measurements at once by sending a `measurements` array containing all the measurements to be created. The content type must be `application/vnd.com.nsn.cumulocity.measurementcollection+json`. @@ -143,7 +143,7 @@ interface MeasurementsApi { * * HTTP 201 A measurement was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -171,7 +171,7 @@ interface MeasurementsApi { * * The example below uses `c8y_Steam` in the request body to illustrate a fragment for recording temperature measurements. * - * > **⚠️ Important:** Property names used for fragment and series must not contain whitespaces nor the special characters `. , * [ ] ( ) @ $`. This is required to ensure a correct processing and visualization of measurement series on UI graphs. + * > **������ Important:** Property names used for fragment and series must not contain whitespaces nor the special characters `. , * [ ] ( ) @ $`. This is required to ensure a correct processing and visualization of measurement series on UI graphs. * ### Create multiple measurements * * It is also possible to create multiple measurements at once by sending a `measurements` array containing all the measurements to be created. The content type must be `application/vnd.com.nsn.cumulocity.measurementcollection+json`. @@ -189,7 +189,7 @@ interface MeasurementsApi { * * HTTP 201 A measurement was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -210,7 +210,7 @@ interface MeasurementsApi { * * DELETE requests are not synchronous. The response could be returned before the delete request has been completed. This may happen especially when there are a lot of measurements to be deleted. * - * > **⚠️ Important:** Note that it is possible to call this endpoint without providing any parameter - it may result in deleting all measurements and it is not recommended. + * > **������ Important:** Note that it is possible to call this endpoint without providing any parameter - it may result in deleting all measurements and it is not recommended. * In case of enhanced time series measurements, both `dateFrom` and `dateTo` parameters must be truncated to full hours (for example, 2022-08-19T14:00:00.000Z), otherwise an error will be returned.The `fragmentType` parameter allows to delete measurements only by a measurement fragment when enhanced time series measurements are used.It's not possible to delete by a custom (non-measurement) fragment. * * Example for a valid measurement value fragment: @@ -244,7 +244,7 @@ interface MeasurementsApi { * * HTTP 204 A collection of measurements was removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param xCumulocityProcessingMode * Used to explicitly control the processing mode of the request. See [Processing mode](#processing-mode) for more details. @@ -336,7 +336,7 @@ interface MeasurementsApi { * * It is possible to fetch aggregated results using the `aggregationType` parameter. If the aggregation is not specified, the result will contain no more than 5000 values. * - * > **⚠️ Important:** For the aggregation to be done correctly, a device shall always use the same time zone when it sends dates. + * > **������ Important:** For the aggregation to be done correctly, a device shall always use the same time zone when it sends dates. * * ##### Required roles * diff --git a/src/main/java/com/cumulocity/client/api/NewDeviceRequestsApi.kt b/src/main/java/com/cumulocity/client/api/NewDeviceRequestsApi.kt index db25041..c512ab2 100644 --- a/src/main/java/com/cumulocity/client/api/NewDeviceRequestsApi.kt +++ b/src/main/java/com/cumulocity/client/api/NewDeviceRequestsApi.kt @@ -99,7 +99,7 @@ interface NewDeviceRequestsApi { * * * HTTP 201 A new device request was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode diff --git a/src/main/java/com/cumulocity/client/api/OperationsApi.kt b/src/main/java/com/cumulocity/client/api/OperationsApi.kt index 1ff2de1..65bb1c8 100644 --- a/src/main/java/com/cumulocity/client/api/OperationsApi.kt +++ b/src/main/java/com/cumulocity/client/api/OperationsApi.kt @@ -131,7 +131,7 @@ interface OperationsApi { * * * HTTP 201 An operation was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode diff --git a/src/main/java/com/cumulocity/client/api/OptionsApi.kt b/src/main/java/com/cumulocity/client/api/OptionsApi.kt index ae452dc..7643b3c 100644 --- a/src/main/java/com/cumulocity/client/api/OptionsApi.kt +++ b/src/main/java/com/cumulocity/client/api/OptionsApi.kt @@ -124,7 +124,7 @@ interface OptionsApi { * * * HTTP 200 An option was created. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -177,7 +177,7 @@ interface OptionsApi { * * * HTTP 200 A collection of options was updated. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param category @@ -237,7 +237,7 @@ interface OptionsApi { * * HTTP 200 An option was updated. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Option not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param category diff --git a/src/main/java/com/cumulocity/client/api/RealtimeNotificationApi.kt b/src/main/java/com/cumulocity/client/api/RealtimeNotificationApi.kt index e4cd2ba..8d80f01 100644 --- a/src/main/java/com/cumulocity/client/api/RealtimeNotificationApi.kt +++ b/src/main/java/com/cumulocity/client/api/RealtimeNotificationApi.kt @@ -238,7 +238,7 @@ interface RealtimeNotificationApi { * The following table gives an overview of the possible response codes and their meanings: * * * HTTP 200 The operation was completed and the result is sent in the response. - * * HTTP 400 Unprocessable Entity – invalid payload. + * * HTTP 400 Unprocessable Entity ��� invalid payload. * * HTTP 401 Authentication information is missing or invalid. * * @param body diff --git a/src/main/java/com/cumulocity/client/api/RetentionRulesApi.kt b/src/main/java/com/cumulocity/client/api/RetentionRulesApi.kt index 04a470f..e7eed0b 100644 --- a/src/main/java/com/cumulocity/client/api/RetentionRulesApi.kt +++ b/src/main/java/com/cumulocity/client/api/RetentionRulesApi.kt @@ -100,7 +100,7 @@ interface RetentionRulesApi { * * HTTP 201 A retention rule was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -157,7 +157,7 @@ interface RetentionRulesApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. * * HTTP 404 Retention rule not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param id diff --git a/src/main/java/com/cumulocity/client/api/RolesApi.kt b/src/main/java/com/cumulocity/client/api/RolesApi.kt index bf034c1..1d15445 100644 --- a/src/main/java/com/cumulocity/client/api/RolesApi.kt +++ b/src/main/java/com/cumulocity/client/api/RolesApi.kt @@ -166,8 +166,8 @@ interface RolesApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. * * HTTP 404 Group not found. - * * HTTP 409 Conflict – Role already assigned to the user group. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 409 Conflict ��� Role already assigned to the user group. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -239,7 +239,7 @@ interface RolesApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 User not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/api/SubscriptionsApi.kt b/src/main/java/com/cumulocity/client/api/SubscriptionsApi.kt index 25a54e2..b9ffbbd 100644 --- a/src/main/java/com/cumulocity/client/api/SubscriptionsApi.kt +++ b/src/main/java/com/cumulocity/client/api/SubscriptionsApi.kt @@ -123,7 +123,7 @@ interface SubscriptionsApi { * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 Managed object not found. * * HTTP 409 Duplicated subscription. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode @@ -155,7 +155,7 @@ interface SubscriptionsApi { * * HTTP 204 A collection of subscriptions was removed. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. - * * HTTP 422 Unprocessable Entity – error in query parameters + * * HTTP 422 Unprocessable Entity ��� error in query parameters * * @param xCumulocityProcessingMode * Used to explicitly control the processing mode of the request. See [Processing mode](#processing-mode) for more details. diff --git a/src/main/java/com/cumulocity/client/api/SystemOptionsApi.kt b/src/main/java/com/cumulocity/client/api/SystemOptionsApi.kt index edc4314..8b91dbc 100644 --- a/src/main/java/com/cumulocity/client/api/SystemOptionsApi.kt +++ b/src/main/java/com/cumulocity/client/api/SystemOptionsApi.kt @@ -49,7 +49,7 @@ interface SystemOptionsApi { * * Retrieve all the system options available on the tenant. * - * > **⚠️ Important:** Note that it is possible to call this endpoint without the ROLE_OPTION_MANAGEMENT_ADMIN role, but options that are considered secured (see the list of options above) will be obfuscated with a constant value `"<>"`. + * > **������ Important:** Note that it is possible to call this endpoint without the ROLE_OPTION_MANAGEMENT_ADMIN role, but options that are considered secured (see the list of options above) will be obfuscated with a constant value `"<>"`. * ##### Response Codes * * The following table gives an overview of the possible response codes and their meanings: @@ -67,7 +67,7 @@ interface SystemOptionsApi { * * Retrieve a specific system option (by a given category and key) on your tenant. * - * > **⚠️ Important:** Note that it is possible to call this endpoint without the ROLE_OPTION_MANAGEMENT_ADMIN role, but only the options that are considered not secured (see the list of options above) will be returned. Otherwise, if the option is considered secured and the user does not have the required role, an HTTP response 403 will be returned. + * > **������ Important:** Note that it is possible to call this endpoint without the ROLE_OPTION_MANAGEMENT_ADMIN role, but only the options that are considered not secured (see the list of options above) will be returned. Otherwise, if the option is considered secured and the user does not have the required role, an HTTP response 403 will be returned. * * ##### Required roles * diff --git a/src/main/java/com/cumulocity/client/api/TenantApplicationsApi.kt b/src/main/java/com/cumulocity/client/api/TenantApplicationsApi.kt index 68b235d..30db423 100644 --- a/src/main/java/com/cumulocity/client/api/TenantApplicationsApi.kt +++ b/src/main/java/com/cumulocity/client/api/TenantApplicationsApi.kt @@ -110,7 +110,7 @@ interface TenantApplicationsApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Application not found. * * HTTP 409 The application is already assigned to the tenant. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/api/TenantsApi.kt b/src/main/java/com/cumulocity/client/api/TenantsApi.kt index 240b9a9..3dff371 100644 --- a/src/main/java/com/cumulocity/client/api/TenantsApi.kt +++ b/src/main/java/com/cumulocity/client/api/TenantsApi.kt @@ -33,14 +33,14 @@ import com.cumulocity.client.model.TenantTfaData * * In general, the tenant domain should be used for communication if it is known. * - * > **⚠️ Important:** For support user access, the tenant ID must be used and not the tenant domain. + * > **������ Important:** For support user access, the tenant ID must be used and not the tenant domain. * See [Tenant > Current tenant](#operation/getCurrentTenantResource) for information on how to retrieve the tenant ID and domain of the current tenant via the API. * * In the UI, the tenant ID is displayed in the user dropdown menu, see [Getting started > User options and settings](https://cumulocity.com/guides/users-guide/getting-started/#user-settings) in the User guide. * * ### Access rights and permissions * - * There are two types of roles in Cumulocity IoT – global and inventory. Global roles are applied at the tenant level. In a Role Based Access Control (RBAC) approach you must use the inventory roles in order to have the correct level of separation. Apart from some global permissions (like "own user management") customer users will not be assigned any roles. Inventory roles must be created, or the default roles used, and then assigned to the user in combination with the assets the roles apply to. This needs to be done at least once for each customer. + * There are two types of roles in Cumulocity IoT ��� global and inventory. Global roles are applied at the tenant level. In a Role Based Access Control (RBAC) approach you must use the inventory roles in order to have the correct level of separation. Apart from some global permissions (like "own user management") customer users will not be assigned any roles. Inventory roles must be created, or the default roles used, and then assigned to the user in combination with the assets the roles apply to. This needs to be done at least once for each customer. * * In a multi-tenancy approach, as the tenant is completely separated from all other customers you do not necessarily need to be involved in setting up the access rights of the customer. If customers are given administration rights for their tenants, they can set up permissions on their own. It is not possible for customers to have any sight or knowledge of other customers. * @@ -133,8 +133,8 @@ interface TenantsApi { * * HTTP 201 A tenant was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. - * * HTTP 409 Conflict – The tenant domain/ID already exists. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 409 Conflict ��� The tenant domain/ID already exists. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ @@ -218,7 +218,7 @@ interface TenantsApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not authorized to perform this operation. * * HTTP 404 Tenant not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -237,7 +237,7 @@ interface TenantsApi { * * Remove a specific tenant by a given ID. * - * > **⚠️ Important:** Deleting a subtenant cannot be reverted. For security reasons, it is therefore only available in the management tenant. You cannot delete tenants from any tenant but the management tenant. + * > **������ Important:** Deleting a subtenant cannot be reverted. For security reasons, it is therefore only available in the management tenant. You cannot delete tenants from any tenant but the management tenant. * Administrators in Enterprise Tenants are only allowed to suspend active subtenants, but not to delete them. * * ##### Required roles diff --git a/src/main/java/com/cumulocity/client/api/TokensApi.kt b/src/main/java/com/cumulocity/client/api/TokensApi.kt index de2b35e..db876e3 100644 --- a/src/main/java/com/cumulocity/client/api/TokensApi.kt +++ b/src/main/java/com/cumulocity/client/api/TokensApi.kt @@ -69,7 +69,7 @@ interface TokensApi { * * HTTP 200 A notification token was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param xCumulocityProcessingMode diff --git a/src/main/java/com/cumulocity/client/api/TrustedCertificatesApi.kt b/src/main/java/com/cumulocity/client/api/TrustedCertificatesApi.kt index 0228f8b..942ae5c 100644 --- a/src/main/java/com/cumulocity/client/api/TrustedCertificatesApi.kt +++ b/src/main/java/com/cumulocity/client/api/TrustedCertificatesApi.kt @@ -113,8 +113,8 @@ interface TrustedCertificatesApi { * * HTTP 201 The certificate was added to the tenant. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Tenant not found. - * * HTTP 409 Duplicate – A certificate with the same fingerprint already exists. - * * HTTP 422 Unprocessable Entity – Invalid certificate data. + * * HTTP 409 Duplicate ��� A certificate with the same fingerprint already exists. + * * HTTP 422 Unprocessable Entity ��� Invalid certificate data. * * @param body * @param tenantId @@ -152,8 +152,8 @@ interface TrustedCertificatesApi { * * HTTP 201 The certificates were added to the tenant. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Tenant not found. - * * HTTP 409 Duplicate – A certificate with the same fingerprint already exists. - * * HTTP 422 Unprocessable Entity – Invalid certificates data. + * * HTTP 409 Duplicate ��� A certificate with the same fingerprint already exists. + * * HTTP 422 Unprocessable Entity ��� Invalid certificates data. * * @param body * @param tenantId @@ -218,7 +218,7 @@ interface TrustedCertificatesApi { * * HTTP 200 The certificate was updated on the tenant. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 404 Certificate not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/api/UsageStatisticsApi.kt b/src/main/java/com/cumulocity/client/api/UsageStatisticsApi.kt index 3493c95..09cab07 100644 --- a/src/main/java/com/cumulocity/client/api/UsageStatisticsApi.kt +++ b/src/main/java/com/cumulocity/client/api/UsageStatisticsApi.kt @@ -237,6 +237,8 @@ interface UsageStatisticsApi { * Retrieve usage statistics summary files report metadata. * * > **ⓘ Info:** This is only accessible by the Management tenant. + * Date range defines the search criteria for files which have any data inside this range. For example, query containing `dateFrom=2023-03-01&dateTo=2023-03-31`will return files with statistics from ranges 2023-02-25---2023-03-03, 2023-03-04---2023-03-05, 2023-03-15---2023-04-15, but not the files wherethe whole range of data is outside of queried range, like 2023-02-01---2023-02-27. + * * * ##### Required roles * @@ -252,9 +254,9 @@ interface UsageStatisticsApi { * @param currentPage * The current page of the paginated results. * @param dateFrom - * Start date or date and time of the statistics file generation. + * Start date or date and time of the range included in statistics file. * @param dateTo - * End date or date and time of the statistics file generation. + * End date or date and time of the range included in statistics file. * @param pageSize * Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects. * @param withTotalPages @@ -280,6 +282,8 @@ interface UsageStatisticsApi { * * REAL - generated by the system on the first day of the month and including statistics from the previous month. * * TEST - generated by the user with a time range specified in the query parameters (`dateFrom`, `dateTo`). * + * `dateFrom` and `dateTo` are using daily granularity and each day is stored with respect to local Time Zone of the server. + * * > **ⓘ Info:** This is only accessible by the Management tenant. * * ##### Required roles @@ -292,7 +296,7 @@ interface UsageStatisticsApi { * * * HTTP 201 A statistics file was generated. * * HTTP 401 Authentication information is missing or invalid. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body */ diff --git a/src/main/java/com/cumulocity/client/api/UsersApi.kt b/src/main/java/com/cumulocity/client/api/UsersApi.kt index 57d3442..6c15709 100644 --- a/src/main/java/com/cumulocity/client/api/UsersApi.kt +++ b/src/main/java/com/cumulocity/client/api/UsersApi.kt @@ -81,7 +81,7 @@ interface UsersApi { * * **ⓘ Info:** If you query for multiple user groups at once, comma-separate the values. * @param onlyDevices - * If set to `true`, the response will only contain users created during bootstrap process (starting with “device_”).If the flag is absent or `false` the result will not contain “device_” users. + * If set to `true`, the response will only contain users created during bootstrap process (starting with ���device_���).If the flag is absent or `false` the result will not contain ���device_��� users. * @param owner * Exact username of the owner of the user * @param pageSize @@ -89,7 +89,7 @@ interface UsersApi { * @param username * Prefix or full username * @param withSubusersCount - * If set to `true`, then each of returned user will contain an additional field “subusersCount”.It is the number of direct subusers (users with corresponding “owner”). + * If set to `true`, then each of returned user will contain an additional field ���subusersCount���.It is the number of direct subusers (users with corresponding ���owner���). * @param withTotalElements * When set to `true`, the returned result will contain in the statistics object the total number of elements. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)). * @param withTotalPages @@ -127,8 +127,8 @@ interface UsersApi { * * HTTP 201 A user was created. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. - * * HTTP 409 Duplicate – The userName or alias already exists. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 409 Duplicate ��� The userName or alias already exists. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -199,7 +199,7 @@ interface UsersApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 User not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -254,7 +254,7 @@ interface UsersApi { * * Changing the user's password creates a corresponding audit record of type "User" and activity "User updated", and specifying that the password has been changed. * - * > **⚠️ Important:** If the tenant uses OAI-Secure authentication, the target user will be logged out. + * > **������ Important:** If the tenant uses OAI-Secure authentication, the target user will be logged out. * * ##### Required roles * @@ -269,7 +269,7 @@ interface UsersApi { * * HTTP 200 A user was updated. * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId @@ -407,7 +407,7 @@ interface UsersApi { * * HTTP 401 Authentication information is missing or invalid. * * HTTP 403 Not enough permissions/roles to perform this operation. * * HTTP 404 Group not found. - * * HTTP 422 Unprocessable Entity – invalid payload. + * * HTTP 422 Unprocessable Entity ��� invalid payload. * * @param body * @param tenantId diff --git a/src/main/java/com/cumulocity/client/model/InventoryApiResource.kt b/src/main/java/com/cumulocity/client/model/InventoryApiResource.kt index 361fb74..fbc8603 100644 --- a/src/main/java/com/cumulocity/client/model/InventoryApiResource.kt +++ b/src/main/java/com/cumulocity/client/model/InventoryApiResource.kt @@ -17,7 +17,7 @@ class InventoryApiResource { var managedObjectsForType: String? = null /** - * Read-only collection of managed objects fetched for a given list of ids, for example, “ids=41,43,68”. + * Read-only collection of managed objects fetched for a given list of ids, for example, ���ids=41,43,68���. */ var managedObjectsForListOfIds: String? = null diff --git a/src/main/java/com/cumulocity/client/model/PageStatistics.kt b/src/main/java/com/cumulocity/client/model/PageStatistics.kt index 9612d4f..8db46d5 100644 --- a/src/main/java/com/cumulocity/client/model/PageStatistics.kt +++ b/src/main/java/com/cumulocity/client/model/PageStatistics.kt @@ -27,7 +27,7 @@ class PageStatistics { /** * The total number of paginated results (pages). * - * > **ⓘ Info:** This property is returned by default except when an operation retrieves all records where values are between an upper and lower boundary, for example, querying ranges using `dateFrom`–`dateTo`. In such cases, the query parameter `withTotalPages=true` should be used to include the total number of pages (at the expense of slightly slower performance). + * > **ⓘ Info:** This property is returned by default except when an operation retrieves all records where values are between an upper and lower boundary, for example, querying ranges using `dateFrom`���`dateTo`. In such cases, the query parameter `withTotalPages=true` should be used to include the total number of pages (at the expense of slightly slower performance). */ var totalPages: Int? = null