hubspot-api-ruby 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45060ea19bf32fc857cbeb5d0a043b5c2c9668197ac25a518da74ecee2522e05
-  data.tar.gz: 68dfbf022d1580f26f51a7688151e8fc21c590e812e18b5b21475de9def30930
+  metadata.gz: d3d7600de11889f3e5dfe562ccec90bb6c1edd20b866c972e35ae11c1ce3bacf
+  data.tar.gz: 65698aa080bdb71c8c0e05436cd36af6981b3f1d8c79de9e7e95c32888b9e252
 SHA512:
-  metadata.gz: 413df289081df3767598dc9c5c542dfa4c5e729adf55d79631d101ff905440590cdcc8c532531e62d728940d624941a41031b584eb642e245b4990e7fdd1b268
-  data.tar.gz: 66f6e52964908bd067b9c43fc3a0f82b75328d4fb3588acf5c84f5ebe50660228ad3736a4ebb0f94dc4444619e011eaebd3d3e93afc3a63dc1ad072d4a762a7b
+  metadata.gz: 49597d6095f36055416f3610e5e7b1059a6f08829b9e3a9c248b753f2ad133d31087edcb6c86f5100cd66bb939d33b8ea1c9fab321012a8a9c5394b3c7ec9368
+  data.tar.gz: 6ebf057a56f6d2d643c2582d96f7f8fd8002cfe7088a72d0bec190dc62e06961470f04b18121d87f2d0b42abe3f2bda6821a63294590e1d536be412b0cd6c472

data/hubspot-api-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.19.0"
+  s.version = "0.21.0"
   s.require_paths = ["lib"]
   s.authors = ["Jonathan"]
   s.email = ["jonathan@hoggo.com"]

data/lib/hubspot/association.rb

