hubspot-api-client 10.1.1 → 11.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b4bf5723bba2706db45a4c12db8479e73da35bd34adb0740b21f4ffbd845c2
-  data.tar.gz: e3cc5b9a30ebfbe22db86cef9dec226191a331ec9ea1b0209e58b555ba1455dc
+  metadata.gz: 49773ca87604753beeba481bb492056259454f16f9a984ef165c9a1d4d87556f
+  data.tar.gz: 5802046f01305f5d0c4580cc832b2fa31f3b5e5c01a0429dc45e1583b28220b5
 SHA512:
-  metadata.gz: be0d0d0d879aa2afc63cf4c69ecaee624eaa8745dfb4b297738e991dfd99761d9b3e8829f120b348e0f76ecc1f3e0bd46153634f2a77cd520b392b33aa40baa7
-  data.tar.gz: f2cd1e7907f47a26113422645e240342c51df1095f6ad70e7f2e28c1a4bf3510a7199817ac1d06d93c684d901df3119c0b409ea9b66a2b8129a721f127fc7cf2
+  metadata.gz: fd1127831b253716776f3c88a7a5a0e48984ab4f13f266f51a568612e6c3cd154818f80d0b0c023e91cf0612266fed19467b1337509a0cd1424ceb1d1be79115
+  data.tar.gz: 0eb281a32a8746602b7e3c905b4672bcd8708e35aef144f23fcb04deda01657d42429f00c73635565d5db06a80c28d2ccf57446a9928a699d207b481a59efd81

data/CHANGELOG.md

@@ -5,6 +5,23 @@ 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
+
+## [11.1.0] - 2021-09-10
+
+- added GDPR api modules
+- updated generated code
+
+## [11.0.0] - 2021-08-20
+
+- new generated code with updated class names
+
 ## [10.1.0] - 2021-06-08
 
 - added CommunicationPreferences api module

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (10.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.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.15.3)
+    ffi (1.15.5)
     hashdiff (1.0.1)
