hubspot-api-client 2.3.2 → 3.0.0.pre.beta

data/lib/hubspot/codegen/crm/imports/api_error.rb

@@ -0,0 +1,61 @@
+=begin
+#CRM Imports
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+module Hubspot
+  module Crm
+    module Imports
+      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
+          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
+          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
+  end
+end

data/lib/hubspot/codegen/crm/imports/configuration.rb

@@ -0,0 +1,258 @@
+=begin
+#CRM Imports
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+module Hubspot
+  module Crm
+    module Imports
+      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 = ''
+          @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
+
+        def configure
+          yield(self) if block_given?
+        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 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
+
+        # 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
+
+        # 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 an array of Server setting
+        def server_settings
+          [
+            {
+              url: "https://api.hubapi.com/",
+              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
+
+          # 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]
+
+          # 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
+            else
+              # use default value
+              url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+            end
+          end
+
+          url
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/{timeline/models/divide_numbers.rb → imports/models/action_response.rb}

@@ -1,7 +1,7 @@
 =begin
-#Timeline events
+#CRM Imports
 
-#This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM object like contacts, companies, or deals. You'll find multiple use cases for this API in the sections below.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -14,15 +14,15 @@ require 'date'
 
 module Hubspot
   module Crm
-    module Timeline
-      class DivideNumbers
-        attr_accessor :operator
+    module Imports
+      class ActionResponse
+        attr_accessor :status
 
-        attr_accessor :value
+        attr_accessor :requested_at
 
-        attr_accessor :inputs
+        attr_accessor :started_at
 
-        attr_accessor :property_name
+        attr_accessor :completed_at
 
         class EnumAttributeValidator
           attr_reader :datatype
@@ -49,20 +49,20 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'operator' => :'operator',
-            :'value' => :'value',
-            :'inputs' => :'inputs',
-            :'property_name' => :'propertyName'
+            :'status' => :'status',
+            :'requested_at' => :'requestedAt',
+            :'started_at' => :'startedAt',
+            :'completed_at' => :'completedAt'
           }
         end
 
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'operator' => :'String',
-            :'value' => :'Float',
-            :'inputs' => :'Array<AnyOfConstantBooleanConstantNumberConstantStringBooleanPropertyVariableStringPropertyVariableNumberPropertyVariableAddNumbersSubtractNumbersMultiplyNumbersDivideNumbersRoundDownNumbersRoundUpNumbersUpperCaseLowerCaseConcatStringsContainsBeginsWithNumberToStringParseNumberFetchExchangeRatePipelineProbabilityMaxNumbersMinNumbersLessThanLessThanOrEqualMoreThanMoreThanOrEqualNumberEqualsStringEqualsNotDateMonthYearNowTimeBetweenPeriodToMonthsAndOrXorIfStringIfNumberIfBooleanIsPresentHasEmailReplyHasPlainTextEmailReplyExtractMostRecentEmailReplyHtmlExtractMostRecentEmailReplyTextExtractMostRecentPlainTextEmailReply>',
-            :'property_name' => :'String'
+            :'status' => :'String',
+            :'requested_at' => :'DateTime',
+            :'started_at' => :'DateTime',
+            :'completed_at' => :'DateTime'
           }
         end
 
@@ -76,35 +76,31 @@ module Hubspot
         # @param [Hash] attributes Model attributes in the form of hash
         def initialize(attributes = {})
           if (!attributes.is_a?(Hash))
-            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Timeline::DivideNumbers` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Imports::ActionResponse` initialize method"
           end
 
           # check to see if the attribute exists and convert string to symbol for hash key
           attributes = attributes.each_with_object({}) { |(k, v), h|
             if (!self.class.attribute_map.key?(k.to_sym))
-              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Timeline::DivideNumbers`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Imports::ActionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
             end
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'operator')
-            self.operator = attributes[:'operator']
-          else
-            self.operator = 'DIVIDE_NUMBERS'
+          if attributes.key?(:'status')
+            self.status = attributes[:'status']
           end
 
-          if attributes.key?(:'value')
-            self.value = attributes[:'value']
+          if attributes.key?(:'requested_at')
+            self.requested_at = attributes[:'requested_at']
           end
 
-          if attributes.key?(:'inputs')
-            if (value = attributes[:'inputs']).is_a?(Array)
-              self.inputs = value
-            end
+          if attributes.key?(:'started_at')
+            self.started_at = attributes[:'started_at']
           end
 
-          if attributes.key?(:'property_name')
-            self.property_name = attributes[:'property_name']
+          if attributes.key?(:'completed_at')
+            self.completed_at = attributes[:'completed_at']
           end
         end
 
@@ -112,8 +108,16 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @operator.nil?
-            invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+          if @status.nil?
+            invalid_properties.push('invalid value for "status", status cannot be nil.')
+          end
+
+          if @started_at.nil?
+            invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
+          end
+
+          if @completed_at.nil?
+            invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
           end
 
           invalid_properties
@@ -122,20 +126,22 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          return false if @operator.nil?
-          operator_validator = EnumAttributeValidator.new('String', ["DIVIDE_NUMBERS"])
-          return false unless operator_validator.valid?(@operator)
+          return false if @status.nil?
+          status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
+          return false unless status_validator.valid?(@status)
+          return false if @started_at.nil?
+          return false if @completed_at.nil?
           true
         end
 
         # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] operator Object to be assigned
-        def operator=(operator)
-          validator = EnumAttributeValidator.new('String', ["DIVIDE_NUMBERS"])
-          unless validator.valid?(operator)
-            fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
+        # @param [Object] status Object to be assigned
+        def status=(status)
+          validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
+          unless validator.valid?(status)
+            fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
           end
-          @operator = operator
+          @status = status
         end
 
         # Checks equality by comparing each attribute.
@@ -143,10 +149,10 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              operator == o.operator &&
-              value == o.value &&
-              inputs == o.inputs &&
-              property_name == o.property_name
+              status == o.status &&
+              requested_at == o.requested_at &&
+              started_at == o.started_at &&
+              completed_at == o.completed_at
         end
 
         # @see the `==` method
@@ -158,7 +164,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [operator, value, inputs, property_name].hash
+          [status, requested_at, started_at, completed_at].hash
         end
 
         # Builds the object from hash
@@ -225,7 +231,7 @@ module Hubspot
               end
             end
           else # model
-            Hubspot::Crm::Timeline.const_get(type).build_from_hash(value)
+            Hubspot::Crm::Imports.const_get(type).build_from_hash(value)
           end
         end
 
@@ -277,4 +283,4 @@ module Hubspot
       end
     end
   end
-end
+end