Module: ExactTargetSDK

Defined in:
lib/exact_target_sdk.rb,
lib/exact_target_sdk/client.rb,
lib/exact_target_sdk/config.rb,
lib/exact_target_sdk/errors.rb,
lib/exact_target_sdk/result.rb,
lib/exact_target_sdk/version.rb,
lib/exact_target_sdk/attribute.rb,
lib/exact_target_sdk/api_object.rb,
lib/exact_target_sdk/subscriber.rb,
lib/exact_target_sdk/filter_part.rb,
lib/exact_target_sdk/api_property.rb,
lib/exact_target_sdk/content_area.rb,
lib/exact_target_sdk/create_result.rb,
lib/exact_target_sdk/delete_result.rb,
lib/exact_target_sdk/update_result.rb,
lib/exact_target_sdk/data_extension.rb,
lib/exact_target_sdk/triggered_send.rb,
lib/exact_target_sdk/create_response.rb,
lib/exact_target_sdk/delete_response.rb,
lib/exact_target_sdk/retrieve_result.rb,
lib/exact_target_sdk/update_response.rb,
lib/exact_target_sdk/perform_response.rb,
lib/exact_target_sdk/retrieve_response.rb,
lib/exact_target_sdk/simple_filter_part.rb,
lib/exact_target_sdk/complex_filter_part.rb,
lib/exact_target_sdk/data_extension_field.rb,
lib/exact_target_sdk/data_extension_object.rb,
lib/exact_target_sdk/triggered_send_definition.rb

Defined Under Namespace

Classes: APIObject, APIProperty, Attribute, Client, ComplexFilterPart, ContentArea, CreateResponse, CreateResult, DataExtension, DataExtensionField, DataExtensionObject, DeleteResponse, DeleteResult, Error, FilterPart, HTTPError, InvalidAPIObject, PerformResponse, Result, RetrieveResponse, RetrieveResult, SOAPFault, SimpleFilterPart, Subscriber, TimeoutError, TriggeredSend, TriggeredSendDefinition, UnknownError, UpdateResponse, UpdateResult

Constant Summary collapse

DEFAULT_TIMEOUT = 
15
DEFAULT_ENDPOINT = 
'https://webservice.s4.exacttarget.com/Service.asmx'
DEFAULT_NAMESPACE = 
'http://exacttarget.com/wsdl/partnerAPI'
VERSION = 
'1.0.1'

Class Method Summary collapse

Class Method Details

.config(options = nil) ⇒ Object

Globally configures and retrieves configuration for the ExactTarget SDK.

Environment Variables

For convenience in a command-line environment, configuration may be skipped by setting the EXACT_TARGET_SDK_USERNAME and EXACT_TARGET_SDK_PASSWORD environment variables, which are self-explanatory.

Rails

If running in a rails environment, this configuration will automatically use the global Rails.logger instance. This behavior may be overridden by passing in a :logger option.

Parameters:

  • options (Hash) (defaults to: nil)

Options Hash (options):

  • :username (String) — default: nil —

    ExactTarget account username

  • :password (String) — default: nil —

    ExactTarget account password

  • :logger (Logger) — default: Rails.logger —

    Logger to use

  • :open_timeout (Numeric) — default: ExactTargetSDK::DEFAULT_TIMEOUT —

    Number of seconds to wait for the connection to open (see Net::HTTP#open_timeout)

  • :read_timeout (Numeric) — default: ExactTargetSDK::DEFAULT_TIMEOUT —

    Number of seconds to wait for one block to be read (see Net::HTTP#read_timeout)



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/exact_target_sdk/config.rb', line 33

def self.config(options = nil)
  @config ||= {
    :username => ENV['EXACT_TARGET_SDK_USERNAME'],
    :password => ENV['EXACT_TARGET_SDK_PASSWORD'],
    :logger => default_logger,
    :open_timeout => DEFAULT_TIMEOUT,
    :read_timeout => DEFAULT_TIMEOUT,
    :endpoint => DEFAULT_ENDPOINT,
    :namespace => DEFAULT_NAMESPACE,
  }
  
  @config.merge!(options) if options

  @config
end