Class: Messages

Inherits:
Object
  • Object
show all
Defined in:
lib/unisender_api/message.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Messages

Returns a new instance of Messages.



4
5
6
 
# File 'lib/unisender_api/message.rb', line 4

def initialize(api)
  self.api = api
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.



2
3
4
 
# File 'lib/unisender_api/message.rb', line 2

def api
  @api
end

Instance Method Details

#checkEmail(email_id) ⇒ Object 



111
112
113
114
115
 
# File 'lib/unisender_api/message.rb', line 111

def checkEmail(email_id)
    param = Hash.new
    param.merge!(self.api.gen_hash(email_id, 'email_id'))
    self.api.api_call('checkEmail', param)
end

#checkSms(sms_id) ⇒ Object 



83
84
85
86
87
 
# File 'lib/unisender_api/message.rb', line 83

def checkSms(sms_id)
  param = Hash.new
  param.merge!(self.api.gen_hash(sms_id, 'sms_id'))
  self.api.api_call('checkSms', param)
end

#createCampaign(message_id, start_time = '', timezone = '', track_read = 0, track_links = 0, contacts = '', contacts_url = '', defer = 1, track_ga = 0, payment_limit = 0, payment_currency = '', ga_medium = '', ga_source = '', ga_campaign = '', ga_content = '', ga_term = '') ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/unisender_api/message.rb', line 41

def createCampaign(message_id, start_time = '', timezone = '', track_read = 0, track_links = 0, contacts = '', contacts_url = '', defer = 1, track_ga = 0, payment_limit = 0, payment_currency = '', ga_medium = '', ga_source ='', ga_campaign = '', ga_content = '', ga_term = '')
  param = Hash.new
  param.merge!(self.api.gen_hash(message_id, 'message_id'))
  param.merge!(self.api.gen_hash(start_time, 'start_time')) if start_time != ''
  param.merge!(self.api.gen_hash(timezone, 'timezone')) if timezone != ''
  param.merge!(self.api.gen_hash(track_read, 'track_read'))
  param.merge!(self.api.gen_hash(track_links, 'track_links'))
  param.merge!(self.api.gen_hash(contacts, 'contacts')) if contacts != ''
  param.merge!(self.api.gen_hash(contacts_url, 'contacts_url')) if contacts_url != ''
  param.merge!(self.api.gen_hash(defer, 'defer'))
  param.merge!(self.api.gen_hash(track_ga, 'track_ga.to_s'))
  param.merge!(self.api.gen_hash(payment_limit, 'payment_limit'))
  param.merge!(self.api.gen_hash(payment_currency, 'payment_currency')) if payment_currenct != ''
  param.merge!(self.api.gen_hash(ga_medium, 'ga_medium')) if ga_medium != ''
  param.merge!(self.api.gen_hash(ga_source, 'ga_source')) if ga_source != ''
  param.merge!(self.api.gen_hash(ga_campaign, 'ga_campaign')) if ga_campaign != ''
  param.merge!(self.api.gen_hash(ga_content, 'ga_content')) if ga_content != ''
  param.merge!(self.api.gen_hash(ga_term, 'ga_term')) if ga_term != ''
  self.api.api_call('createCampaign', param)
end

#createEmailMessage(sender_name, sender_email, subject, body, list_id, text_body = '', generate_text = 0, tag = '', attachments = {}, lang = 'en', series_day = '', series_time = '', wrap_type = 'skip', caregories = '') ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/unisender_api/message.rb', line 8

def createEmailMessage(sender_name, sender_email, subject, body, list_id, text_body = '', generate_text = 0, tag = '', attachments = {}, lang = 'en', series_day = '', series_time = '', wrap_type = 'skip', caregories = '')
  param = Hash.new
  param.merge!(self.api.gen_hash(sender_name, 'sender_name'))
  param.merge!(self.api.gen_hash(sender_email, 'sender_email'))
  param.merge!(self.api.gen_hash(subject, 'subject'))
  param.merge!(self.api.gen_hash(body, 'body'))
  param.merge!(self.api.gen_hash(list_id, 'list-id'))
  param.merge!(self.api.gen_hash(text_body, 'text_body')) if text_body != ''
  param.merge!(self.api.gen_hash(generate_text, 'generate_text'))
  param.merge!(self.api.gen_hash(tag, 'tag')) if tag != ''
  if !attachments.empty?
      param.merge!(self.api.gen_hash(arrachments, 'attachments'))
  end
  param.merge!(self.api.gen_hash(lang, 'lang'))
  param.merge!(self.api.gen_hash(series_day, 'series_day')) if series_day != ''
  param.merge!(self.api.gen_hash(series_time, 'series_time')) if series_time != ''
  param.merge!(self.api.gen_hash(wrap_type, 'wrap_type'))
  param.merge!(self.api.gen_hash(categories, 'categories')) if categories != ''
  self.api.api_call('createEmailMessage', param)
end

#createSmsMessage(sender, body, list_id, tag = '', series_day = '', series_time = '', categories = '') ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/unisender_api/message.rb', line 29

def createSmsMessage(sender, body, list_id, tag = '', series_day = '', series_time = '', categories = '')
  param = Hash.new
  param.merge!(self.api.gen_hash(sender, 'sender'))
  param.merge!(self.api.gen_hash(body, 'body'))
  param.merge!(self.api.gen_hash(list_id, 'list_id'))
  param.merge!(self.api.gen_hash(tag, 'tag')) if tag != ''
  param.merge!(self.api.gen_hash(series_day, 'series_day')) if series_day != ''
  param.merge!(self.api.gen_hash(series_time, 'series_time')) if series_time != ''
  param.merge!(self.api.gen_hash(categories, 'categories')) if categories != ''
  self.api.api_call('createSmsMessage', param)
end

#deleteMessage(message_id) ⇒ Object 



127
128
129
130
131
 
# File 'lib/unisender_api/message.rb', line 127

def deleteMessage(message_id)
    param = Hash.new
    param.merge!(self.api.gen_hash(message_id, 'message_id'))
    self.api.api_call('deleteMessage', param)
end

#getCampaigns(from = '', to = '') ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/unisender_api/message.rb', line 62

def getCampaigns(from = '', to = '')
  param = Hash.new
  param.merge!(self.api.gen_hash(from, 'from')) if from != ''
  param.merge!(self.api.gen_hash(to, 'to')) if to != ''
  self.api.api_call('getCampaigns', param)
end

#getCampaignStatus(campaign_id) ⇒ Object 



69
70
71
72
73
 
# File 'lib/unisender_api/message.rb', line 69

def getCampaignStatus(campaign_id)
  param = Hash.new
  param.merge!(self.api.gen_hash(campaign_id, 'campaign_id'))
  self.api.api_call('getCampaignStatus', param)
end

#sendEmail(email, sender_name, sender_email, subject, body, list_id, user_campaign_id, attachments, lang = 'en', track_read = 0, track_links = 0, cc = '', headers = '', wrap_type = 'skip', images_as = 'attachments', error_checking = 0) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/unisender_api/message.rb', line 89

def sendEmail(email, sender_name, sender_email, subject, body, list_id, user_campaign_id, attachments, lang ='en', track_read = 0,track_links = 0, cc = '', headers = '', wrap_type = 'skip', images_as = 'attachments', error_checking = 0)
    param = Hash.new
    param.merge!(self.api.gen_hash(email, 'email'))
    param.merge!(self.api.gen_hash(sender_name, 'sender_name'))
    param.merge!(self.api.gen_hash(sender_email, 'sender_email'))
    param.merge!(self.api.gen_hash(subject, 'subject'))
    param.merge!(self.api.gen_hash(body, 'body'))
    param.merge!(self.api.gen_hash(list_id, 'list_id'))
    param.merge!(self.api.gen_hash(user_campaign_id, 'user_campaign_id'))
    param.merge!(:attach_multi => '1') if attachments.is_a? Array
    param.merge!(self.api.gen_hash(attachments, 'attachments'))
    param.merge!(self.api.gen_hash(lang, 'lang'))
    param.merge!(self.api.gen_hash(track_read, 'track_read'))
    param.merge!(self.api.gen_hash(track_links, 'track_links'))
    param.merge!(self.api.gen_hash(cc, 'cc')) if cc != ''
    param.merge!(self.api.gen_hash(headers, 'headers')) if headers != ''
    param.merge!(self.api.gen_hash(wrap_type, 'wrap_type'))
    param.merge!(self.api.gen_hash(images_as, 'images_as'))
    param.merge!(self.api.gen_hash(error_checking, 'error_checking'))
    self.api.api_call('sendEmail', param)
end

#sendSms(phone, sender, text) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/unisender_api/message.rb', line 75

def sendSms(phone, sender, text)
  param = Hash.new
  param.merge!(self.api.gen_hash(phone, 'phone'))
  param.merge!(self.api.gen_hash(sender, 'sender'))
  param.merge!(self.api.gen_hash(text, 'text'))
  self.api.api_call('sendSms', param)
end

#updateOptInEmail(sender_name, sender_email, subject, body, list_id) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/unisender_api/message.rb', line 117

def updateOptInEmail(sender_name, sender_email, subject, body, list_id)
    param = Hash.new
    param.merge!(self.api.gen_hash(sender_name, 'sender_name'))
    param.merge!(self.api.gen_hash(sender_eamil, 'sender_email'))
    param.merge!(self.api.gen_hash(subject, 'subject'))
    param.merge!(self.api.gen_hash(body, 'body'))
    param.merge!(self.api.gen_hash(list_id, 'list_id'))
    self.api.api_call('updateOptInEmail', param)
end