hubspot-api-client 20.0.0.pre.beta.1 → 20.1.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

data/lib/hubspot/codegen/{cms/performance → oauth/v3}/api_client.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#Auth Oauth
 
-#Use these endpoints to get a time series view of your website's performance.
+#Basepom for all HubSpot Projects
 
 The version of the OpenAPI document: v3
 
@@ -18,8 +18,8 @@ require 'time'
 require 'typhoeus'
 
 module Hubspot
-  module Cms
-    module Performance
+  module Oauth
+    module V3
       class ApiClient
         # The Configuration object holding settings to be used in the API client.
         attr_accessor :config
@@ -294,7 +294,7 @@ module Hubspot
             end
           else
             # models (e.g. Pet) or oneOf
-            klass = Hubspot::Cms::Performance.const_get(return_type)
+            klass = Hubspot::Oauth::V3.const_get(return_type)
             klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
           end
         end

data/lib/hubspot/codegen/{cms/performance → oauth/v3}/api_error.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#Auth Oauth
 
-#Use these endpoints to get a time series view of your website's performance.
+#Basepom for all HubSpot Projects
 
 The version of the OpenAPI document: v3
 
@@ -11,8 +11,8 @@ OpenAPI Generator version: 6.2.1
 =end
 
 module Hubspot
-  module Cms
-    module Performance
+  module Oauth
+    module V3
       class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 

data/lib/hubspot/codegen/{cms/performance → oauth/v3}/configuration.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#Auth Oauth
 
-#Use these endpoints to get a time series view of your website's performance.
+#Basepom for all HubSpot Projects
 
 The version of the OpenAPI document: v3
 
@@ -11,8 +11,8 @@ OpenAPI Generator version: 6.2.1
 =end
 
 module Hubspot
-  module Cms
-    module Performance
+  module Oauth
+    module V3
       class Configuration
         # Defines url scheme
         attr_accessor :scheme
@@ -222,6 +222,13 @@ 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('developer_hapikey')
+              },
             'oauth2' =>
               {
                 type: 'oauth2',

data/lib/hubspot/codegen/{cms/performance/models/public_performance_response.rb → oauth/v3/models/access_token_response.rb}

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#Auth Oauth
 
-#Use these endpoints to get a time series view of your website's performance.
+#Basepom for all HubSpot Projects
 
 The version of the OpenAPI document: v3
 
@@ -14,22 +14,26 @@ require 'date'
 require 'time'
 
 module Hubspot
-  module Cms
-    module Performance
-      class PublicPerformanceResponse
-        attr_accessor :path
+  module Oauth
+    module V3
+      class AccessTokenResponse
+        attr_accessor :access_token
 
-        attr_accessor :period
+        attr_accessor :expires_in
 
-        attr_accessor :start_interval
+        attr_accessor :hub_id
 
-        attr_accessor :data
+        attr_accessor :id_token
 
-        attr_accessor :domain
+        attr_accessor :refresh_token
 
-        attr_accessor :interval
+        attr_accessor :scopes
 
-        attr_accessor :end_interval
+        attr_accessor :token_type
+
+        attr_accessor :token_use
+
+        attr_accessor :user_id
 
         class EnumAttributeValidator
           attr_reader :datatype
@@ -56,13 +60,15 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'path' => :'path',
-            :'period' => :'period',
-            :'start_interval' => :'startInterval',
-            :'data' => :'data',
-            :'domain' => :'domain',
-            :'interval' => :'interval',
-            :'end_interval' => :'endInterval'
+            :'access_token' => :'access_token',
+            :'expires_in' => :'expires_in',
+            :'hub_id' => :'hub_id',
+            :'id_token' => :'id_token',
+            :'refresh_token' => :'refresh_token',
+            :'scopes' => :'scopes',
+            :'token_type' => :'token_type',
+            :'token_use' => :'token_use',
+            :'user_id' => :'user_id'
           }
         end
 
@@ -74,13 +80,15 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'path' => :'String',
-            :'period' => :'String',
-            :'start_interval' => :'Integer',
-            :'data' => :'Array<PerformanceView>',
-            :'domain' => :'String',
-            :'interval' => :'String',
-            :'end_interval' => :'Integer'
+            :'access_token' => :'String',
+            :'expires_in' => :'Integer',
+            :'hub_id' => :'Integer',
+            :'id_token' => :'String',
+            :'refresh_token' => :'String',
+            :'scopes' => :'Array<String>',
+            :'token_type' => :'String',
+            :'token_use' => :'String',
+            :'user_id' => :'Integer'
           }
         end
 
@@ -94,45 +102,55 @@ 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::Cms::Performance::PublicPerformanceResponse` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Oauth::V3::AccessTokenResponse` 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::Cms::Performance::PublicPerformanceResponse`. 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::Oauth::V3::AccessTokenResponse`. 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?(:'path')
-            self.path = attributes[:'path']
+          if attributes.key?(:'access_token')
+            self.access_token = attributes[:'access_token']
+          end
+
+          if attributes.key?(:'expires_in')
+            self.expires_in = attributes[:'expires_in']
           end
 
-          if attributes.key?(:'period')
-            self.period = attributes[:'period']
+          if attributes.key?(:'hub_id')
+            self.hub_id = attributes[:'hub_id']
           end
 
-          if attributes.key?(:'start_interval')
-            self.start_interval = attributes[:'start_interval']
+          if attributes.key?(:'id_token')
+            self.id_token = attributes[:'id_token']
           end
 
