hubspot-api-client 11.1.0 → 15.0.0

data/lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb

@@ -85,23 +85,27 @@ module Hubspot
 
         # Create a redirect
         # Creates and configures a new URL redirect.
+        # @param url_mapping_create_request_body [UrlMappingCreateRequestBody] 
         # @param [Hash] opts the optional parameters
-        # @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body 
         # @return [UrlMapping]
-        def create(opts = {})
-          data, _status_code, _headers = create_with_http_info(opts)
+        def create(url_mapping_create_request_body, opts = {})
+          data, _status_code, _headers = create_with_http_info(url_mapping_create_request_body, opts)
           data
         end
 
         # Create a redirect
         # Creates and configures a new URL redirect.
+        # @param url_mapping_create_request_body [UrlMappingCreateRequestBody] 
         # @param [Hash] opts the optional parameters
-        # @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body 
         # @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers
-        def create_with_http_info(opts = {})
+        def create_with_http_info(url_mapping_create_request_body, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: RedirectsApi.create ...'
           end
+          # verify the required parameter 'url_mapping_create_request_body' is set
+          if @api_client.config.client_side_validation && url_mapping_create_request_body.nil?
+            fail ArgumentError, "Missing the required parameter 'url_mapping_create_request_body' when calling RedirectsApi.create"
+          end
           # resource path
           local_var_path = '/cms/v3/url-redirects/'
 
@@ -119,7 +123,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'url_mapping_create_request_body']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(url_mapping_create_request_body) 
 
           # return_type
           return_type = opts[:return_type] || 'UrlMapping' 
@@ -215,12 +219,10 @@ module Hubspot
         # @option opts [DateTime] :updated_after Only return redirects last updated after this date.
         # @option opts [DateTime] :updated_before Only return redirects last 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 result per page
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @return [CollectionResponseWithTotalUrlMapping]
+        # @return [CollectionResponseWithTotalUrlMappingForwardPaging]
         def get_page(opts = {})
           data, _status_code, _headers = get_page_with_http_info(opts)
           data
@@ -236,12 +238,10 @@ module Hubspot
         # @option opts [DateTime] :updated_after Only return redirects last updated after this date.
         # @option opts [DateTime] :updated_before Only return redirects last 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 result per page
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @return [Array<(CollectionResponseWithTotalUrlMapping, Integer, Hash)>] CollectionResponseWithTotalUrlMapping data, response status code and response headers
+        # @return [Array<(CollectionResponseWithTotalUrlMappingForwardPaging, Integer, Hash)>] CollectionResponseWithTotalUrlMappingForwardPaging 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: RedirectsApi.get_page ...'
@@ -258,9 +258,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?
 
@@ -276,7 +274,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseWithTotalUrlMapping' 
+          return_type = opts[:return_type] || 'CollectionResponseWithTotalUrlMappingForwardPaging' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -300,21 +298,21 @@ module Hubspot
         # Update a redirect
         # Updates the settings for an existing URL redirect.
         # @param url_redirect_id [String] 
+        # @param url_mapping [UrlMapping] 
         # @param [Hash] opts the optional parameters
-        # @option opts [UrlMapping] :url_mapping 
         # @return [UrlMapping]
-        def update(url_redirect_id, opts = {})
-          data, _status_code, _headers = update_with_http_info(url_redirect_id, opts)
+        def update(url_redirect_id, url_mapping, opts = {})
+          data, _status_code, _headers = update_with_http_info(url_redirect_id, url_mapping, opts)
           data
         end
 
         # Update a redirect
         # Updates the settings for an existing URL redirect.
         # @param url_redirect_id [String] 
+        # @param url_mapping [UrlMapping] 
         # @param [Hash] opts the optional parameters
-        # @option opts [UrlMapping] :url_mapping 
         # @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers
-        def update_with_http_info(url_redirect_id, opts = {})
+        def update_with_http_info(url_redirect_id, url_mapping, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: RedirectsApi.update ...'
           end
@@ -322,6 +320,10 @@ module Hubspot
           if @api_client.config.client_side_validation && url_redirect_id.nil?
             fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.update"
           end
+          # verify the required parameter 'url_mapping' is set
+          if @api_client.config.client_side_validation && url_mapping.nil?
+            fail ArgumentError, "Missing the required parameter 'url_mapping' when calling RedirectsApi.update"
+          end
           # resource path
           local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_id.to_s))
 
@@ -339,7 +341,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'url_mapping']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(url_mapping) 
 
           # return_type
           return_type = opts[:return_type] || 'UrlMapping' 

data/lib/hubspot/codegen/cms/url-redirects/api_error.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 module Hubspot
   module Cms
     module UrlRedirects
-      class ApiError < StandardError
+      class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 
         # Usage examples:

data/lib/hubspot/codegen/cms/url-redirects/models/collection_response_with_total_url_mapping_forward_paging.rb

@@ -0,0 +1,240 @@
+=begin
+#URL redirects
+
+#URL redirect operations
+
+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 Cms
+    module UrlRedirects
+      class CollectionResponseWithTotalUrlMappingForwardPaging
+        attr_accessor :total
+
+        attr_accessor :results
+
+        attr_accessor :paging
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'total' => :'total',
+            :'results' => :'results',
+            :'paging' => :'paging'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'total' => :'Integer',
+            :'results' => :'Array<UrlMapping>',
+            :'paging' => :'ForwardPaging'
+          }
+        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::UrlRedirects::CollectionResponseWithTotalUrlMappingForwardPaging` 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::UrlRedirects::CollectionResponseWithTotalUrlMappingForwardPaging`. 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?(:'total')
+            self.total = attributes[:'total']
+          end
+
+          if attributes.key?(:'results')
+            if (value = attributes[:'results']).is_a?(Array)
+              self.results = value
+            end
+          end
+
+          if attributes.key?(:'paging')
+            self.paging = attributes[:'paging']
+          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 @total.nil?
+            invalid_properties.push('invalid value for "total", total cannot be nil.')
+          end
+
+          if @results.nil?
+            invalid_properties.push('invalid value for "results", results 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 @total.nil?
+          return false if @results.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 &&
+              total == o.total &&
+              results == o.results &&
+              paging == o.paging
+        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
+          [total, results, paging].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::Cms::UrlRedirects.const_get(type).build_from_hash(value)
+          end
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          to_hash.to_s
+        end
+
+        # to_body is an alias to to_hash (backward compatibility)
+        # @return [Hash] Returns the object in the form of hash
+        def to_body
+          to_hash
+        end
+
+        # Returns the object in the form of hash
+        # @return [Hash] Returns the object in the form of hash
+        def to_hash
+          hash = {}
+          self.class.attribute_map.each_pair do |attr, param|
+            value = self.send(attr)
+            if value.nil?
+              is_nullable = self.class.openapi_nullable.include?(attr)
+              next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+            end
+            
+            hash[param] = _to_hash(value)
+          end
+          hash
+        end
+
+        # Outputs non-array value in the form of hash
+        # For object, use to_hash. Otherwise, just return the value
+        # @param [Object] value Any valid value
+        # @return [Hash] Returns the value in the form of hash
+        def _to_hash(value)
+          if value.is_a?(Array)
+            value.compact.map { |v| _to_hash(v) }
+          elsif value.is_a?(Hash)
+            {}.tap do |hash|
+              value.each { |k, v| hash[k] = _to_hash(v) }
+            end
+          elsif value.respond_to? :to_hash
+            value.to_hash
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/cms/url-redirects/models/forward_paging.rb

@@ -0,0 +1,210 @@
+=begin
+#URL redirects
+
+#URL redirect operations
+
+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 Cms
+    module UrlRedirects
+      class ForwardPaging
+        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::Cms::UrlRedirects::ForwardPaging` 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::UrlRedirects::ForwardPaging`. 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::Cms::UrlRedirects.const_get(type).build_from_hash(value)
+          end
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          to_hash.to_s
+        end
+
+        # to_body is an alias to to_hash (backward compatibility)
+        # @return [Hash] Returns the object in the form of hash
+        def to_body
+          to_hash
+        end
+
+        # Returns the object in the form of hash
+        # @return [Hash] Returns the object in the form of hash
+        def to_hash
+          hash = {}
+          self.class.attribute_map.each_pair do |attr, param|
+            value = self.send(attr)
+            if value.nil?
+              is_nullable = self.class.openapi_nullable.include?(attr)
+              next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+            end
+            
+            hash[param] = _to_hash(value)
+          end
+          hash
+        end
+
+        # Outputs non-array value in the form of hash
+        # For object, use to_hash. Otherwise, just return the value
+        # @param [Object] value Any valid value
+        # @return [Hash] Returns the value in the form of hash
+        def _to_hash(value)
+          if value.is_a?(Array)
+            value.compact.map { |v| _to_hash(v) }
+          elsif value.is_a?(Hash)
+            {}.tap do |hash|
+              value.each { |k, v| hash[k] = _to_hash(v) }
+            end
+          elsif value.respond_to? :to_hash
+            value.to_hash
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end