hubspot-api-client 2.0.0 → 2.1.0

data/lib/hubspot/codegen/crm/timeline/models/year.rb

@@ -0,0 +1,280 @@
+=begin
+#Timeline events
+
+#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.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Timeline
+      class Year
+        attr_accessor :operator
+
+        attr_accessor :value
+
+        attr_accessor :inputs
+
+        attr_accessor :property_name
+
+        class EnumAttributeValidator
+          attr_reader :datatype
+          attr_reader :allowable_values
+
+          def initialize(datatype, allowable_values)
+            @allowable_values = allowable_values.map do |value|
+              case datatype.to_s
+              when /Integer/i
+                value.to_i
+              when /Float/i
+                value.to_f
+              else
+                value
+              end
+            end
+          end
+
+          def valid?(value)
+            !value || allowable_values.include?(value)
+          end
+        end
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'operator' => :'operator',
+            :'value' => :'value',
+            :'inputs' => :'inputs',
+            :'property_name' => :'propertyName'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'operator' => :'String',
+            :'value' => :'Float',
+            :'inputs' => :'Array<AnyOfConstantBooleanConstantNumberConstantStringBooleanPropertyVariableStringPropertyVariableNumberPropertyVariableAddNumbersSubtractNumbersMultiplyNumbersDivideNumbersRoundDownNumbersRoundUpNumbersUpperCaseLowerCaseConcatStringsContainsBeginsWithNumberToStringParseNumberFetchExchangeRatePipelineProbabilityMaxNumbersMinNumbersLessThanLessThanOrEqualMoreThanMoreThanOrEqualNumberEqualsStringEqualsNotDateMonthYearNowTimeBetweenPeriodToMonthsAndOrXorIfStringIfNumberIfBooleanIsPresentHasEmailReplyHasPlainTextEmailReplyExtractMostRecentEmailReplyHtmlExtractMostRecentEmailReplyTextExtractMostRecentPlainTextEmailReply>',
+            :'property_name' => :'String'
+          }
+        end
+
+        # List of attributes with nullable: true
+        def self.openapi_nullable
+          Set.new([
+          ])
+        end
+
+        # Initializes the object
+        # @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::Year` 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::Year`. 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 = 'YEAR'
+          end
+
+          if attributes.key?(:'value')
+            self.value = attributes[:'value']
+          end
+
+          if attributes.key?(:'inputs')
+            if (value = attributes[:'inputs']).is_a?(Array)
+              self.inputs = value
+            end
+          end
+
+          if attributes.key?(:'property_name')
+            self.property_name = attributes[:'property_name']
+          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
+          invalid_properties = Array.new
+          if @operator.nil?
+            invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+          end
+
+          invalid_properties
+        end
+
+        # 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', ["YEAR"])
+          return false unless operator_validator.valid?(@operator)
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] operator Object to be assigned
+        def operator=(operator)
+          validator = EnumAttributeValidator.new('String', ["YEAR"])
+          unless validator.valid?(operator)
+            fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
+          end
+          @operator = operator
+        end
+
+        # Checks equality by comparing each attribute.
+        # @param [Object] Object to be compared
+        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
+        end
+
+        # @see the `==` method
+        # @param [Object] Object to be compared
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Integer] Hash code
+        def hash
+          [operator, value, inputs, property_name].hash
+        end
+
+        # Builds the object from hash
+        # @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)
+          self.class.openapi_types.each_pair do |key, type|
+            if 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) })
+              end
+            elsif !attributes[self.class.attribute_map[key]].nil?
+              self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+            end # or else data not found in attributes(hash), not an issue as the data can be optional
+          end
+
+          self
+        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)
+          case type.to_sym
+          when :DateTime
+            DateTime.parse(value)
+          when :Date
+            Date.parse(value)
+          when :String
+            value.to_s
+          when :Integer
+            value.to_i
+          when :Float
+            value.to_f
+          when :Boolean
+            if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+              true
+            else
+              false
+            end
+          when :Object
+            # generic object (usually a Hash), return directly
+            value
+          when /\AArray<(?<inner_type>.+)>\z/
+            inner_type = Regexp.last_match[:inner_type]
+            value.map { |v| _deserialize(inner_type, v) }
+          when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+            k_type = Regexp.last_match[:k_type]
+            v_type = Regexp.last_match[:v_type]
+            {}.tap do |hash|
+              value.each do |k, v|
+                hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+              end
+            end
+          else # model
+            Hubspot::Crm::Timeline.const_get(type).build_from_hash(value)
+          end
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          to_hash.to_s
+        end
+
+        # to_body is an alias to to_hash (backward compatibility)
+        # @return [Hash] Returns the object in the form of hash
+        def to_body
+          to_hash
+        end
+
+        # Returns the object in the form of hash
+        # @return [Hash] Returns the object in the form of hash
+        def to_hash
+          hash = {}
+          self.class.attribute_map.each_pair do |attr, param|
+            value = self.send(attr)
+            if value.nil?
+              is_nullable = self.class.openapi_nullable.include?(attr)
+              next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+            end
+            
+            hash[param] = _to_hash(value)
+          end
+          hash
+        end
+
+        # Outputs non-array value in the form of hash
+        # For object, use to_hash. Otherwise, just return the value
+        # @param [Object] value Any valid value
+        # @return [Hash] Returns the value in the form of hash
+        def _to_hash(value)
+          if value.is_a?(Array)
+            value.compact.map { |v| _to_hash(v) }
+          elsif value.is_a?(Hash)
+            {}.tap do |hash|
+              value.each { |k, v| hash[k] = _to_hash(v) }
+            end
+          elsif value.respond_to? :to_hash
+            value.to_hash
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/oauth/api/default_api.rb

