hubspot-api-client 20.0.0 → 20.1.0

data/lib/hubspot/codegen/oauth/v3/models/signed_access_token.rb

@@ -0,0 +1,452 @@
+=begin
+#Auth Oauth
+
+#Basepom for all HubSpot Projects
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Oauth
+    module V3
+      class SignedAccessToken
+        attr_accessor :app_id
+
+        attr_accessor :app_install_id
+
+        attr_accessor :audience
+
+        attr_accessor :expires_at
+
+        attr_accessor :hub_id
+
+        attr_accessor :hublet
+
+        attr_accessor :installing_user_id
+
+        attr_accessor :is_private_distribution
+
+        attr_accessor :is_service_account
+
+        attr_accessor :is_user_level
+
+        attr_accessor :new_signature
+
+        attr_accessor :scope_to_scope_group_pks
+
+        attr_accessor :scopes
+
+        attr_accessor :signature
+
+        attr_accessor :trial_scope_to_scope_group_pks
+
+        attr_accessor :trial_scopes
+
+        attr_accessor :user_id
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'app_id' => :'appId',
+            :'app_install_id' => :'appInstallId',
+            :'audience' => :'audience',
+            :'expires_at' => :'expiresAt',
+            :'hub_id' => :'hubId',
+            :'hublet' => :'hublet',
+            :'installing_user_id' => :'installingUserId',
+            :'is_private_distribution' => :'isPrivateDistribution',
+            :'is_service_account' => :'isServiceAccount',
+            :'is_user_level' => :'isUserLevel',
+            :'new_signature' => :'newSignature',
+            :'scope_to_scope_group_pks' => :'scopeToScopeGroupPks',
+            :'scopes' => :'scopes',
+            :'signature' => :'signature',
+            :'trial_scope_to_scope_group_pks' => :'trialScopeToScopeGroupPks',
+            :'trial_scopes' => :'trialScopes',
+            :'user_id' => :'userId'
+          }
+        end
+
+        # Returns all the JSON keys this model knows about
+        def self.acceptable_attributes
+          attribute_map.values
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'app_id' => :'Integer',
+            :'app_install_id' => :'String',
+            :'audience' => :'String',
+            :'expires_at' => :'Integer',
+            :'hub_id' => :'Integer',
+            :'hublet' => :'String',
+            :'installing_user_id' => :'Integer',
+            :'is_private_distribution' => :'Boolean',
+            :'is_service_account' => :'Boolean',
+            :'is_user_level' => :'Boolean',
+            :'new_signature' => :'String',
+            :'scope_to_scope_group_pks' => :'String',
+            :'scopes' => :'String',
+            :'signature' => :'String',
+            :'trial_scope_to_scope_group_pks' => :'String',
+            :'trial_scopes' => :'String',
+            :'user_id' => :'Integer'
+          }
+        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::Oauth::V3::SignedAccessToken` 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::Oauth::V3::SignedAccessToken`. 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?(:'app_id')
+            self.app_id = attributes[:'app_id']
+          end
+
+          if attributes.key?(:'app_install_id')
+            self.app_install_id = attributes[:'app_install_id']
+          end
+
+          if attributes.key?(:'audience')
+            self.audience = attributes[:'audience']
+          end
+
+          if attributes.key?(:'expires_at')
+            self.expires_at = attributes[:'expires_at']
+          end
+
+          if attributes.key?(:'hub_id')
+            self.hub_id = attributes[:'hub_id']
+          end
+
+          if attributes.key?(:'hublet')
+            self.hublet = attributes[:'hublet']
+          end
+
+          if attributes.key?(:'installing_user_id')
+            self.installing_user_id = attributes[:'installing_user_id']
+          end
+
+          if attributes.key?(:'is_private_distribution')
+            self.is_private_distribution = attributes[:'is_private_distribution']
+          end
+
+          if attributes.key?(:'is_service_account')
+            self.is_service_account = attributes[:'is_service_account']
+          end
+
+          if attributes.key?(:'is_user_level')
+            self.is_user_level = attributes[:'is_user_level']
+          end
+
+          if attributes.key?(:'new_signature')
+            self.new_signature = attributes[:'new_signature']
+          end
+
+          if attributes.key?(:'scope_to_scope_group_pks')
+            self.scope_to_scope_group_pks = attributes[:'scope_to_scope_group_pks']
+          end
+
+          if attributes.key?(:'scopes')
+            self.scopes = attributes[:'scopes']
+          end
+
+          if attributes.key?(:'signature')
+            self.signature = attributes[:'signature']
+          end
+
+          if attributes.key?(:'trial_scope_to_scope_group_pks')
+            self.trial_scope_to_scope_group_pks = attributes[:'trial_scope_to_scope_group_pks']
+          end
+
+          if attributes.key?(:'trial_scopes')
+            self.trial_scopes = attributes[:'trial_scopes']
+          end
+
+          if attributes.key?(:'user_id')
+            self.user_id = attributes[:'user_id']
+          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 @app_id.nil?
+            invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
+          end
+
+          if @app_install_id.nil?
+            invalid_properties.push('invalid value for "app_install_id", app_install_id cannot be nil.')
+          end
+
+          if @audience.nil?
+            invalid_properties.push('invalid value for "audience", audience cannot be nil.')
+          end
+
+          if @expires_at.nil?
+            invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
+          end
+
+          if @hub_id.nil?
+            invalid_properties.push('invalid value for "hub_id", hub_id cannot be nil.')
+          end
+
+          if @hublet.nil?
+            invalid_properties.push('invalid value for "hublet", hublet cannot be nil.')
+          end
+
+          if @installing_user_id.nil?
+            invalid_properties.push('invalid value for "installing_user_id", installing_user_id cannot be nil.')
+          end
+
+          if @is_private_distribution.nil?
+            invalid_properties.push('invalid value for "is_private_distribution", is_private_distribution cannot be nil.')
+          end
+
+          if @is_service_account.nil?
+            invalid_properties.push('invalid value for "is_service_account", is_service_account cannot be nil.')
+          end
+
+          if @is_user_level.nil?
+            invalid_properties.push('invalid value for "is_user_level", is_user_level cannot be nil.')
+          end
+
+          if @new_signature.nil?
+            invalid_properties.push('invalid value for "new_signature", new_signature cannot be nil.')
+          end
+
+          if @scope_to_scope_group_pks.nil?
+            invalid_properties.push('invalid value for "scope_to_scope_group_pks", scope_to_scope_group_pks cannot be nil.')
+          end
+
+          if @scopes.nil?
+            invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+          end
+
+          if @signature.nil?
+            invalid_properties.push('invalid value for "signature", signature cannot be nil.')
+          end
+
+          if @trial_scope_to_scope_group_pks.nil?
+            invalid_properties.push('invalid value for "trial_scope_to_scope_group_pks", trial_scope_to_scope_group_pks cannot be nil.')
+          end
+
+          if @trial_scopes.nil?
+            invalid_properties.push('invalid value for "trial_scopes", trial_scopes cannot be nil.')
+          end
+
+          if @user_id.nil?
+            invalid_properties.push('invalid value for "user_id", user_id 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 @app_id.nil?
+          return false if @app_install_id.nil?
+          return false if @audience.nil?
+          return false if @expires_at.nil?
+          return false if @hub_id.nil?
+          return false if @hublet.nil?
+          return false if @installing_user_id.nil?
+          return false if @is_private_distribution.nil?
+          return false if @is_service_account.nil?
+          return false if @is_user_level.nil?
+          return false if @new_signature.nil?
+          return false if @scope_to_scope_group_pks.nil?
+          return false if @scopes.nil?
+          return false if @signature.nil?
+          return false if @trial_scope_to_scope_group_pks.nil?
+          return false if @trial_scopes.nil?
+          return false if @user_id.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 &&
+              app_id == o.app_id &&
+              app_install_id == o.app_install_id &&
+              audience == o.audience &&
+              expires_at == o.expires_at &&
+              hub_id == o.hub_id &&
+              hublet == o.hublet &&
+              installing_user_id == o.installing_user_id &&
+              is_private_distribution == o.is_private_distribution &&
+              is_service_account == o.is_service_account &&
+              is_user_level == o.is_user_level &&
+              new_signature == o.new_signature &&
+              scope_to_scope_group_pks == o.scope_to_scope_group_pks &&
+              scopes == o.scopes &&
+              signature == o.signature &&
+              trial_scope_to_scope_group_pks == o.trial_scope_to_scope_group_pks &&
+              trial_scopes == o.trial_scopes &&
+              user_id == o.user_id
+        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
+          [app_id, app_install_id, audience, expires_at, hub_id, hublet, installing_user_id, is_private_distribution, is_service_account, is_user_level, new_signature, scope_to_scope_group_pks, scopes, signature, trial_scope_to_scope_group_pks, trial_scopes, user_id].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)
+          attributes = attributes.transform_keys(&:to_sym)
+          self.class.openapi_types.each_pair do |key, type|
+            if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+              self.send("#{key}=", nil)
+            elsif 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
+          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 :Time
+            Time.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
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Oauth::V3.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/oauth/v3/models/token_info_response_base_if.rb

