hubspot-api-client 9.4.0 → 10.0.1

data/lib/hubspot/codegen/events/models/paging.rb

@@ -0,0 +1,208 @@
+=begin
+#HubSpot Events API
+
+#API for accessing CRM object events.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Events
+    class Paging
+      attr_accessor :_next
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'_next' => :'next'
+        }
+      end
+
+      # Attribute type mapping.
+      def self.openapi_types
+        {
+          :'_next' => :'NextPage'
+        }
+      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::Events::Paging` 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::Events::Paging`. 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?(:'_next')
+          self._next = attributes[:'_next']
+        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
+        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?
+        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 &&
+            _next == o._next
+      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
+        [_next].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::Events.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

data/lib/hubspot/codegen/files/files/api/files_api.rb

@@ -382,7 +382,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'File' 
+          return_type = opts[:return_type] || 'HubspotFile' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -552,7 +552,7 @@ module Hubspot
         # @param file_id [String] Id of the desired file.
         # @param [Hash] opts the optional parameters
         # @option opts [String] :user_agent 
-        # @option opts [String] :file File data that will replace existing file in the file manager.
+        # @option opts [File] :file File data that will replace existing file in the file manager.
         # @option opts [String] :charset_hunch Character set of given file data.
         # @option opts [String] :options JSON String representing FileReplaceOptions
         # @return [File]
@@ -566,7 +566,7 @@ module Hubspot
         # @param file_id [String] Id of the desired file.
         # @param [Hash] opts the optional parameters
         # @option opts [String] :user_agent 
-        # @option opts [String] :file File data that will replace existing file in the file manager.
+        # @option opts [File] :file File data that will replace existing file in the file manager.
         # @option opts [String] :charset_hunch Character set of given file data.
         # @option opts [String] :options JSON String representing FileReplaceOptions
         # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -607,7 +607,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'File' 
+          return_type = opts[:return_type] || 'HubspotFile' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -682,7 +682,7 @@ module Hubspot
           post_body = opts[:body] || @api_client.object_to_http_body(file_update_input) 
 
           # return_type
-          return_type = opts[:return_type] || 'File' 
+          return_type = opts[:return_type] || 'HubspotFile' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -707,7 +707,7 @@ module Hubspot
         # Upload a single file with content specified in request body.
         # @param [Hash] opts the optional parameters
         # @option opts [String] :user_agent 
-        # @option opts [String] :file File to be uploaded.
+        # @option opts [File] :file File to be uploaded.
         # @option opts [String] :folder_id Either &#39;folderId&#39; or &#39;folderPath&#39; is required. folderId is the ID of the folder the file will be uploaded to.
         # @option opts [String] :folder_path Either &#39;folderPath&#39; or &#39;folderId&#39; is required. This field represents the destination folder path for the uploaded file. If a path doesn&#39;t exist, the system will try to create one.
         # @option opts [String] :file_name Desired name for the uploaded file.
@@ -723,7 +723,7 @@ module Hubspot
         # Upload a single file with content specified in request body.
         # @param [Hash] opts the optional parameters
         # @option opts [String] :user_agent 
-        # @option opts [String] :file File to be uploaded.
+        # @option opts [File] :file File to be uploaded.
         # @option opts [String] :folder_id Either &#39;folderId&#39; or &#39;folderPath&#39; is required. folderId is the ID of the folder the file will be uploaded to.
         # @option opts [String] :folder_path Either &#39;folderPath&#39; or &#39;folderId&#39; is required. This field represents the destination folder path for the uploaded file. If a path doesn&#39;t exist, the system will try to create one.
         # @option opts [String] :file_name Desired name for the uploaded file.
@@ -761,7 +761,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'File' 
+          return_type = opts[:return_type] || 'HubspotFile' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

data/lib/hubspot/codegen/files/files/api_client.rb

@@ -55,6 +55,20 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           end
 
+          if !response.success? && config.error_handler.any?
+            config.error_handler.each do |statuses, opts|
+              statuses = statuses.is_a?(Integer) ? [statuses] : statuses
+
+              retries = opts[:max_retries] || 5
+              while retries > 0 && statuses.include?(response.code)
+                sleep opts[:seconds_delay] if opts[:seconds_delay]
+                response = request.run
+                opts[:retry_block].call if opts[:retry_block]
+                retries -= 1
+              end
+            end
+          end
+
           unless response.success?
             if response.timed_out?
               fail ApiError.new('Connection timed out')

data/lib/hubspot/codegen/files/files/models/file_update_input.rb

@@ -127,7 +127,7 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           true
         end
@@ -135,7 +135,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/files/files/models/{file.rb → hubspot_file.rb}

@@ -15,7 +15,7 @@ require 'date'
 module Hubspot
   module Files
     module Files
-      class File
+      class HubspotFile
         # File ID.
         attr_accessor :id
 
@@ -269,7 +269,7 @@ module Hubspot
           return false if @updated_at.nil?
           return false if @archived.nil?
           return false if @access.nil?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           true
         end
@@ -277,7 +277,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/files/files/models/import_from_url_input.rb

@@ -184,7 +184,7 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @access.nil?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           return false if @url.nil?
           return false if @duplicate_validation_strategy.nil?
@@ -200,7 +200,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/marketing/transactional/api/default_api.rb

@@ -83,6 +83,66 @@ module Hubspot
           return data, status_code, headers
         end
 
+        # Create a SMTP API token.
+        # Create a SMTP API token.
+        # @param [Hash] opts the optional parameters
+        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
+        # @return [SmtpApiTokenView]
+        def create_token(opts = {})
+          data, _status_code, _headers = create_token_with_http_info(opts)
+          data
+        end
+
+        # Create a SMTP API token.
+        # Create a SMTP API token.
+        # @param [Hash] opts the optional parameters
+        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
+        # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView 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 = '/marketing/v3/transactional/smtp-tokens'
+
+          # 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/json'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'smtp_api_token_request_egg']) 
+
+          # return_type
+          return_type = opts[:return_type] || 'SmtpApiTokenView' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey']
+
+          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
+
         # Query a single token by ID.
         # Query a single token by ID.
         # @param token_id [String] Identifier generated when a token is created.
@@ -213,66 +273,6 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Create a SMTP API token.
-        # Create a SMTP API token.
-        # @param [Hash] opts the optional parameters
-        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
-        # @return [SmtpApiTokenView]
-        def create_token(opts = {})
-          data, _status_code, _headers = create_token_with_http_info(opts)
-          data
-        end
-
-        # Create a SMTP API token.
-        # Create a SMTP API token.
-        # @param [Hash] opts the optional parameters
-        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
-        # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView 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 = '/marketing/v3/transactional/smtp-tokens'
-
-          # 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/json'])
-
-          # form parameters
-          form_params = opts[:form_params] || {}
-
-          # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'smtp_api_token_request_egg']) 
-
-          # return_type
-          return_type = opts[:return_type] || 'SmtpApiTokenView' 
-
-          # auth_names
-          auth_names = opts[:auth_names] || ['hapikey']
-
-          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
-
         # Reset the password of an existing token.
         # Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.
         # @param token_id [String] Identifier generated when a token is created.