Class: MailUp::Stats::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/mailup/stats/base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Base

:nodoc:



6
7
8
9
 
# File 'lib/mailup/stats/base.rb', line 6

def initialize(api) # :nodoc:
    @api = api
    @api.path = "/API/v#{MailUp::API_VERSION}/Rest/MailStatisticsService.svc"
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.



4
5
6
 
# File 'lib/mailup/stats/base.rb', line 4

def api
  @api
end

Instance Method Details

#message(id) ⇒ MailUp::Stats::Message

Create a message object

Examples:


message = mailup.stats.message(1)

Parameters:

  • id (Integer) —

    The message_id of the message to access.

Returns:



21
22
23
 
# File 'lib/mailup/stats/base.rb', line 21

def message(id)
  Message.new id, @api
end

#recipient(id) ⇒ MailUp::Stats::Recipient

Create a recipient object

Examples:


recipient = mailup.stats.recipient(154)

Parameters:

  • id (Integer) —

    The recipient_id of the recipient to access.

Returns:



35
36
37
 
# File 'lib/mailup/stats/base.rb', line 35

def recipient(id)
  Recipient.new id, @api
end