ionoscloud 6.0.0.beta.4 → 6.0.0

data/docs/api/SnapshotsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**snapshots_delete**](SnapshotsApi.md#snapshots_delete) | **DELETE** /snapshots/{snapshotId} | Delete a Snapshot |
-| [**snapshots_find_by_id**](SnapshotsApi.md#snapshots_find_by_id) | **GET** /snapshots/{snapshotId} | Retrieve a Snapshot by its uuid. |
-| [**snapshots_get**](SnapshotsApi.md#snapshots_get) | **GET** /snapshots | List Snapshots |
-| [**snapshots_patch**](SnapshotsApi.md#snapshots_patch) | **PATCH** /snapshots/{snapshotId} | Partially modify a Snapshot |
-| [**snapshots_put**](SnapshotsApi.md#snapshots_put) | **PUT** /snapshots/{snapshotId} | Modify a Snapshot |
+| [**snapshots_delete**](SnapshotsApi.md#snapshots_delete) | **DELETE** /snapshots/{snapshotId} | Delete snapshots |
+| [**snapshots_find_by_id**](SnapshotsApi.md#snapshots_find_by_id) | **GET** /snapshots/{snapshotId} | Retrieve snapshots by ID |
+| [**snapshots_get**](SnapshotsApi.md#snapshots_get) | **GET** /snapshots | List snapshots |
+| [**snapshots_patch**](SnapshotsApi.md#snapshots_patch) | **PATCH** /snapshots/{snapshotId} | Partially modify snapshots |
+| [**snapshots_put**](SnapshotsApi.md#snapshots_put) | **PUT** /snapshots/{snapshotId} | Modify snapshots |
 
 
 ## snapshots_delete
 
 > snapshots_delete(snapshot_id, opts)
 
-Delete a Snapshot
+Delete snapshots
 
 Deletes the specified snapshot.
 
@@ -37,7 +37,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::SnapshotsApi.new
-snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
+snapshot_id = 'snapshot_id_example' # String | The unique ID of the snapshot.
 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
@@ -45,7 +45,7 @@ opts = {
 }
 
 begin
-  # Delete a Snapshot
+  # Delete snapshots
   api_instance.snapshots_delete(snapshot_id, opts)
 rescue Ionoscloud::ApiError => e
   puts "Error when calling SnapshotsApi->snapshots_delete: #{e}"
@@ -60,7 +60,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # Delete a Snapshot
+  # Delete snapshots
   data, status_code, headers = api_instance.snapshots_delete_with_http_info(snapshot_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -74,7 +74,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **snapshot_id** | **String** | The unique ID of the Snapshot |  |
+| **snapshot_id** | **String** | The unique ID of the snapshot. |  |
 | **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] |
@@ -97,9 +97,9 @@ Basic Authentication, Token Authentication
 
 > <Snapshot> snapshots_find_by_id(snapshot_id, opts)
 
-Retrieve a Snapshot by its uuid.
+Retrieve snapshots by ID
 
-Retrieves the attributes of a given Snapshot.
+Retrieve the properties of the specified snapshot.
 
 ### Examples
 
@@ -119,7 +119,7 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::SnapshotsApi.new
-snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
+snapshot_id = 'snapshot_id_example' # String | The unique ID of the snapshot.
 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
@@ -127,7 +127,7 @@ opts = {
 }
 
 begin
-  # Retrieve a Snapshot by its uuid.
+  # Retrieve snapshots by ID
   result = api_instance.snapshots_find_by_id(snapshot_id, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -143,7 +143,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Retrieve a Snapshot by its uuid.
+  # Retrieve snapshots by ID
   data, status_code, headers = api_instance.snapshots_find_by_id_with_http_info(snapshot_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -157,14 +157,14 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **snapshot_id** | **String** | The unique ID of the Snapshot |  |
+| **snapshot_id** | **String** | The unique ID of the snapshot. |  |
 | **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
 
-[**Snapshot**](Snapshot.md)
+[**Snapshot**](../models/Snapshot.md)
 
 ### Authorization
 
@@ -180,9 +180,9 @@ Basic Authentication, Token Authentication
 
 > <Snapshots> snapshots_get(opts)
 
-List Snapshots
+List snapshots
 
-Retrieve a list of available snapshots.
+List all available snapshots.
 
 ### Examples
 
@@ -209,7 +209,7 @@ opts = {
 }
 
 begin
-  # List Snapshots
+  # List snapshots
   result = api_instance.snapshots_get(opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -225,7 +225,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List Snapshots
+  # List snapshots
   data, status_code, headers = api_instance.snapshots_get_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -245,7 +245,7 @@ end
 
 ### Return type
 
-[**Snapshots**](Snapshots.md)
+[**Snapshots**](../models/Snapshots.md)
 
 ### Authorization
 
@@ -261,9 +261,9 @@ Basic Authentication, Token Authentication
 
 > <Snapshot> snapshots_patch(snapshot_id, snapshot, opts)
 
-Partially modify a Snapshot
+Partially modify snapshots
 
-You can use this method to update attributes of a snapshot.
+Update the properties of the specified snapshot.
 
 ### Examples
 
@@ -283,8 +283,8 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::SnapshotsApi.new
-snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
-snapshot = Ionoscloud::SnapshotProperties.new # SnapshotProperties | Modified Snapshot
+snapshot_id = 'snapshot_id_example' # String | The unique ID of the snapshot.
+snapshot = Ionoscloud::SnapshotProperties.new # SnapshotProperties | The properties of the snapshot 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
@@ -292,7 +292,7 @@ opts = {
 }
 
 begin
-  # Partially modify a Snapshot
+  # Partially modify snapshots
   result = api_instance.snapshots_patch(snapshot_id, snapshot, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -308,7 +308,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Partially modify a Snapshot
+  # Partially modify snapshots
   data, status_code, headers = api_instance.snapshots_patch_with_http_info(snapshot_id, snapshot, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -322,15 +322,15 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **snapshot_id** | **String** | The unique ID of the Snapshot |  |
-| **snapshot** | [**SnapshotProperties**](SnapshotProperties.md) | Modified Snapshot |  |
+| **snapshot_id** | **String** | The unique ID of the snapshot. |  |
+| **snapshot** | [**SnapshotProperties**](SnapshotProperties.md) | The properties of the snapshot 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
 
-[**Snapshot**](Snapshot.md)
+[**Snapshot**](../models/Snapshot.md)
 
 ### Authorization
 
@@ -346,9 +346,9 @@ Basic Authentication, Token Authentication
 
 > <Snapshot> snapshots_put(snapshot_id, snapshot, opts)
 
-Modify a Snapshot
+Modify snapshots
 
-You can use update attributes of a resource.
+Modify the properties of the specified snapshot.
 
 ### Examples
 
@@ -368,8 +368,8 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::SnapshotsApi.new
-snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
-snapshot = Ionoscloud::Snapshot.new({properties: Ionoscloud::SnapshotProperties.new}) # Snapshot | Modified Snapshot
+snapshot_id = 'snapshot_id_example' # String | The unique ID of the snapshot.
+snapshot = Ionoscloud::Snapshot.new({properties: Ionoscloud::SnapshotProperties.new}) # Snapshot | The modified snapshot
 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
@@ -377,7 +377,7 @@ opts = {
 }
 
 begin
-  # Modify a Snapshot
+  # Modify snapshots
   result = api_instance.snapshots_put(snapshot_id, snapshot, opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -393,7 +393,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Modify a Snapshot
+  # Modify snapshots
   data, status_code, headers = api_instance.snapshots_put_with_http_info(snapshot_id, snapshot, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -407,15 +407,15 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **snapshot_id** | **String** | The unique ID of the Snapshot |  |
-| **snapshot** | [**Snapshot**](Snapshot.md) | Modified Snapshot |  |
+| **snapshot_id** | **String** | The unique ID of the snapshot. |  |
+| **snapshot** | [**Snapshot**](Snapshot.md) | The modified snapshot |  |
 | **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
 
-[**Snapshot**](Snapshot.md)
+[**Snapshot**](../models/Snapshot.md)
 
 ### Authorization
 

data/docs/api/TemplatesApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**templates_find_by_id**](TemplatesApi.md#templates_find_by_id) | **GET** /templates/{templateId} | Retrieve an available template |
-| [**templates_get**](TemplatesApi.md#templates_get) | **GET** /templates | List Templates |
+| [**templates_find_by_id**](TemplatesApi.md#templates_find_by_id) | **GET** /templates/{templateId} | Retrieve Cubes Templates |
+| [**templates_get**](TemplatesApi.md#templates_get) | **GET** /templates | List Cubes Templates |
 
 
 ## templates_find_by_id
 
 > <Template> templates_find_by_id(template_id, opts)
 
-Retrieve an available template
+Retrieve Cubes Templates
 
-Retrieves the attributes of a given template.
+Retrieve the properties of the specified Cubes Template.  This operation is only supported for the Cubes.
 
 ### Examples
 
@@ -34,13 +34,13 @@ Ionoscloud.configure do |config|
 end
 
 api_instance = Ionoscloud::TemplatesApi.new
-template_id = 'template_id_example' # String | 
+template_id = 'template_id_example' # String | The unique Template ID.
 opts = {
   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
 }
 
 begin
-  # Retrieve an available template
+  # Retrieve Cubes Templates
   result = api_instance.templates_find_by_id(template_id, 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 an available template
+  # Retrieve Cubes Templates
   data, status_code, headers = api_instance.templates_find_by_id_with_http_info(template_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -70,12 +70,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **template_id** | **String** |  |  |
+| **template_id** | **String** | The unique Template ID. |  |
 | **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] |
 
 ### Return type
 
-[**Template**](Template.md)
+[**Template**](../models/Template.md)
 
 ### Authorization
 
@@ -91,9 +91,9 @@ Basic Authentication, Token Authentication
 
 > <Templates> templates_get(opts)
 
-List Templates
+List Cubes Templates
 
-Retrieve a list of available templates. Templates can be used on specific server types only (CUBE at the moment)
+List all of the available Cubes Templates.  This operation is only supported for the Cubes.
 
 ### Examples
 
@@ -118,7 +118,7 @@ opts = {
 }
 
 begin
-  # List Templates
+  # List Cubes Templates
   result = api_instance.templates_get(opts)
   p result
 rescue Ionoscloud::ApiError => e
@@ -134,7 +134,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List Templates
+  # List Cubes Templates
   data, status_code, headers = api_instance.templates_get_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -152,7 +152,7 @@ end
 
 ### Return type
 
-[**Templates**](Templates.md)
+[**Templates**](../models/Templates.md)
 
 ### Authorization