Skip to content

Commit

Permalink
Update to newly built Kotlin Client from GH Run 8
Browse files Browse the repository at this point in the history
  • Loading branch information
openapi-bot committed Oct 25, 2024
1 parent a98142d commit 4f533f9
Show file tree
Hide file tree
Showing 54 changed files with 872 additions and 126 deletions.
4 changes: 2 additions & 2 deletions build-jar.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ plugins {

jar {
archiveBaseName = 'cumulocity-clients-kotlin'
archiveVersion = '10.18.0-4'
archiveVersion = '-8'
}

repositories {
Expand All @@ -18,7 +18,7 @@ publishing {
maven(MavenPublication) {
groupId = 'com.cumulocity'
artifactId = 'cumulocity-clients-kotlin'
version = '10.18.0-4'
version = '-8'
from components.java
}
}
Expand Down
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ android {
defaultConfig {
minSdkVersion 19
targetSdkVersion 33
versionCode 4
versionName "10.18.0"
versionCode 8
versionName ""

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
Expand Down
6 changes: 5 additions & 1 deletion src/main/java/com/cumulocity/client/api/AlarmsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,12 @@ interface AlarmsApi {
* When set to `true` also alarms for related source devices will be included in the request. When this parameter is provided a `source` must be specified.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.alarmcollection+json")
@GET("/alarm/alarms")
Expand Down Expand Up @@ -254,7 +258,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:** DELETE requires at least one of the following parameters: `source`, `dateFrom`, `dateTo`, `createdFrom`, `createdTo`.Also note that DELETE requests are not synchronous. The response could be returned before the delete request has been completed.
*
* ##### Required roles
*
Expand Down
14 changes: 13 additions & 1 deletion src/main/java/com/cumulocity/client/api/ApplicationsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import com.cumulocity.client.model.ApplicationCollection
*
* 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).
*
* Refer to the tables in [Administration > Managing applications](https://cumulocity.com/guides/users-guide/administration#managing-applications) in the *User guide* for the respective application name to be used.
* Refer to the tables in [Platform administration > Standard tenant administration > Managing the ecosystem > Managing applications](https://cumulocity.com/docs/standard-tenant/ecosystem/#managing-applications) in the Cumulocity IoT user documentation for the respective application name to be used.
*
* > **ⓘ Info:** The Accept header should be provided in all POST/PUT requests, otherwise an empty response body will be returned.
*/
Expand Down Expand Up @@ -91,8 +91,12 @@ interface ApplicationsApi {
* The ID of a user that has access to the applications.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
* @param hasVersions
* When set to `true`, the returned result contains applications with an `applicationVersions` field that is not empty. When set to `false`, the result will contain applications with an empty `applicationVersions` field.
*/
Expand Down Expand Up @@ -362,8 +366,12 @@ interface ApplicationsApi {
* Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.applicationcollection+json")
@GET("/application/applicationsByOwner/{tenantId}")
Expand Down Expand Up @@ -400,8 +408,12 @@ interface ApplicationsApi {
* Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.applicationcollection+json")
@GET("/application/applicationsByUser/{username}")
Expand Down
8 changes: 6 additions & 2 deletions src/main/java/com/cumulocity/client/api/AuditsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ interface AuditsApi {
* @param currentPage
* The current page of the paginated results.
* @param dateFrom
* Start date or date and time of the audit record.
* Start date or date and time of the audit record (device time).
* @param dateTo
* End date or date and time of the audit record.
* End date or date and time of the audit record (device time).
* @param pageSize
* Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects.
* @param source
Expand All @@ -81,8 +81,12 @@ interface AuditsApi {
* The username to search for.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.auditrecordcollection+json")
@GET("/audit/auditRecords")
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/com/cumulocity/client/api/BinariesApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,13 @@ interface BinariesApi {
* @param pageSize
* Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects.
* @param text
* Search for managed objects where any property value is equal to the given one. Only string values are supported.
* Search for managed objects where a property value is equal to the given one.The following properties are examined: `id, type, name, owner, externalIds`.
* @param type
* The type of managed object to search for.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobjectcollection+json")
@GET("/inventory/binaries")
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/cumulocity/client/api/BulkOperationsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ interface BulkOperationsApi {
* Indicates how many entries of the collection shall be returned. The upper limit for one page is 2,000 objects.
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.bulkoperationcollection+json, application/vnd.com.nsn.cumulocity.error+json")
@GET("/devicecontrol/bulkoperations")
Expand Down
18 changes: 15 additions & 3 deletions src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,12 @@ interface ChildOperationsApi {
* When set to `true`, the returned result will contain the total number of children in the respective objects (`childAdditions`, `childAssets` and `childDevices`).
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobjectreferencecollection+json")
@GET("/inventory/managedObjects/{id}/childAdditions")
Expand Down Expand Up @@ -201,7 +205,7 @@ interface ChildOperationsApi {
*/
@Headers(*["Content-Type:application/vnd.com.nsn.cumulocity.managedobject+json", "Accept:application/json"])
@POST("/inventory/managedObjects/{id}/childAdditions")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
fun assignAsChildAddition(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down Expand Up @@ -339,8 +343,12 @@ interface ChildOperationsApi {
* When set to `true`, the returned result will contain the total number of children in the respective objects (`childAdditions`, `childAssets` and `childDevices`).
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobjectreferencecollection+json")
@GET("/inventory/managedObjects/{id}/childAssets")
Expand Down Expand Up @@ -457,7 +465,7 @@ interface ChildOperationsApi {
*/
@Headers(*["Content-Type:application/vnd.com.nsn.cumulocity.managedobject+json", "Accept:application/json"])
@POST("/inventory/managedObjects/{id}/childAssets")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
fun assignAsChildAsset(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down Expand Up @@ -595,8 +603,12 @@ interface ChildOperationsApi {
* When set to `true`, the returned result will contain the total number of children in the respective objects (`childAdditions`, `childAssets` and `childDevices`).
* @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)).
*
* **ⓘ Info:** To improve performance, the `totalElements` statistics are cached for 10 seconds.
* @param withTotalPages
* When set to `true`, the returned result will contain in the statistics object the total number of pages. Only applicable on [range queries](https://en.wikipedia.org/wiki/Range_query_(database)).
*
* **ⓘ Info:** To improve performance, the `totalPages` statistics are cached for 10 seconds.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobjectreferencecollection+json")
@GET("/inventory/managedObjects/{id}/childDevices")
Expand Down Expand Up @@ -713,7 +725,7 @@ interface ChildOperationsApi {
*/
@Headers(*["Content-Type:application/vnd.com.nsn.cumulocity.managedobject+json", "Accept:application/json"])
@POST("/inventory/managedObjects/{id}/childDevices")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
fun assignAsChildDevice(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cumulocity/client/api/CurrentUserApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ interface CurrentUserApi {
*
* Generate a secret code to create a QR code to set up the two-factor authentication functionality using a TFA app/service.
*
* For more information about the feature, see [User Guide > Administration > Two-factor authentication](https://cumulocity.com/guides/users-guide/administration/#tfa) in the *Cumulocity IoT documentation*.
* For more information about the feature, see [Platform administration > Authentication > Two-factor authentication](https://cumulocity.com/docs/authentication/tfa/) in the Cumulocity IoT user documentation.
*
*
* ##### Required roles
Expand Down Expand Up @@ -177,7 +177,7 @@ interface CurrentUserApi {
*
* Activates or deactivates the two-factor authentication feature for the current user.
*
* For more information about the feature, see [User Guide > Administration > Two-factor authentication](https://cumulocity.com/guides/users-guide/administration/#tfa) in the *Cumulocity IoT documentation*.
* For more information about the feature, see [Platform administration > Authentication > Two-factor authentication](https://cumulocity.com/docs/authentication/tfa/) in the Cumulocity IoT user documentation.
*
*
* ##### Required roles
Expand All @@ -191,7 +191,7 @@ interface CurrentUserApi {
* * HTTP 204 The two-factor authentication was activated or deactivated.
* * HTTP 401 Authentication information is missing or invalid.
* * HTTP 403 Cannot deactivate TOTP setup.
* * HTTP 404 User not found.
* * HTTP 409 TFA TOTP secret does not exist. First generate secret.
*
* @param body
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import com.cumulocity.client.model.BulkNewDeviceRequest
/**
* API methods to create device credentials in Cumulocity IoT.
*
* 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/).
* 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/docs/additional-resources/contacting-support/).
*
* > **������ 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.
Expand Down Expand Up @@ -92,7 +92,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.
* > **ⓘ 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).
* > **ⓘ 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 [Device management > Device management application > Registering devices > Single device registration > Security token policy](https://cumulocity.com/docs/device-management-application/registering-devices/#security-token-policy) and [Device management > Device integration > Device integration using REST > Integration life cycle](https://cumulocity.com/docs/device-integration/rest/#integration-life-cycle).
* A CSV file can appear in many forms (with regard to the optional tenant column and the occurrence of device information):
*
* * If a user is logged in as the management tenant, then the columns ID, CREDENTIALS and TENANT are mandatory, and the device credentials will be created for the tenant mentioned in the TENANT column.
Expand Down
Loading

0 comments on commit 4f533f9

Please sign in to comment.