-          if attributes.key?(:'data')
-            if (value = attributes[:'data']).is_a?(Array)
-              self.data = value
+          if attributes.key?(:'refresh_token')
+            self.refresh_token = attributes[:'refresh_token']
+          end
+
+          if attributes.key?(:'scopes')
+            if (value = attributes[:'scopes']).is_a?(Array)
+              self.scopes = value
             end
           end
 
-          if attributes.key?(:'domain')
-            self.domain = attributes[:'domain']
+          if attributes.key?(:'token_type')
+            self.token_type = attributes[:'token_type']
           end
 
-          if attributes.key?(:'interval')
-            self.interval = attributes[:'interval']
+          if attributes.key?(:'token_use')
+            self.token_use = attributes[:'token_use']
+          else
+            self.token_use = 'access_token'
           end
 
-          if attributes.key?(:'end_interval')
-            self.end_interval = attributes[:'end_interval']
+          if attributes.key?(:'user_id')
+            self.user_id = attributes[:'user_id']
           end
         end
 
@@ -140,20 +158,24 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @start_interval.nil?
-            invalid_properties.push('invalid value for "start_interval", start_interval cannot be nil.')
+          if @access_token.nil?
+            invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
           end
 
-          if @data.nil?
-            invalid_properties.push('invalid value for "data", data cannot be nil.')
+          if @expires_in.nil?
+            invalid_properties.push('invalid value for "expires_in", expires_in cannot be nil.')
           end
 
-          if @interval.nil?
-            invalid_properties.push('invalid value for "interval", interval cannot be nil.')
+          if @refresh_token.nil?
+            invalid_properties.push('invalid value for "refresh_token", refresh_token cannot be nil.')
           end
 
-          if @end_interval.nil?
-            invalid_properties.push('invalid value for "end_interval", end_interval cannot be nil.')
+          if @token_type.nil?
+            invalid_properties.push('invalid value for "token_type", token_type cannot be nil.')
+          end
+
+          if @token_use.nil?
+            invalid_properties.push('invalid value for "token_use", token_use cannot be nil.')
           end
 
           invalid_properties
@@ -162,35 +184,24 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          period_validator = EnumAttributeValidator.new('String', ["ONE_MINUTE", "FIVE_MINUTES", "TEN_MINUTES", "FIFTEEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "FOUR_HOURS", "TWELVE_HOURS", "ONE_DAY", "ONE_WEEK"])
-          return false unless period_validator.valid?(@period)
-          return false if @start_interval.nil?
-          return false if @data.nil?
-          return false if @interval.nil?
-          interval_validator = EnumAttributeValidator.new('String', ["ONE_MINUTE", "FIVE_MINUTES", "TEN_MINUTES", "FIFTEEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "FOUR_HOURS", "TWELVE_HOURS", "ONE_DAY", "ONE_WEEK"])
-          return false unless interval_validator.valid?(@interval)
-          return false if @end_interval.nil?
+          return false if @access_token.nil?
+          return false if @expires_in.nil?
+          return false if @refresh_token.nil?
+          return false if @token_type.nil?
+          return false if @token_use.nil?
+          token_use_validator = EnumAttributeValidator.new('String', ["access_token"])
+          return false unless token_use_validator.valid?(@token_use)
           true
         end
 
         # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] period Object to be assigned
-        def period=(period)
-          validator = EnumAttributeValidator.new('String', ["ONE_MINUTE", "FIVE_MINUTES", "TEN_MINUTES", "FIFTEEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "FOUR_HOURS", "TWELVE_HOURS", "ONE_DAY", "ONE_WEEK"])
-          unless validator.valid?(period)
-            fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}."
-          end
-          @period = period
-        end
-
-        # Custom attribute writer method checking allowed values (enum).
-        # @param [Object] interval Object to be assigned
-        def interval=(interval)
-          validator = EnumAttributeValidator.new('String', ["ONE_MINUTE", "FIVE_MINUTES", "TEN_MINUTES", "FIFTEEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "FOUR_HOURS", "TWELVE_HOURS", "ONE_DAY", "ONE_WEEK"])
-          unless validator.valid?(interval)
-            fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
+        # @param [Object] token_use Object to be assigned
+        def token_use=(token_use)
+          validator = EnumAttributeValidator.new('String', ["access_token"])
+          unless validator.valid?(token_use)
+            fail ArgumentError, "invalid value for \"token_use\", must be one of #{validator.allowable_values}."
           end
-          @interval = interval
+          @token_use = token_use
         end
 
         # Checks equality by comparing each attribute.
@@ -198,13 +209,15 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              path == o.path &&
-              period == o.period &&
-              start_interval == o.start_interval &&
-              data == o.data &&
-              domain == o.domain &&
-              interval == o.interval &&
-              end_interval == o.end_interval
+              access_token == o.access_token &&
+              expires_in == o.expires_in &&
+              hub_id == o.hub_id &&
+              id_token == o.id_token &&
+              refresh_token == o.refresh_token &&
+              scopes == o.scopes &&
+              token_type == o.token_type &&
+              token_use == o.token_use &&
+              user_id == o.user_id
         end
 
         # @see the `==` method
@@ -216,7 +229,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [path, period, start_interval, data, domain, interval, end_interval].hash
+          [access_token, expires_in, hub_id, id_token, refresh_token, scopes, token_type, token_use, user_id].hash
         end
 
         # Builds the object from hash
@@ -287,7 +300,7 @@ module Hubspot
             end
           else # model
             # models (e.g. Pet) or oneOf
-            klass = Hubspot::Cms::Performance.const_get(type)
+            klass = Hubspot::Oauth::V3.const_get(type)
             klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
           end
         end