hubspot-api-client 11.1.1 → 11.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd888658c9c0cc15a649689283777ae7549822cc23aae28f1bbf0c0bc34e3c22
-  data.tar.gz: 57daa809842df882bbcf2665f53220f54377e565ae3d5753848a15cc21752590
+  metadata.gz: 49773ca87604753beeba481bb492056259454f16f9a984ef165c9a1d4d87556f
+  data.tar.gz: 5802046f01305f5d0c4580cc832b2fa31f3b5e5c01a0429dc45e1583b28220b5
 SHA512:
-  metadata.gz: ccfac78fee61915505f85c358efc1bb99ccd32e3250477c2c6d3f1e6e81308efb6a9dfceee83c392fb099d259cbe091bec05b00e66d722d45105647d346eb94a
-  data.tar.gz: '08390b483ca63ca77597992930faf3924f579466cd0ef0ce468864bd7f5b361c82a88d7bccffcff8eb709285450bcd8dba4e1f03e4780b7cfc762a43d04d9af4'
+  metadata.gz: fd1127831b253716776f3c88a7a5a0e48984ab4f13f266f51a568612e6c3cd154818f80d0b0c023e91cf0612266fed19467b1337509a0cd1424ceb1d1be79115
+  data.tar.gz: 0eb281a32a8746602b7e3c905b4672bcd8708e35aef144f23fcb04deda01657d42429f00c73635565d5db06a80c28d2ccf57446a9928a699d207b481a59efd81

data/CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
+## [11.2.0] - 2022-05-12
+
+- added discovery classes
+
 ## [11.1.1] - 2021-11-10
 
 - fixed type for the file collection response

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (11.1.1)
+    hubspot-api-client (11.2.0)
       json (~> 2.1, >= 2.1.0)
       require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
@@ -16,13 +16,18 @@ GEM
       ZenTest (>= 4.4.1)
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
+    coderay (1.1.3)
     crack (0.4.4)
     diff-lcs (1.4.4)
     ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     hashdiff (1.0.1)
     json (2.6.1)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.6)
     rake (12.3.3)
     rake-release (1.2.1)
@@ -57,6 +62,7 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   hubspot-api-client!
+  pry
   rake (~> 12.3.3)
   rake-release
   rspec (~> 3.6, >= 3.6.0)

data/README.md

@@ -36,6 +36,20 @@ basic_api.get_page(auth_names: 'hapikey')
 
 ```
 
+for new discovery classes since version 11.2
+```ruby
+# Load the gem
+require 'hubspot-api-client'
+
+# Setup client with hapikey authorization
+client = Hubspot::Client.new(api_key: 'demo')
+
+# Get contacts
+basic_api = client.crm.contacts.basic_api
+basic_api.get_page
+
+```
+
 ### Usage
 
 ### Get all:
@@ -45,6 +59,13 @@ get_all method is available for all major objects (Companies, Contacts, Deals, L
 basic_api = Hubspot::Crm::Contacts::BasicApi.new
 all_contacts = basic_api.get_all(auth_names: 'oauth2')
 ```
+
+for new discovery classes since version 11.2
+```ruby
+client = Hubspot::Client(access_token: 'your_oauth2_access_token')
+all_contacts = client.crm.contacts.basic_api.get_all
+```
+
 Please note that pagination is used under the hood to get all results.
 
 

data/hubspot-api-client.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'rake-release'
+  s.add_development_dependency 'pry'
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(sample-apps)/})

data/lib/hubspot/client.rb