@@ -0,0 +1,270 @@
+=begin
+#OAuthService
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module OAuth
+    class DefaultApi
+      attr_accessor :api_client
+
+      def initialize(api_client = ApiClient.default)
+        @api_client = api_client
+      end
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [Error]
+      def archive_refresh_token(token, opts = {})
+        data, _status_code, _headers = archive_refresh_token_with_http_info(token, opts)
+        data
+      end
+
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(Error, Integer, Hash)>] Error data, response status code and response headers
+      def archive_refresh_token_with_http_info(token, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: DefaultApi.archive_refresh_token ...'
+        end
+        # verify the required parameter 'token' is set
+        if @api_client.config.client_side_validation && token.nil?
+          fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.archive_refresh_token"
+        end
+        # resource path
+        local_var_path = '/oauth/v1/refresh-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+        # query parameters
+        query_params = opts[:query_params] || {}
+
+        # header parameters
+        header_params = opts[:header_params] || {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'Error' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || []
+
+        new_options = opts.merge(
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        )
+
+        data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: DefaultApi#archive_refresh_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # @param [Hash] opts the optional parameters
+      # @option opts [String] :grant_type 
+      # @option opts [String] :code 
+      # @option opts [String] :redirect_uri 
+      # @option opts [String] :client_id 
+      # @option opts [String] :client_secret 
+      # @option opts [String] :refresh_token 
+      # @return [TokenResponseIF]
+      def create_token(opts = {})
+        data, _status_code, _headers = create_token_with_http_info(opts)
+        data
+      end
+
+      # @param [Hash] opts the optional parameters
+      # @option opts [String] :grant_type 
+      # @option opts [String] :code 
+      # @option opts [String] :redirect_uri 
+      # @option opts [String] :client_id 
+      # @option opts [String] :client_secret 
+      # @option opts [String] :refresh_token 
+      # @return [Array<(TokenResponseIF, Integer, Hash)>] TokenResponseIF data, response status code and response headers
+      def create_token_with_http_info(opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
+        end
+        # resource path
+        local_var_path = '/oauth/v1/token'
+
+        # query parameters
+        query_params = opts[:query_params] || {}
+
+        # header parameters
+        header_params = opts[:header_params] || {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+        # HTTP header 'Content-Type'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+        form_params['grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
+        form_params['code'] = opts[:'code'] if !opts[:'code'].nil?
+        form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
+        form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+        form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
+        form_params['refresh_token'] = opts[:'refresh_token'] if !opts[:'refresh_token'].nil?
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'TokenResponseIF' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || []
+
+        new_options = opts.merge(
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        )
+
+        data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: DefaultApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [AccessTokenInfoResponse]
+      def get_access_token(token, opts = {})
+        data, _status_code, _headers = get_access_token_with_http_info(token, opts)
+        data
+      end
+
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(AccessTokenInfoResponse, Integer, Hash)>] AccessTokenInfoResponse data, response status code and response headers
+      def get_access_token_with_http_info(token, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: DefaultApi.get_access_token ...'
+        end
+        # verify the required parameter 'token' is set
+        if @api_client.config.client_side_validation && token.nil?
+          fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.get_access_token"
+        end
+        # resource path
+        local_var_path = '/oauth/v1/access-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+        # query parameters
+        query_params = opts[:query_params] || {}
+
+        # header parameters
+        header_params = opts[:header_params] || {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'AccessTokenInfoResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || []
+
+        new_options = opts.merge(
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        )
+
+        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: DefaultApi#get_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [RefreshTokenInfoResponse]
+      def get_refresh_token(token, opts = {})
+        data, _status_code, _headers = get_refresh_token_with_http_info(token, opts)
+        data
+      end
+
+      # @param token [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(RefreshTokenInfoResponse, Integer, Hash)>] RefreshTokenInfoResponse data, response status code and response headers
+      def get_refresh_token_with_http_info(token, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: DefaultApi.get_refresh_token ...'
+        end
+        # verify the required parameter 'token' is set
+        if @api_client.config.client_side_validation && token.nil?
+          fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.get_refresh_token"
+        end
+        # resource path
+        local_var_path = '/oauth/v1/refresh-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+        # query parameters
+        query_params = opts[:query_params] || {}
+
+        # header parameters
+        header_params = opts[:header_params] || {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'RefreshTokenInfoResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || []
+
+        new_options = opts.merge(
+          :header_params => header_params,
+          :query_params => query_params,
+          :form_params => form_params,
+          :body => post_body,
+          :auth_names => auth_names,
+          :return_type => return_type
+        )
+
+        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: DefaultApi#get_refresh_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+    end
+  end
+end