hubspot-api-client 16.0.3 → 16.0.4

data/lib/hubspot/codegen/crm/objects/emails/api/associations_api.rb

@@ -22,26 +22,26 @@ module Hubspot
           def initialize(api_client = ApiClient.default)
             @api_client = api_client
           end
-          # Remove an association between two emails
-          # @param email_id [String] 
+          # Delete
+          # deletes all associations between two records.
+          # @param email_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(email_id, to_object_type, to_object_id, association_type, opts = {})
-            archive_with_http_info(email_id, to_object_type, to_object_id, association_type, opts)
+          def archive(email_id, to_object_type, to_object_id, opts = {})
+            archive_with_http_info(email_id, to_object_type, to_object_id, opts)
             nil
           end
 
-          # Remove an association between two emails
-          # @param email_id [String] 
+          # Delete
+          # deletes all associations between two records.
+          # @param email_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(email_id, to_object_type, to_object_id, association_type, opts = {})
+          def archive_with_http_info(email_id, to_object_type, to_object_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
             end
@@ -57,12 +57,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/emails/{emailId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'emailId' + '}', CGI.escape(email_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/emails/{emailId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || {}
@@ -101,26 +97,28 @@ module Hubspot
             return data, status_code, headers
           end
 
-          # Associate a email with another object
-          # @param email_id [String] 
+          # Create
+          # Set association labels between two records.
+          # @param email_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(email_id, to_object_type, to_object_id, association_type, opts = {})
-            data, _status_code, _headers = create_with_http_info(email_id, to_object_type, to_object_id, association_type, opts)
+          # @return [LabelsBetweenObjectPair]
+          def create(email_id, to_object_type, to_object_id, association_spec, opts = {})
+            data, _status_code, _headers = create_with_http_info(email_id, to_object_type, to_object_id, association_spec, opts)
             data
           end
 
-          # Associate a email with another object
-          # @param email_id [String] 
+          # Create
+          # Set association labels between two records.
+          # @param email_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(email_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(email_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
@@ -136,12 +134,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/emails/{emailId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'emailId' + '}', CGI.escape(email_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/emails/{emailId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || {}
@@ -150,15 +148,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']
@@ -180,25 +183,27 @@ module Hubspot
             return data, status_code, headers
           end
 
-          # List associations of a email by type
-          # @param email_id [String] 
+          # List
+          # List all associations of a email by object type. Limit 1000 per call.
+          # @param email_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(email_id, to_object_type, opts = {})
             data, _status_code, _headers = get_all_with_http_info(email_id, to_object_type, opts)
             data
           end
 
-          # List associations of a email by type
-          # @param email_id [String] 
+          # List
+          # List all associations of a email by object type. Limit 1000 per call.
+          # @param email_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(email_id, to_object_type, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
@@ -231,10 +236,10 @@ 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']
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
             new_options = opts.merge(
               :operation => :"AssociationsApi.get_all",

data/lib/hubspot/codegen/crm/objects/emails/api/basic_api.rb

@@ -214,7 +214,7 @@ module Hubspot
             return_type = opts[:debug_return_type] || 'SimplePublicObjectWithAssociations'
 
             # auth_names
-            auth_names = opts[:debug_auth_names] || ['hapikey']
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
             new_options = opts.merge(
               :operation => :"BasicApi.get_by_id",
@@ -289,7 +289,7 @@ module Hubspot
             return_type = opts[:debug_return_type] || 'CollectionResponseSimplePublicObjectWithAssociationsForwardPaging'
 
             # auth_names
-            auth_names = opts[:debug_auth_names] || ['hapikey']
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
             new_options = opts.merge(
               :operation => :"BasicApi.get_page",

data/lib/hubspot/codegen/crm/objects/emails/api/batch_api.rb

@@ -204,7 +204,7 @@ module Hubspot
             return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
 
             # auth_names
-            auth_names = opts[:debug_auth_names] || ['hapikey']
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
             new_options = opts.merge(
               :operation => :"BatchApi.read",

data/lib/hubspot/codegen/crm/objects/emails/api/search_api.rb

@@ -67,7 +67,7 @@ module Hubspot
             return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalSimplePublicObjectForwardPaging'
 
             # auth_names
-            auth_names = opts[:debug_auth_names] || ['hapikey']
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
             new_options = opts.merge(
               :operation => :"SearchApi.do_search",

data/lib/hubspot/codegen/crm/objects/emails/models/association_spec.rb

@@ -0,0 +1,278 @@
+=begin
+#Emails
+
+#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 Objects
+      module Emails
+        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::Objects::Emails::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::Objects::Emails::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::Objects::Emails.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
+end