Skip to content

Commit

Permalink
Updated generated sources
Browse files Browse the repository at this point in the history
  • Loading branch information
joerghartmann committed Sep 27, 2024
1 parent dea0092 commit 080425e
Show file tree
Hide file tree
Showing 51 changed files with 294 additions and 472 deletions.
10 changes: 5 additions & 5 deletions Sources/CumulocityCoreLibrary/Api/AlarmsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public class AlarmsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -237,7 +237,7 @@ public class AlarmsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -285,7 +285,7 @@ public class AlarmsApi: AdaptableApi {
///
/// 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:** 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.
///
/// > Tip: Required roles
/// ROLE_ALARM_ADMIN
Expand Down Expand Up @@ -403,7 +403,7 @@ public class AlarmsApi: AdaptableApi {
///
/// 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.
///
/// > **ⓘ Note** 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.
/// > **ⓘ Note** 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 doesnt 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.
///
/// > Tip: Required roles
/// ROLE_ALARM_ADMIN *OR* owner of the source *OR* ALARM_ADMIN permission on the source
Expand All @@ -415,7 +415,7 @@ public class AlarmsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class ApplicationBinariesApi: AdaptableApi {
///
/// 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:
///
Expand Down
8 changes: 4 additions & 4 deletions Sources/CumulocityCoreLibrary/Api/ApplicationsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Combine

/// 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).
///
Expand Down Expand Up @@ -105,7 +105,7 @@ public class ApplicationsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -247,7 +247,7 @@ public class ApplicationsApi: AdaptableApi {
///
/// Delete an application (by a given ID).This method is not supported by microservice applications.
///
/// > **ⓘ Note** 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.
/// > **ⓘ Note** 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.
///
/// > Tip: Required roles
/// ROLE_APPLICATION_MANAGEMENT_ADMIN *AND* tenant is the owner of the application
Expand Down Expand Up @@ -312,7 +312,7 @@ public class ApplicationsApi: AdaptableApi {
///
/// * 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
///
/// - Parameters:
/// - id:
Expand Down
6 changes: 3 additions & 3 deletions Sources/CumulocityCoreLibrary/Api/BinariesApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ public class BinariesApi: AdaptableApi {
///
/// 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`.
///
Expand All @@ -94,7 +94,7 @@ public class BinariesApi: AdaptableApi {
/// 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.
///
Expand Down
6 changes: 3 additions & 3 deletions Sources/CumulocityCoreLibrary/Api/ChildOperationsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ public class ChildOperationsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -646,7 +646,7 @@ public class ChildOperationsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -1024,7 +1024,7 @@ public class ChildOperationsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down
10 changes: 5 additions & 5 deletions Sources/CumulocityCoreLibrary/Api/CurrentUserApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public class CurrentUserApi: AdaptableApi {
///
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -106,7 +106,7 @@ public class CurrentUserApi: AdaptableApi {
///
/// 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.
///
/// > Tip: Required roles
/// ROLE_USER_MANAGEMENT_OWN_ADMIN
Expand All @@ -116,7 +116,7 @@ public class CurrentUserApi: AdaptableApi {
///
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -235,7 +235,7 @@ public class CurrentUserApi: AdaptableApi {
/// * 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 409 TFA TOTP secret does not exist. First generate secret.
/// * HTTP 404 User not found.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -284,7 +284,7 @@ public class CurrentUserApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down
4 changes: 2 additions & 2 deletions Sources/CumulocityCoreLibrary/Api/DeviceCredentialsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Combine
///
/// 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.
/// > **⚠️ Important:** Do not use your tenant credentials with this API.
/// > **ⓘ Note** The Accept header should be provided in all POST requests, otherwise an empty response body will be returned.
public class DeviceCredentialsApi: AdaptableApi {

Expand Down Expand Up @@ -84,7 +84,7 @@ public class DeviceCredentialsApi: AdaptableApi {
///
/// 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.
/// > **ⓘ Note** 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):
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import Combine
///
/// 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"]`.
public class DevicePermissionsApi: AdaptableApi {

/// Returns all device permissions assignments
Expand Down
10 changes: 5 additions & 5 deletions Sources/CumulocityCoreLibrary/Api/EventsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public class EventsApi: AdaptableApi {
///
/// 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`.
///
///
/// > Tip: Required roles
Expand Down Expand Up @@ -46,7 +46,7 @@ public class EventsApi: AdaptableApi {
/// - 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.
/// - lastUpdatedFrom:
/// Start date or date and time of the last update made.
/// - lastUpdatedTo:
Expand Down Expand Up @@ -124,7 +124,7 @@ public class EventsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down Expand Up @@ -172,7 +172,7 @@ public class EventsApi: AdaptableApi {
///
/// 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:** DELETE requires at least one of the following parameters: `source`, `dateFrom`, `dateTo`, `createdFrom`, `createdTo`.
///
/// > Tip: Required roles
/// ROLE_EVENT_ADMIN
Expand Down Expand Up @@ -281,7 +281,7 @@ public class EventsApi: AdaptableApi {
/// * 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.
///
/// - Parameters:
/// - body:
Expand Down
2 changes: 1 addition & 1 deletion Sources/CumulocityCoreLibrary/Api/ExternalIDsApi.swift
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class ExternalIDsApi: AdaptableApi {
/// * 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.
/// * HTTP 409 Duplicate Identity already bound to a different Global ID.
///
/// - Parameters:
/// - body:
Expand Down
Loading

0 comments on commit 080425e

Please sign in to comment.