ionoscloud 6.0.0.beta.4 → 6.0.0

data/lib/ionoscloud/api/private_cross_connects_api.rb

@@ -3,7 +3,7 @@
 
 #IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the \"Data Center Designer\" (DCD) browser-based tool.    Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.
 
-The version of the OpenAPI document: 6.0-SDK.3
+The version of the OpenAPI document: 6.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1-SNAPSHOT
@@ -19,9 +19,9 @@ module Ionoscloud
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Delete a Private Cross-Connect
-    # Delete a private cross-connect if no data centers are joined to the given PCC
-    # @param pcc_id [String] The unique ID of the private cross-connect
+    # Delete private Cross-Connects
+    # Remove the specified private Cross-Connect (only if not connected to any data centers).
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -32,9 +32,9 @@ module Ionoscloud
       nil
     end
 
-    # Delete a Private Cross-Connect
-    # Delete a private cross-connect if no data centers are joined to the given PCC
-    # @param pcc_id [String] The unique ID of the private cross-connect
+    # Delete private Cross-Connects
+    # Remove the specified private Cross-Connect (only if not connected to any data centers).
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
@@ -99,9 +99,9 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Retrieve a Private Cross-Connect
-    # You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.
-    # @param pcc_id [String] The unique ID of the private cross-connect
+    # Retrieve private Cross-Connects
+    # Retrieve a private Cross-Connect by the resource ID. Cross-Connect ID is in the response body when the private Cross-Connect is created, and in the list of private Cross-Connects, returned by GET.
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -112,9 +112,9 @@ module Ionoscloud
       data
     end
 
-    # Retrieve a Private Cross-Connect
-    # You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.
-    # @param pcc_id [String] The unique ID of the private cross-connect
+    # Retrieve private Cross-Connects
+    # Retrieve a private Cross-Connect by the resource ID. Cross-Connect ID is in the response body when the private Cross-Connect is created, and in the list of private Cross-Connects, returned by GET.
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
@@ -179,8 +179,8 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # List Private Cross-Connects
-    # You can retrieve a complete list of private cross-connects provisioned under your account
+    # List private Cross-Connects
+    # List all private Cross-Connects for your account.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -191,8 +191,8 @@ module Ionoscloud
       data
     end
 
-    # List Private Cross-Connects
-    # You can retrieve a complete list of private cross-connects provisioned under your account
+    # List private Cross-Connects
+    # List all private Cross-Connects for your account.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
@@ -253,10 +253,10 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Partially Modify a Private Cross-Connect
-    # You can use update private cross-connect to re-name or update its description
-    # @param pcc_id [String] The unique ID of the private cross-connect
-    # @param pcc [PrivateCrossConnectProperties] Modified properties of private cross-connect
+    # Partially modify private Cross-Connects
+    # Update the properties of the specified private Cross-Connect.
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
+    # @param pcc [PrivateCrossConnectProperties] The properties of the private Cross-Connect to be updated.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -267,10 +267,10 @@ module Ionoscloud
       data
     end
 
-    # Partially Modify a Private Cross-Connect
-    # You can use update private cross-connect to re-name or update its description
-    # @param pcc_id [String] The unique ID of the private cross-connect
-    # @param pcc [PrivateCrossConnectProperties] Modified properties of private cross-connect
+    # Partially modify private Cross-Connects
+    # Update the properties of the specified private Cross-Connect.
+    # @param pcc_id [String] The unique ID of the private Cross-Connect.
+    # @param pcc [PrivateCrossConnectProperties] The properties of the private Cross-Connect to be updated.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
@@ -341,9 +341,9 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Create a Private Cross-Connect
-    # You can use this POST method to create a private cross-connect.
-    # @param pcc [PrivateCrossConnect] Private Cross-Connect to be created
+    # Create private Cross-Connects
+    # Create a private Cross-Connect.
+    # @param pcc [PrivateCrossConnect] The private Cross-Connect to create.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -354,9 +354,9 @@ module Ionoscloud
       data
     end
 
-    # Create a Private Cross-Connect
-    # You can use this POST method to create a private cross-connect.
-    # @param pcc [PrivateCrossConnect] Private Cross-Connect to be created
+    # Create private Cross-Connects
+    # Create a private Cross-Connect.
+    # @param pcc [PrivateCrossConnect] The private Cross-Connect to create.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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

data/lib/ionoscloud/api/requests_api.rb

@@ -3,7 +3,7 @@
 
 #IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the \"Data Center Designer\" (DCD) browser-based tool.    Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.
 
-The version of the OpenAPI document: 6.0-SDK.3
+The version of the OpenAPI document: 6.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1-SNAPSHOT
@@ -19,9 +19,9 @@ module Ionoscloud
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Retrieve a Request
-    # Retrieves the attributes of a given request.
-    # @param request_id [String] 
+    # Retrieve requests
+    # Retrieve the properties of the specified request.
+    # @param request_id [String] The unique ID of the request.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -32,9 +32,9 @@ module Ionoscloud
       data
     end
 
-    # Retrieve a Request
-    # Retrieves the attributes of a given request.
-    # @param request_id [String] 
+    # Retrieve requests
+    # Retrieve the properties of the specified request.
+    # @param request_id [String] The unique ID of the request.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
@@ -99,23 +99,23 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # List Requests
-    # Retrieve a list of API requests.
+    # List requests
+    # List all API requests.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
     # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
-    # @option opts [String] :filter_status Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter
-    # @option opts [String] :filter_created_after Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
-    # @option opts [String] :filter_created_before Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
-    # @option opts [String] :filter_created_date Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it  depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z
-    # @option opts [String] :filter_created_by Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_etag Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_request_status Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_method Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_headers Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_body Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_url Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
+    # @option opts [String] :filter_status Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_after Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_before Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_date Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.
+    # @option opts [String] :filter_created_by Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_etag Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_request_status Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_method Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_headers Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_body Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_url Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
     # @option opts [Integer] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). (default to 0)
     # @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination). (default to 1000)
     # @return [Requests]
@@ -124,23 +124,23 @@ module Ionoscloud
       data
     end
 
-    # List Requests
-    # Retrieve a list of API requests.
+    # List requests
+    # List all API requests.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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
     # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
-    # @option opts [String] :filter_status Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter
-    # @option opts [String] :filter_created_after Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
-    # @option opts [String] :filter_created_before Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
-    # @option opts [String] :filter_created_date Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it  depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z
-    # @option opts [String] :filter_created_by Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_etag Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_request_status Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_method Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_headers Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_body Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
-    # @option opts [String] :filter_url Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. 
+    # @option opts [String] :filter_status Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_after Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_before Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.
+    # @option opts [String] :filter_created_date Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.
+    # @option opts [String] :filter_created_by Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_etag Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_request_status Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_method Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_headers Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_body Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
+    # @option opts [String] :filter_url Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. 
     # @option opts [Integer] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
     # @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination).
     # @return [Array<(Requests, Integer, Hash)>] Requests data, response status code and response headers
@@ -224,9 +224,9 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Retrieve Request Status
-    # Retrieves the status of a given request.
-    # @param request_id [String] 
+    # Retrieve request status
+    # Retrieve the status of the specified request.
+    # @param request_id [String] The unique ID of the request.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
     # @option opts [Integer] :depth 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 (default to 0)
@@ -237,9 +237,9 @@ module Ionoscloud
       data
     end
 
-    # Retrieve Request Status
-    # Retrieves the status of a given request.
-    # @param request_id [String] 
+    # Retrieve request status
+    # Retrieve the status of the specified request.
+    # @param request_id [String] The unique ID of the request.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
     # @option opts [Integer] :depth 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