Skip to content

Commit

Permalink
Update to newly built Kotlin Client from GH Run 269
Browse files Browse the repository at this point in the history
  • Loading branch information
openapi-bot committed Apr 23, 2024
1 parent a2d27bc commit 6495c58
Show file tree
Hide file tree
Showing 32 changed files with 106 additions and 244 deletions.
2 changes: 1 addition & 1 deletion build-jar.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ plugins {

jar {
archiveBaseName = 'cumulocity-clients-kotlin'
archiveVersion = '-268'
archiveVersion = '10.18.0-269'
}

repositories {
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 268
versionName ""
versionCode 269
versionName "10.18.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/cumulocity/client/api/AlarmsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ interface AlarmsApi {
*
* Remove alarm collections specified by query parameters.
*
* > **⚠️ 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.
* > **⚠️ 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
*
Expand Down
2 changes: 1 addition & 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 [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.
* 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.
*
* > **ⓘ Info:** The Accept header should be provided in all POST/PUT requests, otherwise an empty response body will be returned.
*/
Expand Down
4 changes: 2 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 (device time).
* Start date or date and time of the audit record.
* @param dateTo
* End date or date and time of the audit record (device time).
* End date or date and time of the audit record.
* @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 Down
2 changes: 1 addition & 1 deletion src/main/java/com/cumulocity/client/api/BinariesApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ 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 a property value is equal to the given one.The following properties are examined: `id, type, name, owner, externalIds`.
* Search for managed objects where any property value is equal to the given one. Only string values are supported.
* @param type
* The type of managed object to search for.
* @param withTotalPages
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cumulocity/client/api/ChildOperationsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,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", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
fun assignAsChildAddition(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down Expand Up @@ -457,7 +457,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", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
fun assignAsChildAsset(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down Expand Up @@ -713,7 +713,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", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
fun assignAsChildDevice(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/cumulocity/client/api/CurrentUserApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,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 [Platform administration > Authentication > Two-factor authentication](https://cumulocity.com/docs/authentication/tfa/) in the Cumulocity IoT user documentation.
* 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*.
*
*
* ##### Required roles
Expand Down Expand Up @@ -175,7 +175,7 @@ interface CurrentUserApi {
*
* Activates or deactivates the two-factor authentication feature for the current user.
*
* 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.
* 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*.
*
*
* ##### Required roles
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/docs/additional-resources/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/guides/about-doc/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 [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).
* > **ⓘ 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):
*
* * 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
2 changes: 1 addition & 1 deletion src/main/java/com/cumulocity/client/api/EventsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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:** DELETE requires at least one of the following parameters: `source`, `dateFrom`, `dateTo`, `createdFrom`, `createdTo`.
* > **⚠️ 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
*
Expand Down
1 change: 0 additions & 1 deletion src/main/java/com/cumulocity/client/api/ExternalIDsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ interface ExternalIDsApi {
*
* * HTTP 201 An external ID was created.
* * HTTP 401 Authentication information is missing or invalid.
* * HTTP 404 Global ID not found.
* * HTTP 409 Duplicate – Identity already bound to a different Global ID.
*
* @param body
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/cumulocity/client/api/LoginOptionsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import com.cumulocity.client.model.LoginOptionCollection
/**
* API methods to retrieve the login options configured in the tenant.
*
* More detailed information about the parameters and their meaning can be found in [Platform administration > Standard tenant administration > Changing settings](https://cumulocity.com/docs/standard-tenant/changing-settings/) in the Cumulocity IoT user documentation.
* More detailed information about the parameters and their meaning can be found in [Administration > Changing settings](https://cumulocity.com/guides/users-guide/administration/#changing-settings) in the *Users guide*.
*
* > **ⓘ Info:** If OAuth external is the only login option shown in the response, the user will be automatically redirected to the SSO login screen.
*/
Expand Down
20 changes: 5 additions & 15 deletions src/main/java/com/cumulocity/client/api/ManagedObjectsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface ManagedObjectsApi {
* @param skipChildrenNames
* When set to `true`, the returned references of child devices won't contain their names.
* @param text
* Search for managed objects where a property value is equal to the given one.The following properties are examined: `id, type, name, owner, externalIds`.
* Search for managed objects where any property value is equal to the given one. Only string values are supported.
* @param type
* The type of managed object to search for.
* @param withChildren
Expand All @@ -107,10 +107,6 @@ interface ManagedObjectsApi {
* 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
* 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)).
* @param withLatestValues
* If set to true the platform returns managed objects with the fragment `c8y_LatestMeasurements, which contains the latest measurement values reported by the device to the platform.
*
* **⚠️ Feature Preview:** The parameter is a part of the Latest Measurement feature which is still under public preview.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobjectcollection+json")
@GET("/inventory/managedObjects")
Expand All @@ -134,8 +130,7 @@ interface ManagedObjectsApi {
@Query("withGroups") withGroups: Boolean? = null,
@Query("withParents") withParents: Boolean? = null,
@Query("withTotalElements") withTotalElements: Boolean? = null,
@Query("withTotalPages") withTotalPages: Boolean? = null,
@Query("withLatestValues") withLatestValues: Boolean? = null
@Query("withTotalPages") withTotalPages: Boolean? = null
): Call<ManagedObjectCollection>

/**
Expand Down Expand Up @@ -173,7 +168,7 @@ interface ManagedObjectsApi {
*/
@Headers(*["Content-Type:application/vnd.com.nsn.cumulocity.managedobject+json", "Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobject+json"])
@POST("/inventory/managedObjects")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
fun createManagedObject(
@Body body: ManagedObject,
@Header("X-Cumulocity-Processing-Mode") xCumulocityProcessingMode: String? = null
Expand Down Expand Up @@ -207,10 +202,6 @@ interface ManagedObjectsApi {
* When set to `true`, the returned result will contain the total number of children in the respective objects (`childAdditions`, `childAssets` and `childDevices`).
* @param withParents
* When set to `true`, the returned references of child parents will return the device's parents (if any). Otherwise, it will be an empty array.
* @param withLatestValues
* If set to true the platform returns managed objects with the fragment `c8y_LatestMeasurements, which contains the latest measurement values reported by the device to the platform.
*
* **⚠️ Feature Preview:** The parameter is a part of the Latest Measurement feature which is still under public preview.
*/
@Headers("Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobject+json")
@GET("/inventory/managedObjects/{id}")
Expand All @@ -219,8 +210,7 @@ interface ManagedObjectsApi {
@Query("skipChildrenNames") skipChildrenNames: Boolean? = null,
@Query("withChildren") withChildren: Boolean? = null,
@Query("withChildrenCount") withChildrenCount: Boolean? = null,
@Query("withParents") withParents: Boolean? = null,
@Query("withLatestValues") withLatestValues: Boolean? = null
@Query("withParents") withParents: Boolean? = null
): Call<ManagedObject>

/**
Expand Down Expand Up @@ -253,7 +243,7 @@ interface ManagedObjectsApi {
*/
@Headers(*["Content-Type:application/vnd.com.nsn.cumulocity.managedobject+json", "Accept:application/vnd.com.nsn.cumulocity.error+json, application/vnd.com.nsn.cumulocity.managedobject+json"])
@PUT("/inventory/managedObjects/{id}")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "c8y_LatestMeasurements", "self", "assetParents", "deviceParents", "id")
@ReadOnlyProperties("owner", "additionParents", "lastUpdated", "childDevices", "childAssets", "creationTime", "childAdditions", "self", "assetParents", "deviceParents", "id")
fun updateManagedObject(
@Body body: ManagedObject,
@Path("id") id: String,
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cumulocity/client/api/MeasurementsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ interface MeasurementsApi {
* * `value` - The value of the individual measurement. The maximum precision for floating point numbers is 64-bit IEEE 754. For integers it's a 64-bit two's complement integer. The `value` is mandatory for a fragment.
* * `unit` - The unit of the measurements.
*
* Review the [System of units](#section/System-of-units) section for details about the conversions of units. Also review [Getting started > Technical concepts > Cumulocity IoT's domain model > Inventory > Fragments > Naming conventions of fragments](https://cumulocity.com/docs/concepts/domain-model/#naming-conventions-of-fragments) in the Cumulocity IoT user documentation.
* Review the [System of units](#section/System-of-units) section for details about the conversions of units. Also review the [Naming conventions of fragments](https://cumulocity.com/guides/concepts/domain-model/#naming-conventions-of-fragments) in the Concepts guide.
*
* The example below uses `c8y_Steam` in the request body to illustrate a fragment for recording temperature measurements.
*
Expand Down Expand Up @@ -167,7 +167,7 @@ interface MeasurementsApi {
* * `value` - The value of the individual measurement. The maximum precision for floating point numbers is 64-bit IEEE 754. For integers it's a 64-bit two's complement integer. The `value` is mandatory for a fragment.
* * `unit` - The unit of the measurements.
*
* Review the [System of units](#section/System-of-units) section for details about the conversions of units. Also review [Getting started > Technical concepts > Cumulocity IoT's domain model > Inventory > Fragments > Naming conventions of fragments](https://cumulocity.com/docs/concepts/domain-model/#naming-conventions-of-fragments) in the Cumulocity IoT user documentation.
* Review the [System of units](#section/System-of-units) section for details about the conversions of units. Also review the [Naming conventions of fragments](https://cumulocity.com/guides/concepts/domain-model/#naming-conventions-of-fragments) in the Concepts guide.
*
* The example below uses `c8y_Steam` in the request body to illustrate a fragment for recording temperature measurements.
*
Expand Down Expand Up @@ -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:** DELETE requires at least one of the following parameters: `source`, `dateFrom`, `dateTo`.
* > **⚠️ 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:
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/cumulocity/client/api/OptionsApi.kt
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ interface OptionsApi {
*
* **access.control**
*
* | Key | Default value | Predefined | Description ||--|--|--|--|| allow.origin | * | Yes | Comma separated list of domains allowed for execution of CORS. Wildcards are allowed (for example, `*.cumulocity.com`) |
* | Key | Default value | Predefined | Description ||--|--|--|--|| allow.origin | * | Yes | Comma separated list of domains allowed for execution of CORS. Wildcards are allowed (for example, `*.cumuclocity.com`) |
*
* **alarm.type.mapping**
*
Expand Down
Loading

0 comments on commit 6495c58

Please sign in to comment.