hubspot-api-client 2.0.0 → 2.1.0

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -62,6 +62,7 @@ module Hubspot
             conn.request :url_encoded
           end
           conn.adapter(Faraday.default_adapter)
+          conn.options[:params_encoder] = Faraday::FlatParamsEncoder
 
           # Errors handler settings
           if !config.error_handler.empty?
@@ -269,9 +270,7 @@ module Hubspot
           end
         else
           # models, e.g. Pet
-          Hubspot::OAuth.const_get(return_type).new.tap do |model|
-            model.build_from_hash data
-          end
+          Hubspot::OAuth.const_get(return_type).build_from_hash(data)
         end
       end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -126,7 +126,7 @@ module Hubspot
       def initialize
         @scheme = 'https'
         @host = 'api.hubapi.com'
-        @base_path = '/oauth'
+        @base_path = ''
         @api_key = {}
         @api_key_prefix = {}
         @timeout = 0
@@ -214,7 +214,7 @@ module Hubspot
       def server_settings
         [
           {
-            url: "https://api.hubapi.com/oauth",
+            url: "https://api.hubapi.com/",
             description: "No description provided",
           }
         ]

data/lib/hubspot/codegen/oauth/models/error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 
 module Hubspot
   module OAuth
-      class Error
+    class Error
       # A human readable message describing the error along with remediation steps where appropriate
       attr_accessor :message
 
@@ -24,6 +24,9 @@ module Hubspot
       # The error category
       attr_accessor :category
 
+      # A specific category that contains more specific detail about the error
+      attr_accessor :sub_category
+
       # further information about the error
       attr_accessor :errors
 
@@ -39,6 +42,7 @@ module Hubspot
           :'message' => :'message',
           :'correlation_id' => :'correlationId',
           :'category' => :'category',
+          :'sub_category' => :'subCategory',
           :'errors' => :'errors',
           :'context' => :'context',
           :'links' => :'links'
@@ -51,6 +55,7 @@ module Hubspot
           :'message' => :'String',
           :'correlation_id' => :'String',
           :'category' => :'String',
+          :'sub_category' => :'String',
           :'errors' => :'Array<ErrorDetail>',
           :'context' => :'Hash<String, Array<String>>',
           :'links' => :'Hash<String, String>'
@@ -90,6 +95,10 @@ module Hubspot
           self.category = attributes[:'category']
         end
 
+        if attributes.key?(:'sub_category')
+          self.sub_category = attributes[:'sub_category']
+        end
+
         if attributes.key?(:'errors')
           if (value = attributes[:'errors']).is_a?(Array)
             self.errors = value
@@ -121,11 +130,6 @@ module Hubspot
           invalid_properties.push('invalid value for "correlation_id", correlation_id cannot be nil.')
         end
 
-        pattern = Regexp.new(/[a-zA-Z0-9]{32}/)
-        if @correlation_id !~ pattern
-          invalid_properties.push("invalid value for \"correlation_id\", must conform to the pattern #{pattern}.")
-        end
-
         if @category.nil?
           invalid_properties.push('invalid value for "category", category cannot be nil.')
         end
@@ -138,26 +142,10 @@ module Hubspot
       def valid?
         return false if @message.nil?
         return false if @correlation_id.nil?
-        return false if @correlation_id !~ Regexp.new(/[a-zA-Z0-9]{32}/)
         return false if @category.nil?
         true
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] correlation_id Value to be assigned
-      def correlation_id=(correlation_id)
-        if correlation_id.nil?
-          fail ArgumentError, 'correlation_id cannot be nil'
-        end
-
-        pattern = Regexp.new(/[a-zA-Z0-9]{32}/)
-        if correlation_id !~ pattern
-          fail ArgumentError, "invalid value for \"correlation_id\", must conform to the pattern #{pattern}."
-        end
-
-        @correlation_id = correlation_id
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(o)
@@ -166,6 +154,7 @@ module Hubspot
             message == o.message &&
             correlation_id == o.correlation_id &&
             category == o.category &&
+            sub_category == o.sub_category &&
             errors == o.errors &&
             context == o.context &&
             links == o.links
@@ -180,7 +169,7 @@ module Hubspot
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [message, correlation_id, category, errors, context, links].hash
+        [message, correlation_id, category, sub_category, errors, context, links].hash
       end
 
       # Builds the object from hash
@@ -298,4 +287,4 @@ module Hubspot
       end
     end
   end
-end
+end

data/lib/hubspot/codegen/oauth/models/error_detail.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -21,6 +21,12 @@ module Hubspot
       # The name of the field or parameter in which the error was found.
       attr_accessor :_in
 
