ionoscloud 6.0.0.beta.4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb68df295cd64de5316bacfd86030446b92348f856c2434a72b3b753b5230c64
-  data.tar.gz: 1c6c643e0f8270af99875969d71589f71feb1c6cdb7efdb3996cb258d9e58d87
+  metadata.gz: 5e7c5a1ec6d1061f36281ed5c5b498d57dde3a8921cd3c296bddcd0d9dbc6244
+  data.tar.gz: 3258d740620ce73e4d39e2a535365ee22f45a0e86eb9a9bf0fd1b93a0301fb35
 SHA512:
-  metadata.gz: d2b79ba6a8d52ba844678848f47d37b445fd30ae7429db6a8aea2067ea9603e8dda69f4bdb93cbabe94b37696bbe4106864787b7d2541b0329b1d7049ba09cfa
-  data.tar.gz: 517d90c29d2c6476f8eb8ebfefaf428cd64315fb55ed01f1dbf52a4a439bd9183269306d6a3ccfc5bbbbf39e71d5f9840bb6426317eb8dfcaa99ea2fa42d2b7a
+  metadata.gz: 4cbdb9708b69d0c74436317a36ca712e98027a6346f63e85daf7f0be8b323d6b19567b06ecaa97b4bc148fe5628245a81154d2d9cb324bc0f5edefd64d2926c4
+  data.tar.gz: 1800c78898b4cc74d7841d0668708775115dae86ec395f0a6be6c95369b3eda14344c9b6fd729de1fef906558a916e6140a52d4657ae3083c926eeeec060bfbb

data/README.md