-    json (2.5.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/codegen/cms/audit-logs/api/{default_api.rb → audit_logs_api.rb}

@@ -15,7 +15,7 @@ require 'cgi'
 module Hubspot
   module Cms
     module AuditLogs
-      class DefaultApi
+      class AuditLogsApi
         attr_accessor :api_client
 
         def initialize(api_client = ApiClient.default)
@@ -52,7 +52,7 @@ module Hubspot
         # @return [Array<(CollectionResponsePublicAuditLog, Integer, Hash)>] CollectionResponsePublicAuditLog data, response status code and response headers
         def get_page_with_http_info(opts = {})
           if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: DefaultApi.get_page ...'
+            @api_client.config.logger.debug 'Calling API: AuditLogsApi.get_page ...'
           end
           # resource path
           local_var_path = '/cms/v3/audit-logs/'
@@ -96,7 +96,7 @@ module Hubspot
 
           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: DefaultApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            @api_client.config.logger.debug "API called: AuditLogsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
           end
           return data, status_code, headers
         end

data/lib/hubspot/codegen/cms/blogs/authors/api/{default_api.rb → author_api.rb}

@@ -16,7 +16,7 @@ module Hubspot
   module Cms
     module Blogs
       module Authors
-        class DefaultApi
+        class AuthorApi
           attr_accessor :api_client
 
           def initialize(api_client = ApiClient.default)
@@ -41,11 +41,11 @@ module Hubspot
           # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
           def archive_with_http_info(object_id, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.archive ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.archive ...'
             end
             # verify the required parameter 'object_id' is set
             if @api_client.config.client_side_validation && object_id.nil?
-              fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.archive"
+              fail ArgumentError, "Missing the required parameter 'object_id' when calling AuthorApi.archive"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
@@ -82,7 +82,7 @@ module Hubspot
 
             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: DefaultApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -104,11 +104,11 @@ module Hubspot
           # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
           def archive_batch_with_http_info(batch_input_string, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.archive_batch ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.archive_batch ...'
             end
             # verify the required parameter 'batch_input_string' is set
             if @api_client.config.client_side_validation && batch_input_string.nil?
-              fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling DefaultApi.archive_batch"
+              fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling AuthorApi.archive_batch"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/batch/archive'
@@ -146,7 +146,7 @@ module Hubspot
 
             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: DefaultApi#archive_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#archive_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -168,11 +168,11 @@ module Hubspot
           # @return [Array<(BlogAuthor, Integer, Hash)>] BlogAuthor data, response status code and response headers
           def create_with_http_info(blog_author, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.create ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.create ...'
             end
             # verify the required parameter 'blog_author' is set
             if @api_client.config.client_side_validation && blog_author.nil?
-              fail ArgumentError, "Missing the required parameter 'blog_author' when calling DefaultApi.create"
+              fail ArgumentError, "Missing the required parameter 'blog_author' when calling AuthorApi.create"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors'
@@ -210,7 +210,7 @@ module Hubspot
 
             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: DefaultApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -232,11 +232,11 @@ module Hubspot
           # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
           def create_batch_with_http_info(batch_input_blog_author, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.create_batch ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.create_batch ...'
             end
             # verify the required parameter 'batch_input_blog_author' is set
             if @api_client.config.client_side_validation && batch_input_blog_author.nil?
-              fail ArgumentError, "Missing the required parameter 'batch_input_blog_author' when calling DefaultApi.create_batch"
+              fail ArgumentError, "Missing the required parameter 'batch_input_blog_author' when calling AuthorApi.create_batch"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/batch/create'
@@ -274,7 +274,7 @@ module Hubspot
 
             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: DefaultApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -298,11 +298,11 @@ module Hubspot
           # @return [Array<(BlogAuthor, Integer, Hash)>] BlogAuthor data, response status code and response headers
           def get_by_id_with_http_info(object_id, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.get_by_id ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.get_by_id ...'
             end
             # verify the required parameter 'object_id' is set
             if @api_client.config.client_side_validation && object_id.nil?
-              fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.get_by_id"
+              fail ArgumentError, "Missing the required parameter 'object_id' when calling AuthorApi.get_by_id"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
@@ -339,7 +339,7 @@ module Hubspot
 
             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: DefaultApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -379,7 +379,7 @@ module Hubspot
           # @return [Array<(CollectionResponseWithTotalBlogAuthorForwardPaging, Integer, Hash)>] CollectionResponseWithTotalBlogAuthorForwardPaging data, response status code and response headers
           def get_page_with_http_info(opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.get_page ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.get_page ...'
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors'
@@ -425,7 +425,7 @@ module Hubspot
 
             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: DefaultApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -449,11 +449,11 @@ module Hubspot
           # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
           def read_batch_with_http_info(batch_input_string, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.read_batch ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.read_batch ...'
             end
             # verify the required parameter 'batch_input_string' is set
             if @api_client.config.client_side_validation && batch_input_string.nil?
-              fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling DefaultApi.read_batch"
+              fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling AuthorApi.read_batch"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/batch/read'
@@ -492,7 +492,7 @@ module Hubspot
 
             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: DefaultApi#read_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#read_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -518,15 +518,15 @@ module Hubspot
           # @return [Array<(BlogAuthor, Integer, Hash)>] BlogAuthor data, response status code and response headers
           def update_with_http_info(object_id, blog_author, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.update ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.update ...'
             end
             # verify the required parameter 'object_id' is set
             if @api_client.config.client_side_validation && object_id.nil?
-              fail ArgumentError, "Missing the required parameter 'object_id' when calling DefaultApi.update"
+              fail ArgumentError, "Missing the required parameter 'object_id' when calling AuthorApi.update"
             end
             # verify the required parameter 'blog_author' is set
             if @api_client.config.client_side_validation && blog_author.nil?
-              fail ArgumentError, "Missing the required parameter 'blog_author' when calling DefaultApi.update"
+              fail ArgumentError, "Missing the required parameter 'blog_author' when calling AuthorApi.update"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
@@ -565,7 +565,7 @@ module Hubspot
 
             data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
             if @api_client.config.debugging
-              @api_client.config.logger.debug "API called: DefaultApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end
@@ -589,11 +589,11 @@ module Hubspot
           # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
           def update_batch_with_http_info(batch_input_json_node, opts = {})
             if @api_client.config.debugging
-              @api_client.config.logger.debug 'Calling API: DefaultApi.update_batch ...'
+              @api_client.config.logger.debug 'Calling API: AuthorApi.update_batch ...'
             end
             # verify the required parameter 'batch_input_json_node' is set
             if @api_client.config.client_side_validation && batch_input_json_node.nil?
-              fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling DefaultApi.update_batch"
+              fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling AuthorApi.update_batch"
             end
             # resource path
             local_var_path = '/cms/v3/blogs/authors/batch/update'
@@ -632,7 +632,7 @@ module Hubspot
 
             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: DefaultApi#update_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              @api_client.config.logger.debug "API called: AuthorApi#update_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
             end
             return data, status_code, headers
           end