@@ -0,0 +1,59 @@
+=begin
+#Auth Oauth
+
+#Basepom for all HubSpot Projects
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Oauth
+    module V3
+      module TokenInfoResponseBaseIF
+        class << self
+          # List of class defined in oneOf (OpenAPI v3)
+          def openapi_one_of
+            [
+              :'PublicAccessTokenInfoResponse',
+              :'PublicRefreshTokenInfoResponse'
+            ]
+          end
+
+          # Discriminator's property name (OpenAPI v3)
+          def openapi_discriminator_name
+            :'token_use'
+          end
+
+          # Discriminator's mapping (OpenAPI v3)
+          def openapi_discriminator_mapping
+            {
+              :'access_token' => :'PublicAccessTokenInfoResponse',
+              :'refresh_token' => :'PublicRefreshTokenInfoResponse'
+            }
+          end
+
+          # Builds the object
+          # @param [Mixed] Data to be matched against the list of oneOf items
+          # @return [Object] Returns the model or the data itself
+          def build(data)
+            discriminator_value = data[openapi_discriminator_name]
+            return nil if discriminator_value.nil?
+
+            klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+            return nil unless klass
+
+            Hubspot::Oauth::V3.const_get(klass).build_from_hash(data)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/hubspot/codegen/oauth/v3/models/token_response_if.rb

@@ -0,0 +1,59 @@
+=begin
+#Auth Oauth
+
+#Basepom for all HubSpot Projects
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Oauth
+    module V3
+      module TokenResponseIF
+        class << self
+          # List of class defined in oneOf (OpenAPI v3)
+          def openapi_one_of
+            [
+              :'AccessTokenResponse',
+              :'ClientCredentialsTokenResponse'
+            ]
+          end
+
+          # Discriminator's property name (OpenAPI v3)
+          def openapi_discriminator_name
+            :'token_use'
+          end
+
+          # Discriminator's mapping (OpenAPI v3)
+          def openapi_discriminator_mapping
+            {
+              :'access_token' => :'AccessTokenResponse',
+              :'client_credentials' => :'ClientCredentialsTokenResponse'
+            }
+          end
+
+          # Builds the object
+          # @param [Mixed] Data to be matched against the list of oneOf items
+          # @return [Object] Returns the model or the data itself
+          def build(data)
+            discriminator_value = data[openapi_discriminator_name]
+            return nil if discriminator_value.nil?
+
+            klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+            return nil unless klass
+
+            Hubspot::Oauth::V3.const_get(klass).build_from_hash(data)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/hubspot/discovery/base_api_client.rb

@@ -55,7 +55,7 @@ module Hubspot
       end
 
       def require_api_models
-        def (Kernel.const_get(codegen_module_name)).const_get(const)
+        def (Kernel.const_get(codegen_module_name)).const_get(const, *)
           require 'hubspot/helpers/path'
           codegen_module_path = Hubspot::Helpers::Path.new.format(self.name).gsub('hubspot/', 'hubspot/codegen/')
           codegen_model = Hubspot::Helpers::Path.new.format(const)

data/lib/hubspot/discovery/oauth/client.rb

@@ -6,6 +6,12 @@ module Hubspot
       class Client
         include Hubspot::Discovery::BaseModuleClient
 
+        def api_modules
+          %i[
+            v3
+          ].freeze
+        end
+
         def api_classes
           %i[
             access_tokens

data/lib/hubspot/discovery/oauth/v3/api/advanced_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Oauth
+      module V3
+        class AdvancedApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/oauth/v3/client.rb

@@ -0,0 +1,19 @@
+require_relative '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Oauth
+      module V3
+        class Client
+          include Hubspot::Discovery::BaseModuleClient
+
+          def api_classes
+            %i[
+              advanced
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end