hubspot-api-client 11.1.0 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b00d4159c770613a072936042edb28525d928740dbbd0c7c72e588fea1fa216
-  data.tar.gz: 2da33f4c672c0978c6404af0991acff0265e0ef508fe2afae50c16078aa59008
+  metadata.gz: 258c55c06d2bb92967ba618919065c527f886d5066f771fae9cd40bde1f7999e
+  data.tar.gz: deb1a80f49da296b0ea65e5bbdd8736f8568167808974db91dbfbbb4b62f8e5e
 SHA512:
-  metadata.gz: ebc91f661b95f4370aac0996053bf0f6a7a4fd519cdfde832a03acc1ccec084605b12776664f9f1c3f09891fe458fb8b7cb65ca65abc25cb49e5dd0c397f7d71
-  data.tar.gz: 064f15d336b041c3d52edeae05c2505b8b82d301278e949f96579eec854932ee63dc983384f015b01a9c14989be0f7f5725f530d5d81e2015c484d0407590162
+  metadata.gz: 1551a766599640bfef6efc93bb4709c9c0af1d96949787e539b02c130aa744cf4c03d09600668faccc6da656faa324eb5422f5deb71dc5d97f71a5de143cfab6
+  data.tar.gz: c111b2335a6e5b938d3ca0844f4185d2c1637c9b36856ee49e42bb2d6131521e758ecaf2ffac6e91232f692cb540e21a86579f4c57fbc5d161d4623ee5621238

data/CHANGELOG.md

@@ -5,6 +5,61 @@ 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).
 
+## [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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (11.1.0)
+    hubspot-api-client (14.1.0)
       json (~> 2.1, >= 2.1.0)
       require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
@@ -9,45 +9,52 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.12.0)
-    addressable (2.7.0)
+    ZenTest (4.12.1)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.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 (4.0.7)
     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.0)
       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.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
+    webmock (3.17.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -57,11 +64,12 @@ 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)
   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

@@ -26,18 +26,32 @@ require 'hubspot-api-client'
 
 # Setup authorization
 Hubspot.configure do |config|
-  # Configure API key authorization: hapikey
-  config.api_key['hapikey'] = 'demo'
+  config.access_token = 'your_access_token'
 end
 
 # Get contacts
 basic_api = Hubspot::Crm::Contacts::BasicApi.new
-basic_api.get_page(auth_names: 'hapikey')
+basic_api.get_page(auth_names: 'oauth2')
+```
+
+for new discovery classes since version 11.2
+```ruby
+# Load the gem
+require 'hubspot-api-client'
 
+# Setup client
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+# Get contacts
+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
 
@@ -45,6 +59,15 @@ 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.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.
 
 
@@ -54,38 +77,43 @@ Please note that pagination is used under the hood to get all results.
 
 ```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)
+  config.access_token = 'your_access_token'
+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)
 ```
 
 
@@ -113,8 +141,6 @@ end
 
 api_client = ::Hubspot::Crm::Companies::ApiClient.new(config)
 basic_api = ::Hubspot::Crm::Companies::BasicApi.new(api_client)
-end
-
 ```
 
 ### Sample apps

data/hubspot-api-client.gemspec

@@ -11,7 +11,7 @@ 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'
@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
 
   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 '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,52 @@
+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
+        settings
+        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/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: