ionoscloud 6.0.0.beta.3 → 6.0.0.beta.4

data/lib/ionoscloud/api/ip_blocks_api.rb

@@ -1,12 +1,12 @@
 =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: 6.0-SDK.1
+The version of the OpenAPI document: 6.0-SDK.3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1-SNAPSHOT
+OpenAPI Generator version: 5.2.1-SNAPSHOT
 
 =end
 
@@ -23,9 +23,9 @@ module Ionoscloud
     # Removes the specific IP Block.
     # @param ipblock_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 [nil]
     def ipblocks_delete(ipblock_id, opts = {})
       ipblocks_delete_with_http_info(ipblock_id, opts)
@@ -36,9 +36,9 @@ module Ionoscloud
     # Removes the specific IP Block.
     # @param ipblock_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<(nil, Integer, Hash)>] nil, response status code and response headers
     def ipblocks_delete_with_http_info(ipblock_id, opts = {})
       if @api_client.config.debugging
@@ -103,9 +103,9 @@ module Ionoscloud
     # Retrieves the attributes of a given IP Block.
     # @param ipblock_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 [IpBlock]
     def ipblocks_find_by_id(ipblock_id, opts = {})
       data, _status_code, _headers = ipblocks_find_by_id_with_http_info(ipblock_id, opts)
@@ -116,9 +116,9 @@ module Ionoscloud
     # Retrieves the attributes of a given IP Block.
     # @param ipblock_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<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
     def ipblocks_find_by_id_with_http_info(ipblock_id, opts = {})
       if @api_client.config.debugging
@@ -182,9 +182,11 @@ module Ionoscloud
     # List IP Blocks 
     # Retrieve a list of all reserved IP Blocks.
     # @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 [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 100)
     # @return [IpBlocks]
     def ipblocks_get(opts = {})
       data, _status_code, _headers = ipblocks_get_with_http_info(opts)
@@ -194,9 +196,11 @@ module Ionoscloud
     # List IP Blocks 
     # Retrieve a list of all reserved IP Blocks.
     # @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 [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<(IpBlocks, Integer, Hash)>] IpBlocks data, response status code and response headers
     def ipblocks_get_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -210,6 +214,18 @@ module Ionoscloud
         fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_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 IPBlocksApi.ipblocks_get, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IPBlocksApi.ipblocks_get, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IPBlocksApi.ipblocks_get, must be greater than or equal to 1.'
+      end
+
       # resource path
       local_var_path = '/ipblocks'
 
@@ -217,6 +233,8 @@ module Ionoscloud
       query_params = opts[:query_params] || {}
       query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
       query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -258,9 +276,9 @@ module Ionoscloud
     # @param ipblock_id [String] 
     # @param ipblock [IpBlockProperties] IP Block to be modified
     # @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 [IpBlock]
     def ipblocks_patch(ipblock_id, ipblock, opts = {})
       data, _status_code, _headers = ipblocks_patch_with_http_info(ipblock_id, ipblock, opts)
@@ -272,9 +290,9 @@ module Ionoscloud
     # @param ipblock_id [String] 
     # @param ipblock [IpBlockProperties] IP Block to be modified
     # @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<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
     def ipblocks_patch_with_http_info(ipblock_id, ipblock, opts = {})
       if @api_client.config.debugging
@@ -345,9 +363,9 @@ module Ionoscloud
     # This will reserve a new IP Block.
     # @param ipblock [IpBlock] IP Block to be reserved
     # @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 [IpBlock]
     def ipblocks_post(ipblock, opts = {})
       data, _status_code, _headers = ipblocks_post_with_http_info(ipblock, opts)
@@ -358,9 +376,9 @@ module Ionoscloud
     # This will reserve a new IP Block.
     # @param ipblock [IpBlock] IP Block to be reserved
     # @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<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
     def ipblocks_post_with_http_info(ipblock, opts = {})
       if @api_client.config.debugging
@@ -428,9 +446,9 @@ module Ionoscloud
     # @param ipblock_id [String] 
     # @param ipblock [IpBlock] IP Block to be modified
     # @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 [IpBlock]
     def ipblocks_put(ipblock_id, ipblock, opts = {})
       data, _status_code, _headers = ipblocks_put_with_http_info(ipblock_id, ipblock, opts)
@@ -442,9 +460,9 @@ module Ionoscloud
     # @param ipblock_id [String] 
     # @param ipblock [IpBlock] IP Block to be modified
     # @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<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
     def ipblocks_put_with_http_info(ipblock_id, ipblock, opts = {})
       if @api_client.config.debugging