ionoscloud 5.1.1 → 6.0.0.beta.4

data/lib/ionoscloud/api/{request_api.rb → requests_api.rb}

@@ -1,9 +1,9 @@
 =begin
 #CLOUD API
 
-#An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based \"Data Center Designer\" (DCD) tool or via an easy to use API.   The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.
+#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: 5.0
+The version of the OpenAPI document: 6.0-SDK.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1-SNAPSHOT
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1-SNAPSHOT
 require 'cgi'
 
 module Ionoscloud
-  class RequestApi
+  class RequestsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
@@ -23,9 +23,9 @@ module Ionoscloud
     # Retrieves the attributes of a given request.
     # @param request_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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.
     # @return [Request]
     def requests_find_by_id(request_id, opts = {})
       data, _status_code, _headers = requests_find_by_id_with_http_info(request_id, opts)
@@ -36,24 +36,24 @@ module Ionoscloud
     # Retrieves the attributes of a given request.
     # @param request_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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.
     # @return [Array<(Request, Integer, Hash)>] Request data, response status code and response headers
     def requests_find_by_id_with_http_info(request_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RequestApi.requests_find_by_id ...'
+        @api_client.config.logger.debug 'Calling API: RequestsApi.requests_find_by_id ...'
       end
       # verify the required parameter 'request_id' is set
       if @api_client.config.client_side_validation && request_id.nil?
-        fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestApi.requests_find_by_id"
+        fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestsApi.requests_find_by_id"
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_find_by_id, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_find_by_id, must be smaller than or equal to 10.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_find_by_id, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_find_by_id, must be greater than or equal to 0.'
       end
 
       # resource path
@@ -83,7 +83,7 @@ module Ionoscloud
       auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']
 
       new_options = opts.merge(
-        :operation => :"RequestApi.requests_find_by_id",
+        :operation => :"RequestsApi.requests_find_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -94,7 +94,7 @@ module Ionoscloud
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RequestApi#requests_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RequestsApi#requests_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -102,9 +102,9 @@ module Ionoscloud
     # List Requests
     # Retrieve a list of API requests.
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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)
-    # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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)
+    # @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&#39;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&#39;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&#39;t depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
@@ -116,8 +116,8 @@ module Ionoscloud
     # @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 [Integer] :offset the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) (default to 0)
-    # @option opts [Integer] :limit the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) (default to 1000)
+    # @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]
     def requests_get(opts = {})
       data, _status_code, _headers = requests_get_with_http_info(opts)
@@ -127,9 +127,9 @@ module Ionoscloud
     # List Requests
     # Retrieve a list of API requests.
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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
-    # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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
+    # @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&#39;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&#39;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&#39;t depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
@@ -141,31 +141,31 @@ module Ionoscloud
     # @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 [Integer] :offset the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination)
-    # @option opts [Integer] :limit the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination)
+    # @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
     def requests_get_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RequestApi.requests_get ...'
+        @api_client.config.logger.debug 'Calling API: RequestsApi.requests_get ...'
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_get, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_get, must be smaller than or equal to 10.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_get, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_get, must be greater than or equal to 0.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling RequestApi.requests_get, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling RequestsApi.requests_get, must be greater than or equal to 0.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RequestApi.requests_get, must be smaller than or equal to 10000.'
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RequestsApi.requests_get, must be smaller than or equal to 10000.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RequestApi.requests_get, must be greater than or equal to 1.'
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RequestsApi.requests_get, must be greater than or equal to 1.'
       end
 
       # resource path
@@ -208,7 +208,7 @@ module Ionoscloud
       auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']
 
       new_options = opts.merge(
-        :operation => :"RequestApi.requests_get",
+        :operation => :"RequestsApi.requests_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -219,7 +219,7 @@ module Ionoscloud
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RequestApi#requests_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RequestsApi#requests_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -228,9 +228,9 @@ module Ionoscloud
     # Retrieves the status of a given request.
     # @param request_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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)
-    # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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)
+    # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
     # @return [RequestStatus]
     def requests_status_get(request_id, opts = {})
       data, _status_code, _headers = requests_status_get_with_http_info(request_id, opts)
@@ -241,24 +241,24 @@ module Ionoscloud
     # Retrieves the status of a given request.
     # @param request_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
-    # @option opts [Integer] :depth Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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
-    # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+    # @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
+    # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
     # @return [Array<(RequestStatus, Integer, Hash)>] RequestStatus data, response status code and response headers
     def requests_status_get_with_http_info(request_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RequestApi.requests_status_get ...'
+        @api_client.config.logger.debug 'Calling API: RequestsApi.requests_status_get ...'
       end
       # verify the required parameter 'request_id' is set
       if @api_client.config.client_side_validation && request_id.nil?
-        fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestApi.requests_status_get"
+        fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestsApi.requests_status_get"
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_status_get, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_status_get, must be smaller than or equal to 10.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestApi.requests_status_get, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_status_get, must be greater than or equal to 0.'
       end
 
       # resource path
@@ -288,7 +288,7 @@ module Ionoscloud
       auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']
 
       new_options = opts.merge(
-        :operation => :"RequestApi.requests_status_get",
+        :operation => :"RequestsApi.requests_status_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -299,7 +299,7 @@ module Ionoscloud
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RequestApi#requests_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RequestsApi#requests_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end