@@ -1,6 +1,8 @@
-[![Gitter](https://img.shields.io/gitter/room/ionos-cloud/sdk-general)](https://gitter.im/ionos-cloud/sdk-general)
+![CI](https://github.com/ionos-cloud/sdk-resources/workflows/%5B%20CI%20%5D%20CloudApi%20V6%20/%20Ruby/badge.svg)
+[![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
 
-# ionoscloud
+
+# Ionoscloud
 
 Ionoscloud - the Ruby gem for the CLOUD API
 

data/docs/README.md

@@ -92,6 +92,70 @@ rescue Ionoscloud::ApiError => e
 end
 ```
 
+### Authentication
+
+The username and password or the authentication token can be manually specified when initializing the SDK client:
+
+```ruby
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+```
+
+Environment variables can also be used for initialization. For example:
+
+```ruby
+Ionoscloud.configure do |config|
+  config.username = ENV['IONOS_USERNAME']
+  config.password = ENV['IONOS_PASSWORD']
+  config.api_key['Authorization'] = ENV['IONOS_TOKEN']
+end
+```
+
+{% hint style="danger" %}
+**Warning**: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.
+{% endhint %}
+
+### Depth
+
+Many of the _List_ or _Get_ operations will accept an optional _depth_ argument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, but it generally follows this pattern.
+
+| Depth | Description |
+| :--- | :--- |
+| 0 | Only direct properties are included. Children are not included. |
+| 1 | Direct properties and children's references are returned. |
+| 2 | Direct properties and children's properties are returned. |
+| 3 | Direct properties, children's properties, and descendants' references are returned. |
+| 4 | Direct properties, children's properties, and descendants' properties are returned. |
+| 5 | Returns all available properties. |
+
+### Pretty
+
+The operations will also accept an optional _pretty_ argument. Setting this to a value of `true` or `false` controls whether the response is pretty-printed \(with indentation and new lines\). By default, the SDK sets the _pretty_ argument to `true`.
+
+### Changing the base URL
+
+Base URL for the HTTP operation can be changed in the following way:
+
+```ruby
+Ionoscloud.configure do |config|
+  config.username = ENV['IONOS_USERNAME']
+  config.password = ENV['IONOS_PASSWORD']
+
+  # Configure the url used by the SDK
+  config.host = 'https://api.ionos.com/cloudapi/v6'
+  # This must be set as well because of the way the API works, otherwise the set url will not be used
+  condif.server_index = nil
+end
+```
+
 ## Feature Reference
 
 The IONOS Cloud SDK for Ruby aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:

data/docs/api/BackupUnitsApi.md

@@ -4,22 +4,22 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**backupunits_delete**](BackupUnitsApi.md#backupunits_delete) | **DELETE** /backupunits/{backupunitId} | Delete a Backup Unit |
-| [**backupunits_find_by_id**](BackupUnitsApi.md#backupunits_find_by_id) | **GET** /backupunits/{backupunitId} | Returns the specified Backup Unit |
-| [**backupunits_get**](BackupUnitsApi.md#backupunits_get) | **GET** /backupunits | List Backup Units |
-| [**backupunits_patch**](BackupUnitsApi.md#backupunits_patch) | **PATCH** /backupunits/{backupunitId} | Partially modify a Backup Unit |
-| [**backupunits_post**](BackupUnitsApi.md#backupunits_post) | **POST** /backupunits | Create a Backup Unit |
-| [**backupunits_put**](BackupUnitsApi.md#backupunits_put) | **PUT** /backupunits/{backupunitId} | Modify a Backup Unit |
-| [**backupunits_ssourl_get**](BackupUnitsApi.md#backupunits_ssourl_get) | **GET** /backupunits/{backupunitId}/ssourl | Returns a single signon URL for the specified Backup Unit |
+| [**backupunits_delete**](BackupUnitsApi.md#backupunits_delete) | **DELETE** /backupunits/{backupunitId} | Delete backup units |
+| [**backupunits_find_by_id**](BackupUnitsApi.md#backupunits_find_by_id) | **GET** /backupunits/{backupunitId} | Retrieve backup units |
+| [**backupunits_get**](BackupUnitsApi.md#backupunits_get) | **GET** /backupunits | List backup units |
+| [**backupunits_patch**](BackupUnitsApi.md#backupunits_patch) | **PATCH** /backupunits/{backupunitId} | Partially modify backup units |
+| [**backupunits_post**](BackupUnitsApi.md#backupunits_post) | **POST** /backupunits | Create backup units |
+| [**backupunits_put**](BackupUnitsApi.md#backupunits_put) | **PUT** /backupunits/{backupunitId} | Modify backup units |
+| [**backupunits_ssourl_get**](BackupUnitsApi.md#backupunits_ssourl_get) | **GET** /backupunits/{backupunitId}/ssourl | Retrieve BU single sign-on URLs |
 
 
 ## backupunits_delete
 
 > backupunits_delete(backupunit_id, opts)
 
-Delete a Backup Unit
+Delete backup units
 
-NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit
+Remove the specified backup unit.  This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself
 
 ### Examples
 
@@ -39,7 +39,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup Unit
+backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -47,7 +47,7 @@ opts = {
 }
 
 begin
-  # Delete a Backup Unit
+  # Delete backup units
   api_instance.backupunits_delete(backupunit_id, opts)
 rescue Ionoscloud::ApiError => e
   puts "Error when calling BackupUnitsApi->backupunits_delete: #{e}"
@@ -62,7 +62,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # Delete a Backup Unit
+  # Delete backup units
   data, status_code, headers = api_instance.backupunits_delete_with_http_info(backupunit_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -76,7 +76,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backupunit_id** | **String** | The unique ID of the backup Unit |  |
+| **backupunit_id** | **String** | The unique ID of the backup unit. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
@@ -99,9 +99,9 @@ Basic Authentication, Token Authentication
 
 > <BackupUnit> backupunits_find_by_id(backupunit_id, opts)
 
-Returns the specified Backup Unit
+Retrieve backup units
 
-You can retrieve the details of an specific backup unit.
+Retrieve the properties of the specified backup unit.
 
 ### Examples
 
@@ -121,7 +121,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
+backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -129,7 +129,7 @@ opts = {
 }
 
 begin
-  # Returns the specified Backup Unit
+  # Retrieve backup units
   result = api_instance.backupunits_find_by_id(backupunit_id, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -145,7 +145,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Returns the specified Backup Unit
+  # Retrieve backup units
   data, status_code, headers = api_instance.backupunits_find_by_id_with_http_info(backupunit_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -159,14 +159,14 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backupunit_id** | **String** | The unique ID of the backup unit |  |
+| **backupunit_id** | **String** | The unique ID of the backup unit. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included.  - depth&#x3D;1: Direct properties and children references are included.  - depth&#x3D;2: Direct properties and children properties are included.  - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included.  - depth&#x3D;... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**BackupUnit**](BackupUnit.md)
+[**BackupUnit**](../models/BackupUnit.md)
 
 ### Authorization
 
@@ -182,9 +182,9 @@ Basic Authentication, Token Authentication
 
 > <BackupUnits> backupunits_get(opts)
 
-List Backup Units
+List backup units
 
-You can retrieve a complete list of backup Units that you have access to.
+List all available backup units.
 
 ### Examples
 
@@ -211,7 +211,7 @@ opts = {
 }
 
 begin
-  # List Backup Units
+  # List backup units
   result = api_instance.backupunits_get(opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -227,7 +227,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List Backup Units
+  # List backup units
   data, status_code, headers = api_instance.backupunits_get_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -247,7 +247,7 @@ end
 
 ### Return type
 
-[**BackupUnits**](BackupUnits.md)
+[**BackupUnits**](../models/BackupUnits.md)
 
 ### Authorization
 
@@ -261,11 +261,11 @@ Basic Authentication, Token Authentication
 
 ## backupunits_patch
 
-> <BackupUnit> backupunits_patch(backupunit_id, backup_unit_properties, opts)
+> <BackupUnit> backupunits_patch(backupunit_id, backup_unit, opts)
 
-Partially modify a Backup Unit
+Partially modify backup units
 
-You can use update a Backup Unit properties.
+Update the properties of the specified backup unit.
 
 ### Examples
 
@@ -285,8 +285,8 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
-backup_unit_properties = Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'}) # BackupUnitProperties | Modified backup Unit properties
+backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit.
+backup_unit = Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'}) # BackupUnitProperties | The properties of the backup unit to be updated.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -294,8 +294,8 @@ opts = {
 }
 
 begin
-  # Partially modify a Backup Unit
-  result = api_instance.backupunits_patch(backupunit_id, backup_unit_properties, opts)
+  # Partially modify backup units
+  result = api_instance.backupunits_patch(backupunit_id, backup_unit, opts)
   p result
 rescue Ionoscloud::ApiError => e
   puts "Error when calling BackupUnitsApi->backupunits_patch: #{e}"
@@ -306,12 +306,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BackupUnit>, Integer, Hash)> backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
+> <Array(<BackupUnit>, Integer, Hash)> backupunits_patch_with_http_info(backupunit_id, backup_unit, opts)
 
 ```ruby
 begin
-  # Partially modify a Backup Unit
-  data, status_code, headers = api_instance.backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
+  # Partially modify backup units
+  data, status_code, headers = api_instance.backupunits_patch_with_http_info(backupunit_id, backup_unit, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BackupUnit>
@@ -324,15 +324,15 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backupunit_id** | **String** | The unique ID of the backup unit |  |
-| **backup_unit_properties** | [**BackupUnitProperties**](BackupUnitProperties.md) | Modified backup Unit properties |  |
+| **backupunit_id** | **String** | The unique ID of the backup unit. |  |
+| **backup_unit** | [**BackupUnitProperties**](BackupUnitProperties.md) | The properties of the backup unit to be updated. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included.  - depth&#x3D;1: Direct properties and children references are included.  - depth&#x3D;2: Direct properties and children properties are included.  - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included.  - depth&#x3D;... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**BackupUnit**](BackupUnit.md)
+[**BackupUnit**](../models/BackupUnit.md)
 
 ### Authorization
 
@@ -348,9 +348,9 @@ Basic Authentication, Token Authentication
 
 > <BackupUnit> backupunits_post(backup_unit, opts)
 
-Create a Backup Unit
+Create backup units
 
-Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature 
+Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management. 
 
 ### Examples
 
@@ -370,7 +370,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Payload containing data to create a new Backup Unit
+backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | The backup unit to create.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -378,7 +378,7 @@ opts = {
 }
 
 begin
-  # Create a Backup Unit
+  # Create backup units
   result = api_instance.backupunits_post(backup_unit, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -394,7 +394,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create a Backup Unit
+  # Create backup units
   data, status_code, headers = api_instance.backupunits_post_with_http_info(backup_unit, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -408,14 +408,14 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backup_unit** | [**BackupUnit**](BackupUnit.md) | Payload containing data to create a new Backup Unit |  |
+| **backup_unit** | [**BackupUnit**](BackupUnit.md) | The backup unit to create. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included.  - depth&#x3D;1: Direct properties and children references are included.  - depth&#x3D;2: Direct properties and children properties are included.  - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included.  - depth&#x3D;... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**BackupUnit**](BackupUnit.md)
+[**BackupUnit**](../models/BackupUnit.md)
 
 ### Authorization
 
@@ -431,9 +431,9 @@ Basic Authentication, Token Authentication
 
 > <BackupUnit> backupunits_put(backupunit_id, backup_unit, opts)
 
-Modify a Backup Unit
+Modify backup units
 
-You can use update a Backup Unit properties.
+Modify the properties of the specified backup unit.
 
 ### Examples
 
@@ -453,8 +453,8 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
-backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Modified backup Unit
+backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit.
+backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | The modified backup unit.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -462,7 +462,7 @@ opts = {
 }
 
 begin
-  # Modify a Backup Unit
+  # Modify backup units
   result = api_instance.backupunits_put(backupunit_id, backup_unit, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -478,7 +478,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Modify a Backup Unit
+  # Modify backup units
   data, status_code, headers = api_instance.backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -492,15 +492,15 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backupunit_id** | **String** | The unique ID of the backup unit |  |
-| **backup_unit** | [**BackupUnit**](BackupUnit.md) | Modified backup Unit |  |
+| **backupunit_id** | **String** | The unique ID of the backup unit. |  |
+| **backup_unit** | [**BackupUnit**](BackupUnit.md) | The modified backup unit. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included.  - depth&#x3D;1: Direct properties and children references are included.  - depth&#x3D;2: Direct properties and children properties are included.  - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included.  - depth&#x3D;... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**BackupUnit**](BackupUnit.md)
+[**BackupUnit**](../models/BackupUnit.md)
 
 ### Authorization
 
@@ -516,9 +516,9 @@ Basic Authentication, Token Authentication
 
 > <BackupUnitSSO> backupunits_ssourl_get(backupunit_id, opts)
 
-Returns a single signon URL for the specified Backup Unit
+Retrieve BU single sign-on URLs
 
-Returns a single signon URL for the specified Backup Unit.
+Retrieve a single sign-on URL for the specified backup unit.
 
 ### Examples
 
@@ -538,14 +538,14 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::BackupUnitsApi.new
-backupunit_id = 'backupunit_id_example' # String | The unique UUID of the backup unit
+backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
 }
 
 begin
-  # Returns a single signon URL for the specified Backup Unit
+  # Retrieve BU single sign-on URLs
   result = api_instance.backupunits_ssourl_get(backupunit_id, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -561,7 +561,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Returns a single signon URL for the specified Backup Unit
+  # Retrieve BU single sign-on URLs
   data, status_code, headers = api_instance.backupunits_ssourl_get_with_http_info(backupunit_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -575,13 +575,13 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **backupunit_id** | **String** | The unique UUID of the backup unit |  |
+| **backupunit_id** | **String** | The unique ID of the backup unit. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**BackupUnitSSO**](BackupUnitSSO.md)
+[**BackupUnitSSO**](../models/BackupUnitSSO.md)
 
 ### Authorization
 

data/docs/api/ContractResourcesApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**contracts_get**](ContractResourcesApi.md#contracts_get) | **GET** /contracts | Retrieve a Contract |
+| [**contracts_get**](ContractResourcesApi.md#contracts_get) | **GET** /contracts | Retrieve contracts |
 
 
 ## contracts_get
 
 > <Contracts> contracts_get(opts)
 
-Retrieve a Contract
+Retrieve contracts
 
-Retrieves the attributes of user's contract. In this version, the resource became a collection.
+Retrieve the properties of the user's contract. In this version, the resource became a collection.
 
 ### Examples
 
@@ -40,7 +40,7 @@ opts = {
 }
 
 begin
-  # Retrieve a Contract
+  # Retrieve contracts
   result = api_instance.contracts_get(opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -56,7 +56,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Retrieve a Contract
+  # Retrieve contracts
   data, status_code, headers = api_instance.contracts_get_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -76,7 +76,7 @@ end
 
 ### Return type
 
-[**Contracts**](Contracts.md)
+[**Contracts**](../models/Contracts.md)
 
 ### Authorization
 

data/docs/api/DataCentersApi.md

@@ -18,7 +18,7 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
 
 Delete data centers
 
-Remove the specified data center and all the elements it contains. This is method is destructive and should be used carefully.
+Delete the specified data center and all the elements it contains. This is method is destructive and should be used carefully.
 
 ### Examples
 
@@ -165,7 +165,7 @@ end
 
 ### Return type
 
-[**Datacenter**](Datacenter.md)
+[**Datacenter**](../models/Datacenter.md)
 
 ### Authorization
 
@@ -250,7 +250,7 @@ end
 
 ### Return type
 
-[**Datacenters**](Datacenters.md)
+[**Datacenters**](../models/Datacenters.md)
 
 ### Authorization
 
@@ -268,7 +268,7 @@ Basic Authentication, Token Authentication
 
 Partially modify data centers
 
-Update data centers, rename them, or change their descriptions.
+Update the properties of the specified data center, rename it, or change the description.
 
 ### Examples
 
@@ -289,7 +289,7 @@ end
 
 api_instance = Ionoscloud::DataCentersApi.new
 datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
-datacenter = Ionoscloud::DatacenterProperties.new({location: 'us/las'}) # DatacenterProperties | The modified properties of the data center.
+datacenter = Ionoscloud::DatacenterProperties.new({location: 'us/las'}) # DatacenterProperties | The properties of the data center to be updated.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -328,14 +328,14 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **datacenter_id** | **String** | The unique ID of the data center. |  |
-| **datacenter** | [**DatacenterProperties**](DatacenterProperties.md) | The modified properties of the data center. |  |
+| **datacenter** | [**DatacenterProperties**](DatacenterProperties.md) | The properties of the data center to be updated. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**Datacenter**](Datacenter.md)
+[**Datacenter**](../models/Datacenter.md)
 
 ### Authorization
 
@@ -353,7 +353,7 @@ Basic Authentication, Token Authentication
 
 Create data centers
 
-Create new data centers, and data centers that already contain elements, such as servers and storage volumes, with this POST method.  Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.
+Create new data centers, and data centers that already contain elements, such as servers and storage volumes.  Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.
 
 ### Examples
 
@@ -373,7 +373,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::DataCentersApi.new
-datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | The data center to be created.
+datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | The data center to create.
 opts = {
   pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
   depth: 56, # Integer | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on
@@ -411,14 +411,14 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **datacenter** | [**Datacenter**](Datacenter.md) | The data center to be created. |  |
+| **datacenter** | [**Datacenter**](Datacenter.md) | The data center to create. |  |
 | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
 | **depth** | **Integer** | Controls the detail depth of the response objects.  GET /datacenters/[ID]  - depth=0: Only direct properties are included; children (servers and other elements) are not included.  - depth=1: Direct properties and children references are included.  - depth=2: Direct properties and children properties are included.  - depth=3: Direct properties and children properties and children's children are included.  - depth=... and so on | [optional][default to 0] |
 | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
 
 ### Return type
 
-[**Datacenter**](Datacenter.md)
+[**Datacenter**](../models/Datacenter.md)
 
 ### Authorization
 
@@ -436,7 +436,7 @@ Basic Authentication, Token Authentication
 
 Modify data centers
 
-Update data centers, rename them, or change their descriptions.
+Modify the properties of the specified data center, rename it, or change the description.
 
 ### Examples
 
@@ -503,7 +503,7 @@ end
 
 ### Return type
 
-[**Datacenter**](Datacenter.md)
+[**Datacenter**](../models/Datacenter.md)
 
 ### Authorization