@@ -6,29 +6,30 @@ class Hubspot::Association
   }.freeze
 
   ASSOCIATION_DEFINITIONS = {
+    "Contact" => {
+      "Deal" => 4
+    },
     "Company" => {
       "Contact" => 2,
-      "Deal" => 6,
-      "Company" => 13
+      "Company" => 13,
+      "Deal" => 6
     },
     "Deal" => {
-      "Company" => 5,
-      "Contact" => 3
+      "Contact" => 3,
+      "Company" => 5
     },
-    "Contact" => {
-      "Deal" => 4
+    "Task" => {
+      "Contact" => 204,
+      "Company" => 192,
+      "Deal" => 216,
+      "Ticket" => 230
     },
     "Ticket" => {
       "Contact" => 16,
-      "Deal" => 28,
+      "Conversation" => 32,
       "Company" => 339,
+      "Deal" => 28,
       "Task" => 229
-    },
-    "Task" => {
-      "Contact" => 204,
-      "Deal" => 216,
-      "Company" => 192,
-      "Ticket" => 230
     }
   }.freeze
 

data/lib/hubspot/conversation_thread.rb

@@ -0,0 +1,27 @@
+require 'hubspot/utils'
+
+module Hubspot
+  #
+  # HubSpot Tasks API
+  #
+  # {https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages}
+  #
+  class ConversationThread
+    THREAD_PATH = '/conversations/v3/conversations/threads/:thread_id'
+
+    attr_reader :properties, :id
+
+    def initialize(response_hash)
+      @id = response_hash['id']
+      @properties = response_hash.deep_symbolize_keys
+    end
+
+    class << self
+      def find(thread_id, with_associations: false)
+        association = with_associations ? ['TICKET'] : []
+        response = Hubspot::Connection.get_json(THREAD_PATH, thread_id:, association:)
+        new(response)
+      end
+    end
+  end
+end

data/lib/hubspot/owner.rb

@@ -2,24 +2,21 @@ module Hubspot
   #
   # HubSpot Owners API
   #
-  # {http://developers.hubspot.com/docs/methods/owners/get_owners}
+  # {https://developers.hubspot.com/docs/reference/api/crm/owners/v3}
+  #
   #
-  # TODO: Create an Owner
-  # TODO: Update an Owner
-  # TODO: Delete an Owner
   class Owner
-    GET_OWNER_PATH    = '/owners/v2/owners/:owner_id' # GET
-    GET_OWNERS_PATH   = '/owners/v2/owners' # GET
-    CREATE_OWNER_PATH = '/owners/v2/owners' # POST
-    UPDATE_OWNER_PATH = '/owners/v2/owners/:owner_id' # PUT
-    DELETE_OWNER_PATH = '/owners/v2/owners/:owner_id' # DELETE
-
+    GET_OWNER_PATH    = '/crm/v3/owners/:owner_id' # GET
+    GET_OWNERS_PATH   = '/crm/v3/owners' # GET
+    CREATE_OWNER_PATH = "/crm/v3/owners" # POST
+    UPDATE_OWNER_PATH = '/crm/v3/owners/:owner_id' # PUT
+    DELETE_OWNER_PATH = '/crm/v3/owners/:owner_id' # DELETE
 
     attr_reader :properties, :owner_id, :email
 
     def initialize(property_hash)
       @properties = property_hash
-      @owner_id   = @properties['ownerId']
+      @owner_id   = @properties['id']
       @email      = @properties['email']
     end
 
@@ -28,29 +25,46 @@ module Hubspot
     end
 
     class << self
-      def all(include_inactive=false)
-        path     = GET_OWNERS_PATH
-        params   = { includeInactive: include_inactive }
+      def all(include_archived: false, limit: 100, after: nil)
+        path = GET_OWNERS_PATH
+        params = {
+          archived: include_archived,
+          limit: limit,
+          after: after
+        }.compact
+
         response = Hubspot::Connection.get_json(path, params)
-        response.map { |r| new(r) }
+        {
+          results: response['results'].map { |r| new(r) },
+          pagination: {
+            next: response['paging']&.dig('next', 'after'),
+            total: response['total']
+          }
+        }
       end
 
-      def find(id, include_inactive=false)
-        path     = GET_OWNER_PATH
-        response = Hubspot::Connection.get_json(path, owner_id: id,
-          include_inactive: include_inactive)
+      def find(id, id_property: nil)
+        path = GET_OWNER_PATH
+        params = { owner_id: id }
+        params[:idProperty] = id_property if id_property
+        response = Hubspot::Connection.get_json(path, params)
         new(response)
       end
 
-      def find_by_email(email, include_inactive=false)
-        path     = GET_OWNERS_PATH
-        params   = { email: email, includeInactive: include_inactive }
+      def find_by_email(email, include_archived: false, limit: 100, after: nil)
+        path = GET_OWNERS_PATH
+        params = {
+          email: email,
+          archived: include_archived,
+          limit: limit,
+          after: after
+        }.compact
         response = Hubspot::Connection.get_json(path, params)
-        response.blank? ? nil : new(response.first)
+        response['results'].blank? ? nil : new(response['results'].first)
       end
 
-      def find_by_emails(emails, include_inactive=false)
-        emails.map { |email| find_by_email(email, include_inactive) }.reject(&:blank?)
+      def find_by_emails(emails = [], include_archived: false)
+        emails.map { |email| find_by_email(email, include_archived: include_archived) }.reject(&:nil?)
       end
     end
   end

data/lib/hubspot-api-ruby.rb

@@ -32,6 +32,7 @@ require 'hubspot/meeting'
 require 'hubspot/ticket'
 require 'hubspot/ticket_properties'
 require 'hubspot/task'
+require 'hubspot/conversation_thread'
 
 module Hubspot
   def self.configure(config={})

data/spec/lib/hubspot/conversation_thread_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe Hubspot::ConversationThread do
+  describe 'find' do
+    let(:thread_id) { 3_176_297_853 }
+
+    subject(:existing_thread) { described_class.find(thread_id, with_associations: true) }
+
+    it 'gets existing conversation thread' do
+      VCR.use_cassette 'conversation_thread_find' do
+        expect(existing_thread.id).not_to be_nil
+        expect(existing_thread.properties[:status]).to eq('OPEN')
+        expect(existing_thread.properties[:threadAssociations]).to eq(associatedTicketId: '21514722825')
+      end
+    end
+
+    context 'when task does not exist' do
+      let(:thread_id) { 996_174_569_112 }
+
+      it 'raises an error' do
+        VCR.use_cassette 'conversation_thread_find' do
+          expect { existing_thread }.to raise_error Hubspot::NotFoundError
+        end
+      end
+    end
+  end
+end

data/spec/lib/hubspot/owner_spec.rb

@@ -2,7 +2,7 @@ describe Hubspot::Owner do
   let(:example_owners) do
     VCR.use_cassette('owner_example') do
       headers = { Authorization: "Bearer #{ENV.fetch('HUBSPOT_ACCESS_TOKEN')}" }
-      HTTParty.get('https://api.hubapi.com/owners/v2/owners', headers: headers).parsed_response
+      HTTParty.get('https://api.hubapi.com/crm/v3/owners', headers: headers).parsed_response['results']
     end
   end
 
@@ -13,7 +13,22 @@ describe Hubspot::Owner do
       owners = Hubspot::Owner.all
 
       expect(owners.blank?).to be false
-      compare_owners(owners, example_owners)
+      expect(owners[:results].blank?).to be false
+      compare_owners(owners[:results], example_owners)
+    end
+  end
+
+  describe '.find' do
+    cassette 'owner_find_by_id'
+
+    let(:sample) { example_owners.first }
+    let(:id) { sample['id'] }
+
+    it 'should find a user via their id' do
+      owner = Hubspot::Owner.find(id)
+      sample.map do |key, val|
+        expect(owner[key]).to eq(val)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Jonathan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -274,6 +274,7 @@ files:
 - lib/hubspot/contact.rb
 - lib/hubspot/contact_list.rb
 - lib/hubspot/contact_properties.rb
+- lib/hubspot/conversation_thread.rb
 - lib/hubspot/custom_event.rb
 - lib/hubspot/deal.rb
 - lib/hubspot/deal_pipeline.rb
@@ -309,6 +310,7 @@ files:
 - spec/lib/hubspot/contact_list_spec.rb
 - spec/lib/hubspot/contact_properties_spec.rb
 - spec/lib/hubspot/contact_spec.rb
+- spec/lib/hubspot/conversation_thread_spec.rb
 - spec/lib/hubspot/custom_event_spec.rb
 - spec/lib/hubspot/deal_pipeline_spec.rb
 - spec/lib/hubspot/deal_properties_spec.rb