Class: Selligent::Client

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
CIM, Content, Cumulio, CustomJourney, Data, Journeys, Lists, Organizations, SingleBatch, Status, StoredProcedures, Tasks, TransactionalBulk, Transactionals, Connection
Defined in:
lib/selligent/client.rb,
lib/selligent/client/cim.rb,
lib/selligent/client/data.rb,
lib/selligent/client/lists.rb,
lib/selligent/client/tasks.rb,
lib/selligent/client/status.rb,
lib/selligent/client/content.rb,
lib/selligent/client/cumulio.rb,
lib/selligent/client/journeys.rb,
lib/selligent/client/single_batch.rb,
lib/selligent/client/organizations.rb,
lib/selligent/client/custom_journey.rb,
lib/selligent/client/transactionals.rb,
lib/selligent/client/stored_procedures.rb,
lib/selligent/client/transactional_bulk.rb

Overview

The actual Selligent client

Defined Under Namespace

Modules: CIM, Content, Cumulio, CustomJourney, Data, Journeys, Lists, Organizations, SingleBatch, Status, StoredProcedures, Tasks, TransactionalBulk, Transactionals

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Transactionals

#send_transactional, #transactional, #transactional_status, #transactionals, #transactionals_status, #update_profile_and_send_transactional

Methods included from TransactionalBulk

#send_transactional_bulk

Methods included from Tasks

#disable_task, #enable_task, #run_task, #task, #task_actions, #tasks

Methods included from StoredProcedures

#stored_procedure, #stored_procedures

Methods included from Status

#status

Methods included from SingleBatch

#cancel_single_batch, #create_single_batch, #launch_single_batch, #send_single_batch_email, #send_single_batch_push, #send_single_batch_sms, #single_batch, #single_batches, #trigger_single_batch

Methods included from Organizations

#organization, #organizations

Methods included from Lists

#create_fields, #create_list, #create_relation, #delete_field, #delete_list, #delete_record, #delete_relation, #fields, #list, #lists, #records_count, #relation, #relations, #segment, #segments, #update_field, #update_list, #update_relation

Methods included from Journeys

#journeys

Methods included from Data

#delete_data, #delete_data_from_segment, #load_data, #load_data_into_segment, #search_data, #search_data_within_segment

Methods included from CIM

#cim_cancel, #cim_collect, #cim_optout, #cim_remove, #cim_result, #cim_state

Methods included from CustomJourney

#trigger_custom_journey

Methods included from Cumulio

#cumulio_datasets, #cumulio_query

Methods included from Content

#create_email, #create_page, #create_push_message, #create_sms

Methods included from Connection

#delete, #get, #post, #put

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



44
45
46
47
 
# File 'lib/selligent/client.rb', line 44

def initialize(options = {})
  Selligent::Middlewares::Authorization.setup!
  @config = Selligent::Configuration.new(options)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



42
43
44
 
# File 'lib/selligent/client.rb', line 42

def config
  @config
end

Instance Method Details

#base_url ⇒ Object 



57
58
59
 
# File 'lib/selligent/client.rb', line 57

def base_url
  "#{root_url}/organizations/#{config.organization}"
end

#configure {|config| ... } ⇒ Object

Yields:



49
50
51
 
# File 'lib/selligent/client.rb', line 49

def configure
  yield config
end

#root_url ⇒ Object 



53
54
55
 
# File 'lib/selligent/client.rb', line 53

def root_url
  '/Portal/Api'
end