Class: ActiveCampaignRuby::Client

Inherits:
Object
  • Object
show all
Includes:
ActiveCampaignRuby::Core::Campaigns, ActiveCampaignRuby::Core::Contacts, ActiveCampaignRuby::Core::Deals, ActiveCampaignRuby::Core::Forms, ActiveCampaignRuby::Core::Groups, ActiveCampaignRuby::Core::List, ActiveCampaignRuby::Core::Messages, ActiveCampaignRuby::Core::Tracks, ActiveCampaignRuby::Core::Users, HTTParty
Defined in:
lib/active_campaign_ruby/client.rb

Constant Summary collapse

API_ENDPOINT = 
'https://subdomain.activehosted.com/admin/api.php'
API_KEY = 
'API_KEY'
API_OUTPUT = 
'json'

Instance Method Summary collapse

Methods included from ActiveCampaignRuby::Core::Users

#user_add, #user_delete, #user_delete_list, #user_edit, #user_list, #user_me, #user_view, #user_view_email, #user_view_username

Methods included from ActiveCampaignRuby::Core::Tracks

#track_event_add, #track_event_delete, #track_event_list, #track_event_status_edit, #track_site_list, #track_site_status_edit, #track_site_whitelist_add, #track_site_whitelist_delete

Methods included from ActiveCampaignRuby::Core::Messages

#message_add, #message_delete, #message_delete_list, #message_edit, #message_list, #message_template_add, #message_template_delete, #message_template_delete_list, #message_template_edit, #message_template_export, #message_template_import, #message_template_list, #message_template_view, #message_view

Methods included from ActiveCampaignRuby::Core::Groups

#group_add, #group_delete, #group_delete_list, #group_edit, #group_list, #group_view

Methods included from ActiveCampaignRuby::Core::Forms

#form_getforms, #form_html

Methods included from ActiveCampaignRuby::Core::Deals

#deal_add, #deal_delete, #deal_edit, #deal_get, #deal_list, #deal_note_add, #deal_note_edit, #deal_pipeline_add, #deal_pipeline_delete, #deal_pipeline_edit, #deal_pipeline_list, #deal_stage_add, #deal_stage_delete, #deal_stage_edit, #deal_stage_list, #deal_task_add, #deal_task_edit, #deal_tasktype_add, #deal_tasktype_delete, #deal_tasktype_edit

Methods included from ActiveCampaignRuby::Core::Contacts

#contact_add, #contact_automation_list, #contact_delete, #contact_delete_list, #contact_edit, #contact_list, #contact_note_add, #contact_note_delete, #contact_note_edit, #contact_paginator, #contact_sync, #contact_tag_add, #contact_tag_remove, #contact_view, #contact_view_email, #contact_view_hash

Methods included from ActiveCampaignRuby::Core::Campaigns

#campaign_create, #campaign_delete, #campaign_delete_list, #campaign_edit, #campaign_list, #campaign_paginator, #campaign_report_bounce_list, #campaign_report_bounce_totals, #campaign_report_forward_list, #campaign_report_forward_totals, #campaign_report_link_list, #campaign_report_link_totals, #campaign_report_open_list, #campaign_report_open_totals, #campaign_report_totals, #campaign_report_unopen_list, #campaign_report_unsubscription_list, #campaign_report_unsubscription_totals, #campaign_send, #campaign_status

Methods included from ActiveCampaignRuby::Core::List

#list_add, #list_delete, #list_delete_list, #list_edit, #list_field_add, #list_field_delete, #list_field_edit, #list_field_view, #list_list, #list_paginator, #list_view

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



29
30
31
32
33
 
# File 'lib/active_campaign_ruby/client.rb', line 29

def initialize(options = {})
  self.class.base_uri (options[:api_endpoint] || API_ENDPOINT)+'?api_action='
  @option = { api_key: options[:api_key] || API_KEY,
              api_output: options[:api_output] || API_OUTPUT }
end

Instance Method Details

#get(api_method, options = {}) ⇒ Object

Make get request



36
37
38
 
# File 'lib/active_campaign_ruby/client.rb', line 36

def get(api_method, options = {})
  self.class.get(api_method.to_s, req_params(__method__, options))
end

#post(api_method, options = {}) ⇒ Object

Make post request



41
42
43
 
# File 'lib/active_campaign_ruby/client.rb', line 41

def post(api_method, options = {})
  self.class.post(api_method.to_s, req_params(__method__, options))
end