hubspot-api-client 10.0.1 → 17.1.0

data/lib/hubspot/codegen/cms/blogs/tags/models/update_languages_request_v_next.rb

@@ -0,0 +1,271 @@
+=begin
+#Blog Post endpoints
+
+#Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags
+
+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 Cms
+    module Blogs
+      module Tags
+        # Request object for updating languages within a multi-language group.
+        class UpdateLanguagesRequestVNext
+          # ID of the primary object in the multi-language group.
+          attr_accessor :primary_id
+
+          # Map of object IDs to associated languages of object in the multi-language group.
+          attr_accessor :languages
+
+          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
+            {
+              :'primary_id' => :'primaryId',
+              :'languages' => :'languages'
+            }
+          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
+            {
+              :'primary_id' => :'String',
+              :'languages' => :'Hash<String, 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::Cms::Blogs::Tags::UpdateLanguagesRequestVNext` 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::Cms::Blogs::Tags::UpdateLanguagesRequestVNext`. 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?(:'primary_id')
+              self.primary_id = attributes[:'primary_id']
+            end
+
+            if attributes.key?(:'languages')
+              if (value = attributes[:'languages']).is_a?(Hash)
+                self.languages = value
+              end
+            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 @primary_id.nil?
+              invalid_properties.push('invalid value for "primary_id", primary_id cannot be nil.')
+            end
+
+            if @languages.nil?
+              invalid_properties.push('invalid value for "languages", languages 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 @primary_id.nil?
+            return false if @languages.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 &&
+                primary_id == o.primary_id &&
+                languages == o.languages
+          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
+            [primary_id, languages].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::Cms::Blogs::Tags.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

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -25,7 +25,6 @@ module Hubspot
         # Returns a single domains with the id specified.
         # @param domain_id [String] The unique ID of the domain.
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :archived Whether to return only results that have been archived.
         # @return [Domain]
         def get_by_id(domain_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(domain_id, opts)
@@ -36,7 +35,6 @@ module Hubspot
         # Returns a single domains with the id specified.
         # @param domain_id [String] The unique ID of the domain.
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :archived Whether to return only results that have been archived.
         # @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers
         def get_by_id_with_http_info(domain_id, opts = {})
           if @api_client.config.debugging
@@ -51,7 +49,6 @@ module Hubspot
 
           # query parameters
           query_params = opts[:query_params] || {}
-          query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
 
           # header parameters
           header_params = opts[:header_params] || {}
@@ -62,15 +59,16 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] 
+          post_body = opts[:debug_body]
 
           # return_type
-          return_type = opts[:return_type] || 'Domain' 
+          return_type = opts[:debug_return_type] || 'Domain'
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+          auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
+            :operation => :"DomainsApi.get_by_id",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -89,19 +87,17 @@ module Hubspot
         # Get current domains
         # Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.
         # @param [Hash] opts the optional parameters
-        # @option opts [Integer] :created_at Only return domains created at this date.
-        # @option opts [Integer] :created_after Only return domains created after this date.
-        # @option opts [Integer] :created_before Only return domains created before this date.
-        # @option opts [Integer] :updated_at Only return domains updated at this date.
-        # @option opts [Integer] :updated_after Only return domains updated after this date.
-        # @option opts [Integer] :updated_before Only return domains updated before this date.
+        # @option opts [Time] :created_at Only return domains created at this date.
+        # @option opts [Time] :created_after Only return domains created after this date.
+        # @option opts [Time] :created_before Only return domains created before this date.
+        # @option opts [Time] :updated_at Only return domains updated at this date.
+        # @option opts [Time] :updated_after Only return domains updated after this date.
+        # @option opts [Time] :updated_before Only return domains updated before this date.
         # @option opts [Array<String>] :sort 
-        # @option opts [Array<String>] :properties 
         # @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 [String] :before 
         # @option opts [Integer] :limit Maximum number of results per page.
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @return [CollectionResponseWithTotalDomain]
+        # @return [CollectionResponseWithTotalDomainForwardPaging]
         def get_page(opts = {})
           data, _status_code, _headers = get_page_with_http_info(opts)
           data
@@ -110,19 +106,17 @@ module Hubspot
         # Get current domains
         # Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.
         # @param [Hash] opts the optional parameters
-        # @option opts [Integer] :created_at Only return domains created at this date.
-        # @option opts [Integer] :created_after Only return domains created after this date.
-        # @option opts [Integer] :created_before Only return domains created before this date.
-        # @option opts [Integer] :updated_at Only return domains updated at this date.
-        # @option opts [Integer] :updated_after Only return domains updated after this date.
-        # @option opts [Integer] :updated_before Only return domains updated before this date.
+        # @option opts [Time] :created_at Only return domains created at this date.
+        # @option opts [Time] :created_after Only return domains created after this date.
+        # @option opts [Time] :created_before Only return domains created before this date.
+        # @option opts [Time] :updated_at Only return domains updated at this date.
+        # @option opts [Time] :updated_after Only return domains updated after this date.
+        # @option opts [Time] :updated_before Only return domains updated before this date.
         # @option opts [Array<String>] :sort 
-        # @option opts [Array<String>] :properties 
         # @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 [String] :before 
         # @option opts [Integer] :limit Maximum number of results per page.
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @return [Array<(CollectionResponseWithTotalDomain, Integer, Hash)>] CollectionResponseWithTotalDomain data, response status code and response headers
+        # @return [Array<(CollectionResponseWithTotalDomainForwardPaging, Integer, Hash)>] CollectionResponseWithTotalDomainForwardPaging data, response status code and response headers
         def get_page_with_http_info(opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: DomainsApi.get_page ...'
@@ -139,9 +133,7 @@ module Hubspot
           query_params[:'updatedAfter'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
           query_params[:'updatedBefore'] = opts[:'updated_before'] if !opts[:'updated_before'].nil?
           query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
-          query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
           query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
-          query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
           query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
 
@@ -154,15 +146,16 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] 
+          post_body = opts[:debug_body]
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseWithTotalDomain' 
+          return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalDomainForwardPaging'
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+          auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
+            :operation => :"DomainsApi.get_page",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'typhoeus'
 
 module Hubspot
@@ -102,12 +103,13 @@ module Hubspot
         # @option opts [Object] :body HTTP body (JSON/XML)
         # @return [Typhoeus::Request] A Typhoeus Request
         def build_request(http_method, path, opts = {})
-          url = build_request_url(path)
+          url = build_request_url(path, opts)
           http_method = http_method.to_sym.downcase
 
           header_params = @default_headers.merge(opts[:header_params] || {})
           query_params = opts[:query_params] || {}
           form_params = opts[:form_params] || {}
+          follow_location = opts[:follow_location] || true
 
           update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -124,7 +126,8 @@ module Hubspot
             :ssl_verifyhost => _verify_ssl_host,
             :sslcert => @config.cert_file,
             :sslkey => @config.key_file,
-            :verbose => @config.debugging
+            :verbose => @config.debugging,
+            :followlocation => follow_location
           }
 
           # set custom cert, if provided
@@ -171,6 +174,44 @@ module Hubspot
           data
         end
 
+        # Save response body into a file in (the defined) temporary folder, using the filename
+        # from the "Content-Disposition" header if provided, otherwise a random filename.
+        # The response body is written to the file in chunks in order to handle files which
+        # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+        # process can use.
+        #
+        # @see Configuration#temp_folder_path
+        def download_file(request)
+          tempfile = nil
+          encoding = nil
+          request.on_headers do |response|
+            content_disposition = response.headers['Content-Disposition']
+            if content_disposition && content_disposition =~ /filename=/i
+              filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+              prefix = sanitize_filename(filename)
+            else
+              prefix = 'download-'
+            end
+            prefix = prefix + '-' unless prefix.end_with?('-')
+            encoding = response.body.encoding
+            tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+            @tempfile = tempfile
+          end
+          request.on_body do |chunk|
+            chunk.force_encoding(encoding)
+            tempfile.write(chunk)
+          end
+          request.on_complete do |response|
+            if tempfile
+              tempfile.close
+              @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                                  "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                                  "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                                  "explicitly with `tempfile.delete`"
+            end
+          end
+        end
+
         # Check if the given MIME is a JSON MIME.
         # JSON MIME examples:
         #   application/json
@@ -207,7 +248,7 @@ module Hubspot
           begin
             data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
           rescue JSON::ParserError => e
-            if %w(String Date DateTime).include?(return_type)
+            if %w(String Date Time).include?(return_type)
               data = body
             else
               raise e
@@ -232,9 +273,9 @@ module Hubspot
             data.to_f
           when 'Boolean'
             data == true
-          when 'DateTime'
+          when 'Time'
             # parse date time (expecting ISO 8601 format)
-            DateTime.parse data
+            Time.parse data
           when 'Date'
             # parse date time (expecting ISO 8601 format)
             Date.parse data
@@ -252,46 +293,9 @@ module Hubspot
               data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
             end
           else
-            # models, e.g. Pet
-            Hubspot::Cms::Domains.const_get(return_type).build_from_hash(data)
-          end
-        end
-
-        # Save response body into a file in (the defined) temporary folder, using the filename
-        # from the "Content-Disposition" header if provided, otherwise a random filename.
-        # The response body is written to the file in chunks in order to handle files which
-        # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-        # process can use.
-        #
-        # @see Configuration#temp_folder_path
-        def download_file(request)
-          tempfile = nil
-          encoding = nil
-          request.on_headers do |response|
-            content_disposition = response.headers['Content-Disposition']
-            if content_disposition && content_disposition =~ /filename=/i
-              filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-              prefix = sanitize_filename(filename)
-            else
-              prefix = 'download-'
-            end
-            prefix = prefix + '-' unless prefix.end_with?('-')
-            encoding = response.body.encoding
-            tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-            @tempfile = tempfile
-          end
-          request.on_body do |chunk|
-            chunk.force_encoding(encoding)
-            tempfile.write(chunk)
-          end
-          request.on_complete do |response|
-            if tempfile
-              tempfile.close
-              @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                                  "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                                  "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                                  "explicitly with `tempfile.delete`"
-            end
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Cms::Domains.const_get(return_type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
           end
         end
 
@@ -304,13 +308,13 @@ module Hubspot
           filename.gsub(/.*[\/\\]/, '')
         end
 
-        def build_request_url(path)
+        def build_request_url(path, opts = {})
           # Add leading and trailing slashes to path
           path = "/#{path}".gsub(/\/+/, '/')
-          @config.base_url + path
+          @config.base_url(opts[:operation]) + path
         end
 
-        # Update hearder and query params based on authentication settings.
+        # Update header and query params based on authentication settings.
         #
         # @param [Hash] header_params Header parameters
         # @param [Hash] query_params Query parameters
@@ -322,7 +326,7 @@ module Hubspot
             case auth_setting[:in]
             when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
             when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-            else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+            else fail ArgumentError, 'Authentication token must be in `query` or `header`'
             end
           end
         end
@@ -349,8 +353,8 @@ module Hubspot
         # @param [Array] content_types array for Content-Type
         # @return [String] the Content-Type header  (e.g. application/json)
         def select_header_content_type(content_types)
-          # use application/json by default
-          return 'application/json' if content_types.nil? || content_types.empty?
+          # return nil by default
+          return if content_types.nil? || content_types.empty?
           # use JSON when present, otherwise use the first one
           json_content_type = content_types.find { |s| json_mime?(s) }
           json_content_type || content_types.first

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

@@ -6,14 +6,14 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
 module Hubspot
   module Cms
     module Domains
-      class ApiError < StandardError
+      class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 
         # Usage examples: