hubspot-api-client 3.3.0 → 7.1.0

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

@@ -0,0 +1,306 @@
+=begin
+#URL redirects
+
+#URL redirect operations
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Cms
+    module UrlRedirects
+      class UrlMappingCreateRequestBody
+        attr_accessor :route_prefix
+
+        attr_accessor :destination
+
+        attr_accessor :redirect_style
+
+        attr_accessor :precedence
+
+        attr_accessor :is_only_after_not_found
+
+        attr_accessor :is_match_full_url
+
+        attr_accessor :is_match_query_string
+
+        attr_accessor :is_pattern
+
+        attr_accessor :is_trailing_slash_optional
+
+        attr_accessor :is_protocol_agnostic
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'route_prefix' => :'routePrefix',
+            :'destination' => :'destination',
+            :'redirect_style' => :'redirectStyle',
+            :'precedence' => :'precedence',
+            :'is_only_after_not_found' => :'isOnlyAfterNotFound',
+            :'is_match_full_url' => :'isMatchFullUrl',
+            :'is_match_query_string' => :'isMatchQueryString',
+            :'is_pattern' => :'isPattern',
+            :'is_trailing_slash_optional' => :'isTrailingSlashOptional',
+            :'is_protocol_agnostic' => :'isProtocolAgnostic'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'route_prefix' => :'String',
+            :'destination' => :'String',
+            :'redirect_style' => :'Integer',
+            :'precedence' => :'Integer',
+            :'is_only_after_not_found' => :'Boolean',
+            :'is_match_full_url' => :'Boolean',
+            :'is_match_query_string' => :'Boolean',
+            :'is_pattern' => :'Boolean',
+            :'is_trailing_slash_optional' => :'Boolean',
+            :'is_protocol_agnostic' => :'Boolean'
+          }
+        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::UrlMappingCreateRequestBody` 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::UrlMappingCreateRequestBody`. 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?(:'route_prefix')
+            self.route_prefix = attributes[:'route_prefix']
+          end
+
+          if attributes.key?(:'destination')
+            self.destination = attributes[:'destination']
+          end
+
+          if attributes.key?(:'redirect_style')
+            self.redirect_style = attributes[:'redirect_style']
+          end
+
+          if attributes.key?(:'precedence')
+            self.precedence = attributes[:'precedence']
+          end
+
+          if attributes.key?(:'is_only_after_not_found')
+            self.is_only_after_not_found = attributes[:'is_only_after_not_found']
+          end
+
+          if attributes.key?(:'is_match_full_url')
+            self.is_match_full_url = attributes[:'is_match_full_url']
+          end
+
+          if attributes.key?(:'is_match_query_string')
+            self.is_match_query_string = attributes[:'is_match_query_string']
+          end
+
+          if attributes.key?(:'is_pattern')
+            self.is_pattern = attributes[:'is_pattern']
+          end
+
+          if attributes.key?(:'is_trailing_slash_optional')
+            self.is_trailing_slash_optional = attributes[:'is_trailing_slash_optional']
+          end
+
+          if attributes.key?(:'is_protocol_agnostic')
+            self.is_protocol_agnostic = attributes[:'is_protocol_agnostic']
+          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 @route_prefix.nil?
+            invalid_properties.push('invalid value for "route_prefix", route_prefix cannot be nil.')
+          end
+
+          if @destination.nil?
+            invalid_properties.push('invalid value for "destination", destination cannot be nil.')
+          end
+
+          if @redirect_style.nil?
+            invalid_properties.push('invalid value for "redirect_style", redirect_style 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 @route_prefix.nil?
+          return false if @destination.nil?
+          return false if @redirect_style.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 &&
+              route_prefix == o.route_prefix &&
+              destination == o.destination &&
+              redirect_style == o.redirect_style &&
+              precedence == o.precedence &&
+              is_only_after_not_found == o.is_only_after_not_found &&
+              is_match_full_url == o.is_match_full_url &&
+              is_match_query_string == o.is_match_query_string &&
+              is_pattern == o.is_pattern &&
+              is_trailing_slash_optional == o.is_trailing_slash_optional &&
+              is_protocol_agnostic == o.is_protocol_agnostic
+        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
+          [route_prefix, destination, redirect_style, precedence, is_only_after_not_found, is_match_full_url, is_match_query_string, is_pattern, is_trailing_slash_optional, is_protocol_agnostic].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/crm/companies/api/associations_api.rb

@@ -99,7 +99,7 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Associate two companies
+        # Associate a company with another object
         # @param company_id [String] 
         # @param to_object_type [String] 
         # @param to_object_id [String] 
@@ -111,7 +111,7 @@ module Hubspot
           data
         end
 
-        # Associate two companies
+        # Associate a company with another object
         # @param company_id [String] 
         # @param to_object_type [String] 
         # @param to_object_id [String] 

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

@@ -87,23 +87,27 @@ module Hubspot
 
         # Create
         # Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.
+        # @param simple_public_object_input [SimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [SimplePublicObjectInput] :simple_public_object_input 
         # @return [SimplePublicObject]
-        def create(opts = {})
-          data, _status_code, _headers = create_with_http_info(opts)
+        def create(simple_public_object_input, opts = {})
+          data, _status_code, _headers = create_with_http_info(simple_public_object_input, opts)
           data
         end
 
         # Create
         # Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.
+        # @param simple_public_object_input [SimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [SimplePublicObjectInput] :simple_public_object_input 
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
-        def create_with_http_info(opts = {})
+        def create_with_http_info(simple_public_object_input, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BasicApi.create ...'
           end
+          # verify the required parameter 'simple_public_object_input' is set
+          if @api_client.config.client_side_validation && simple_public_object_input.nil?
+            fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.create"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies'
 
@@ -121,7 +125,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'simple_public_object_input']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(simple_public_object_input) 
 
           # return_type
           return_type = opts[:return_type] || 'SimplePublicObject' 
@@ -293,21 +297,21 @@ module Hubspot
         # Update
         # Perform a partial update of an Object identified by `{companyId}`. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
         # @param company_id [String] 
+        # @param simple_public_object_input [SimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [SimplePublicObjectInput] :simple_public_object_input 
         # @return [SimplePublicObject]
-        def update(company_id, opts = {})
-          data, _status_code, _headers = update_with_http_info(company_id, opts)
+        def update(company_id, simple_public_object_input, opts = {})
+          data, _status_code, _headers = update_with_http_info(company_id, simple_public_object_input, opts)
           data
         end
 
         # Update
         # Perform a partial update of an Object identified by &#x60;{companyId}&#x60;. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
         # @param company_id [String] 
+        # @param simple_public_object_input [SimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [SimplePublicObjectInput] :simple_public_object_input 
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
-        def update_with_http_info(company_id, opts = {})
+        def update_with_http_info(company_id, simple_public_object_input, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BasicApi.update ...'
           end
@@ -315,6 +319,10 @@ module Hubspot
           if @api_client.config.client_side_validation && company_id.nil?
             fail ArgumentError, "Missing the required parameter 'company_id' when calling BasicApi.update"
           end
+          # verify the required parameter 'simple_public_object_input' is set
+          if @api_client.config.client_side_validation && simple_public_object_input.nil?
+            fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.update"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies/{companyId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s))
 
@@ -332,7 +340,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'simple_public_object_input']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(simple_public_object_input) 
 
           # return_type
           return_type = opts[:return_type] || 'SimplePublicObject' 

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

@@ -23,23 +23,27 @@ module Hubspot
         end
         # Archive a batch of companies by ID
         # Archive a list of companies given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
+        # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectId] :batch_input_simple_public_object_id 
         # @return [nil]
-        def archive(opts = {})
-          archive_with_http_info(opts)
+        def archive(batch_input_simple_public_object_id, opts = {})
+          archive_with_http_info(batch_input_simple_public_object_id, opts)
           nil
         end
 
         # Archive a batch of companies by ID
         # Archive a list of companies given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
+        # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectId] :batch_input_simple_public_object_id 
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-        def archive_with_http_info(opts = {})
+        def archive_with_http_info(batch_input_simple_public_object_id, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
           end
+          # verify the required parameter 'batch_input_simple_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies/batch/archive'
 
@@ -57,7 +61,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_id']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_id) 
 
           # return_type
           return_type = opts[:return_type] 
@@ -83,23 +87,27 @@ module Hubspot
 
         # Create a batch of companies
         # Create a batch of companies. This follows the same rules as creating an individual object.
+        # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectInput] :batch_input_simple_public_object_input 
         # @return [BatchResponseSimplePublicObject]
-        def create(opts = {})
-          data, _status_code, _headers = create_with_http_info(opts)
+        def create(batch_input_simple_public_object_input, opts = {})
+          data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input, opts)
           data
         end
 
         # Create a batch of companies
         # Create a batch of companies. This follows the same rules as creating an individual object.
+        # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectInput] :batch_input_simple_public_object_input 
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
-        def create_with_http_info(opts = {})
+        def create_with_http_info(batch_input_simple_public_object_input, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
           end
+          # verify the required parameter 'batch_input_simple_public_object_input' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_input.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input' when calling BatchApi.create"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies/batch/create'
 
@@ -117,7 +125,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_input']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_input) 
 
           # return_type
           return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
@@ -143,25 +151,29 @@ module Hubspot
 
         # Read a batch of companies by internal ID, or unique property values
         # Read a list of companies given a collection of IDs. Use the `properties` request body property to control which properties are returned.
+        # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
-        # @option opts [BatchReadInputSimplePublicObjectId] :batch_read_input_simple_public_object_id 
         # @return [BatchResponseSimplePublicObject]
-        def read(opts = {})
-          data, _status_code, _headers = read_with_http_info(opts)
+        def read(batch_read_input_simple_public_object_id, opts = {})
+          data, _status_code, _headers = read_with_http_info(batch_read_input_simple_public_object_id, opts)
           data
         end
 
         # Read a batch of companies by internal ID, or unique property values
         # Read a list of companies given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
+        # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @option opts [BatchReadInputSimplePublicObjectId] :batch_read_input_simple_public_object_id 
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
-        def read_with_http_info(opts = {})
+        def read_with_http_info(batch_read_input_simple_public_object_id, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
           end
+          # verify the required parameter 'batch_read_input_simple_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies/batch/read'
 
@@ -180,7 +192,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_read_input_simple_public_object_id']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id) 
 
           # return_type
           return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
@@ -206,23 +218,27 @@ module Hubspot
 
         # Update a batch of companies
         # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
+        # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectBatchInput] :batch_input_simple_public_object_batch_input 
         # @return [BatchResponseSimplePublicObject]
-        def update(opts = {})
-          data, _status_code, _headers = update_with_http_info(opts)
+        def update(batch_input_simple_public_object_batch_input, opts = {})
+          data, _status_code, _headers = update_with_http_info(batch_input_simple_public_object_batch_input, opts)
           data
         end
 
         # Update a batch of companies
         # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
+        # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputSimplePublicObjectBatchInput] :batch_input_simple_public_object_batch_input 
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
-        def update_with_http_info(opts = {})
+        def update_with_http_info(batch_input_simple_public_object_batch_input, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
           end
+          # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/companies/batch/update'
 
@@ -240,7 +256,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'batch_input_simple_public_object_batch_input']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input) 
 
           # return_type
           return_type = opts[:return_type] || 'BatchResponseSimplePublicObject'