hubspot-api-client 17.1.1 → 17.2.0

data/lib/hubspot/discovery/crm/objects/goals/api/search_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Goals
+          class SearchApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/goals/client.rb

@@ -0,0 +1,25 @@
+require_relative '../../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Goals
+          class Client
+            include Hubspot::Discovery::BaseModuleClient
+
+            def api_classes
+              %i[
+                basic
+                batch
+                gdpr
+                public_object
+                search
+              ].freeze
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/api/basic_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class BasicApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/api/batch_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class BatchApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/api/gdpr_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class GdprApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/api/public_object_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class PublicObjectApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/api/search_api.rb

@@ -0,0 +1,15 @@
+require_relative '../../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class SearchApi
+            include Hubspot::Discovery::BaseApiClient
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/crm/objects/taxes/client.rb

@@ -0,0 +1,25 @@
+require_relative '../../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Crm
+      module Objects
+        module Taxes
+          class Client
+            include Hubspot::Discovery::BaseModuleClient
+
+            def api_classes
+              %i[
+                basic
+                batch
+                gdpr
+                public_object
+                search
+              ].freeze
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,12 @@ module Hubspot
     module Events
       class Client
         include Hubspot::Discovery::BaseModuleClient
+        
+        def api_modules
+          %i[
+            send
+          ].freeze
+        end
 
         def api_classes
           %i[

data/lib/hubspot/discovery/events/send/api/behavioral_events_tracking_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Events
+      module Send
+        class BehavioralEventsTrackingApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/events/send/client.rb

@@ -0,0 +1,19 @@
+require_relative '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Events
+      module Send
+        class Client
+          include Hubspot::Discovery::BaseModuleClient
+
+          def api_classes
+            %i[
+              behavioral_events_tracking
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/business_units/api/business_unit_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module BusinessUnits
+        class BusinessUnitApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/business_units/client.rb

@@ -0,0 +1,19 @@
+require_relative '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module BusinessUnits
+        class Client
+          include Hubspot::Discovery::BaseModuleClient
+
+          def api_classes
+            %i[
+              business_unit
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Hubspot
 
         def api_modules
           %i[
+            business_units
             users
           ].freeze
         end

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
 module Hubspot
-VERSION = '17.1.1'
+VERSION = '17.2.0'
 end

data/spec/discovery/client_spec.rb

@@ -12,5 +12,6 @@ describe 'Hubspot::Client' do
   it { is_expected.to respond_to(:files) }
   it { is_expected.to respond_to(:marketing) }
   it { is_expected.to respond_to(:oauth) }
+  it { is_expected.to respond_to(:settings) }
   it { is_expected.to respond_to(:webhooks) }
 end

data/spec/discovery/cms/client_spec.rb

@@ -7,6 +7,7 @@ describe 'Hubspot::Client' do
   it { is_expected.to respond_to(:blogs) }
   it { is_expected.to respond_to(:domains) }
   it { is_expected.to respond_to(:hubdb) }
+  it { is_expected.to respond_to(:pages) }
   it { is_expected.to respond_to(:performance) }
   it { is_expected.to respond_to(:site_search) }
   it { is_expected.to respond_to(:url_redirects) }

data/spec/discovery/cms/pages/landing_pages_api_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Pages::LandingPagesApi' do
+  subject(:pages_api) { Hubspot::Client.new(access_token: 'test').cms.pages.landing_pages_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_batch) }
+  it { is_expected.to respond_to(:archive_folder) }
+  it { is_expected.to respond_to(:archive_folders) }
+  it { is_expected.to respond_to(:attach_to_lang_group) }
+  it { is_expected.to respond_to(:clone) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:create_ab_test_variation) }
+  it { is_expected.to respond_to(:create_batch) }
+  it { is_expected.to respond_to(:create_folder) }
+  it { is_expected.to respond_to(:create_folders) }
+  it { is_expected.to respond_to(:create_lang_variation) }
+  it { is_expected.to respond_to(:detach_from_lang_group) }
+  it { is_expected.to respond_to(:end_active_ab_test) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_draft_by_id) }
+  it { is_expected.to respond_to(:get_folder_by_id) }
+  it { is_expected.to respond_to(:get_folder_previous_version) }
+  it { is_expected.to respond_to(:get_folder_previous_versions) }
+  it { is_expected.to respond_to(:get_folders_page) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:get_previous_version) }
+  it { is_expected.to respond_to(:get_previous_versions) }
+  it { is_expected.to respond_to(:push_live) }
+  it { is_expected.to respond_to(:read_batch) }
+  it { is_expected.to respond_to(:read_folders) }
+  it { is_expected.to respond_to(:rerun_previous_ab_test) }
+  it { is_expected.to respond_to(:reset_draft) }
+  it { is_expected.to respond_to(:restore_folder_previous_version) }
+  it { is_expected.to respond_to(:restore_previous_version) }
+  it { is_expected.to respond_to(:restore_previous_version_to_draft) }
+  it { is_expected.to respond_to(:schedule) }
+  it { is_expected.to respond_to(:set_lang_primary) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:update_batch) }
+  it { is_expected.to respond_to(:update_draft) }
+  it { is_expected.to respond_to(:update_folder) }
+  it { is_expected.to respond_to(:update_folders) }
+  it { is_expected.to respond_to(:update_langs) }
+end

