hubspot-api-client 20.0.0 → 20.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee0f134bcb5fd133a077e86f5853808a1401a19adca17a111851952cf7d73a7
-  data.tar.gz: 62674fd3da3da53040440e3d6e0d7a28405295c648e284aeb621b5fcd4dc7d33
+  metadata.gz: 1c4afe89bf606532f2b13cae4d69ca2e1f80df7ef1494fa2d0fefa353928f14e
+  data.tar.gz: 5a58910eb844420ff294be50a30756d7d028714fd70f1602039c1ef276ffc043
 SHA512:
-  metadata.gz: 718ff3c137d0dc5a3f6009a426d5da1b0925fb6124966ef6829e01c6114feeb2f4307e9211f8a6c97e5e0f17000605cd47da80de59ba42d93a04a8f387040c47
-  data.tar.gz: 1c58837bf3e12672c0c0f8413da6af61a737addcd18edb409331f3cfabcce824a89e8b444310ac51a7be54bbe51479918b2b098bb9dbb772b2d999a9cc3b3431
+  metadata.gz: 28cb9b7d21ae02bb022980366ffc1b3e756e7e29c7a07aef49e68a77e5a62d71faee97e9e3a8770a2286334586b002fa327fe15f23d04e56cfc8a2fa1b0464e5
+  data.tar.gz: 445e9caa575fdd847eb1fda8c63883936fc05e493fe0bd4493269be4a34b798d3d01987efb4e95135079ed77355377fcf9a52f5a6ec206a7a9e178f9c8d9d5fb

data/CHANGELOG.md

