Class: BundleUp::Unify::CRM

Inherits:
Base
  • Object
show all
Defined in:
lib/bundleup/unify/crm.rb,
sig/bundleup/unify/crm.rbs

Overview

Client for CRM-related Unify endpoints.

Constant Summary

Constants inherited from Base

Base::API_VERSION, Base::BASE_URL

Instance Attribute Summary

Attributes inherited from Base

#api_key, #connection_id

Instance Method Summary collapse

Methods inherited from Base

#connection, #initialize

Constructor Details

This class inherits a constructor from BundleUp::Unify::Base

Instance Method Details

#companies(params = {}) ⇒ { data: Array[crm_company], metadata: metadata }

Fetches companies from the connected CRM provider.

Parameters:

  • params (Hash[Symbol, untyped]) (defaults to: {})

Returns:

  • ({ data: Array[crm_company], metadata: metadata }) 


8
9
10
11
12
13
14
15
16
 
# File 'lib/bundleup/unify/crm.rb', line 8

def companies(params = {})
  response = connection.get('crm/companies') do |req|
    req.params = params
  end

  raise "Failed to fetch crm/companies: #{response.status}" unless response.success?

  response.body
end

#contacts(params = {}) ⇒ { data: Array[crm_contact], metadata: metadata }

Fetches contacts from the connected CRM provider.

Parameters:

  • params (Hash[Symbol, untyped]) (defaults to: {})

Returns:

  • ({ data: Array[crm_contact], metadata: metadata }) 


19
20
21
22
23
24
25
26
27
 
# File 'lib/bundleup/unify/crm.rb', line 19

def contacts(params = {})
  response = connection.get('crm/contacts') do |req|
    req.params = params
  end

  raise "Failed to fetch crm/contacts: #{response.status}" unless response.success?

  response.body
end