Class: Contactology::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/contactology/configuration.rb

Overview

Holds configuration objects used by the library. The Contactology module holds reference to a default Configuration, which will be used when no explicit configurations are given to a particular query.

Instance Attribute Summary collapse

Instance Attribute Details

#endpointObject

Public: Get the API endpoint used by the configuration. Unless explicitly set, the endpoint will default to the official production endpoint at “api.emailcampaigns.net/2/REST/”.

Returns the String for the API endpoint.



41
42
43
# File 'lib/contactology/configuration.rb', line 41

def endpoint
  @endpoint ||= 'https://api.emailcampaigns.net/2/REST/'
end

#keyObject

Public: Get the API key used for queries.

Returns the String of the key.



23
24
25
# File 'lib/contactology/configuration.rb', line 23

def key
  @key
end