Class: MailUp::Console::Base

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Base

:nodoc:



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

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

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.



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

def api
  @api
end

Instance Method Details

#email ⇒ MailUp::Console::Email

Create an email object

Examples:


email = mailup.console.email

Returns:



19
20
21
 
# File 'lib/mailup/console/base.rb', line 19

def email
  Email.new @api
end

#group(id) ⇒ MailUp::Console::Group

Create a group object

Examples:


group = mailup.console.group(1)

Parameters:

  • id (Integer) —

    The group_id of the group to access.

Returns:



33
34
35
 
# File 'lib/mailup/console/base.rb', line 33

def group(id)
  Group.new id, @api
end

#images ⇒ MailUp::Console::Images

Create an images object

Examples:


images = mailup.console.images

Returns:



45
46
47
 
# File 'lib/mailup/console/base.rb', line 45

def images
  Images.new @api
end

#import(id) ⇒ MailUp::Console::Import

Create an import object

Examples:


import = mailup.console.import(9)

Parameters:

  • idImport (Integer) —

    The ID of the import process.

Returns:



59
60
61
 
# File 'lib/mailup/console/base.rb', line 59

def import(id)
  Import.new id, @api
end

#list(id) ⇒ MailUp::Console::List

Create a list object

Examples:


list = mailup.console.list(2)

Parameters:

  • id (Integer) —

    The list_id of the list to access.

Returns:



73
74
75
 
# File 'lib/mailup/console/base.rb', line 73

def list(id)
  List.new id, @api
end

#public ⇒ MailUp::Console::List

Create a public methods object

Examples:


list = mailup.console.list(2)

Returns:



85
86
87
 
# File 'lib/mailup/console/base.rb', line 85

def public
  Public::Base.new @api
end

#recipient ⇒ MailUp::Console::Recipient

Create a recipient object

Examples:


recipient = mailup.console.recipient

Returns:



97
98
99
 
# File 'lib/mailup/console/base.rb', line 97

def recipient
  Recipient.new @api
end

#user ⇒ MailUp::Console::User

Create a user object

Examples:


user = mailup.console.user

Returns:



109
110
111
 
# File 'lib/mailup/console/base.rb', line 109

def user
  User.new @api
end