hubspot-api-client 9.3.0 → 10.0.0

data/lib/hubspot/codegen/crm/schemas/api/core_api.rb

@@ -23,8 +23,9 @@ module Hubspot
         end
         # Delete a schema
         # Deletes a schema. Any existing records of this schema must be deleted **first**. Otherwise this call will fail.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param [Hash] opts the optional parameters
+        # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
         # @return [nil]
         def archive(object_type, opts = {})
           archive_with_http_info(object_type, opts)
@@ -33,8 +34,9 @@ module Hubspot
 
         # Delete a schema
         # Deletes a schema. Any existing records of this schema must be deleted **first**. Otherwise this call will fail.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param [Hash] opts the optional parameters
+        # @option opts [Boolean] :archived Whether to return only results that have been archived.
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
         def archive_with_http_info(object_type, opts = {})
           if @api_client.config.debugging
@@ -49,6 +51,7 @@ 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] || {}
@@ -85,7 +88,7 @@ module Hubspot
 
         # Remove an association
         # Removes an existing association from a schema.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param association_identifier [String] Unique ID of the association to remove.
         # @param [Hash] opts the optional parameters
         # @return [nil]
@@ -96,7 +99,7 @@ module Hubspot
 
         # Remove an association
         # Removes an existing association from a schema.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param association_identifier [String] Unique ID of the association to remove.
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -217,7 +220,7 @@ module Hubspot
 
         # Create an association
         # Defines a new association between the primary schema's object type and other object types.
-        # @param object_type [String] Fully qualified name or object type ID for the primary schema to associate.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param association_definition_egg [AssociationDefinitionEgg] Attributes that define the association.
         # @param [Hash] opts the optional parameters
         # @return [AssociationDefinition]
@@ -228,7 +231,7 @@ module Hubspot
 
         # Create an association
         # Defines a new association between the primary schema&#39;s object type and other object types.
-        # @param object_type [String] Fully qualified name or object type ID for the primary schema to associate.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param association_definition_egg [AssociationDefinitionEgg] Attributes that define the association.
         # @param [Hash] opts the optional parameters
         # @return [Array<(AssociationDefinition, Integer, Hash)>] AssociationDefinition data, response status code and response headers
@@ -286,18 +289,20 @@ module Hubspot
         end
 
         # Get all schemas
-        # Returns all object schemas that have been defined for the target account.
+        # Returns all object schemas that have been defined for your account.
         # @param [Hash] opts the optional parameters
-        # @return [CollectionResponseObjectSchema]
+        # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
+        # @return [CollectionResponseObjectSchemaNoPaging]
         def get_all(opts = {})
           data, _status_code, _headers = get_all_with_http_info(opts)
           data
         end
 
         # Get all schemas
-        # Returns all object schemas that have been defined for the target account.
+        # Returns all object schemas that have been defined for your account.
         # @param [Hash] opts the optional parameters
-        # @return [Array<(CollectionResponseObjectSchema, Integer, Hash)>] CollectionResponseObjectSchema data, response status code and response headers
+        # @option opts [Boolean] :archived Whether to return only results that have been archived.
+        # @return [Array<(CollectionResponseObjectSchemaNoPaging, Integer, Hash)>] CollectionResponseObjectSchemaNoPaging data, response status code and response headers
         def get_all_with_http_info(opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: CoreApi.get_all ...'
@@ -307,6 +312,7 @@ 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] || {}
@@ -320,7 +326,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseObjectSchema' 
+          return_type = opts[:return_type] || 'CollectionResponseObjectSchemaNoPaging' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -343,7 +349,7 @@ module Hubspot
 
         # Get an existing schema
         # Returns an existing object schema.
-        # @param object_type [String] Fully qualified name or object type ID of the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param [Hash] opts the optional parameters
         # @return [ObjectSchema]
         def get_by_id(object_type, opts = {})
@@ -353,7 +359,7 @@ module Hubspot
 
         # Get an existing schema
         # Returns an existing object schema.
-        # @param object_type [String] Fully qualified name or object type ID of the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
         # @param [Hash] opts the optional parameters
         # @return [Array<(ObjectSchema, Integer, Hash)>] ObjectSchema data, response status code and response headers
         def get_by_id_with_http_info(object_type, opts = {})
@@ -405,8 +411,8 @@ module Hubspot
 
         # Update a schema
         # Update the details for an existing object schema.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
-        # @param object_type_definition_patch [ObjectTypeDefinitionPatch] Attributes to update in the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
+        # @param object_type_definition_patch [ObjectTypeDefinitionPatch] Attributes to update in your schema.
         # @param [Hash] opts the optional parameters
         # @return [ObjectTypeDefinition]
         def update(object_type, object_type_definition_patch, opts = {})
@@ -416,8 +422,8 @@ module Hubspot
 
         # Update a schema
         # Update the details for an existing object schema.
