hubspot-api-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17e146d01b10a81f19cb9beba07cbbfeeae72df53a0b1b2858e25366ecd6117
-  data.tar.gz: 7b9989937e97d03dd9cc2e7eba3e3dce9189bd770f6a0ac0ab3359145d1ce824
+  metadata.gz: 5a5f8ab77ee357c6bf8d8d2ffe5fe55c66ea13690fe00b97d147b7c09cc9d323
+  data.tar.gz: bd1eee4989460b544bff7e2714e4db8f51f4bb85558ddc844b1f69447c1f8b5a
 SHA512:
-  metadata.gz: 964a080fddcfb82cfe0d45ec8bc18995917269bb7561f13294ca968c4237b38a98ec8123a77f4f6a5faa168c8beabdced43b9278d6f147775d89c34ab658973a
-  data.tar.gz: d7afb3b2a027772b62fcf8fa0201d8f4b493ad5d330b2e91086c6c2a12be16c3181b993fa0a441c6b128929bcfbaeb5520904b3032e756b0e80185bfa0a8e21d
+  metadata.gz: 569e668d3e62a8f7a637eba8b229a1beb1d2846fb1a571138b5f4625350d30bc0204f1c112cacdf48d811dff0a8244a6b1d14037052ddee6a8233b2d7b321142
+  data.tar.gz: 49eb8002e5d7e8c9480851e2386944efd284cf928bdbce3fbce3d0896f1db576c96b9f86323e15a28cd17b9fff11273b1aed40b6e07c42959dc11b30a67ac0b3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (2.0.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)
 
@@ -20,7 +20,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.3)
     hashdiff (1.0.0)

data/lib/hubspot-api-client.rb

@@ -21,19 +21,20 @@ module Hubspot
   class << self
     CLIENTS = [
       'OAuth',
+      'Webhooks',
       'Crm::Associations',
       'Crm::Companies',
       'Crm::Contacts',
       'Crm::Deals',
       'Crm::Extensions::Cards',
       'Crm::LineItems',
-      'Crm::Objects',
       'Crm::Owners',
       'Crm::Pipelines',
       'Crm::Products',
       'Crm::Properties',
       'Crm::Quotes',
-      'Crm::Tickets'
+      'Crm::Tickets',
+      'Crm::Timeline'
     ].freeze
 
     def configure

data/lib/hubspot/codegen/crm/associations/api/batch_api.rb

@@ -53,7 +53,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive_batch"
           end
           # resource path
-          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -125,7 +125,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create_batch"
           end
           # resource path
-          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -197,7 +197,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.read_batch"
           end
           # resource path
-          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}

data/lib/hubspot/codegen/crm/associations/api/types_api.rb

@@ -0,0 +1,94 @@
+=begin
+#Associations
+
+#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Associations
+      class TypesApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # List association types
+        # List all the valid association types available between two object types
+        # @param from_object_type [String] 
+        # @param to_object_type [String] 
+        # @param [Hash] opts the optional parameters
+        # @return [CollectionResponsePublicAssociationDefiniton]
+        def get_types(from_object_type, to_object_type, opts = {})
+          data, _status_code, _headers = get_types_with_http_info(from_object_type, to_object_type, opts)
+          data
+        end
+
+        # List association types
+        # List all the valid association types available between two object types
+        # @param from_object_type [String] 
+        # @param to_object_type [String] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(CollectionResponsePublicAssociationDefiniton, Integer, Hash)>] CollectionResponsePublicAssociationDefiniton data, response status code and response headers
+        def get_types_with_http_info(from_object_type, to_object_type, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: TypesApi.get_types ...'
+          end
+          # verify the required parameter 'from_object_type' is set
+          if @api_client.config.client_side_validation && from_object_type.nil?
+            fail ArgumentError, "Missing the required parameter 'from_object_type' when calling TypesApi.get_types"
+          end
+          # verify the required parameter 'to_object_type' is set
+          if @api_client.config.client_side_validation && to_object_type.nil?
+            fail ArgumentError, "Missing the required parameter 'to_object_type' when calling TypesApi.get_types"
+          end
+          # resource path
+          local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/types'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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] || 'CollectionResponsePublicAssociationDefiniton' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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: TypesApi#get_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/associations/api_client.rb

@@ -63,6 +63,7 @@ module Hubspot
               conn.request :url_encoded
             end
             conn.adapter(Faraday.default_adapter)
+            conn.options[:params_encoder] = Faraday::FlatParamsEncoder
 
             # Errors handler settings
             if !config.error_handler.empty?

data/lib/hubspot/codegen/crm/associations/models/associated_id.rb

@@ -0,0 +1,229 @@
+=begin
+#Associations
+
+#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.
+
+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 Associations
+      class AssociatedId
+        attr_accessor :id
+
+        attr_accessor :type
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'id' => :'id',
+            :'type' => :'type'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'id' => :'String',
+            :'type' => :'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::Associations::AssociatedId` 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::Associations::AssociatedId`. 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?(:'id')
+            self.id = attributes[:'id']
+          end
+
+          if attributes.key?(:'type')
+            self.type = attributes[:'type']
+          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 @id.nil?
+            invalid_properties.push('invalid value for "id", id cannot be nil.')
+          end
+
+          if @type.nil?
+            invalid_properties.push('invalid value for "type", type 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 @id.nil?
+          return false if @type.nil?
+          true
+        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 &&
+              id == o.id &&
+              type == o.type
+        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
+          [id, type].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::Associations.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/crm/associations/models/batch_input_public_object_id.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 

data/lib/hubspot/codegen/crm/associations/models/batch_response_public_association.rb

@@ -140,10 +140,6 @@ module Hubspot
             invalid_properties.push('invalid value for "results", results cannot be nil.')
           end
 
-          if @errors.nil?
-            invalid_properties.push('invalid value for "errors", errors cannot be nil.')
-          end
-
           if @status.nil?
             invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
@@ -163,7 +159,6 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @results.nil?
-          return false if @errors.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)

data/lib/hubspot/codegen/crm/associations/models/batch_response_public_association_multi.rb

@@ -140,10 +140,6 @@ module Hubspot
             invalid_properties.push('invalid value for "results", results cannot be nil.')
           end
 
-          if @errors.nil?
-            invalid_properties.push('invalid value for "errors", errors cannot be nil.')
-          end
-
           if @status.nil?
             invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
@@ -163,7 +159,6 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @results.nil?
-          return false if @errors.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)