Module: Cupid::Retrieve

Included in:
Cupid
Defined in:
lib/cupid/retrieve.rb

Constant Summary collapse

LIST_FIELDS = 
%w(ID ListName CustomerKey)
EMAIL_FIELDS = 
%w(ID Name)
FOLDER_FIELDS = 
%w(ID Name ParentFolder.ID ParentFolder.Name)
DELIVERY_FIELDS = 
%w(ID Status)
UI_EMAIL_FIELDS = 
%w(CustomerKey Name Email.ID EmailSubject CategoryID)

Instance Method Summary collapse

Instance Method Details

#deliveries(*fields) ⇒ Object 



33
34
35
 
# File 'lib/cupid/retrieve.rb', line 33

def deliveries(*fields)
  retrieve 'Send', DELIVERY_FIELDS + fields
end

#emails(name = nil, *fields) ⇒ Object 



9
10
11
12
13
 
# File 'lib/cupid/retrieve.rb', line 9

def emails(name=nil, *fields)
  retrieve 'Email',
    EMAIL_FIELDS + fields,
    filter_email_like(name)
end

#folders(*fields) ⇒ Object 



21
22
23
 
# File 'lib/cupid/retrieve.rb', line 21

def folders(*fields)
  data_folders 'email', *fields
end

#lists(*fields) ⇒ Object 



29
30
31
 
# File 'lib/cupid/retrieve.rb', line 29

def lists(*fields)
  retrieve 'List', LIST_FIELDS + fields
end

#ui_emails(folder = nil, *fields) ⇒ Object 



15
16
17
18
19
 
# File 'lib/cupid/retrieve.rb', line 15

def ui_emails(folder=nil, *fields)
  retrieve 'EmailSendDefinition',
    UI_EMAIL_FIELDS + fields,
    filter_by_folder(folder)
end

#ui_folders(*fields) ⇒ Object 



25
26
27
 
# File 'lib/cupid/retrieve.rb', line 25

def ui_folders(*fields)
  data_folders 'userinitiated', *fields
end