+      # The status code associated with the error detail
+      attr_accessor :code
+
+      # A specific category that contains more specific detail about the error
+      attr_accessor :sub_category
+
       # Context about the error condition
       attr_accessor :context
 
@@ -29,6 +35,8 @@ module Hubspot
         {
           :'message' => :'message',
           :'_in' => :'in',
+          :'code' => :'code',
+          :'sub_category' => :'subCategory',
           :'context' => :'context'
         }
       end
@@ -38,6 +46,8 @@ module Hubspot
         {
           :'message' => :'String',
           :'_in' => :'String',
+          :'code' => :'String',
+          :'sub_category' => :'String',
           :'context' => :'Hash<String, Array<String>>'
         }
       end
@@ -52,13 +62,13 @@ 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::Client::OAuth::ErrorDetail` initialize method"
+          fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::OAuth::ErrorDetail` 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::Client::OAuth::ErrorDetail`. 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::ErrorDetail`. 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
         }
@@ -71,6 +81,14 @@ module Hubspot
           self._in = attributes[:'_in']
         end
 
+        if attributes.key?(:'code')
+          self.code = attributes[:'code']
+        end
+
+        if attributes.key?(:'sub_category')
+          self.sub_category = attributes[:'sub_category']
+        end
+
         if attributes.key?(:'context')
           if (value = attributes[:'context']).is_a?(Hash)
             self.context = value
@@ -103,6 +121,8 @@ module Hubspot
         self.class == o.class &&
             message == o.message &&
             _in == o._in &&
+            code == o.code &&
+            sub_category == o.sub_category &&
             context == o.context
       end
 
@@ -115,7 +135,7 @@ module Hubspot
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [message, _in, context].hash
+        [message, _in, code, sub_category, context].hash
       end
 
       # Builds the object from hash
@@ -182,7 +202,7 @@ module Hubspot
             end
           end
         else # model
-          Hubspot::Client::OAuth.const_get(type).build_from_hash(value)
+          Hubspot::OAuth.const_get(type).build_from_hash(value)
         end
       end
 
@@ -233,4 +253,4 @@ module Hubspot
       end
     end
   end
-end
+end

data/lib/hubspot/codegen/oauth/models/{refresh_token.rb → token_response_if.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -14,32 +14,28 @@ require 'date'
 
 module Hubspot
   module OAuth
-    class RefreshToken
-      attr_accessor :token
+    class TokenResponseIF
+      attr_accessor :access_token
 
-      attr_accessor :client_id
+      attr_accessor :expires_in
 
-      attr_accessor :hub_id
-
-      attr_accessor :user_id
+      attr_accessor :refresh_token
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :'token' => :'token',
-          :'client_id' => :'clientId',
-          :'hub_id' => :'hubId',
-          :'user_id' => :'userId'
+          :'access_token' => :'access_token',
+          :'expires_in' => :'expires_in',
+          :'refresh_token' => :'refresh_token'
         }
       end
 
       # Attribute type mapping.
       def self.openapi_types
         {
-          :'token' => :'String',
-          :'client_id' => :'String',
-          :'hub_id' => :'Integer',
-          :'user_id' => :'Integer'
+          :'access_token' => :'String',
+          :'expires_in' => :'Integer',
+          :'refresh_token' => :'String'
         }
       end
 
@@ -53,31 +49,27 @@ 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::OAuth::RefreshToken` initialize method"
+          fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::OAuth::TokenResponseIF` 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::RefreshToken`. 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::TokenResponseIF`. 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?(:'token')
-          self.token = attributes[:'token']
-        end
-
-        if attributes.key?(:'client_id')
-          self.client_id = attributes[:'client_id']
+        if attributes.key?(:'access_token')
+          self.access_token = attributes[:'access_token']
         end
 
-        if attributes.key?(:'hub_id')
-          self.hub_id = attributes[:'hub_id']
+        if attributes.key?(:'expires_in')
+          self.expires_in = attributes[:'expires_in']
         end
 
-        if attributes.key?(:'user_id')
-          self.user_id = attributes[:'user_id']
+        if attributes.key?(:'refresh_token')
+          self.refresh_token = attributes[:'refresh_token']
         end
       end
 
@@ -85,20 +77,16 @@ module Hubspot
       # @return Array for valid properties with the reasons
       def list_invalid_properties
         invalid_properties = Array.new
-        if @token.nil?
-          invalid_properties.push('invalid value for "token", token cannot be nil.')
-        end
-
-        if @client_id.nil?
-          invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
+        if @access_token.nil?
+          invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
         end
 
