hubspot-api-client 11.1.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b00d4159c770613a072936042edb28525d928740dbbd0c7c72e588fea1fa216
-  data.tar.gz: 2da33f4c672c0978c6404af0991acff0265e0ef508fe2afae50c16078aa59008
+  metadata.gz: 6e5d57460bdda8cbf2fc666059e9395762d26202a84f30e056dbde2117f28724
+  data.tar.gz: 7850afe9111512e550dc7ceb610e67f2cc9ce8615efef94fab894c98bfa2fb5a
 SHA512:
-  metadata.gz: ebc91f661b95f4370aac0996053bf0f6a7a4fd519cdfde832a03acc1ccec084605b12776664f9f1c3f09891fe458fb8b7cb65ca65abc25cb49e5dd0c397f7d71
-  data.tar.gz: 064f15d336b041c3d52edeae05c2505b8b82d301278e949f96579eec854932ee63dc983384f015b01a9c14989be0f7f5725f530d5d81e2015c484d0407590162
+  metadata.gz: 9e5adbb09e055024a83f888ddc2b3e5f9eab6d57d301297cf5b1c7a55833ba7a513af0fe9bc2da85637edb4fe3fad382484571c619c302a01a4874a175ddfa66
+  data.tar.gz: bff167e47d455162d09a78883d866644cad52b00193150668177e32da752108ee532f520bf0781c5fb8af950e2093886a124cbb272c86c8065a1cd517d5e6e86

data/CHANGELOG.md

@@ -5,6 +5,100 @@ 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).
 
+## [15.0.0] - 2022-10-12
+### Changed
+
+- requiring only codegen files that is using to optimize memory usage
+
+### Removed
+
+- old client syntax support
+
+## [14.5.2] - 2022-10-05
+### Fixed
+
+- passing params with existing model
+
+## [14.5.1] - 2022-09-30
+### Changed
+
+- with_http methods were added to the discovery classes
+
+## [14.5.0] - 2022-09-30
+### Changed
+
+- handling ApiError with retries
+
+## [14.4.0] - 2022-09-27
+### Changed
+
+- handling ApiError by passing a block
+
+## [14.3.0] - 2022-08-31
+### Changed
+
+- using hash instead of model object for Hubspot::Client with body param
+
+## [14.2.0] - 2022-08-25
+### Changed
+
+- using new separate configurations for Hubspot::Client
+
+## [14.1.0] - 2022-08-23
+### Changed
+
+- using default ruby StandardError
+
+## [14.0.0] - 2022-08-11
+### Changed
+
+- required ruby version was increased to 2.7
+
+## [13.2.0] - 2022-08-09
+### Changed
+
+- models updates
+
+### Fixed
+
+- query properties param
+
+## [13.0.0] - 2022-06-29
+### Changed (Breaking changes)
+
+- crm.objects.feedback_submissions API
+
+### Fixed
+
+- crm.contacts.basic_api id_property
+
+## [12.0.0] - 2022-06-09
+### Added
+
+- cms.source_code API client
+- crm.objects.calls API client
+- crm.objects.emails API client
+- crm.objects.meetings API client
+- crm.objects.notes API client
+- crm.objects.tasks API client
+- marketing.forms API client
+- marketing.events API client
+- settings.users API client
+
+### Changed (Breaking changes)
+
+- cms.blogs.authors.author_api => cms.blogs.authors.blog_authors_api
+- cms.blogs.blog_posts.default_api => cms.blogs.blog_posts.blog_posts_api
+- cms.blogs.tags.default_api => cms.blogs.tags.blog_tags_api
+
+## [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

data/Gemfile.lock

@@ -1,53 +1,58 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (11.1.0)
+    hubspot-api-client (15.0.0)
       json (~> 2.1, >= 2.1.0)
