hubspot-api-client 16.0.2 → 16.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae73f52acb44623f2bb0fb3f7c975f04bbf0a657d8ea07b177f309c4c4860813
-  data.tar.gz: 746e3b0d15d305d2c1c7771ab7ded7f042d46cd86c0f0a525c62cc1099442582
+  metadata.gz: e8204da9cda81deddc0e84762accf9428dc794cf0164b9f1e34008ebc04f39ac
+  data.tar.gz: 6a9e42f140a5598203c427d7f262eff8cd7482fedd562a8898e3f6284b9b503b
 SHA512:
-  metadata.gz: edbe1af1ad7914e04832f672e2970b85f897edfa60711fec78a85741101e27f5103f59aeed7af5f1132766e3012feef97a9fe3ac47e21374c6893bc32f4d9755
-  data.tar.gz: afc63b3cb3735d3fc928d5d29188e9a37518a76f0df2c7acb17753893b329fee50373dad325531ce33c220f4b8a40a5cc0f452739fd1fb65f8e4801114893b1b
+  metadata.gz: 5146fdebcceeb22af4ca68028ad99aa1f31e17a53908cc6b4c7051b882a45ff2a31353ea78b4d6a90957e775a440a5601ce76016e37bda14b7d156a4a89bac3b
+  data.tar.gz: 71f6717ff5bbcc6af9c43006ffb942906d624ec15b040059f1fd34963bdb97c7b0516765af796059acea0aa13cd563dc355269a121de8e9b77be7eacc865c37e

data/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [16.0.4] - 2022-12-08
+### Changed
+
+- Added Private App access token to (
+    - cms.domains
+    - crm.imports
+    - crm.objects.emals
+    - marketing.events
+    )
+
+### Fixed
+
+- Fix all association APIs
+
+## [16.0.3] - 2022-11-23
+### Changed
+
+- auth_names => debug_auth_names
+
 ## [16.0.2] - 2022-11-22
 ### Fixed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (16.0.2)
+    hubspot-api-client (16.0.4)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 

data/lib/hubspot/codegen/cms/domains/api/domains_api.rb

@@ -65,7 +65,7 @@ module Hubspot
           return_type = opts[:debug_return_type] || 'Domain'
 
           # auth_names
-          auth_names = opts[:debug_auth_names] || ['hapikey']
+          auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
           new_options = opts.merge(
             :operation => :"DomainsApi.get_by_id",
@@ -152,7 +152,7 @@ module Hubspot
           return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalDomainForwardPaging'
 
           # auth_names
-          auth_names = opts[:debug_auth_names] || ['hapikey']
+          auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
           new_options = opts.merge(
             :operation => :"DomainsApi.get_page",

data/lib/hubspot/codegen/cms/domains/configuration.rb

@@ -229,6 +229,13 @@ module Hubspot
                 key: 'hapikey',
                 value: api_key_with_prefix('hapikey')
               },
+            'oauth2' =>
+              {
+                type: 'oauth2',
+                in: 'header',
+                key: 'Authorization',
+                value: "Bearer #{access_token}"
+              },
           }
         end
 

data/lib/hubspot/codegen/crm/companies/api/associations_api.rb

@@ -21,26 +21,26 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         end
-        # Remove an association between two companies
-        # @param company_id [String] 
+        # Delete
+        # deletes all associations between two records.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
-        # @param to_object_id [String] 
-        # @param association_type [String] 
+        # @param to_object_id [Integer] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
-        def archive(company_id, to_object_type, to_object_id, association_type, opts = {})
-          archive_with_http_info(company_id, to_object_type, to_object_id, association_type, opts)
+        def archive(company_id, to_object_type, to_object_id, opts = {})
+          archive_with_http_info(company_id, to_object_type, to_object_id, opts)
           nil
         end
 
-        # Remove an association between two companies
-        # @param company_id [String] 
+        # Delete
+        # deletes all associations between two records.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
-        # @param to_object_id [String] 
-        # @param association_type [String] 
+        # @param to_object_id [Integer] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-        def archive_with_http_info(company_id, to_object_type, to_object_id, association_type, opts = {})
+        def archive_with_http_info(company_id, to_object_type, to_object_id, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
           end
@@ -56,12 +56,8 @@ module Hubspot
           if @api_client.config.client_side_validation && to_object_id.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive"
           end
-          # verify the required parameter 'association_type' is set
-          if @api_client.config.client_side_validation && association_type.nil?
-            fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.archive"
-          end
           # resource path
-          local_var_path = '/crm/v4/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))
+          local_var_path = '/crm/v4/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -100,26 +96,28 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Associate a company with another object
-        # @param company_id [String] 
+        # Create
+        # Set association labels between two records.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
-        # @param to_object_id [String] 
-        # @param association_type [String] 
+        # @param to_object_id [Integer] 
+        # @param association_spec [Array<AssociationSpec>] 
         # @param [Hash] opts the optional parameters
-        # @return [SimplePublicObjectWithAssociations]
-        def create(company_id, to_object_type, to_object_id, association_type, opts = {})
-          data, _status_code, _headers = create_with_http_info(company_id, to_object_type, to_object_id, association_type, opts)
+        # @return [LabelsBetweenObjectPair]
+        def create(company_id, to_object_type, to_object_id, association_spec, opts = {})
+          data, _status_code, _headers = create_with_http_info(company_id, to_object_type, to_object_id, association_spec, opts)
           data
         end
 
-        # Associate a company with another object
-        # @param company_id [String] 
+        # Create
+        # Set association labels between two records.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
-        # @param to_object_id [String] 
-        # @param association_type [String] 
+        # @param to_object_id [Integer] 
+        # @param association_spec [Array<AssociationSpec>] 
         # @param [Hash] opts the optional parameters
-        # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
-        def create_with_http_info(company_id, to_object_type, to_object_id, association_type, opts = {})
+        # @return [Array<(LabelsBetweenObjectPair, Integer, Hash)>] LabelsBetweenObjectPair data, response status code and response headers
+        def create_with_http_info(company_id, to_object_type, to_object_id, association_spec, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
           end
@@ -135,12 +133,12 @@ module Hubspot
           if @api_client.config.client_side_validation && to_object_id.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create"
           end
-          # verify the required parameter 'association_type' is set
-          if @api_client.config.client_side_validation && association_type.nil?
-            fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.create"
+          # verify the required parameter 'association_spec' is set
+          if @api_client.config.client_side_validation && association_spec.nil?
+            fail ArgumentError, "Missing the required parameter 'association_spec' when calling AssociationsApi.create"
           end
           # resource path
-          local_var_path = '/crm/v4/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))
+          local_var_path = '/crm/v4/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -149,15 +147,20 @@ module Hubspot
           header_params = opts[:header_params] || {}
           # HTTP header 'Accept' (if needed)
           header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
 
           # form parameters
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body]
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(association_spec)
 
           # return_type
-          return_type = opts[:debug_return_type] || 'SimplePublicObjectWithAssociations'
+          return_type = opts[:debug_return_type] || 'LabelsBetweenObjectPair'
 
           # auth_names
           auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
@@ -179,25 +182,27 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # List associations of a company by type
-        # @param company_id [String] 
+        # List
+        # List all associations of a company by object type. Limit 1000 per call.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
-        # @return [CollectionResponseAssociatedIdForwardPaging]
+        # @return [CollectionResponseMultiAssociatedObjectWithLabelForwardPaging]
         def get_all(company_id, to_object_type, opts = {})
           data, _status_code, _headers = get_all_with_http_info(company_id, to_object_type, opts)
           data
         end
 
-        # List associations of a company by type
-        # @param company_id [String] 
+        # List
+        # List all associations of a company by object type. Limit 1000 per call.
+        # @param company_id [Integer] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
-        # @return [Array<(CollectionResponseAssociatedIdForwardPaging, Integer, Hash)>] CollectionResponseAssociatedIdForwardPaging data, response status code and response headers
+        # @return [Array<(CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, Integer, Hash)>] CollectionResponseMultiAssociatedObjectWithLabelForwardPaging data, response status code and response headers
         def get_all_with_http_info(company_id, to_object_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
@@ -230,7 +235,7 @@ module Hubspot
           post_body = opts[:debug_body]
 
           # return_type
-          return_type = opts[:debug_return_type] || 'CollectionResponseAssociatedIdForwardPaging'
+          return_type = opts[:debug_return_type] || 'CollectionResponseMultiAssociatedObjectWithLabelForwardPaging'
 
           # auth_names
           auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']

data/lib/hubspot/codegen/crm/companies/models/association_spec.rb

@@ -0,0 +1,276 @@
+=begin
+#Companies
+
+#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: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Crm
+    module Companies
+      class AssociationSpec
+        attr_accessor :association_category
+
+        attr_accessor :association_type_id
+
+        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
+          {
+            :'association_category' => :'associationCategory',
+            :'association_type_id' => :'associationTypeId'
+          }
+        end
+
+        # Returns all the JSON keys this model knows about
+        def self.acceptable_attributes
+          attribute_map.values
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'association_category' => :'String',
+            :'association_type_id' => :'Integer'
+          }
+        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::Companies::AssociationSpec` 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::Companies::AssociationSpec`. 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?(:'association_category')
+            self.association_category = attributes[:'association_category']
+          end
+
+          if attributes.key?(:'association_type_id')
+            self.association_type_id = attributes[:'association_type_id']
+          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 @association_category.nil?
+            invalid_properties.push('invalid value for "association_category", association_category cannot be nil.')
+          end
+
+          if @association_type_id.nil?
+            invalid_properties.push('invalid value for "association_type_id", association_type_id 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 @association_category.nil?
+          association_category_validator = EnumAttributeValidator.new('String', ["HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED"])
+          return false unless association_category_validator.valid?(@association_category)
+          return false if @association_type_id.nil?
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] association_category Object to be assigned
+        def association_category=(association_category)
+          validator = EnumAttributeValidator.new('String', ["HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED"])
+          unless validator.valid?(association_category)
+            fail ArgumentError, "invalid value for \"association_category\", must be one of #{validator.allowable_values}."
+          end
+          @association_category = association_category
+        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 &&
+              association_category == o.association_category &&
+              association_type_id == o.association_type_id
+        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
+          [association_category, association_type_id].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)
+          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)
+            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) })
+              end
+            elsif !attributes[self.class.attribute_map[key]].nil?
+              self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+            end
+          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 :Time
+            Time.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
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Crm::Companies.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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