hubspot-api-client 1.0.1 → 2.0.0

data/lib/hubspot/codegen/oauth/api_error.rb

@@ -11,50 +11,48 @@ OpenAPI Generator version: 4.2.2
 =end
 
 module Hubspot
-  module Client
-    module OAuth
-      class ApiError < StandardError
-        attr_reader :code, :response_headers, :response_body
-
-        # Usage examples:
-        #   ApiError.new
-        #   ApiError.new("message")
-        #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
-        #   ApiError.new(:code => 404, :message => "Not Found")
-        def initialize(arg = nil)
-          if arg.is_a? Hash
-            if arg.key?(:message) || arg.key?('message')
-              super(arg[:message] || arg['message'])
-            else
-              super arg
-            end
-
-            arg.each do |k, v|
-              instance_variable_set "@#{k}", v
-            end
+  module OAuth
+    class ApiError < StandardError
+      attr_reader :code, :response_headers, :response_body
+
+      # Usage examples:
+      #   ApiError.new
+      #   ApiError.new("message")
+      #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+      #   ApiError.new(:code => 404, :message => "Not Found")
+      def initialize(arg = nil)
+        if arg.is_a? Hash
+          if arg.key?(:message) || arg.key?('message')
+            super(arg[:message] || arg['message'])
           else
             super arg
           end
-        end
-
-        # Override to_s to display a friendly error message
-        def to_s
-          message
-        end
 
-        def message
-          if @message.nil?
-            msg = "Error message: the server returns an error"
-          else
-            msg = @message
+          arg.each do |k, v|
+            instance_variable_set "@#{k}", v
           end
+        else
+          super arg
+        end
+      end
 
-          msg += "\nHTTP status code: #{code}" if code
-          msg += "\nResponse headers: #{response_headers}" if response_headers
-          msg += "\nResponse body: #{response_body}" if response_body
+      # Override to_s to display a friendly error message
+      def to_s
+        message
+      end
 
-          msg
+      def message
+        if @message.nil?
+          msg = "Error message: the server returns an error"
+        else
+          msg = @message
         end
+
+        msg += "\nHTTP status code: #{code}" if code
+        msg += "\nResponse headers: #{response_headers}" if response_headers
+        msg += "\nResponse body: #{response_body}" if response_body
+
+        msg
       end
     end
   end

data/lib/hubspot/codegen/oauth/configuration.rb

@@ -11,247 +11,245 @@ OpenAPI Generator version: 4.2.2
 =end
 
 module Hubspot
