hubspot-api-client 13.0.0 → 16.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f008ac88a61c76cec04ee11d2230e1f1278aaa5ed5b478116158380d050bfe00
-  data.tar.gz: 8ed33bc9aceb5fe322d3e6479588b39eeb2319353e2a62f035bb81e5f94fb47f
+  metadata.gz: 52e4c8fb1abbce80746a0ba2d1a512e7f2402f42ddfa4330ed8a334e9798e6bc
+  data.tar.gz: 79f9c68a85531802bf73e1c9cf50095a4561ced51194882d5c57588d2470ca72
 SHA512:
-  metadata.gz: be9db5880ec10d6370d00682d0b5d6cd15be21adf1bd50da91af226d08d5cf1834d3be51ed845e508f674d67b4973ef7b9c5ba23deab4bdac7b57b673d4f0a92
-  data.tar.gz: 9cd45ee4f8c2a1f604ec8101e07a0f48231eee4436aa5d650e1689648537a1769907738ca66afd5243b13e0989a9e8130ce68c724d87f4b4e84693a9077b7244
+  metadata.gz: c0d326e50bdddb2939422730caef3e4dc3036db7bdd2230c30f5c05e43f7f817506440e50f2da437ea8b09ef9b7e83ae10db6775a5830405ec8187e2626917a1
+  data.tar.gz: de8e1f260e0a1405608eeaab382c8b5b67c7e8d2a6a804c111b4bfdc71019ed56cd87925c507f9abf8b8ea7aced0bdb6d9ca96fa6c0e78b74a3a0100d7432a8a

data/CHANGELOG.md

@@ -5,6 +5,151 @@ 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).
 
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v16.4.0...HEAD)
+
+## [16.4.0] - 2023-03-02
+### Added
+
+- Update models for `crm.properties` API client
+
+## [16.3.0] - 2023-02-21
+### Added
+
+- `crm.associations.v4` API client
+
+### Fixed
+
+- Fix `auth.oauth.refresh_tokens_api.archive_refresh_token` method
+
+
+## [16.2.1] - 2023-01-24
+### Fixed
+
+- Added missing modules
+
+
+## [16.2.0] - 2023-01-09
+### Added
+
+- Signature's util 'HubSpot.utils.signature'
+
+### Deprecated
+
+- webhook's util 'HubSpot.utils.webhooks'
+
+## [16.1.1] - 2022-12-23
+### Fixed
+
+- Added pipelineAuditsApi and pipelineStageAuditsApi to crm.pipelines discovery
+
+## [16.1.0] - 2022-12-22
+### Added
+
+- crm.objects.postal_mail API client
+
+## [16.0.4] - 2022-12-08
+### Changed
+
+- Added Private App access token to (
+    - cms.domains
+    - crm.imports
+    - crm.objects.emails
+    - marketing.events
+    )
+
+### Fixed
+
+- Fix all association APIs
+
+## [16.0.3] - 2022-11-23
+### Changed
+
+- auth_names => debug_auth_names
+
+## [16.0.2] - 2022-11-22
+### Fixed
+
+- added missing public_object_api classes
+
+## [16.0.1] - 2022-11-16
+### Fixed
+
+- remove passing params with snake case
+
+## [16.0.0] - 2022-11-10
+### Changed
+
+- update generated code
+- marketing.events (breaking changes)
+
+## [15.0.2] - 2022-11-04
+### Fixed
+
+- pass params with snake case
+
+## [15.0.1] - 2022-10-17
+### Fixed
+
+- codegen path mapping for requiring models
+
+## [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)
 

data/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :development, :test do
   gem 'rake', '~> 12.3.3'
+  gem 'openssl'
 end

data/Gemfile.lock

@@ -1,17 +1,16 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (13.0.0)
+    hubspot-api-client (16.4.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.8.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)
@@ -19,39 +18,39 @@ GEM
     coderay (1.1.3)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    ethon (0.15.0)
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
     hashdiff (1.0.1)
     json (2.6.2)
     method_source (1.0.0)
+    openssl (3.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
+    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)
     rexml (3.2.5)