-      require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.12.0)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    ZenTest (4.12.1)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    crack (0.4.4)
-    diff-lcs (1.4.4)
-    ethon (0.14.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     hashdiff (1.0.1)
-    json (2.5.1)
-    public_suffix (4.0.6)
+    json (2.6.2)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
     rake (12.3.3)
-    rake-release (1.2.1)
+    rake-release (1.3.0)
       bundler (>= 1.11, < 3)
-    require_all (3.0.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -57,11 +62,12 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   hubspot-api-client!
+  pry (~> 0.14)
   rake (~> 12.3.3)
-  rake-release
+  rake-release (~> 1.3)
   rspec (~> 3.6, >= 3.6.0)
   vcr (~> 3.0, >= 3.0.1)
-  webmock (~> 1.24, >= 1.24.3)
+  webmock (~> 3.14)
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

data/README.md

@@ -20,31 +20,34 @@ gem 'hubspot-api-client'
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
+
 ```ruby
 # Load the gem
 require 'hubspot-api-client'
 
-# Setup authorization
-Hubspot.configure do |config|
-  # Configure API key authorization: hapikey
-  config.api_key['hapikey'] = 'demo'
-end
+# Setup client
+client = Hubspot::Client.new(access_token: 'your_access_token')
 
 # Get contacts
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-basic_api.get_page(auth_names: 'hapikey')
-
+contacts = client.crm.contacts.basic_api.get_page
 ```
 
 ### Usage
 
+#### Hapikey support:
+
+Please, note that hapikey is no longer supported after v13.1.0. You can get more info about hapikey sunset [here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset). Also, plese, visit a [migration guide](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app) if you need help with a migration process.
+
 ### Get all:
 get_all method is available for all major objects (Companies, Contacts, Deals, LineItems, Products, Quotes & Tickets) and works like
 
 ```ruby
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-all_contacts = basic_api.get_all(auth_names: 'oauth2')
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
+all_contacts = client.crm.contacts.basic_api.get_all
 ```
+
+You'll need to create a [private app](https://developers.hubspot.com/docs/api/private-apps) to get your access token or you can obtain OAuth2 access token.
+
 Please note that pagination is used under the hood to get all results.
 
 
@@ -53,68 +56,78 @@ Please note that pagination is used under the hood to get all results.
 #### Creation
 
 ```ruby
-config = ::Hubspot::Crm::Schemas::Configuration.new do |config|
-    config.api_key = { 'hapikey' => 'your_hapikey' }
-  end
-  api_client = ::Hubspot::Crm::Schemas::ApiClient.new(config)
-  api = ::Hubspot::Crm::Schemas::CoreApi.new(api_client)
-  labels = ::Hubspot::Crm::Schemas::ObjectTypeDefinitionLabels.new(singular: 'My object', plural: 'My objects')
-  option = ::Hubspot::Crm::Schemas::OptionInput.new(
-    label: 'Option A',
-    value: 'A',
-    description: 'Choice number one',
-    display_order: 1,
-    hidden: false
-  )
-  property = ::Hubspot::Crm::Schemas::ObjectTypePropertyCreate.new(
-      name: 'property001',
-      label: 'My object property',
-      group_name: 'my_object_information',
-      options: [option],
-      display_order: 2,
-      type: 'enumeration',
-      field_type: 'select'
-  )
-  object_schema_egg = ::Hubspot::Crm::Schemas::ObjectSchemaEgg.new(
-      labels: labels,
-      required_properties: ['property001'],
-      searchable_properties: [],
-      primary_display_property: 'property001',
-      secondary_display_properties: [],
-      properties: [property],
-      associated_objects: ['CONTACT'],
-      name: 'my_object'
-  )
-  api_response = api.create(object_schema_egg)
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
+
+labels = {
+  singular: 'My object',
+  plural: 'My objects'
+}
+
+option = {
+  label: 'Option A',
+  value: 'A',
+  description: 'Choice number one',
+  display_order: 1,
+  hidden: false
+}
+
+property = {
+  name: 'property001',
+  label: 'My object property',
+  group_name: 'my_object_information',
+  options: [option],
+  display_order: 2,
+  type: 'enumeration',
+  field_type: 'select'
+}
+
+body = {
+  labels: labels,
+  required_properties: ['property001'],
+  searchable_properties: [],
+  primary_display_property: 'property001',
+  secondary_display_properties: [],
+  properties: [property],
+  associated_objects: ['CONTACT'],
+  name: 'my_object'
+}
+
+api_response = client.crm.schemas.core_api.create(body: body)
 ```
 
 
 ### Error handling
 
+#### You can rescue an ApiError by passing a block to the method
+
+```ruby
+require 'hubspot-api-client'
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+contacts = client.crm.contacts.basic_api.get_page { |error| error.message }
+```
+
 #### You can set number of retry attempts and delay in seconds before retry on specific status code of response.
 
 Available params:
   - max_retries (maximum number of retries)
   - seconds_delay (pause in seconds between retries)
-  - retry_block (block that is executed after every retry)
+  - passing a block (block that handles errors occured)
 
 
 ```ruby
-config = ::Hubspot::Crm::Companies::Configuration.new do |config|
-  config.access_token = 'YOUR ACCESS TOKEN'
+require 'hubspot-api-client'
 
-  # Set handlers of statuses you want to handle
-  config.error_handler = {
-    [429, 430, 442] => { max_retries: 5, seconds_delay: 1 },
-    (500..530).to_a => { max_retries: 2, seconds_delay: 2 },
-    400 => { max_retries: 3, seconds_delay: 3 },
-  }
-end
+# Set handlers of statuses you want to handle
+retry_config = {
+  500..530 => { max_retries: 2, seconds_delay: 2 },
+  400 => { max_retries: 3, seconds_delay: 3 }
+}
 
-api_client = ::Hubspot::Crm::Companies::ApiClient.new(config)
-basic_api = ::Hubspot::Crm::Companies::BasicApi.new(api_client)
-end
+client = Hubspot::Client.new(access_token: 'your_access_token')
 
+contacts = client.crm.contacts.basic_api.get_page(retry: retry_config) { |error| error.code }
 ```
 
 ### Sample apps

data/hubspot-api-client.gemspec

@@ -11,19 +11,19 @@ Gem::Specification.new do |s|
   s.summary     = "HubSpot Ruby API Gem"
   s.description = "HubSpot Ruby API client"
   s.license     = "Apache-2.0"
-  s.required_ruby_version = ">= 1.9"
+  s.required_ruby_version = ">= 2.7"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.4.0'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
-  s.add_runtime_dependency 'require_all', '~> 3.0.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
-  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'webmock', '~> 3.14'
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   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 'rake-release', '~> 1.3'
+  s.add_development_dependency 'pry', '~> 0.14'
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(sample-apps)/})

data/lib/hubspot/client.rb

@@ -0,0 +1,32 @@
+require_relative 'discovery/base_module_client'
+
+module Hubspot
+  class Client
+    include Hubspot::Discovery::BaseModuleClient
+
+    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?
+      super
+    end
+
+    def api_modules
+      %i[
+        automation
+        cms
+        communication_preferences
+        conversations
+        crm
+        events
+        files
+        marketing
+        o_auth
+        settings
+        webhooks
+      ].freeze
+    end
+
+    def base_module
+      'Hubspot::Discovery'
+    end
+  end
+end

data/lib/hubspot/codegen/automation/actions/api_error.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 module Hubspot
   module Automation
     module Actions
-      class ApiError < StandardError
+      class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 
         # Usage examples:

data/lib/hubspot/codegen/cms/audit-logs/api_error.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 module Hubspot
   module Cms
     module AuditLogs
-      class ApiError < StandardError
+      class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 
         # Usage examples: