hubspot-api-client 2.0.0 → 2.1.0

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

@@ -0,0 +1,264 @@
+=begin
+#Webhooks API
+
+#Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.
+
+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 Webhooks
+    # Configuration details for webhook throttling.
+    class ThrottlingSettings
+      # The maximum number of HTTP requests HubSpot will attempt to make to your app in a given time frame determined by `period`.
+      attr_accessor :max_concurrent_requests
+
+      # Time scale for this setting. Can be either `SECONDLY` (per second) or `ROLLING_MINUTE` (per minute).
+      attr_accessor :period
+
+      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
+        {
+          :'max_concurrent_requests' => :'maxConcurrentRequests',
+          :'period' => :'period'
+        }
+      end
+
+      # Attribute type mapping.
+      def self.openapi_types
+        {
+          :'max_concurrent_requests' => :'Integer',
+          :'period' => :'String'
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+        ])
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Webhooks::ThrottlingSettings` 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::Webhooks::ThrottlingSettings`. 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?(:'max_concurrent_requests')
+          self.max_concurrent_requests = attributes[:'max_concurrent_requests']
+        end
+
+        if attributes.key?(:'period')
+          self.period = attributes[:'period']
+        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 @max_concurrent_requests.nil?
+          invalid_properties.push('invalid value for "max_concurrent_requests", max_concurrent_requests cannot be nil.')
+        end
+
+        if @period.nil?
+          invalid_properties.push('invalid value for "period", period 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 @max_concurrent_requests.nil?
+        return false if @period.nil?
+        period_validator = EnumAttributeValidator.new('String', ["SECONDLY", "ROLLING_MINUTE"])
+        return false unless period_validator.valid?(@period)
+        true
+      end
+
+      # Custom attribute writer method checking allowed values (enum).
+      # @param [Object] period Object to be assigned
+      def period=(period)
+        validator = EnumAttributeValidator.new('String', ["SECONDLY", "ROLLING_MINUTE"])
+        unless validator.valid?(period)
+          fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}."
+        end
+        @period = period
+      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 &&
+            max_concurrent_requests == o.max_concurrent_requests &&
+            period == o.period
+      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
+        [max_concurrent_requests, period].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::Webhooks.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

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
  module Hubspot
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
  end

data/sample-apps/companies-app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (2.0.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)
 
@@ -84,7 +84,7 @@ GEM
       railties (>= 3.2, < 6.1)
     erubi (1.9.0)
     execjs (2.7.0)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     geckodriver-helper (0.24.0)

data/sample-apps/companies-app/app/lib/services/authorization/tokens/generate.rb

@@ -8,8 +8,8 @@ module Services
         end
 
         def call
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :authorization_code,
             code: @code,
             redirect_uri: redirect_uri,

data/sample-apps/companies-app/app/lib/services/authorization/tokens/refresh.rb

@@ -15,8 +15,8 @@ module Services
         private
 
         def refresh_tokens
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :refresh_token,
             refresh_token: @tokens[:refresh_token],
             redirect_uri: redirect_uri,

data/sample-apps/companies-app/app/lib/services/hubspot/associations/create.rb

@@ -11,7 +11,7 @@ module Services
           ::Hubspot::Crm::Associations::BatchApi.new.create_batch(
             'companies',
             'contacts',
-            body: association,
+            batch_input_public_association: association,
             auth_names: 'oauth2'
           )
         end
@@ -28,7 +28,8 @@ module Services
           @contacts_ids.map do |id|
             ::Hubspot::Crm::Associations::PublicAssociation.new(
               from: ::Hubspot::Crm::Associations::PublicObjectId.new(id: @company_id),
-              to: ::Hubspot::Crm::Associations::PublicObjectId.new(id: id)
+              to: ::Hubspot::Crm::Associations::PublicObjectId.new(id: id),
+              type: 'company_to_contact'
             )
           end
         end

data/sample-apps/companies-app/app/lib/services/hubspot/associations/delete.rb

@@ -11,7 +11,7 @@ module Services
           ::Hubspot::Crm::Associations::BatchApi.new.archive_batch(
             'companies',
             'contacts',
-            body: association,
+            batch_input_public_association: association,
             auth_names: 'oauth2'
           )
         end
@@ -28,7 +28,8 @@ module Services
           @contacts_ids.map do |id|
             ::Hubspot::Crm::Associations::PublicAssociation.new(
               from: ::Hubspot::Crm::Associations::PublicObjectId.new(id: @company_id),
-              to: ::Hubspot::Crm::Associations::PublicObjectId.new(id: id)
+              to: ::Hubspot::Crm::Associations::PublicObjectId.new(id: id),
+              type: 'company_to_contact'
             )
           end
         end

data/sample-apps/contacts-app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (2.0.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)
 
@@ -84,7 +84,7 @@ GEM
       railties (>= 3.2, < 6.1)
     erubi (1.9.0)
     execjs (2.7.0)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     geckodriver-helper (0.24.0)

data/sample-apps/contacts-app/app/lib/services/authorization/tokens/generate.rb

@@ -8,8 +8,8 @@ module Services
         end
 
         def call
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :authorization_code,
             code: @code,
             redirect_uri: redirect_uri,

data/sample-apps/contacts-app/app/lib/services/authorization/tokens/refresh.rb

@@ -15,8 +15,8 @@ module Services
         private
 
         def refresh_tokens
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :refresh_token,
             refresh_token: @tokens[:refresh_token],
             redirect_uri: redirect_uri,

data/sample-apps/contacts-app/app/lib/services/hubspot/contacts/create.rb

@@ -14,7 +14,7 @@ module Services
         private
 
         def contact_input
-          @contact_input ||= ::Hubspot::Crm::Objects::SimplePublicObjectInput.new(properties: @properties)
+          @contact_input ||= ::Hubspot::Crm::Contacts::SimplePublicObjectInput.new(properties: @properties)
         end
       end
     end

data/sample-apps/contacts-app/app/lib/services/hubspot/contacts/update.rb

@@ -16,7 +16,7 @@ module Services
         private
 
         def contact_input
-          @contact_input ||= ::Hubspot::Crm::Objects::SimplePublicObjectInput.new(properties: @properties)
+          @contact_input ||= ::Hubspot::Crm::Contacts::SimplePublicObjectInput.new(properties: @properties)
         end
       end
     end

data/sample-apps/contacts-app/app/views/contacts/show.html.erb

@@ -11,6 +11,7 @@
       <h3>Properties</h3>
       <%= form_for :contact, url: "/contacts/#{params[:id]}", method: 'put' do |form| %>
         <% @contact.properties.each do |property_key, property_value| %>
+          <% next if @properties.find { |p| p.name == property_key }.modification_metadata.read_only_value %>
           <%= label(:contact, property_key, @properties.find { |p| p.name == property_key }.label) %>
           <% if property_key == 'hubspot_owner_id' %>
             <%= select(

data/sample-apps/leaky-bucket-app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (2.0.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)
 
@@ -85,7 +85,7 @@ GEM
       railties (>= 3.2, < 6.1)
     erubi (1.9.0)
     execjs (2.7.0)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     geckodriver-helper (0.24.0)

data/sample-apps/leaky-bucket-app/app/lib/services/authorization/tokens/generate.rb

@@ -8,8 +8,8 @@ module Services
         end
 
         def call
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :authorization_code,
             code: @code,
             redirect_uri: redirect_uri,