data/spec/discovery/cms/pages/site_pages_api_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Pages::SitePagesApi' do
+  subject(:pages_api) { Hubspot::Client.new(access_token: 'test').cms.pages.site_pages_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_batch) }
+  it { is_expected.to respond_to(:attach_to_lang_group) }
+  it { is_expected.to respond_to(:clone) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:create_ab_test_variation) }
+  it { is_expected.to respond_to(:create_batch) }
+  it { is_expected.to respond_to(:create_lang_variation) }
+  it { is_expected.to respond_to(:detach_from_lang_group) }
+  it { is_expected.to respond_to(:end_active_ab_test) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_draft_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:get_previous_version) }
+  it { is_expected.to respond_to(:get_previous_versions) }
+  it { is_expected.to respond_to(:push_live) }
+  it { is_expected.to respond_to(:read_batch) }
+  it { is_expected.to respond_to(:rerun_previous_ab_test) }
+  it { is_expected.to respond_to(:reset_draft) }
+  it { is_expected.to respond_to(:restore_previous_version) }
+  it { is_expected.to respond_to(:restore_previous_version_to_draft) }
+  it { is_expected.to respond_to(:schedule) }
+  it { is_expected.to respond_to(:set_lang_primary) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:update_batch) }
+  it { is_expected.to respond_to(:update_draft) }
+  it { is_expected.to respond_to(:update_langs) }
+end

data/spec/discovery/crm/lists/lists_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Lists::ListsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.lists.lists_api }
+  
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:do_search) }
+  it { is_expected.to respond_to(:get_all) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_by_name) }
+  it { is_expected.to respond_to(:remove) }
+  it { is_expected.to respond_to(:restore) }
+  it { is_expected.to respond_to(:update_list_filters) }
+  it { is_expected.to respond_to(:update_name) }
+end

data/spec/discovery/crm/lists/memberships_api_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Lists::MembershipsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.lists.memberships_api }
+  
+  it { is_expected.to respond_to(:add) }
+  it { is_expected.to respond_to(:add_all_from_list) }
+  it { is_expected.to respond_to(:add_remove) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:remove) }
+  it { is_expected.to respond_to(:remove_all) }
+end

data/spec/discovery/crm/objects/goals/basic_api_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Goals::BasicApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.goals.basic_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:update) }
+end

data/spec/discovery/crm/objects/goals/batch_api_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Goals::BatchApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.goals.batch_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:read) }
+  it { is_expected.to respond_to(:update) }
+end

data/spec/discovery/crm/objects/goals/gdpr_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Goals::GdprApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.goals.gdpr_api }
+  
+  it { is_expected.to respond_to(:purge) }
+end

data/spec/discovery/crm/objects/goals/public_object_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Goals::PublicObjectApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.goals.public_object_api }
+  
+  it { is_expected.to respond_to(:merge) }
+end

data/spec/discovery/crm/objects/goals/search_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Goals::SearchApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.goals.search_api }
+  
+  it { is_expected.to respond_to(:do_search) }
+end