-  module Client
-    module OAuth
-      class Configuration
-        # Defines url scheme
-        attr_accessor :scheme
-
-        # Defines url host
-        attr_accessor :host
-
-        # Defines url base path
-        attr_accessor :base_path
-
-        # Defines API keys used with API Key authentications.
-        #
-        # @return [Hash] key: parameter name, value: parameter value (API key)
-        #
-        # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-        #   config.api_key['api_key'] = 'xxx'
-        attr_accessor :api_key
-
-        # Defines API key prefixes used with API Key authentications.
-        #
-        # @return [Hash] key: parameter name, value: API key prefix
-        #
-        # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-        #   config.api_key_prefix['api_key'] = 'Token'
-        attr_accessor :api_key_prefix
-
-        # Defines the username used with HTTP basic authentication.
-        #
-        # @return [String]
-        attr_accessor :username
-
-        # Defines the password used with HTTP basic authentication.
-        #
-        # @return [String]
-        attr_accessor :password
-
-        # Defines the access token (Bearer) used with OAuth2.
-        attr_accessor :access_token
-
-        # 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.
-        #
-        # @return [true, false]
-        attr_accessor :debugging
-
-        # Defines the logger used for debugging.
-        # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-        #
-        # @return [#debug]
-        attr_accessor :logger
-
-        # Defines the temporary folder to store downloaded files
-        # (for API endpoints that have file response).
-        # Default to use `Tempfile`.
-        #
-        # @return [String]
-        attr_accessor :temp_folder_path
-
-        # The time limit for HTTP request in seconds.
-        # Default to 0 (never times out).
-        attr_accessor :timeout
-
-        # Set this to false to skip client side validation in the operation.
-        # Default to true.
-        # @return [true, false]
-        attr_accessor :client_side_validation
-
-        ### TLS/SSL setting
-        # Set this to false to skip verifying SSL certificate when calling API from https server.
-        # Default to true.
-        #
-        # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-        #
-        # @return [true, false]
-        attr_accessor :ssl_verify
-
-        ### TLS/SSL setting
-        # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
-        #
-        # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-        #
-        attr_accessor :ssl_verify_mode
-
-        ### TLS/SSL setting
-        # Set this to customize the certificate file to verify the peer.
-        #
-        # @return [String] the path to the certificate file
-        attr_accessor :ssl_ca_file
-
-        ### TLS/SSL setting
-        # Client certificate file (for client certificate)
-        attr_accessor :ssl_client_cert
-
-        ### TLS/SSL setting
-        # Client private key file (for client certificate)
-        attr_accessor :ssl_client_key
-
-        # Set this to customize parameters encoding of array parameter with multi collectionFormat.
-        # Default to nil.
-        #
-        # @see The params_encoding option of Ethon. Related source code:
-        # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
-        attr_accessor :params_encoding
-
-        attr_accessor :inject_format
-
-        attr_accessor :force_ending_format
-
-        attr_accessor :error_handler
-
-        def initialize
-          @scheme = 'https'
-          @host = 'api.hubapi.com'
-          @base_path = '/oauth'
-          @api_key = {}
-          @api_key_prefix = {}
-          @timeout = 0
-          @client_side_validation = true
-          @ssl_verify = true
-          @ssl_verify_mode = nil
-          @ssl_ca_file = nil
-          @ssl_client_cert = nil
-          @ssl_client_key = nil
-          @debugging = false
-          @inject_format = false
-          @force_ending_format = false
-          @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-          # error_handler params: { 'status_code': { max_retries: ..., seconds_delay: ... }, ... }
-          @error_handler = {}
-
-          yield(self) if block_given?
-        end
+  module OAuth
+    class Configuration
+      # Defines url scheme
+      attr_accessor :scheme
+
+      # Defines url host
+      attr_accessor :host
+
+      # Defines url base path
+      attr_accessor :base_path
+
+      # Defines API keys used with API Key authentications.
+      #
+      # @return [Hash] key: parameter name, value: parameter value (API key)
+      #
+      # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+      #   config.api_key['api_key'] = 'xxx'
+      attr_accessor :api_key
+
+      # Defines API key prefixes used with API Key authentications.
+      #
+      # @return [Hash] key: parameter name, value: API key prefix
+      #
+      # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+      #   config.api_key_prefix['api_key'] = 'Token'
+      attr_accessor :api_key_prefix
+
+      # Defines the username used with HTTP basic authentication.
+      #
+      # @return [String]
+      attr_accessor :username
+
+      # Defines the password used with HTTP basic authentication.
+      #
+      # @return [String]
+      attr_accessor :password
+
+      # Defines the access token (Bearer) used with OAuth2.
+      attr_accessor :access_token
+
+      # 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.
+      #
+      # @return [true, false]
+      attr_accessor :debugging
+
+      # Defines the logger used for debugging.
+      # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+      #
+      # @return [#debug]
+      attr_accessor :logger
+
+      # Defines the temporary folder to store downloaded files
+      # (for API endpoints that have file response).
+      # Default to use `Tempfile`.
+      #
+      # @return [String]
+      attr_accessor :temp_folder_path
+
+      # The time limit for HTTP request in seconds.
+      # Default to 0 (never times out).
+      attr_accessor :timeout
+
+      # Set this to false to skip client side validation in the operation.
+      # Default to true.
+      # @return [true, false]
+      attr_accessor :client_side_validation
+
+      ### TLS/SSL setting
+      # Set this to false to skip verifying SSL certificate when calling API from https server.
+      # Default to true.
+      #
+      # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+      #
+      # @return [true, false]
+      attr_accessor :ssl_verify
+
+      ### TLS/SSL setting
+      # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
+      #
+      # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+      #
+      attr_accessor :ssl_verify_mode
+
+      ### TLS/SSL setting
+      # Set this to customize the certificate file to verify the peer.
+      #
+      # @return [String] the path to the certificate file
+      attr_accessor :ssl_ca_file
+
+      ### TLS/SSL setting
+      # Client certificate file (for client certificate)
+      attr_accessor :ssl_client_cert
+
+      ### TLS/SSL setting
+      # Client private key file (for client certificate)
+      attr_accessor :ssl_client_key
+
+      # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+      # Default to nil.
+      #
+      # @see The params_encoding option of Ethon. Related source code:
+      # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+      attr_accessor :params_encoding
+
+      attr_accessor :inject_format
+
+      attr_accessor :force_ending_format
+
+      attr_accessor :error_handler
+
+      def initialize
+        @scheme = 'https'
+        @host = 'api.hubapi.com'
+        @base_path = '/oauth'
+        @api_key = {}
+        @api_key_prefix = {}
+        @timeout = 0
+        @client_side_validation = true
+        @ssl_verify = true
+        @ssl_verify_mode = nil
+        @ssl_ca_file = nil
+        @ssl_client_cert = nil
+        @ssl_client_key = nil
+        @debugging = false
+        @inject_format = false
+        @force_ending_format = false
+        @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+        # error_handler params: { 'status_code': { max_retries: ..., seconds_delay: ... }, ... }
+        @error_handler = {}
+
+        yield(self) if block_given?
+      end
 
-        # The default Configuration object.
-        def self.default
-          @@default ||= Configuration.new
-        end
+      # The default Configuration object.
+      def self.default
+        @@default ||= Configuration.new
+      end
 
-        def configure
-          yield(self) if block_given?
-        end
+      def configure
+        yield(self) if block_given?
+      end
 
-        def scheme=(scheme)
-          # remove :// from scheme
-          @scheme = scheme.sub(/:\/\//, '')
-        end
+      def scheme=(scheme)
+        # remove :// from scheme
+        @scheme = scheme.sub(/:\/\//, '')
+      end
 
-        def host=(host)
-          # remove http(s):// and anything after a slash
-          @host = host.sub(/https?:\/\//, '').split('/').first
-        end
+      def host=(host)
+        # remove http(s):// and anything after a slash
+        @host = host.sub(/https?:\/\//, '').split('/').first
+      end
 
-        def base_path=(base_path)
-          # Add leading and trailing slashes to base_path
-          @base_path = "/#{base_path}".gsub(/\/+/, '/')
-          @base_path = '' if @base_path == '/'
-        end
+      def base_path=(base_path)
+        # Add leading and trailing slashes to base_path
+        @base_path = "/#{base_path}".gsub(/\/+/, '/')
+        @base_path = '' if @base_path == '/'
+      end
 
-        def base_url
-          "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-        end
+      def base_url
+        "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      end
 
-        # Gets API key (with prefix if set).
-        # @param [String] param_name the parameter name of API key auth
-        def api_key_with_prefix(param_name)
-          if @api_key_prefix[param_name]
-            "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
-          else
-            @api_key[param_name]
-          end
+      # Gets API key (with prefix if set).
+      # @param [String] param_name the parameter name of API key auth
+      def api_key_with_prefix(param_name)
+        if @api_key_prefix[param_name]
+          "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        else
+          @api_key[param_name]
         end
+      end
 
-        # Gets Basic Auth token string
-        def basic_auth_token
-          'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-        end
+      # Gets Basic Auth token string
+      def basic_auth_token
+        'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+      end
+
+      # Returns Auth Settings hash for api client.
+      def auth_settings
+        {
+          'hapikey' =>
+            {
+              type: 'api_key',
+              in: 'query',
+              key: 'hapikey',
+              value: api_key_with_prefix('hapikey')
+            },
+          'oauth2' =>
+            {
+              type: 'oauth2',
+              in: 'header',
+              key: 'Authorization',
+              value: "Bearer #{access_token}"
+            },
+        }
+      end
 
-        # Returns Auth Settings hash for api client.
-        def auth_settings
+      # Returns an array of Server setting
+      def server_settings
+        [
           {
-            'hapikey' =>
-              {
-                type: 'api_key',
-                in: 'query',
-                key: 'hapikey',
-                value: api_key_with_prefix('hapikey')
-              },
-            'oauth2' =>
-              {
-                type: 'oauth2',
-                in: 'header',
-                key: 'Authorization',
-                value: "Bearer #{access_token}"
-              },
+            url: "https://api.hubapi.com/oauth",
+            description: "No description provided",
           }
-        end
+        ]
+      end
 
-        # Returns an array of Server setting
-        def server_settings
-          [
-            {
-              url: "https://api.hubapi.com/oauth",
-              description: "No description provided",
-            }
-          ]
-        end
+      # Returns URL based on server settings
+      #
+      # @param index array index of the server settings
+      # @param variables hash of variable and the corresponding value
+      def server_url(index, variables = {})
+        servers = server_settings
 
-        # Returns URL based on server settings
-        #
-        # @param index array index of the server settings
-        # @param variables hash of variable and the corresponding value
-        def server_url(index, variables = {})
-          servers = server_settings
+        # 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}"
+        end
 
-          # 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}"
-          end
+        server = servers[index]
+        url = server[:url]
 
-          server = servers[index]
-          url = server[:url]
-
-          # go through variable and assign a value
-          server[:variables].each do |name, variable|
-            if variables.key?(name)
-              if (server[:variables][name][:enum_values].include? variables[name])
-                url.gsub! "{" + name.to_s + "}", variables[name]
-              else
-                fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
-              end
+        # go through variable and assign a value
+        server[:variables].each do |name, variable|
+          if variables.key?(name)
+            if (server[:variables][name][:enum_values].include? variables[name])
+              url.gsub! "{" + name.to_s + "}", variables[name]
             else
-              # use default value
-              url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+              fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
             end
+          else
+            # use default value
+            url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
           end
-
-          url
         end
+
+        url
       end
     end
   end