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:



86
87
88
89
90
91
 
# File 'lib/basecrm.rb', line 86

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.



67
68
69
 
# File 'lib/basecrm.rb', line 67

def config
  @config
end

#http_client ⇒ Object (readonly)

Returns the value of attribute http_client.



68
69
70
 
# File 'lib/basecrm.rb', line 68

def http_client
  @http_client
end

Instance Method Details

#accounts ⇒ AccountsService

Access all Accounts related actions.

Returns:

See Also:



98
99
100
 
# File 'lib/basecrm.rb', line 98

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

#associated_contacts ⇒ AssociatedContactsService

Access all AssociatedContacts related actions.

Returns:

See Also:



107
108
109
 
# File 'lib/basecrm.rb', line 107

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

#contacts ⇒ ContactsService

Access all Contacts related actions.

Returns:

See Also:



116
117
118
 
# File 'lib/basecrm.rb', line 116

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

#deal_sources ⇒ DealSourcesService

Access all DealSources related actions.

Returns:

See Also:



134
135
136
 
# File 'lib/basecrm.rb', line 134

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

#deal_unqualified_reasons ⇒ DealUnqualifiedReasonsService

Access all DealUnqualifiedReasons related actions.

Returns:

See Also:



143
144
145
 
# File 'lib/basecrm.rb', line 143

def deal_unqualified_reasons
  @deal_unqualified_reasons ||= DealUnqualifiedReasonsService.new(@http_client)
end

#deals ⇒ DealsService

Access all Deals related actions.

Returns:

See Also:



125
126
127
 
# File 'lib/basecrm.rb', line 125

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

#lead_sources ⇒ LeadSourcesService

Access all LeadSources related actions.

Returns:

See Also:



161
162
163
 
# File 'lib/basecrm.rb', line 161

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

#lead_unqualified_reasons ⇒ LeadUnqualifiedReasonsService

Access all LeadUnqualifiedReasons related actions.

Returns:

See Also:



170
171
172
 
# File 'lib/basecrm.rb', line 170

def lead_unqualified_reasons
  @lead_unqualified_reasons ||= LeadUnqualifiedReasonsService.new(@http_client)
end

#leads ⇒ LeadsService

Access all Leads related actions.

Returns:

See Also:



152
153
154
 
# File 'lib/basecrm.rb', line 152

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

#line_items ⇒ LineItemsService

Access all LineItems related actions.

Returns:

See Also:



179
180
181
 
# File 'lib/basecrm.rb', line 179

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

#loss_reasons ⇒ LossReasonsService

Access all LossReasons related actions.

Returns:

See Also:



188
189
190
 
# File 'lib/basecrm.rb', line 188

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

#notes ⇒ NotesService

Access all Notes related actions.

Returns:

See Also:



197
198
199
 
# File 'lib/basecrm.rb', line 197

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

#orders ⇒ OrdersService

Access all Orders related actions.

Returns:

See Also:



206
207
208
 
# File 'lib/basecrm.rb', line 206

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

#pipelines ⇒ PipelinesService

Access all Pipelines related actions.

Returns:

See Also:



215
216
217
 
# File 'lib/basecrm.rb', line 215

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

#products ⇒ ProductsService

Access all Products related actions.

Returns:

See Also:



224
225
226
 
# File 'lib/basecrm.rb', line 224

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

#sources ⇒ SourcesService

Access all Sources related actions.

Returns:

See Also:



233
234
235
 
# File 'lib/basecrm.rb', line 233

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

#stages ⇒ StagesService

Access all Stages related actions.

Returns:

See Also:



242
243
244
 
# File 'lib/basecrm.rb', line 242

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

#sync ⇒ SyncService

Access Sync API related low-level actions.

Returns:

See Also:



277
278
279
 
# File 'lib/basecrm.rb', line 277

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

#tags ⇒ TagsService

Access all Tags related actions.

Returns:

See Also:



251
252
253
 
# File 'lib/basecrm.rb', line 251

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

#tasks ⇒ TasksService

Access all Tasks related actions.

Returns:

See Also:



260
261
262
 
# File 'lib/basecrm.rb', line 260

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

#users ⇒ UsersService

Access all Users related actions.

Returns:

See Also:



269
270
271
 
# File 'lib/basecrm.rb', line 269

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