data/spec/discovery/crm/objects/taxes/basic_api_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Taxes::BasicApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.taxes.basic_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:update) }
+end

data/spec/discovery/crm/objects/taxes/batch_api_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Taxes::BatchApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.taxes.batch_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:read) }
+  it { is_expected.to respond_to(:update) }
+end

data/spec/discovery/crm/objects/taxes/gdpr_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Taxes::GdprApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.taxes.gdpr_api }
+  
+  it { is_expected.to respond_to(:purge) }
+end

data/spec/discovery/crm/objects/taxes/public_object_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Taxes::PublicObjectApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.taxes.public_object_api }
+  
+  it { is_expected.to respond_to(:merge) }
+end

data/spec/discovery/crm/objects/taxes/search_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Crm::Objects::Taxes::SearchApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').crm.objects.taxes.search_api }
+  
+  it { is_expected.to respond_to(:do_search) }
+end

data/spec/discovery/events/send/behavioral_events_tracking_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Events::Send::BehavioralEventsTrackingApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').events.send.behavioral_events_tracking_api}
+  
+  it { is_expected.to respond_to(:call_send) }
+end

data/spec/discovery/settings/businnes_units/business_unit_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Settings::BusinessUnits::BusinessUnitApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').settings.business_units.business_unit_api }
+  
+  it { is_expected.to respond_to(:get_by_user_id) }
+end

data/spec/integration/contacts_spec.rb

@@ -0,0 +1,85 @@
+require 'hubspot-api-client'
+require 'rspec'
+
+CONTACT_PROPERTIES = {
+  'email' => 'aRocket@TestCompany.net',
+  'lastname' => 'Rocket',
+  'firstname' => 'Racoon'
+}
+
+RSpec.describe 'Contact Tests' do
+  let(:api_client) { Hubspot::Client.new(access_token: 'pat-na1-d2e7a773-0553-46a5-a96e-f695dbf5c56d') }
+
+  context 'when creating a contact' do
+    it 'creates a contact and archives it' do
+      contact = api_client.crm.contacts.basic_api.create(body: { properties: CONTACT_PROPERTIES })
+      expect(contact).to_not be_nil
+
+      api_client.crm.contacts.basic_api.archive(contact_id: contact.id)
+    end
+  end
+  context 'when creating a company' do
+    it 'creates a company and archives it' do
+      properties = {
+        'domain' => 'TestCompany.net',
+        'name' => 'TestCompany'
+      }
+
+      company = api_client.crm.companies.basic_api.create(body: { properties: properties })
+      expect(company).to_not be_nil
+
+      api_client.crm.companies.basic_api.archive(company_id: company.id)
+    end
+  end
+
+  context 'when getting or creating a contact associated with a company' do
+    it 'retrieves or creates a contact associated with a company' do
+      create_company = api_client.crm.companies.basic_api.create(body: { properties: {
+        'domain' => 'TestCompany.net',
+        'name' => 'TestCompany'
+      }})
+
+      contact = get_or_create_contact_associated_with_company(api_client, create_company)
+      expect(contact).to_not be_nil
+    end
+  end
+
+end
+
+def get_or_create_contact_associated_with_company(api_client, company)
+
+  contact_data = {
+    'associations' => [
+      {
+        'to' => { 'id' => company.id },
+        'types' => [
+          {
+            'associationCategory' => 'HUBSPOT_DEFINED',
+            'associationTypeId' => 1
+          }
+        ]
+      }
+    ],
+    'properties' => CONTACT_PROPERTIES
+  }
+    contact = api_client.crm.contacts.basic_api.get_by_id(contact_id: CONTACT_PROPERTIES['email'], id_property: 'email')
+  # search_response = api_client.crm.contacts.search_api.do_search(public_object_search_request:
+  #   {filterGroups: [
+  #     {
+  #       filters: [
+  #         {
+  #           value: CONTACT_PROPERTIES['email'],
+  #           propertyName: 'email',
+  #           operator: 'EQ'
+  #         }
+  #       ]
+  #     }
+  #   ]}
+  # )
+
+  if contact
+    return contact
+  else
+    return api_client.crm.contacts.basic_api.create(body: contact_data)
+  end
+end