hubspot-api-client 6.0.0 → 7.3.0

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

@@ -0,0 +1,252 @@
+=begin
+#Schemas
+
+#The CRM uses schemas to define how custom objects should store and represent information in the HubSpot CRM. Schemas define details about an object's type, properties, and associations. The schema can be uniquely identified by its **object type ID**.
+
+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 Crm
+    module Schemas
+      class PropertyModificationMetadata
+        attr_accessor :archivable
+
+        attr_accessor :read_only_definition
+
+        attr_accessor :read_only_options
+
+        attr_accessor :read_only_value
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'archivable' => :'archivable',
+            :'read_only_definition' => :'readOnlyDefinition',
+            :'read_only_options' => :'readOnlyOptions',
+            :'read_only_value' => :'readOnlyValue'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'archivable' => :'Boolean',
+            :'read_only_definition' => :'Boolean',
+            :'read_only_options' => :'Boolean',
+            :'read_only_value' => :'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::Crm::Schemas::PropertyModificationMetadata` 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::PropertyModificationMetadata`. 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?(:'archivable')
+            self.archivable = attributes[:'archivable']
+          end
+
+          if attributes.key?(:'read_only_definition')
+            self.read_only_definition = attributes[:'read_only_definition']
+          end
+
+          if attributes.key?(:'read_only_options')
+            self.read_only_options = attributes[:'read_only_options']
+          end
+
+          if attributes.key?(:'read_only_value')
+            self.read_only_value = attributes[:'read_only_value']
+          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 @archivable.nil?
+            invalid_properties.push('invalid value for "archivable", archivable cannot be nil.')
+          end
+
+          if @read_only_definition.nil?
+            invalid_properties.push('invalid value for "read_only_definition", read_only_definition cannot be nil.')
+          end
+
+          if @read_only_value.nil?
+            invalid_properties.push('invalid value for "read_only_value", read_only_value 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 @archivable.nil?
+          return false if @read_only_definition.nil?
+          return false if @read_only_value.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 &&
+              archivable == o.archivable &&
+              read_only_definition == o.read_only_definition &&
+              read_only_options == o.read_only_options &&
+              read_only_value == o.read_only_value
+        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
+          [archivable, read_only_definition, read_only_options, read_only_value].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::Crm::Schemas.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/tickets/configuration.rb

@@ -194,13 +194,6 @@ module Hubspot
         # Returns Auth Settings hash for api client.
         def auth_settings
           {
-            'developer-hapikey' =>
-              {
-                type: 'api_key',
-                in: 'query',
-                key: 'hapikey',
-                value: api_key_with_prefix('hapikey')
-              },
             'hapikey' =>
               {
                 type: 'api_key',

data/lib/hubspot/codegen/crm/timeline/configuration.rb

@@ -194,13 +194,6 @@ module Hubspot
         # Returns Auth Settings hash for api client.
         def auth_settings
           {
-            'developer-hapikey' =>
-              {
-                type: 'api_key',
-                in: 'query',
-                key: 'hapikey',
-                value: api_key_with_prefix('hapikey')
-              },
             'hapikey' =>
               {
                 type: 'api_key',

data/lib/hubspot/codegen/oauth/configuration.rb

@@ -193,27 +193,6 @@ module Hubspot
       # Returns Auth Settings hash for api client.
       def auth_settings
         {
-          'developer-hapikey' =>
-            {
-              type: 'api_key',
-              in: 'query',
-              key: 'hapikey',
-              value: api_key_with_prefix('hapikey')
-            },
-          'hapikey' =>
-            {
-              type: 'api_key',
-              in: 'query',
-              key: 'hapikey',
-              value: api_key_with_prefix('hapikey')
-            },
-          'oauth2' =>
-            {
-              type: 'oauth2',
-              in: 'header',
-              key: 'Authorization',
-              value: "Bearer #{access_token}"
-            },
         }
       end
 

data/lib/hubspot/codegen/webhooks/api/subscriptions_api.rb

@@ -292,11 +292,11 @@ module Hubspot
       # Updates the details for an existing subscription.
       # @param subscription_id [Integer] The ID of the subscription to update.
       # @param app_id [Integer] The ID of the target app.
+      # @param subscription_patch_request [SubscriptionPatchRequest] Updated details for the subscription.
       # @param [Hash] opts the optional parameters
-      # @option opts [SubscriptionPatchRequest] :subscription_patch_request Updated details for the subscription.
       # @return [SubscriptionResponse]
-      def update(subscription_id, app_id, opts = {})
-        data, _status_code, _headers = update_with_http_info(subscription_id, app_id, opts)
+      def update(subscription_id, app_id, subscription_patch_request, opts = {})
+        data, _status_code, _headers = update_with_http_info(subscription_id, app_id, subscription_patch_request, opts)
         data
       end
 
@@ -304,10 +304,10 @@ module Hubspot
       # Updates the details for an existing subscription.
       # @param subscription_id [Integer] The ID of the subscription to update.
       # @param app_id [Integer] The ID of the target app.
+      # @param subscription_patch_request [SubscriptionPatchRequest] Updated details for the subscription.
       # @param [Hash] opts the optional parameters
-      # @option opts [SubscriptionPatchRequest] :subscription_patch_request Updated details for the subscription.
       # @return [Array<(SubscriptionResponse, Integer, Hash)>] SubscriptionResponse data, response status code and response headers
-      def update_with_http_info(subscription_id, app_id, opts = {})
+      def update_with_http_info(subscription_id, app_id, subscription_patch_request, opts = {})
         if @api_client.config.debugging
           @api_client.config.logger.debug 'Calling API: SubscriptionsApi.update ...'
         end
@@ -319,6 +319,10 @@ module Hubspot
         if @api_client.config.client_side_validation && app_id.nil?
           fail ArgumentError, "Missing the required parameter 'app_id' when calling SubscriptionsApi.update"
         end
+        # verify the required parameter 'subscription_patch_request' is set
+        if @api_client.config.client_side_validation && subscription_patch_request.nil?
+          fail ArgumentError, "Missing the required parameter 'subscription_patch_request' when calling SubscriptionsApi.update"
+        end
         # resource path
         local_var_path = '/webhooks/v3/{appId}/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', CGI.escape(subscription_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
 
@@ -336,7 +340,7 @@ module Hubspot
         form_params = opts[:form_params] || {}
 
         # http body (model)
-        post_body = opts[:body] || @api_client.object_to_http_body(opts[:'subscription_patch_request']) 
+        post_body = opts[:body] || @api_client.object_to_http_body(subscription_patch_request) 
 
         # return_type
         return_type = opts[:return_type] || 'SubscriptionResponse' 
@@ -361,9 +365,9 @@ module Hubspot
       end
 
       # Batch update subscriptions
-      # Activates or deactivates specified subscriptions for the given app.
-      # @param app_id [Integer] The ID of the target app.
-      # @param batch_input_subscription_batch_update_request [BatchInputSubscriptionBatchUpdateRequest] Collection of updated details for the specified subscription.
+      # Activates or deactivates target app subscriptions.
+      # @param app_id [Integer] The app ID of the target app.
+      # @param batch_input_subscription_batch_update_request [BatchInputSubscriptionBatchUpdateRequest] Updated details for the specified subscriptions.
       # @param [Hash] opts the optional parameters
       # @return [BatchResponseSubscriptionResponse]
       def update_batch(app_id, batch_input_subscription_batch_update_request, opts = {})
@@ -372,9 +376,9 @@ module Hubspot
       end
 
       # Batch update subscriptions
-      # Activates or deactivates specified subscriptions for the given app.
-      # @param app_id [Integer] The ID of the target app.
-      # @param batch_input_subscription_batch_update_request [BatchInputSubscriptionBatchUpdateRequest] Collection of updated details for the specified subscription.
+      # Activates or deactivates target app subscriptions.
+      # @param app_id [Integer] The app ID of the target app.
+      # @param batch_input_subscription_batch_update_request [BatchInputSubscriptionBatchUpdateRequest] Updated details for the specified subscriptions.
       # @param [Hash] opts the optional parameters
       # @return [Array<(BatchResponseSubscriptionResponse, Integer, Hash)>] BatchResponseSubscriptionResponse data, response status code and response headers
       def update_batch_with_http_info(app_id, batch_input_subscription_batch_update_request, opts = {})

data/lib/hubspot/codegen/webhooks/configuration.rb

@@ -193,13 +193,6 @@ module Hubspot
       # Returns Auth Settings hash for api client.
       def auth_settings
         {
-          'developer-hapikey' =>
-            {
-              type: 'api_key',
-              in: 'query',
-              key: 'hapikey',
-              value: api_key_with_prefix('hapikey')
-            },
           'hapikey' =>
             {
               type: 'api_key',
@@ -207,13 +200,6 @@ module Hubspot
               key: 'hapikey',
               value: api_key_with_prefix('hapikey')
             },
-          'oauth2' =>
-            {
-              type: 'oauth2',
-              in: 'header',
-              key: 'Authorization',
-              value: "Bearer #{access_token}"
-            },
         }
       end
 

data/lib/hubspot/codegen/webhooks/models/batch_response_subscription_response.rb

@@ -19,10 +19,6 @@ module Hubspot
 
       attr_accessor :results
 
-      attr_accessor :num_errors
-
-      attr_accessor :errors
-
       attr_accessor :requested_at
 
       attr_accessor :started_at
@@ -58,8 +54,6 @@ module Hubspot
         {
           :'status' => :'status',
           :'results' => :'results',
-          :'num_errors' => :'numErrors',
-          :'errors' => :'errors',
           :'requested_at' => :'requestedAt',
           :'started_at' => :'startedAt',
           :'completed_at' => :'completedAt',
@@ -72,8 +66,6 @@ module Hubspot
         {
           :'status' => :'String',
           :'results' => :'Array<SubscriptionResponse>',
-          :'num_errors' => :'Integer',
-          :'errors' => :'Array<Error>',
           :'requested_at' => :'DateTime',
           :'started_at' => :'DateTime',
           :'completed_at' => :'DateTime',
@@ -112,16 +104,6 @@ module Hubspot
           end
         end
 
-        if attributes.key?(:'num_errors')
-          self.num_errors = attributes[:'num_errors']
-        end
-
-        if attributes.key?(:'errors')
-          if (value = attributes[:'errors']).is_a?(Array)
-            self.errors = value
-          end
-        end
-
         if attributes.key?(:'requested_at')
           self.requested_at = attributes[:'requested_at']
         end
@@ -193,8 +175,6 @@ module Hubspot
         self.class == o.class &&
             status == o.status &&
             results == o.results &&
-            num_errors == o.num_errors &&
-            errors == o.errors &&
             requested_at == o.requested_at &&
             started_at == o.started_at &&
             completed_at == o.completed_at &&
@@ -210,7 +190,7 @@ module Hubspot
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [status, results, num_errors, errors, requested_at, started_at, completed_at, links].hash
+        [status, results, requested_at, started_at, completed_at, links].hash
       end
 
       # Builds the object from hash