-        if @hub_id.nil?
-          invalid_properties.push('invalid value for "hub_id", hub_id cannot be nil.')
+        if @expires_in.nil?
+          invalid_properties.push('invalid value for "expires_in", expires_in cannot be nil.')
         end
 
-        if @user_id.nil?
-          invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+        if @refresh_token.nil?
+          invalid_properties.push('invalid value for "refresh_token", refresh_token cannot be nil.')
         end
 
         invalid_properties
@@ -107,10 +95,9 @@ module Hubspot
       # 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 @token.nil?
-        return false if @client_id.nil?
-        return false if @hub_id.nil?
-        return false if @user_id.nil?
+        return false if @access_token.nil?
+        return false if @expires_in.nil?
+        return false if @refresh_token.nil?
         true
       end
 
@@ -119,10 +106,9 @@ module Hubspot
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
-            token == o.token &&
-            client_id == o.client_id &&
-            hub_id == o.hub_id &&
-            user_id == o.user_id
+            access_token == o.access_token &&
+            expires_in == o.expires_in &&
+            refresh_token == o.refresh_token
       end
 
       # @see the `==` method
@@ -134,7 +120,7 @@ module Hubspot
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [token, client_id, hub_id, user_id].hash
+        [access_token, expires_in, refresh_token].hash
       end
 
       # Builds the object from hash
@@ -252,4 +238,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -0,0 +1,214 @@
+=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 'cgi'
+
+module Hubspot
+  module Webhooks
+    class SettingsApi
+      attr_accessor :api_client
+
+      def initialize(api_client = ApiClient.default)
+        @api_client = api_client
+      end
+      # Clear webhook settings
+      # Resets webhook target URL to empty, and max concurrency limit to `0` for the given app. This will effectively pause all webhook subscriptions until new settings are provided.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @return [nil]
+      def clear_settings(app_id, opts = {})
+        clear_settings_with_http_info(app_id, opts)
+        nil
+      end
+
+      # Clear webhook settings
+      # Resets webhook target URL to empty, and max concurrency limit to `0` for the given app. This will effectively pause all webhook subscriptions until new settings are provided.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+      def clear_settings_with_http_info(app_id, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: SettingsApi.clear_settings ...'
+        end
+        # verify the required parameter 'app_id' is set
+        if @api_client.config.client_side_validation && app_id.nil?
+          fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.clear_settings"
+        end
+        # resource path
+        local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+        # 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(['*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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(:DELETE, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: SettingsApi#clear_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # Configure webhook settings
+      # Used to set the webhook target URL and max concurrency limit for the given app.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @option opts [SettingsChangeRequest] :settings_change_request Settings state to create new with or replace existing settings with.
+      # @return [SettingsResponse]
+      def configure_settings(app_id, opts = {})
+        data, _status_code, _headers = configure_settings_with_http_info(app_id, opts)
+        data
+      end
+
+      # Configure webhook settings
+      # Used to set the webhook target URL and max concurrency limit for the given app.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @option opts [SettingsChangeRequest] :settings_change_request Settings state to create new with or replace existing settings with.
+      # @return [Array<(SettingsResponse, Integer, Hash)>] SettingsResponse data, response status code and response headers
+      def configure_settings_with_http_info(app_id, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: SettingsApi.configure_settings ...'
+        end
+        # verify the required parameter 'app_id' is set
+        if @api_client.config.client_side_validation && app_id.nil?
+          fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.configure_settings"
+        end
+        # resource path
+        local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+        # 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'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] || @api_client.object_to_http_body(opts[:'settings_change_request']) 
+
+        # return_type
+        return_type = opts[:return_type] || 'SettingsResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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(:PUT, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: SettingsApi#configure_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # Get webhook settings
+      # Returns the current state of webhook settings for the given app. These settings include the app's configured target URL and max concurrency limit.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @return [SettingsResponse]
+      def get_settings(app_id, opts = {})
+        data, _status_code, _headers = get_settings_with_http_info(app_id, opts)
+        data
+      end
+
+      # Get webhook settings
+      # Returns the current state of webhook settings for the given app. These settings include the app&#39;s configured target URL and max concurrency limit.
+      # @param app_id [Integer] The ID of the target app.
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(SettingsResponse, Integer, Hash)>] SettingsResponse data, response status code and response headers
+      def get_settings_with_http_info(app_id, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: SettingsApi.get_settings ...'
+        end
+        # verify the required parameter 'app_id' is set
+        if @api_client.config.client_side_validation && app_id.nil?
+          fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.get_settings"
+        end
+        # resource path
+        local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+        # 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', '*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'SettingsResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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(:GET, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: SettingsApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+    end
+  end
+end