Class: Carbon::CRMApi

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/api/crm_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CRMApi

Returns a new instance of CRMApi.



15
16
17
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#get_account(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Account

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



26
27
28
29
30
31
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 26

def (id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  api_response = (id, data_source_id, extra)
  api_response.data
end

#get_account_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Account

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



40
41
42
43
44
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 40

def (id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  (id, data_source_id, extra)
end

#get_accounts(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Accounts

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (AccountFilters) (defaults to: SENTINEL)
  • order_by (AccountsOrderByNullable) (defaults to: SENTINEL)
  • body (AccountsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 133

def get_accounts(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  accounts_request = _body
  api_response = get_accounts_with_http_info_impl(accounts_request, extra)
  api_response.data
end

#get_accounts_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Accounts

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (AccountFilters) (defaults to: SENTINEL)
  • order_by (AccountsOrderByNullable) (defaults to: SENTINEL)
  • body (AccountsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 160

def get_accounts_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  accounts_request = _body
  get_accounts_with_http_info_impl(accounts_request, extra)
end

#get_contact(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Contact

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



248
249
250
251
252
253
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 248

def get_contact(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  api_response = get_contact_with_http_info_impl(id, data_source_id, extra)
  api_response.data
end

#get_contact_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Contact

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



262
263
264
265
266
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 262

def get_contact_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  get_contact_with_http_info_impl(id, data_source_id, extra)
end

#get_contacts(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Contacts

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (ContactFilters) (defaults to: SENTINEL)
  • order_by (ContactsOrderByNullable) (defaults to: SENTINEL)
  • body (ContactsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 355

def get_contacts(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  contacts_request = _body
  api_response = get_contacts_with_http_info_impl(contacts_request, extra)
  api_response.data
end

#get_contacts_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Contacts

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (ContactFilters) (defaults to: SENTINEL)
  • order_by (ContactsOrderByNullable) (defaults to: SENTINEL)
  • body (ContactsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 382

def get_contacts_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  contacts_request = _body
  get_contacts_with_http_info_impl(contacts_request, extra)
end

#get_lead(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Lead

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



470
471
472
473
474
475
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 470

def get_lead(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  api_response = get_lead_with_http_info_impl(id, data_source_id, extra)
  api_response.data
end

#get_lead_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Lead

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



484
485
486
487
488
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 484

def get_lead_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  get_lead_with_http_info_impl(id, data_source_id, extra)
end

#get_leads(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Leads

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (LeadFilters) (defaults to: SENTINEL)
  • order_by (LeadsOrderByNullable) (defaults to: SENTINEL)
  • body (LeadsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 577

def get_leads(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  leads_request = _body
  api_response = get_leads_with_http_info_impl(leads_request, extra)
  api_response.data
end

#get_leads_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Leads

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (LeadFilters) (defaults to: SENTINEL)
  • order_by (LeadsOrderByNullable) (defaults to: SENTINEL)
  • body (LeadsRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 604

def get_leads_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  leads_request = _body
  get_leads_with_http_info_impl(leads_request, extra)
end

#get_opportunities(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Opportunities

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (OpportunityFilters) (defaults to: SENTINEL)
  • order_by (OpportunitiesOrderByNullable) (defaults to: SENTINEL)
  • body (OpportunitiesRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 697

def get_opportunities(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  opportunities_request = _body
  api_response = get_opportunities_with_http_info_impl(opportunities_request, extra)
  api_response.data
end

#get_opportunities_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {}) ⇒ Object

Get Opportunities

Parameters:

  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • next_cursor (String) (defaults to: SENTINEL)
  • page_size (Integer) (defaults to: SENTINEL)
  • order_dir (OrderDirV2Nullable) (defaults to: 'asc')
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • filters (OpportunityFilters) (defaults to: SENTINEL)
  • order_by (OpportunitiesOrderByNullable) (defaults to: SENTINEL)
  • body (OpportunitiesRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 724

def get_opportunities_with_http_info(data_source_id:, include_remote_data: false, next_cursor: SENTINEL, page_size: SENTINEL, order_dir: 'asc', includes: SENTINEL, filters: SENTINEL, order_by: SENTINEL, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  _body[:next_cursor] = next_cursor if next_cursor != SENTINEL
  _body[:page_size] = page_size if page_size != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:includes] = includes if includes != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  opportunities_request = _body
  get_opportunities_with_http_info_impl(opportunities_request, extra)
end

#get_opportunity(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Opportunity

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



812
813
814
815
816
817
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 812

def get_opportunity(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  api_response = get_opportunity_with_http_info_impl(id, data_source_id, extra)
  api_response.data
end

#get_opportunity_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {}) ⇒ Object

Get Opportunity

Parameters:

  • id (String)
  • data_source_id (Integer)
  • include_remote_data (Boolean) (defaults to: false)
  • includes (Array<BaseIncludes>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



826
827
828
829
830
 
# File 'lib/carbon_ruby_sdk/api/crm_api.rb', line 826

def get_opportunity_with_http_info(id:, data_source_id:, include_remote_data: false, includes: SENTINEL, extra: {})
  extra[:include_remote_data] = include_remote_data if include_remote_data != SENTINEL
  extra[:includes] = includes if includes != SENTINEL
  get_opportunity_with_http_info_impl(id, data_source_id, extra)
end