ionoscloud 5.1.1 → 6.0.0.beta.4

data/lib/ionoscloud/api/{location_api.rb → locations_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,47 +13,47 @@ OpenAPI Generator version: 5.2.1-SNAPSHOT
 require 'cgi'
 
 module Ionoscloud
-  class LocationApi
+  class LocationsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List Locations within a region
-    # Retrieve a list of Locations within a world's region
+    # List locations within regions
+    # List locations by region ID.
     # @param region_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 [Locations]
     def locations_find_by_region_id(region_id, opts = {})
       data, _status_code, _headers = locations_find_by_region_id_with_http_info(region_id, opts)
       data
     end
 
-    # List Locations within a region
-    # Retrieve a list of Locations within a world's region
+    # List locations within regions
+    # List locations by region ID.
     # @param region_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<(Locations, Integer, Hash)>] Locations data, response status code and response headers
     def locations_find_by_region_id_with_http_info(region_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: LocationApi.locations_find_by_region_id ...'
+        @api_client.config.logger.debug 'Calling API: LocationsApi.locations_find_by_region_id ...'
       end
       # verify the required parameter 'region_id' is set
       if @api_client.config.client_side_validation && region_id.nil?
-        fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationApi.locations_find_by_region_id"
+        fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationsApi.locations_find_by_region_id"
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationApi.locations_find_by_region_id, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_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 LocationApi.locations_find_by_region_id, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_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 => :"LocationApi.locations_find_by_region_id",
+        :operation => :"LocationsApi.locations_find_by_region_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -94,52 +94,52 @@ 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: LocationApi#locations_find_by_region_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LocationsApi#locations_find_by_region_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Retrieve a Location
+    # Retrieve specified locations
     # Retrieves the attributes of a given location
     # @param region_id [String] 
     # @param location_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 [Location]
     def locations_find_by_region_id_and_id(region_id, location_id, opts = {})
       data, _status_code, _headers = locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts)
       data
     end
 
-    # Retrieve a Location
+    # Retrieve specified locations
     # Retrieves the attributes of a given location
     # @param region_id [String] 
     # @param location_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<(Location, Integer, Hash)>] Location data, response status code and response headers
     def locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: LocationApi.locations_find_by_region_id_and_id ...'
+        @api_client.config.logger.debug 'Calling API: LocationsApi.locations_find_by_region_id_and_id ...'
       end
       # verify the required parameter 'region_id' is set
       if @api_client.config.client_side_validation && region_id.nil?
-        fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationApi.locations_find_by_region_id_and_id"
+        fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationsApi.locations_find_by_region_id_and_id"
       end
       # verify the required parameter 'location_id' is set
       if @api_client.config.client_side_validation && location_id.nil?
-        fail ArgumentError, "Missing the required parameter 'location_id' when calling LocationApi.locations_find_by_region_id_and_id"
+        fail ArgumentError, "Missing the required parameter 'location_id' when calling LocationsApi.locations_find_by_region_id_and_id"
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationApi.locations_find_by_region_id_and_id, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id_and_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 LocationApi.locations_find_by_region_id_and_id, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id_and_id, must be greater than or equal to 0.'
       end
 
       # resource path
@@ -169,7 +169,7 @@ module Ionoscloud
       auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']
 
       new_options = opts.merge(
-        :operation => :"LocationApi.locations_find_by_region_id_and_id",
+        :operation => :"LocationsApi.locations_find_by_region_id_and_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -180,40 +180,40 @@ 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: LocationApi#locations_find_by_region_id_and_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LocationsApi#locations_find_by_region_id_and_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List Locations
-    # Retrieve a list of Locations. This list represents where you can provision your virtual data centers
+    # List locations
+    # List the available locations for provisioning your virtual data centers.
     # @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 [Locations]
     def locations_get(opts = {})
       data, _status_code, _headers = locations_get_with_http_info(opts)
       data
     end
 
-    # List Locations
-    # Retrieve a list of Locations. This list represents where you can provision your virtual data centers
+    # List locations
+    # List the available locations for provisioning your virtual data centers.
     # @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<(Locations, Integer, Hash)>] Locations data, response status code and response headers
     def locations_get_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: LocationApi.locations_get ...'
+        @api_client.config.logger.debug 'Calling API: LocationsApi.locations_get ...'
       end
       if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
-        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationApi.locations_get, must be smaller than or equal to 10.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_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 LocationApi.locations_get, must be greater than or equal to 0.'
+        fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_get, must be greater than or equal to 0.'
       end
 
       # resource path
@@ -243,7 +243,7 @@ module Ionoscloud
       auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']
 
       new_options = opts.merge(
-        :operation => :"LocationApi.locations_get",
+        :operation => :"LocationsApi.locations_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -254,7 +254,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: LocationApi#locations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LocationsApi#locations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end