-    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)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
-    webmock (3.14.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -64,12 +63,13 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   hubspot-api-client!
-  pry
+  openssl
+  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 (~> 3.14)
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

data/README.md

@@ -20,21 +20,7 @@ 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|
-  config.access_token = 'your_access_token'
-end
 
-# Get contacts
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-basic_api.get_page(auth_names: 'oauth2')
-```
-
-for new discovery classes since version 11.2
 ```ruby
 # Load the gem
 require 'hubspot-api-client'
@@ -48,15 +34,13 @@ contacts = client.crm.contacts.basic_api.get_page
 
 ### Usage
 
-### Get all:
-get_all method is available for all major objects (Companies, Contacts, Deals, LineItems, Products, Quotes & Tickets) and works like
+#### Hapikey support:
 
-```ruby
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-all_contacts = basic_api.get_all(auth_names: 'oauth2')
-```
+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 objects (Companies, Contacts, Deals and etc).
 
-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
@@ -66,29 +50,60 @@ You'll need to create a [private app](https://developers.hubspot.com/docs/api/pr
 
 Please note that pagination is used under the hood to get all results.
 
+## Search:
+`do_search` method is available for all objects (Companies, Contacts, Deals and etc).
+
+Only 3 `FilterGroups` with max 3 `Filters` are supported.
+
+### Example search by date
+```ruby
+require 'hubspot-api-client'
+require 'date'
+
+api_client = Hubspot::Client.new(access_token: "YOUR_ACCESS_TOKEN")
+# timestamp in milliseconds
+timestamp = (DateTime.parse("XXXX-XX-XXTXX:XX:XX.XXXZ").to_time.to_f * 1000).to_i.to_s
+body = {
+  "filterGroups":
+    [
+      {
+        "filters":[
+          {
+            "value": timestamp,
+            "propertyName":"lastmodifieddate",
+            "operator":"EQ"
+          }
+        ]
+      }
+    ]
+}
+api_response = api_client.crm.contacts.search_api.do_search(
+  body: body
+)
+puts api_response
+```
 
 ### Crm Object Schemas client usage:
 
 #### Creation
 
 ```ruby
-config = ::Hubspot::Crm::Schemas::Configuration.new do |config|
-  config.access_token = 'your_access_token'
-end
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
 
-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')
+labels = {
+  singular: 'My object',
+  plural: 'My objects'
+}
 
-option = ::Hubspot::Crm::Schemas::OptionInput.new(
+option = {
   label: 'Option A',
   value: 'A',
   description: 'Choice number one',
   display_order: 1,
   hidden: false
-)
+}
 
-property = ::Hubspot::Crm::Schemas::ObjectTypePropertyCreate.new(
+property = {
   name: 'property001',
   label: 'My object property',
   group_name: 'my_object_information',
@@ -96,9 +111,9 @@ property = ::Hubspot::Crm::Schemas::ObjectTypePropertyCreate.new(
   display_order: 2,
   type: 'enumeration',
   field_type: 'select'
-)
+}
 
-object_schema_egg = ::Hubspot::Crm::Schemas::ObjectSchemaEgg.new(
+body = {
   labels: labels,
   required_properties: ['property001'],
   searchable_properties: [],
@@ -107,38 +122,44 @@ object_schema_egg = ::Hubspot::Crm::Schemas::ObjectSchemaEgg.new(
   properties: [property],
   associated_objects: ['CONTACT'],
   name: 'my_object'
-)
+}
 
-api_response = api.create(object_schema_egg)
+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,11 +11,10 @@ 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'
@@ -23,8 +22,8 @@ Gem::Specification.new do |s|
   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.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

@@ -1,10 +1,15 @@
-require_rel 'discovery'
+require_relative 'discovery/base_module_client'
 
 module Hubspot
   class Client
-    attr_reader :api_key, :access_token
+    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 self.api_modules
+    def api_modules
       %i[
         automation
         cms
@@ -20,33 +25,8 @@ module Hubspot
       ].freeze
     end
 
-    include Hubspot::Discovery::BaseModuleClient
-
-    private
-
-    def self.base_module
+    def 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/callbacks_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v4
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -61,21 +61,25 @@ module Hubspot
           # HTTP header 'Accept' (if needed)
           header_params['Accept'] = @api_client.select_header_accept(['*/*'])
           # HTTP header 'Content-Type'
-          header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
 
           # form parameters
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(callback_completion_request) 
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(callback_completion_request)
 
           # return_type
-          return_type = opts[:return_type] 
+          return_type = opts[:debug_return_type]
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+          auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
           new_options = opts.merge(
+            :operation => :"CallbacksApi.complete",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -125,21 +129,25 @@ module Hubspot
           # HTTP header 'Accept' (if needed)
           header_params['Accept'] = @api_client.select_header_accept(['*/*'])
           # HTTP header 'Content-Type'
-          header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
 
           # form parameters
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(batch_input_callback_completion_batch_request) 
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_callback_completion_batch_request)
 
           # return_type
-          return_type = opts[:return_type] 
+          return_type = opts[:debug_return_type]
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+          auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
 
           new_options = opts.merge(
+            :operation => :"CallbacksApi.complete_batch",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,