ionoscloud 6.0.0.beta.3 → 6.0.1

data/lib/ionoscloud/api/user_s3_keys_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
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1-SNAPSHOT
+OpenAPI Generator version: 5.2.1-SNAPSHOT
 
 =end
 
@@ -19,28 +19,28 @@ module Ionoscloud
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Delete an S3 Key
-    # Delete an S3 key.
-    # @param user_id [String] The unique ID of the user
-    # @param key_id [String] The unique access key ID of the S3 key
+    # Delete S3 keys
+    # Delete the specified user S3 key.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
     # @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, for which all API requests are to be executed.
     # @return [nil]
     def um_users_s3keys_delete(user_id, key_id, opts = {})
       um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
       nil
     end
 
-    # Delete an S3 Key
-    # Delete an S3 key.
-    # @param user_id [String] The unique ID of the user
-    # @param key_id [String] The unique access key ID of the S3 key
+    # Delete S3 keys
+    # Delete the specified user S3 key.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
     # @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, for which all API requests are to be executed.
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def um_users_s3keys_delete_with_http_info(user_id, key_id, opts = {})
       if @api_client.config.debugging
@@ -105,28 +105,28 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Retrieve given S3 Key belonging to the given User
-    # You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
-    # @param user_id [String] The unique ID of the user
-    # @param key_id [String] The unique access key ID of the S3 key
+    # Retrieve user S3 keys by key ID
+    # Retrieve the specified user S3 key. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. The key ID is in the response body when the S3 key is created, and in the list of all user S3 keys, returned by GET.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
     # @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, for which all API requests are to be executed.
     # @return [S3Key]
     def um_users_s3keys_find_by_key_id(user_id, key_id, opts = {})
       data, _status_code, _headers = um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
       data
     end
 
-    # Retrieve given S3 Key belonging to the given User
-    # You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
-    # @param user_id [String] The unique ID of the user
-    # @param key_id [String] The unique access key ID of the S3 key
+    # Retrieve user S3 keys by key ID
+    # Retrieve the specified user S3 key. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. The key ID is in the response body when the S3 key is created, and in the list of all user S3 keys, returned by GET.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
     # @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, for which all API requests are to be executed.
     # @return [Array<(S3Key, Integer, Hash)>] S3Key data, response status code and response headers
     def um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts = {})
       if @api_client.config.debugging
@@ -191,26 +191,26 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Retrieve a User's S3 keys
-    # You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
-    # @param user_id [String] The unique ID of the user
+    # List user S3 keys
+    # List S3 keys by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+    # @param user_id [String] The unique ID of the user.
     # @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, for which all API requests are to be executed.
     # @return [S3Keys]
     def um_users_s3keys_get(user_id, opts = {})
       data, _status_code, _headers = um_users_s3keys_get_with_http_info(user_id, opts)
       data
     end
 
-    # Retrieve a User&#39;s S3 keys
-    # You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
-    # @param user_id [String] The unique ID of the user
+    # List user S3 keys
+    # List S3 keys by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+    # @param user_id [String] The unique ID of the user.
     # @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, for which all API requests are to be executed.
     # @return [Array<(S3Keys, Integer, Hash)>] S3Keys data, response status code and response headers
     def um_users_s3keys_get_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
@@ -271,26 +271,26 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Create a S3 Key for the given User
-    # Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
-    # @param user_id [String] The unique ID of the user
+    # Create user S3 keys
+    # Create an S3 key for the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. A maximum of five keys per user can be generated.
+    # @param user_id [String] The unique ID of the user.
     # @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, for which all API requests are to be executed.
     # @return [S3Key]
     def um_users_s3keys_post(user_id, opts = {})
       data, _status_code, _headers = um_users_s3keys_post_with_http_info(user_id, opts)
       data
     end
 
-    # Create a S3 Key for the given User
-    # Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
-    # @param user_id [String] The unique ID of the user
+    # Create user S3 keys
+    # Create an S3 key for the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. A maximum of five keys per user can be generated.
+    # @param user_id [String] The unique ID of the user.
     # @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, for which all API requests are to be executed.
     # @return [Array<(S3Key, Integer, Hash)>] S3Key data, response status code and response headers
     def um_users_s3keys_post_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
@@ -351,30 +351,30 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Modify a S3 key having the given key id
-    # You can enable or disable a given S3 key.
-    # @param user_id [String] 
-    # @param key_id [String] The unique access key ID of the S3 key
-    # @param s3_key [S3Key] Modified S3 key
+    # Modify S3 keys by key ID
+    # Enable or disable the specified user S3 key.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
+    # @param s3_key [S3Key] The modified S3 key.
     # @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, for which all API requests are to be executed.
     # @return [S3Key]
     def um_users_s3keys_put(user_id, key_id, s3_key, opts = {})
       data, _status_code, _headers = um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
       data
     end
 
-    # Modify a S3 key having the given key id
-    # You can enable or disable a given S3 key.
-    # @param user_id [String] 
-    # @param key_id [String] The unique access key ID of the S3 key
-    # @param s3_key [S3Key] Modified S3 key
+    # Modify S3 keys by key ID
+    # Enable or disable the specified user S3 key.
+    # @param user_id [String] The unique ID of the user.
+    # @param key_id [String] The unique ID of the S3 key.
+    # @param s3_key [S3Key] The modified S3 key.
     # @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, for which all API requests are to be executed.
     # @return [Array<(S3Key, Integer, Hash)>] S3Key data, response status code and response headers
     def um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts = {})
       if @api_client.config.debugging
@@ -445,24 +445,24 @@ module Ionoscloud
       return data, status_code, headers
     end
 
-    # Retrieve S3 object storage single signon URL for the given user
-    # You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
-    # @param user_id [String] The unique ID of the user
+    # Retrieve S3 single sign-on URLs
+    # Retrieve S3 Object Storage single sign-on URLs for the the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+    # @param user_id [String] The unique ID of the user.
     # @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] :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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
     # @return [S3ObjectStorageSSO]
     def um_users_s3ssourl_get(user_id, opts = {})
       data, _status_code, _headers = um_users_s3ssourl_get_with_http_info(user_id, opts)
       data
     end
 
-    # Retrieve S3 object storage single signon URL for the given user
-    # You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
-    # @param user_id [String] The unique ID of the user
+    # Retrieve S3 single sign-on URLs
+    # Retrieve S3 Object Storage single sign-on URLs for the the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+    # @param user_id [String] The unique ID of the user.
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
-    # @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
     # @return [Array<(S3ObjectStorageSSO, Integer, Hash)>] S3ObjectStorageSSO data, response status code and response headers
     def um_users_s3ssourl_get_with_http_info(user_id, opts = {})
       if @api_client.config.debugging