Module: Iterable

Defined in:
lib/iterable.rb,
lib/iterable/email.rb,
lib/iterable/lists.rb,
lib/iterable/users.rb,
lib/iterable/config.rb,
lib/iterable/device.rb,
lib/iterable/events.rb,
lib/iterable/export.rb,
lib/iterable/request.rb,
lib/iterable/channels.rb,
lib/iterable/commerce.rb,
lib/iterable/metadata.rb,
lib/iterable/response.rb,
lib/iterable/campaigns.rb,
lib/iterable/templates.rb,
lib/iterable/workflows.rb,
lib/iterable/experiments.rb,
lib/iterable/api_resource.rb,
lib/iterable/csv_exporter.rb,
lib/iterable/json_exporter.rb,
lib/iterable/message_types.rb,
lib/iterable/metadata_table.rb,
lib/iterable/push_templates.rb,
lib/iterable/email_templates.rb

Overview

Iterable module for API interactions

Defined Under Namespace

Classes: ApiResource, Campaigns, Channels, Commerce, Config, CsvExporter, Device, Email, EmailTemplates, Events, Experiments, Export, JsonExporter, Lists, MessageTypes, Metadata, MetadataTable, PushTemplates, Response, Templates, Users, Workflows

Constant Summary collapse

DATE_FORMAT =
'%Y-%m-%d'.freeze

Class Method Summary collapse

Class Method Details

.configIterable::Config

Returns The default config for API endpoints.

Returns:



61
62
63
# File 'lib/iterable.rb', line 61

def config
  @config ||= Config.new
end

.configureObject

Configure a default [Iterable::Config] object to be used when interacting with API endpoints

Examples:

Configuring with token

Iterable.configure do |conf|
  conf.token = 'secret-token'
end


52
53
54
55
56
# File 'lib/iterable.rb', line 52

def configure
  config.tap do |conf|
    yield conf
  end
end