Class: Eloquant::Client

Inherits:
Object
  • Object
show all
Includes:
Accounts, Activities, Authentication, CampaignResponses, Campaigns, Connection, Contacts, CustomObjects, Events, ExternalActivities, Helpers, Opportunities
Defined in:
lib/eloquant.rb

Constant Summary collapse

DEFAULT_HOST_URL = 
"https://login.eloqua.com".freeze

Instance Attribute Summary

Attributes included from Connection

#connection

Instance Method Summary collapse

Methods included from Opportunities

#describe_opportunities, #describe_opportunities_csv

Methods included from Contacts

#create_bulk_contact_export, #describe_contacts, #describe_contacts_csv, #get_contact, #list_contact_exports, #number_of_contacts

Methods included from Campaigns

#describe_campaigns, #describe_campaigns_csv, #get_campaigns, #number_of_campaigns

Methods included from CampaignResponses

#describe_campaign_responses, #describe_campaign_responses_csv

Methods included from Activities

#create_bulk_activity_export, #describe_activities, #describe_activities_csv, #list_activity_exports

Methods included from Accounts

#create_bulk_account_export, #describe_accounts, #describe_accounts_csv, #get_account, #list_account_exports, #number_of_accounts

Methods included from Helpers

#check_export_status, #count_endpoint, #create_bulk_export, #csv_custom_headers, #describe_endpoint, #describe_endpoint_csv, #enqueue_export, #get_export_data, #initialize_bulk_export, #json_custom_headers, #json_post, #list_bulk_exports

Methods included from Connection

#init_connection, #reload_connection

Methods included from Authentication

#add_authorization, #encoded_sitename_username_and_password, #host_information, #set_host_url_to_clients_url, #username_and_sitename

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/eloquant.rb', line 40

def initialize(options = {})
  # Required
  @username = options.fetch(:username, ENV["ELOQUA_USERNAME"])
  @sitename = options.fetch(:sitename, ENV["ELOQUA_SITENAME"])
  @password = options.fetch(:password, ENV["ELOQUA_PASSWORD"])

  # Optional
  @max_retries = options.fetch(:max_retries, 10)
  @connection  = options.fetch(:connection, nil)
  @debug       = options.fetch(:debug, true)
  @logger      = options.fetch(:logger, nil)
  @host        = options.fetch(:host, DEFAULT_HOST_URL)

  @options = options
end

Instance Method Details

#set_host_url_if_default ⇒ Object 



74
75
76
77
78
 
# File 'lib/eloquant.rb', line 74

def set_host_url_if_default
  if @host == DEFAULT_HOST_URL
    set_host_url_to_clients_url
  end
end