@@ -0,0 +1,51 @@
+require_rel 'discovery'
+
+module Hubspot
+  class Client
+    attr_reader :api_key, :access_token
+
+    def self.api_modules
+      %i[
+        automation
+        cms
+        communication_preferences
+        conversations
+        crm
+        events
+        files
+        marketing
+        o_auth
+        webhooks
+      ].freeze
+    end
+
+    include Hubspot::Discovery::BaseModuleClient
+
+    private
+
+    def self.base_module
+      'Hubspot::Discovery'
+    end
+
+    def configure_api_key
+      Hubspot.configure do |config|
+        config.api_key['hapikey'] = api_key
+      end
+    end
+
+    def configure_access_token
+      Hubspot.configure do |config|
+        config.access_token = access_token
+      end
+    end
+
+    def initialize(params)
+      raise 'Please, pass :api_key or :access_token' if params[:api_key].nil? && params[:developer_api_key].nil? && params[:access_token].nil?
+      @api_key = params[:api_key] || params[:developer_api_key]
+      @access_token = params[:access_token]
+      @params = params
+      configure_api_key if @api_key
+      configure_access_token if @access_token
+    end
+  end
+end

data/lib/hubspot/discovery/automation/actions/api/callbacks_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      module Actions
+        class CallbacksApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/automation/actions/api/definitions_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      module Actions
+        class DefinitionsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/automation/actions/api/functions_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      module Actions
+        class FunctionsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/automation/actions/api/revisions_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      module Actions
+        class RevisionsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/automation/actions/client.rb

@@ -0,0 +1,22 @@
+require_rel '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      module Actions
+        class Client
+          def self.api_classes 
+            %i[
+              callbacks
+              definitions
+              functions
+              revisions
+            ].freeze
+          end
+
+          include Hubspot::Discovery::BaseModuleClient
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_rel '../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Automation
+      class Client
+        def self.api_modules
+          %i[
+            actions
+          ].freeze
+        end
+
+        include Hubspot::Discovery::BaseModuleClient
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/base_api_client.rb

@@ -0,0 +1,70 @@
+module Hubspot
+  module Discovery
+    module BaseApiClient
+      attr_reader :base_params
+
+      def initialize(params)
+        @base_params = params
+        define_methods
+      end
+
+      def api_methods
+        api.methods.grep(/with_http_info/).map {|elem| elem.to_s.gsub('_with_http_info', '').to_sym }
+      end
+
+      def api_client
+        api&.api_client
+      end
+
+      def api
+        @api ||= Kernel.const_get(codegen_api_class).new
+      end
+
+      def get_all(params = {})
+        api.get_all(params)
+      end
+
+      private
+
+      def codegen_api_class
+        self.class.name.gsub('Discovery::', '')
+      end
+
+      def define_methods
+        define_api_methods
+      end
+      
+      def define_api_methods
+        api_methods.each do |api_method|
+          self.class.define_method(api_method) do |params = {}|
+            params_with_defaults = params
+            params_with_defaults[:opts] ||= {}
+            params_with_defaults[:opts][:auth_names] = if base_params[:access_token]
+                                                         'oauth2' 
+                                                       elsif base_params[:api_key]
+                                                         'hapikey'
+                                                       elsif base_params[:developer_api_key]
+                                                         'developer_hapikey'
+                                                       else
+                                                         raise 'Unauthorized. Please, provide access_token, api_key or developer_api_key'
+                                                       end
+
+            signature_params = api.method(api_method).parameters
+
+            signature_param_names = signature_params.map { |_, param| param }
+            params_with_defaults.each do |param_name, param_value|
+              params_with_defaults[:opts][param_name] = param_value unless signature_param_names.include?(param_name)
+            end
+
+            params_to_pass = signature_params.map do |req, param|
+              raise "Param #{param} is required for #{api.class}\##{api_method} method" if req == :req && params_with_defaults[param].nil?
+              params_with_defaults[param]
+            end
+
+            api.public_send(api_method, *params_to_pass)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/base_module_client.rb

@@ -0,0 +1,55 @@
+require_rel '../helpers/camel_case'
+
+module Hubspot
+  module Discovery
+    module BaseModuleClient
+      module ClassMethods
+        def base_module
+          modules = name.split('::')
+          modules.pop
+          modules.join('::')
+        end
+  
+        def api_modules
+          []
+        end
+  
+        def api_classes
+          []
+        end
+  
+        def define_methods
+          define_modules_methods
+          define_classes_methods
+        end
+  
+        def define_modules_methods
+          api_modules.each do |api_module|
+            define_method(api_module) do 
+              Kernel.const_get("#{self.class.base_module}::#{Hubspot::Helpers::CamelCase.new.format(__method__.to_s)}::Client").new(params)
+            end
+          end
+        end
+        
+        def define_classes_methods
+          api_classes.each do |api_class|
+            define_method("#{api_class}_api") do
+              Kernel.const_get("#{self.class.base_module}::#{Hubspot::Helpers::CamelCase.new.format(__method__.to_s)}").new(params)
+            end
+          end
+        end
+      end
+
+      attr_reader :params
+
+      def initialize(params)
+        @params = params
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_eval { define_methods }
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/audit_logs/api/audit_logs_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module AuditLogs
+        class AuditLogsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/audit_logs/client.rb

@@ -0,0 +1,19 @@
+require_rel '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module AuditLogs
+        class Client
+          def self.api_classes 
+            %i[
+              audit_logs
+            ].freeze
+          end
+
+          include Hubspot::Discovery::BaseModuleClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/authors/api/author_api.rb

@@ -0,0 +1,15 @@
+require_rel '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module Authors
+          class AuthorApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/authors/client.rb

@@ -0,0 +1,21 @@
+require_rel '../../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module Authors
+          class Client
+            def self.api_classes
+              %i[
+                author
+              ].freeze
+            end
+  
+            include Hubspot::Discovery::BaseModuleClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/blog_posts/api/blog_post_api.rb

@@ -0,0 +1,15 @@
+require_rel '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module BlogPosts
+          class BlogPostApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/blog_posts/client.rb

@@ -0,0 +1,21 @@
+require_rel '../../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module BlogPosts
+          class Client
+            def self.api_classes
+              %i[
+                blog_post
+              ].freeze
+            end
+  
+            include Hubspot::Discovery::BaseModuleClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/client.rb

@@ -0,0 +1,21 @@
+require_rel '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        class Client
+          def self.api_modules
+            %i[
+              authors
+              blog_posts
+              tags
+            ].freeze
+          end
+
+          include Hubspot::Discovery::BaseModuleClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/tags/api/tag_api.rb

@@ -0,0 +1,15 @@
+require_rel '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module Tags
+          class TagApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/blogs/tags/client.rb

@@ -0,0 +1,21 @@
+require_rel '../../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Blogs
+        module Tags
+          class Client
+            def self.api_classes
+              %i[
+                tag
+              ].freeze
+            end
+  
+            include Hubspot::Discovery::BaseModuleClient
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_rel '../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      class Client
+        def self.api_modules
+          %i[
+            audit_logs
+            blogs
+            domains
+            hubdb
+            performance
+            site_search
+            url_redirects
+          ].freeze
+        end
+
+        include Hubspot::Discovery::BaseModuleClient
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/domains/api/domains_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Domains
+        class DomainsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/domains/client.rb

@@ -0,0 +1,19 @@
+require_rel '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Domains
+        class Client
+          def self.api_classes 
+            %i[
+              domains
+            ].freeze
+          end
+
+          include Hubspot::Discovery::BaseModuleClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/hubdb/api/rows_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Hubdb
+        class RowsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/hubdb/api/rows_batch_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Hubdb
+        class RowsBatchApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/hubdb/api/tables_api.rb

@@ -0,0 +1,13 @@
+require_rel '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Hubdb
+        class TablesApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/cms/hubdb/client.rb

@@ -0,0 +1,21 @@
+require_rel '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Cms
+      module Hubdb
+        class Client
+          def self.api_classes 
+            %i[
+              rows
+              rows_batch
+              tables
+            ].freeze
+          end
+
+          include Hubspot::Discovery::BaseModuleClient
+        end
+      end
+    end
+  end
+end