pnap_bmc_api 1.5.0 → 2.0.0

data/lib/pnap_bmc_api/api/ssh_keys_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -78,23 +78,27 @@ module BmcApi
 
     # Create SSH Key.
     # Create an SSH Key. SSH Keys created can be used for server creation and reset functionality.
+    # @param ssh_key_create [SshKeyCreate] 
     # @param [Hash] opts the optional parameters
-    # @option opts [SshKeyCreate] :ssh_key_create 
     # @return [SshKey]
-    def ssh_keys_post(opts = {})
-      data, _status_code, _headers = ssh_keys_post_with_http_info(opts)
+    def ssh_keys_post(ssh_key_create, opts = {})
+      data, _status_code, _headers = ssh_keys_post_with_http_info(ssh_key_create, opts)
       data
     end
 
     # Create SSH Key.
     # Create an SSH Key. SSH Keys created can be used for server creation and reset functionality.
+    # @param ssh_key_create [SshKeyCreate] 
     # @param [Hash] opts the optional parameters
-    # @option opts [SshKeyCreate] :ssh_key_create 
     # @return [Array<(SshKey, Integer, Hash)>] SshKey data, response status code and response headers
-    def ssh_keys_post_with_http_info(opts = {})
+    def ssh_keys_post_with_http_info(ssh_key_create, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SSHKeysApi.ssh_keys_post ...'
       end
+      # verify the required parameter 'ssh_key_create' is set
+      if @api_client.config.client_side_validation && ssh_key_create.nil?
+        fail ArgumentError, "Missing the required parameter 'ssh_key_create' when calling SSHKeysApi.ssh_keys_post"
+      end
       # resource path
       local_var_path = '/ssh-keys'
 
@@ -115,7 +119,7 @@ module BmcApi
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'ssh_key_create'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ssh_key_create)
 
       # return_type
       return_type = opts[:debug_return_type] || 'SshKey'
@@ -269,21 +273,21 @@ module BmcApi
     # Edit SSH Key.
     # Edit SSH Key details.
     # @param ssh_key_id [String] The SSH Key&#39;s ID.
+    # @param ssh_key_update [SshKeyUpdate] 
     # @param [Hash] opts the optional parameters
-    # @option opts [SshKeyUpdate] :ssh_key_update 
     # @return [SshKey]
-    def ssh_keys_ssh_key_id_put(ssh_key_id, opts = {})
-      data, _status_code, _headers = ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, opts)
+    def ssh_keys_ssh_key_id_put(ssh_key_id, ssh_key_update, opts = {})
+      data, _status_code, _headers = ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, ssh_key_update, opts)
       data
     end
 
     # Edit SSH Key.
     # Edit SSH Key details.
     # @param ssh_key_id [String] The SSH Key&#39;s ID.
+    # @param ssh_key_update [SshKeyUpdate] 
     # @param [Hash] opts the optional parameters
-    # @option opts [SshKeyUpdate] :ssh_key_update 
     # @return [Array<(SshKey, Integer, Hash)>] SshKey data, response status code and response headers
-    def ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, opts = {})
+    def ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, ssh_key_update, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SSHKeysApi.ssh_keys_ssh_key_id_put ...'
       end
@@ -291,6 +295,10 @@ module BmcApi
       if @api_client.config.client_side_validation && ssh_key_id.nil?
         fail ArgumentError, "Missing the required parameter 'ssh_key_id' when calling SSHKeysApi.ssh_keys_ssh_key_id_put"
       end
+      # verify the required parameter 'ssh_key_update' is set
+      if @api_client.config.client_side_validation && ssh_key_update.nil?
+        fail ArgumentError, "Missing the required parameter 'ssh_key_update' when calling SSHKeysApi.ssh_keys_ssh_key_id_put"
+      end
       # resource path
       local_var_path = '/ssh-keys/{sshKeyId}'.sub('{' + 'sshKeyId' + '}', CGI.escape(ssh_key_id.to_s))
 
@@ -311,7 +319,7 @@ module BmcApi
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'ssh_key_update'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ssh_key_update)
 
       # return_type
       return_type = opts[:debug_return_type] || 'SshKey'

data/lib/pnap_bmc_api/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module BmcApi
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -31,6 +32,7 @@ module BmcApi
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
+      @config.params_encoding = :multi
       @user_agent = "PNAP-ruby-sdk-bmc/#{ BmcApi::VERSION }"
       @powered_by = "PNAP-ruby-sdk-bmc/#{ BmcApi::VERSION }"
       @default_headers = {
@@ -47,9 +49,10 @@ module BmcApi
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -71,7 +74,9 @@ module BmcApi
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -127,9 +132,7 @@ module BmcApi
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -167,6 +170,8 @@ module BmcApi
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -181,21 +186,24 @@ module BmcApi
         prefix = prefix + '-' unless prefix.end_with?('-')
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
       end
       request.on_body do |chunk|
         chunk.force_encoding(encoding)
         tempfile.write(chunk)
       end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -216,15 +224,10 @@ module BmcApi
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'

data/lib/pnap_bmc_api/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -32,6 +32,7 @@ module BmcApi
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/pnap_bmc_api/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -62,6 +62,16 @@ module BmcApi
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -142,7 +152,7 @@ module BmcApi
       @scheme = 'https'
       @host = 'api.phoenixnap.com'
       @base_path = '/bmc/v1'
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -190,10 +200,12 @@ module BmcApi
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -208,6 +220,12 @@ module BmcApi
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -221,7 +239,7 @@ module BmcApi
             type: 'oauth2',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
           },
       }
     end
@@ -249,8 +267,8 @@ module BmcApi
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -275,5 +293,6 @@ module BmcApi
       url
     end
 
+
   end
 end

data/lib/pnap_bmc_api/models/action_result.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -61,12 +61,15 @@ module BmcApi
 
       if attributes.key?(:'result')
         self.result = attributes[:'result']
+      else
+        self.result = nil
       end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @result.nil?
         invalid_properties.push('invalid value for "result", result cannot be nil.')
@@ -78,6 +81,7 @@ module BmcApi
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @result.nil?
       true
     end
@@ -106,37 +110,30 @@ module BmcApi
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -171,7 +168,7 @@ module BmcApi
       else # model
         # models (e.g. Pet) or oneOf
         klass = BmcApi.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/pnap_bmc_api/models/delete_result.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -66,16 +66,21 @@ module BmcApi
 
       if attributes.key?(:'result')
         self.result = attributes[:'result']
+      else
+        self.result = nil
       end
 
       if attributes.key?(:'server_id')
         self.server_id = attributes[:'server_id']
+      else
+        self.server_id = nil
       end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @result.nil?
         invalid_properties.push('invalid value for "result", result cannot be nil.')
@@ -91,6 +96,7 @@ module BmcApi
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @result.nil?
       return false if @server_id.nil?
       true
@@ -121,37 +127,30 @@ module BmcApi
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -186,7 +185,7 @@ module BmcApi
       else # model
         # models (e.g. Pet) or oneOf
         klass = BmcApi.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/pnap_bmc_api/models/delete_ssh_key_result.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -66,16 +66,21 @@ module BmcApi
 
       if attributes.key?(:'result')
         self.result = attributes[:'result']
+      else
+        self.result = nil
       end
 
       if attributes.key?(:'ssh_key_id')
         self.ssh_key_id = attributes[:'ssh_key_id']
+      else
+        self.ssh_key_id = nil
       end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @result.nil?
         invalid_properties.push('invalid value for "result", result cannot be nil.')
@@ -91,6 +96,7 @@ module BmcApi
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @result.nil?
       return false if @ssh_key_id.nil?
       true
@@ -121,37 +127,30 @@ module BmcApi
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -186,7 +185,7 @@ module BmcApi
       else # model
         # models (e.g. Pet) or oneOf
         klass = BmcApi.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end