@@ -5,7 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v20.0.0...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v20.1.0...HEAD)
+
+## [20.1.0] - 2026-10-27
+
+## OAuth
+
+- Added OAuth v3 client, available as `oauth.v3`.
+- Added `oauth.v3.advanced_api` with methods `get_token()`, `introspect_token()` and `revoke_token()`.
+- Added models `AccessTokenResponse`, `ClientCredentialsTokenResponse`, `PublicAccessTokenInfoResponse`, `PublicRefreshTokenInfoResponse`, `SignedAccessToken`, `Error` and `ErrorDetail`.
+- Added polymorphic base models `TokenResponseIF` and `TokenInfoResponseBaseIF`, which deserialize to the matching token response type.
 
 ## [20.0.0] - 2025-05-08
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (20.0.0)
+    hubspot-api-client (20.1.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 

data/hubspot-api-client.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 2.7"
 
-  s.add_runtime_dependency 'typhoeus', '~> 1.4.0'
+  s.add_runtime_dependency 'typhoeus', '>= 1.4.0'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

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

@@ -0,0 +1,273 @@
+=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 'cgi'
+
+module Hubspot
+  module Oauth
+    module V3
+      class AdvancedApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # OAuth token endpoint
+        # Authenticates a client and returns access and refresh tokens.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :assertion 
+        # @option opts [String] :client_assertion 
+        # @option opts [String] :client_assertion_type 
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :code 
+        # @option opts [String] :code_verifier 
+        # @option opts [String] :grant_type 
+        # @option opts [String] :redirect_uri 
+        # @option opts [String] :refresh_token 
+        # @option opts [String] :scope 
+        # @return [TokenResponseIF]
+        def get_token(opts = {})
+          data, _status_code, _headers = get_token_with_http_info(opts)
+          data
+        end
+
+        # OAuth token endpoint
+        # Authenticates a client and returns access and refresh tokens.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :assertion 
+        # @option opts [String] :client_assertion 
+        # @option opts [String] :client_assertion_type 
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :code 
+        # @option opts [String] :code_verifier 
+        # @option opts [String] :grant_type 
+        # @option opts [String] :redirect_uri 
+        # @option opts [String] :refresh_token 
+        # @option opts [String] :scope 
+        # @return [Array<(TokenResponseIF, Integer, Hash)>] TokenResponseIF data, response status code and response headers
+        def get_token_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: AdvancedApi.get_token ...'
+          end
+          allowable_values = ["authorization_code", "client_credentials", "refresh_token", "urn:ietf:params:oauth:grant-type:jwt-bearer"]
+          if @api_client.config.client_side_validation && opts[:'grant_type'] && !allowable_values.include?(opts[:'grant_type'])
+            fail ArgumentError, "invalid value for \"grant_type\", must be one of #{allowable_values}"
+          end
+          # resource path
+          local_var_path = '/oauth/v3/token'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+          form_params['assertion'] = opts[:'assertion'] if !opts[:'assertion'].nil?
+          form_params['client_assertion'] = opts[:'client_assertion'] if !opts[:'client_assertion'].nil?
+          form_params['client_assertion_type'] = opts[:'client_assertion_type'] if !opts[:'client_assertion_type'].nil?
+          form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+          form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
+          form_params['code'] = opts[:'code'] if !opts[:'code'].nil?
+          form_params['code_verifier'] = opts[:'code_verifier'] if !opts[:'code_verifier'].nil?
+          form_params['grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
+          form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
+          form_params['refresh_token'] = opts[:'refresh_token'] if !opts[:'refresh_token'].nil?
+          form_params['scope'] = opts[:'scope'] if !opts[:'scope'].nil?
+
+          # http body (model)
+          post_body = opts[:debug_body]
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'TokenResponseIF'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || []
+
+          new_options = opts.merge(
+            :operation => :"AdvancedApi.get_token",
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: AdvancedApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Token introspection endpoint
+        # Returns validity and metadata for access and refresh tokens.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :token 
+        # @option opts [String] :token_type_hint 
+        # @return [TokenInfoResponseBaseIF]
+        def introspect_token(opts = {})
+          data, _status_code, _headers = introspect_token_with_http_info(opts)
+          data
+        end
+
+        # Token introspection endpoint
+        # Returns validity and metadata for access and refresh tokens.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :token 
+        # @option opts [String] :token_type_hint 
+        # @return [Array<(TokenInfoResponseBaseIF, Integer, Hash)>] TokenInfoResponseBaseIF data, response status code and response headers
+        def introspect_token_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: AdvancedApi.introspect_token ...'
+          end
+          # resource path
+          local_var_path = '/oauth/v3/token/introspect'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+          form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+          form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
+          form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
+          form_params['token_type_hint'] = opts[:'token_type_hint'] if !opts[:'token_type_hint'].nil?
+
+          # http body (model)
+          post_body = opts[:debug_body]
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'TokenInfoResponseBaseIF'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || []
+
+          new_options = opts.merge(
+            :operation => :"AdvancedApi.introspect_token",
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: AdvancedApi#introspect_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Token Revocation endpoint
+        # Deletes/Revokes provided Refresh Token
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :token 
+        # @option opts [String] :token_type_hint 
+        # @return [nil]
+        def revoke_token(opts = {})
+          revoke_token_with_http_info(opts)
+          nil
+        end
+
+        # Token Revocation endpoint
+        # Deletes/Revokes provided Refresh Token
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :client_id 
+        # @option opts [String] :client_secret 
+        # @option opts [String] :token 
+        # @option opts [String] :token_type_hint 
+        # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+        def revoke_token_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: AdvancedApi.revoke_token ...'
+          end
+          # resource path
+          local_var_path = '/oauth/v3/token/revoke'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+          form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+          form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
+          form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
+          form_params['token_type_hint'] = opts[:'token_type_hint'] if !opts[:'token_type_hint'].nil?
+
+          # http body (model)
+          post_body = opts[:debug_body]
+
+          # return_type
+          return_type = opts[:debug_return_type]
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || []
+
+          new_options = opts.merge(
+            :operation => :"AdvancedApi.revoke_token",
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: AdvancedApi#revoke_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end