-        # @param object_type [String] Fully qualified name or object type ID for the target schema.
-        # @param object_type_definition_patch [ObjectTypeDefinitionPatch] Attributes to update in the target schema.
+        # @param object_type [String] Fully qualified name or object type ID of your schema.
+        # @param object_type_definition_patch [ObjectTypeDefinitionPatch] Attributes to update in your schema.
         # @param [Hash] opts the optional parameters
         # @return [Array<(ObjectTypeDefinition, Integer, Hash)>] ObjectTypeDefinition data, response status code and response headers
         def update_with_http_info(object_type, object_type_definition_patch, opts = {})

data/lib/hubspot/codegen/crm/schemas/api_client.rb

@@ -56,6 +56,20 @@ module Hubspot
           end
 
           unless response.success?
+            if 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
+
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0

data/lib/hubspot/codegen/crm/schemas/models/association_definition.rb

@@ -25,10 +25,6 @@ module Hubspot
         # A unique name for this association.
         attr_accessor :name
 
-        attr_accessor :cardinality
-
-        attr_accessor :inverse_cardinality
-
         # A unique ID for this association.
         attr_accessor :id
 
@@ -38,36 +34,12 @@ module Hubspot
         # When the association was last updated.
         attr_accessor :updated_at
 
-        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
           {
             :'from_object_type_id' => :'fromObjectTypeId',
             :'to_object_type_id' => :'toObjectTypeId',
             :'name' => :'name',
-            :'cardinality' => :'cardinality',
-            :'inverse_cardinality' => :'inverseCardinality',
             :'id' => :'id',
             :'created_at' => :'createdAt',
             :'updated_at' => :'updatedAt'
@@ -80,8 +52,6 @@ module Hubspot
             :'from_object_type_id' => :'String',
             :'to_object_type_id' => :'String',
             :'name' => :'String',
-            :'cardinality' => :'String',
-            :'inverse_cardinality' => :'String',
             :'id' => :'String',
             :'created_at' => :'DateTime',
             :'updated_at' => :'DateTime'
@@ -121,14 +91,6 @@ module Hubspot
             self.name = attributes[:'name']
           end
 
-          if attributes.key?(:'cardinality')
-            self.cardinality = attributes[:'cardinality']
-          end
-
-          if attributes.key?(:'inverse_cardinality')
-            self.inverse_cardinality = attributes[:'inverse_cardinality']
-          end
-
           if attributes.key?(:'id')
             self.id = attributes[:'id']
           end
@@ -154,14 +116,6 @@ module Hubspot
             invalid_properties.push('invalid value for "to_object_type_id", to_object_type_id cannot be nil.')
           end
 
-          if @cardinality.nil?
-            invalid_properties.push('invalid value for "cardinality", cardinality cannot be nil.')
-          end
-
-          if @inverse_cardinality.nil?
-            invalid_properties.push('invalid value for "inverse_cardinality", inverse_cardinality cannot be nil.')
-          end
-
           if @id.nil?
             invalid_properties.push('invalid value for "id", id cannot be nil.')
           end
@@ -174,36 +128,10 @@ module Hubspot
         def valid?
           return false if @from_object_type_id.nil?
           return false if @to_object_type_id.nil?
-          return false if @cardinality.nil?
-          cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          return false unless cardinality_validator.valid?(@cardinality)
-          return false if @inverse_cardinality.nil?
-          inverse_cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          return false unless inverse_cardinality_validator.valid?(@inverse_cardinality)
           return false if @id.nil?
           true
         end
 
-        # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] cardinality Object to be assigned
-        def cardinality=(cardinality)
-          validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          unless validator.valid?(cardinality)
-            fail ArgumentError, "invalid value for \"cardinality\", must be one of #{validator.allowable_values}."
-          end
-          @cardinality = cardinality
-        end
-
-        # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] inverse_cardinality Object to be assigned
-        def inverse_cardinality=(inverse_cardinality)
-          validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          unless validator.valid?(inverse_cardinality)
-            fail ArgumentError, "invalid value for \"inverse_cardinality\", must be one of #{validator.allowable_values}."
-          end
-          @inverse_cardinality = inverse_cardinality
-        end
-
         # Checks equality by comparing each attribute.
         # @param [Object] Object to be compared
         def ==(o)
@@ -212,8 +140,6 @@ module Hubspot
               from_object_type_id == o.from_object_type_id &&
               to_object_type_id == o.to_object_type_id &&
               name == o.name &&
-              cardinality == o.cardinality &&
-              inverse_cardinality == o.inverse_cardinality &&
               id == o.id &&
               created_at == o.created_at &&
               updated_at == o.updated_at
@@ -228,7 +154,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [from_object_type_id, to_object_type_id, name, cardinality, inverse_cardinality, id, created_at, updated_at].hash
+          [from_object_type_id, to_object_type_id, name, id, created_at, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/schemas/models/association_definition_egg.rb

@@ -25,40 +25,12 @@ module Hubspot
         # A unique name for this association.
         attr_accessor :name
 
-        attr_accessor :cardinality
-
-        attr_accessor :inverse_cardinality
-
-        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
           {
             :'from_object_type_id' => :'fromObjectTypeId',
             :'to_object_type_id' => :'toObjectTypeId',
-            :'name' => :'name',
-            :'cardinality' => :'cardinality',
-            :'inverse_cardinality' => :'inverseCardinality'
+            :'name' => :'name'
           }
         end
 
@@ -67,9 +39,7 @@ module Hubspot
           {
             :'from_object_type_id' => :'String',
             :'to_object_type_id' => :'String',
-            :'name' => :'String',
-            :'cardinality' => :'String',
-            :'inverse_cardinality' => :'String'
+            :'name' => :'String'
           }
         end
 
@@ -105,14 +75,6 @@ module Hubspot
           if attributes.key?(:'name')
             self.name = attributes[:'name']
           end
-
-          if attributes.key?(:'cardinality')
-            self.cardinality = attributes[:'cardinality']
-          end
-
-          if attributes.key?(:'inverse_cardinality')
-            self.inverse_cardinality = attributes[:'inverse_cardinality']
-          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
@@ -127,14 +89,6 @@ module Hubspot
             invalid_properties.push('invalid value for "to_object_type_id", to_object_type_id cannot be nil.')
           end
 
-          if @cardinality.nil?
-            invalid_properties.push('invalid value for "cardinality", cardinality cannot be nil.')
-          end
-
-          if @inverse_cardinality.nil?
-            invalid_properties.push('invalid value for "inverse_cardinality", inverse_cardinality cannot be nil.')
-          end
-
           invalid_properties
         end
 
@@ -143,35 +97,9 @@ module Hubspot
         def valid?
           return false if @from_object_type_id.nil?
           return false if @to_object_type_id.nil?
-          return false if @cardinality.nil?
-          cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          return false unless cardinality_validator.valid?(@cardinality)
-          return false if @inverse_cardinality.nil?
-          inverse_cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          return false unless inverse_cardinality_validator.valid?(@inverse_cardinality)
           true
         end
 
-        # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] cardinality Object to be assigned
-        def cardinality=(cardinality)
-          validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          unless validator.valid?(cardinality)
-            fail ArgumentError, "invalid value for \"cardinality\", must be one of #{validator.allowable_values}."
-          end
-          @cardinality = cardinality
-        end
-
-        # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] inverse_cardinality Object to be assigned
-        def inverse_cardinality=(inverse_cardinality)
-          validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
-          unless validator.valid?(inverse_cardinality)
-            fail ArgumentError, "invalid value for \"inverse_cardinality\", must be one of #{validator.allowable_values}."
-          end
-          @inverse_cardinality = inverse_cardinality
-        end
-
         # Checks equality by comparing each attribute.
         # @param [Object] Object to be compared
         def ==(o)
@@ -179,9 +107,7 @@ module Hubspot
           self.class == o.class &&
               from_object_type_id == o.from_object_type_id &&
               to_object_type_id == o.to_object_type_id &&
-              name == o.name &&
-              cardinality == o.cardinality &&
-              inverse_cardinality == o.inverse_cardinality
+              name == o.name
         end
 
         # @see the `==` method
@@ -193,7 +119,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [from_object_type_id, to_object_type_id, name, cardinality, inverse_cardinality].hash
+          [from_object_type_id, to_object_type_id, name].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/schemas/models/{collection_response_object_schema.rb → collection_response_object_schema_no_paging.rb}

@@ -15,24 +15,20 @@ require 'date'
 module Hubspot
   module Crm
     module Schemas
-      class CollectionResponseObjectSchema
+      class CollectionResponseObjectSchemaNoPaging
         attr_accessor :results
 
-        attr_accessor :paging
-
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'results' => :'results',
-            :'paging' => :'paging'
+            :'results' => :'results'
           }
         end
 
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'results' => :'Array<ObjectSchema>',
-            :'paging' => :'Paging'
+            :'results' => :'Array<ObjectSchema>'
           }
         end
 
@@ -46,13 +42,13 @@ module Hubspot
         # @param [Hash] attributes Model attributes in the form of hash
         def initialize(attributes = {})
           if (!attributes.is_a?(Hash))
-            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Schemas::CollectionResponseObjectSchema` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Schemas::CollectionResponseObjectSchemaNoPaging` initialize method"
           end
 
           # check to see if the attribute exists and convert string to symbol for hash key
           attributes = attributes.each_with_object({}) { |(k, v), h|
             if (!self.class.attribute_map.key?(k.to_sym))
-              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Schemas::CollectionResponseObjectSchema`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Schemas::CollectionResponseObjectSchemaNoPaging`. 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
           }
@@ -62,10 +58,6 @@ module Hubspot
               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?
@@ -91,8 +83,7 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              results == o.results &&
-              paging == o.paging
+              results == o.results
         end
 
         # @see the `==` method
@@ -104,7 +95,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [results, paging].hash
+          [results].hash
         end
 
         # Builds the object from hash