Class: MailerLite::Client

Inherits:
Object
  • Object
show all
Includes:
MailerLite::Clients::Account, MailerLite::Clients::Campaigns, MailerLite::Clients::Fields, MailerLite::Clients::Groups, MailerLite::Clients::Segments, MailerLite::Clients::Subscribers, MailerLite::Clients::Webhooks
Defined in:
lib/mailerlite/client.rb

Overview

Wrapper class for all actions.

Instance Method Summary collapse

Methods included from MailerLite::Clients::Webhooks

#create_webhook, #delete_webhook, #update_webhook, #webhook, #webhooks

Methods included from MailerLite::Clients::Subscribers

#create_subscriber, #delete_subscriber, #search_subscribers, #subscriber, #subscriber_activities, #subscriber_groups, #subscribers, #update_subscriber

Methods included from MailerLite::Clients::Segments

#segments

Methods included from MailerLite::Clients::Groups

#create_group, #create_group_subscriber, #delete_group, #delete_group_subscriber, #group, #group_subscribers, #groups, #import_group_subscribers, #update_group

Methods included from MailerLite::Clients::Fields

#create_field, #delete_field, #fields, #update_field

Methods included from MailerLite::Clients::Campaigns

#campaign_action, #campaigns_by_status, #create_campaign, #delete_campaign, #update_campaign_content

Methods included from MailerLite::Clients::Account

#account, #stats

Constructor Details

#initialize(options = {}) ⇒ Client

Initialize client.

Parameters:

  • (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :api_key (String) —

    API Key provider from MailerLite.

  • :timeout (String) —

    optional open/read timeout Integer in seconds



31
32
33
34
 
# File 'lib/mailerlite/client.rb', line 31

def initialize(options = {})
  config.api_key = options[:api_key] if options[:api_key]
  config.timeout = options[:timeout] if options[:timeout]
end

Instance Method Details

#config ⇒ Configuration Also known as: configuration

Returns:



37
38
39
 
# File 'lib/mailerlite/client.rb', line 37

def config
  @config ||= Configuration.new
end

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

Configure client with a block of settings.

Yields:



43
44
45
46
 
# File 'lib/mailerlite/client.rb', line 43

def configure
  yield(config) if block_given?
  true
end

#connection ⇒ Connection

Returns:



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

def connection
  @connection ||= Connection.new(self)
end