Class: BaseCRM::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/basecrm.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Instantiate a new BaseCRM API V2 client

Parameters:

  • options (Hash) (defaults to: {}) —

    Client options

Options Hash (options):

  • :access_token (String) —

    Personal access token

  • :base_url (String) — default: https://api.getbase.com —

    Base url for the api

  • :use_agent (String) — default: BaseCRM/v2 Ruby/{Version} —

    Client user agent

  • :timeout (Integer) — default: 30 —

    Request timeout

  • :verbose (Boolean) — default: false —

    Verbose/debug mode

  • :logger (Logger) — default: STDOUT —

    Logged used in verbose mode

Raises:



82
83
84
85
86
87
 
# File 'lib/basecrm.rb', line 82

def initialize(options={})
  @config = Configuration.new(options)
  @config.validate!

  @http_client = HttpClient.new(@config)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



63
64
65
 
# File 'lib/basecrm.rb', line 63

def config
  @config
end

#http_client ⇒ Object (readonly)

Returns the value of attribute http_client.



64
65
66
 
# File 'lib/basecrm.rb', line 64

def http_client
  @http_client
end

Instance Method Details

#accounts ⇒ AccountsService

Access all Accounts related actions.

Returns:

See Also:



94
95
96
 
# File 'lib/basecrm.rb', line 94

def accounts
  @accounts ||= AccountsService.new(@http_client)
end

#associated_contacts ⇒ AssociatedContactsService

Access all AssociatedContacts related actions.

Returns:

See Also:



103
104
105
 
# File 'lib/basecrm.rb', line 103

def associated_contacts
  @associated_contacts ||= AssociatedContactsService.new(@http_client)
end

#contacts ⇒ ContactsService

Access all Contacts related actions.

Returns:

See Also:



112
113
114
 
# File 'lib/basecrm.rb', line 112

def contacts
  @contacts ||= ContactsService.new(@http_client)
end

#deal_sources ⇒ DealSourcesService

Access all DealSources related actions.

Returns:

See Also:



130
131
132
 
# File 'lib/basecrm.rb', line 130

def deal_sources
  @deal_sources ||= DealSourcesService.new(@http_client)
end

#deals ⇒ DealsService

Access all Deals related actions.

Returns:

See Also:



121
122
123
 
# File 'lib/basecrm.rb', line 121

def deals
  @deals ||= DealsService.new(@http_client)
end

#lead_sources ⇒ LeadSourcesService

Access all LeadSources related actions.

Returns:

See Also:



148
149
150
 
# File 'lib/basecrm.rb', line 148

def lead_sources
  @lead_sources ||= LeadSourcesService.new(@http_client)
end

#leads ⇒ LeadsService

Access all Leads related actions.

Returns:

See Also:



139
140
141
 
# File 'lib/basecrm.rb', line 139

def leads
  @leads ||= LeadsService.new(@http_client)
end

#line_items ⇒ LineItemsService

Access all LineItems related actions.

Returns:

See Also:



157
158
159
 
# File 'lib/basecrm.rb', line 157

def line_items
  @line_items ||= LineItemsService.new(@http_client)
end

#loss_reasons ⇒ LossReasonsService

Access all LossReasons related actions.

Returns:

See Also:



166
167
168
 
# File 'lib/basecrm.rb', line 166

def loss_reasons
  @loss_reasons ||= LossReasonsService.new(@http_client)
end

#notes ⇒ NotesService

Access all Notes related actions.

Returns:

See Also:



175
176
177
 
# File 'lib/basecrm.rb', line 175

def notes
  @notes ||= NotesService.new(@http_client)
end

#orders ⇒ OrdersService

Access all Orders related actions.

Returns:

See Also:



184
185
186
 
# File 'lib/basecrm.rb', line 184

def orders
  @orders ||= OrdersService.new(@http_client)
end

#pipelines ⇒ PipelinesService

Access all Pipelines related actions.

Returns:

See Also:



193
194
195
 
# File 'lib/basecrm.rb', line 193

def pipelines
  @pipelines ||= PipelinesService.new(@http_client)
end

#products ⇒ ProductsService

Access all Products related actions.

Returns:

See Also:



202
203
204
 
# File 'lib/basecrm.rb', line 202

def products
  @products ||= ProductsService.new(@http_client)
end

#sources ⇒ SourcesService

Access all Sources related actions.

Returns:

See Also:



211
212
213
 
# File 'lib/basecrm.rb', line 211

def sources
  @sources ||= SourcesService.new(@http_client)
end

#stages ⇒ StagesService

Access all Stages related actions.

Returns:

See Also:



220
221
222
 
# File 'lib/basecrm.rb', line 220

def stages
  @stages ||= StagesService.new(@http_client)
end

#sync ⇒ SyncService

Access Sync API related low-level actions.

Returns:

See Also:



255
256
257
 
# File 'lib/basecrm.rb', line 255

def sync
  @sync ||= SyncService.new(@http_client)
end

#tags ⇒ TagsService

Access all Tags related actions.

Returns:

See Also:



229
230
231
 
# File 'lib/basecrm.rb', line 229

def tags
  @tags ||= TagsService.new(@http_client)
end

#tasks ⇒ TasksService

Access all Tasks related actions.

Returns:

See Also:



238
239
240
 
# File 'lib/basecrm.rb', line 238

def tasks
  @tasks ||= TasksService.new(@http_client)
end

#users ⇒ UsersService

Access all Users related actions.

Returns:

See Also:



247
248
249
 
# File 'lib/basecrm.rb', line 247

def users
  @users ||= UsersService.new(@http_client)
end