campaign_monitor 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG +3 -0
- data/MIT-LICENSE +20 -0
- data/README +30 -0
- data/TODO +3 -0
- data/doc/classes/CMCampaignSummary.html +170 -0
- data/doc/classes/CMCampaignSummary.src/M000003.html +22 -0
- data/doc/classes/CMClient.html +111 -0
- data/doc/classes/CMResult.html +155 -0
- data/doc/classes/CMResult.src/M000004.html +19 -0
- data/doc/classes/CampaignMonitor.html +355 -0
- data/doc/classes/CampaignMonitor.src/M000001.html +20 -0
- data/doc/classes/CampaignMonitor.src/M000002.html +20 -0
- data/doc/classes/CampaignMonitor.src/M000003.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000004.html +20 -0
- data/doc/classes/CampaignMonitor.src/M000005.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000006.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000007.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000008.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000009.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000010.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000011.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000012.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000013.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000014.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000015.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000016.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000017.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000018.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000019.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000020.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000021.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000022.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000023.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000024.html +29 -0
- data/doc/classes/CampaignMonitor.src/M000025.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000026.html +21 -0
- data/doc/classes/CampaignMonitor.src/M000027.html +20 -0
- data/doc/classes/CampaignMonitor.src/M000028.html +19 -0
- data/doc/classes/CampaignMonitor.src/M000029.html +20 -0
- data/doc/classes/CampaignMonitor.src/M000030.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000031.html +18 -0
- data/doc/classes/CampaignMonitor.src/M000032.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000033.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000034.html +23 -0
- data/doc/classes/CampaignMonitor.src/M000035.html +19 -0
- data/doc/classes/CampaignMonitor/Campaign.html +387 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000027.html +22 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000028.html +22 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000029.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000030.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000031.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000032.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000033.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000034.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000035.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000036.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000037.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000053.html +22 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000054.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000055.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000056.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000057.html +23 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000058.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000059.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000060.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000061.html +18 -0
- data/doc/classes/CampaignMonitor/Campaign.src/M000062.html +18 -0
- data/doc/classes/CampaignMonitor/Client.html +226 -0
- data/doc/classes/CampaignMonitor/Client.src/M000016.html +20 -0
- data/doc/classes/CampaignMonitor/Client.src/M000017.html +20 -0
- data/doc/classes/CampaignMonitor/Client.src/M000018.html +23 -0
- data/doc/classes/CampaignMonitor/Client.src/M000019.html +23 -0
- data/doc/classes/CampaignMonitor/Client.src/M000042.html +20 -0
- data/doc/classes/CampaignMonitor/Client.src/M000043.html +23 -0
- data/doc/classes/CampaignMonitor/Client.src/M000044.html +23 -0
- data/doc/classes/CampaignMonitor/List.html +308 -0
- data/doc/classes/CampaignMonitor/List.src/M000021.html +20 -0
- data/doc/classes/CampaignMonitor/List.src/M000022.html +20 -0
- data/doc/classes/CampaignMonitor/List.src/M000023.html +19 -0
- data/doc/classes/CampaignMonitor/List.src/M000024.html +19 -0
- data/doc/classes/CampaignMonitor/List.src/M000025.html +23 -0
- data/doc/classes/CampaignMonitor/List.src/M000026.html +23 -0
- data/doc/classes/CampaignMonitor/List.src/M000027.html +23 -0
- data/doc/classes/CampaignMonitor/List.src/M000047.html +20 -0
- data/doc/classes/CampaignMonitor/List.src/M000048.html +19 -0
- data/doc/classes/CampaignMonitor/List.src/M000049.html +19 -0
- data/doc/classes/CampaignMonitor/List.src/M000050.html +23 -0
- data/doc/classes/CampaignMonitor/List.src/M000051.html +23 -0
- data/doc/classes/CampaignMonitor/List.src/M000052.html +23 -0
- data/doc/classes/CampaignMonitor/Result.html +162 -0
- data/doc/classes/CampaignMonitor/Result.src/M000020.html +19 -0
- data/doc/classes/CampaignMonitor/Result.src/M000021.html +19 -0
- data/doc/classes/CampaignMonitor/Result.src/M000046.html +19 -0
- data/doc/classes/CampaignMonitor/Subscriber.html +212 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000012.html +21 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000013.html +21 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000014.html +19 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000015.html +19 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000038.html +21 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000039.html +19 -0
- data/doc/classes/CampaignMonitor/Subscriber.src/M000040.html +19 -0
- data/doc/classes/CampaignMonitor/SubscriberBounce.html +166 -0
- data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000020.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberClick.html +166 -0
- data/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberClick.src/M000011.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberOpen.html +166 -0
- data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000012.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html +20 -0
- data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html +161 -0
- data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html +19 -0
- data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000016.html +19 -0
- data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html +19 -0
- data/doc/classes/CampaignMonitorTest.html +137 -0
- data/doc/classes/CampaignMonitorTest.src/M000001.html +18 -0
- data/doc/classes/Hash.html +137 -0
- data/doc/classes/Hash.src/M000002.html +18 -0
- data/doc/classes/Symbol.html +143 -0
- data/doc/classes/Symbol.src/M000001.html +18 -0
- data/doc/created.rid +1 -0
- data/doc/files/campaign_monitor_old_rb.html +119 -0
- data/doc/files/init_rb.html +108 -0
- data/doc/files/install_rb.html +101 -0
- data/doc/files/lib/campaign_monitor_rb.html +184 -0
- data/doc/files/test/campaign_monitor_test_rb.html +101 -0
- data/doc/fr_class_index.html +37 -0
- data/doc/fr_file_index.html +28 -0
- data/doc/fr_method_index.html +63 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/lib/campaign_monitor.rb +503 -0
- data/test/campaign_monitor_test.rb +6 -0
- metadata +175 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>new (CMResult)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File campaign_monitor_old.rb, line 308</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">code</span>)
|
|
15
|
+
<span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>
|
|
16
|
+
<span class="ruby-ivar">@code</span> = <span class="ruby-identifier">code</span>
|
|
17
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
18
|
+
</body>
|
|
19
|
+
</html>
|
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Class: CampaignMonitor</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Class</strong></td>
|
|
53
|
+
<td class="class-name-in-header">CampaignMonitor</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../files/lib/campaign_monitor_rb.html">
|
|
59
|
+
lib/campaign_monitor.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
<tr class="top-aligned-row">
|
|
66
|
+
<td><strong>Parent:</strong></td>
|
|
67
|
+
<td>
|
|
68
|
+
Object
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
<!-- banner header -->
|
|
74
|
+
|
|
75
|
+
<div id="bodyContent">
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div id="contextContent">
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
</div>
|
|
84
|
+
|
|
85
|
+
<div id="method-list">
|
|
86
|
+
<h3 class="section-bar">Methods</h3>
|
|
87
|
+
|
|
88
|
+
<div class="name-list">
|
|
89
|
+
<a href="#M000010">add_subscriber</a>
|
|
90
|
+
<a href="#M000008">campaigns</a>
|
|
91
|
+
<a href="#M000007">clients</a>
|
|
92
|
+
<a href="#M000005">http_get</a>
|
|
93
|
+
<a href="#M000009">lists</a>
|
|
94
|
+
<a href="#M000006">method_missing</a>
|
|
95
|
+
<a href="#M000002">new</a>
|
|
96
|
+
<a href="#M000003">request</a>
|
|
97
|
+
<a href="#M000004">request_url</a>
|
|
98
|
+
</div>
|
|
99
|
+
</div>
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<!-- if includes -->
|
|
105
|
+
|
|
106
|
+
<div id="section">
|
|
107
|
+
|
|
108
|
+
<div id="class-list">
|
|
109
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
|
110
|
+
|
|
111
|
+
Class <a href="CampaignMonitor/Campaign.html" class="link">CampaignMonitor::Campaign</a><br />
|
|
112
|
+
Class <a href="CampaignMonitor/Client.html" class="link">CampaignMonitor::Client</a><br />
|
|
113
|
+
Class <a href="CampaignMonitor/List.html" class="link">CampaignMonitor::List</a><br />
|
|
114
|
+
Class <a href="CampaignMonitor/Result.html" class="link">CampaignMonitor::Result</a><br />
|
|
115
|
+
Class <a href="CampaignMonitor/Subscriber.html" class="link">CampaignMonitor::Subscriber</a><br />
|
|
116
|
+
Class <a href="CampaignMonitor/SubscriberBounce.html" class="link">CampaignMonitor::SubscriberBounce</a><br />
|
|
117
|
+
Class <a href="CampaignMonitor/SubscriberClick.html" class="link">CampaignMonitor::SubscriberClick</a><br />
|
|
118
|
+
Class <a href="CampaignMonitor/SubscriberOpen.html" class="link">CampaignMonitor::SubscriberOpen</a><br />
|
|
119
|
+
Class <a href="CampaignMonitor/SubscriberUnsubscribe.html" class="link">CampaignMonitor::SubscriberUnsubscribe</a><br />
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<!-- if method_list -->
|
|
130
|
+
<div id="methods">
|
|
131
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
132
|
+
|
|
133
|
+
<div id="method-M000002" class="method-detail">
|
|
134
|
+
<a name="M000002"></a>
|
|
135
|
+
|
|
136
|
+
<div class="method-heading">
|
|
137
|
+
<a href="CampaignMonitor.src/M000002.html" target="Code" class="method-signature"
|
|
138
|
+
onclick="popupCode('CampaignMonitor.src/M000002.html');return false;">
|
|
139
|
+
<span class="method-name">new</span><span class="method-args">(api_key=CAMPAIGN_MONITOR_API_KEY)</span>
|
|
140
|
+
</a>
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
<div class="method-description">
|
|
144
|
+
<p>
|
|
145
|
+
Replace this API key with your own (<a
|
|
146
|
+
href="http://www.campaignmonitor.com/api">www.campaignmonitor.com/api</a>/)
|
|
147
|
+
</p>
|
|
148
|
+
</div>
|
|
149
|
+
</div>
|
|
150
|
+
|
|
151
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
152
|
+
|
|
153
|
+
<div id="method-M000010" class="method-detail">
|
|
154
|
+
<a name="M000010"></a>
|
|
155
|
+
|
|
156
|
+
<div class="method-heading">
|
|
157
|
+
<a href="CampaignMonitor.src/M000010.html" target="Code" class="method-signature"
|
|
158
|
+
onclick="popupCode('CampaignMonitor.src/M000010.html');return false;">
|
|
159
|
+
<span class="method-name">add_subscriber</span><span class="method-args">(list_id, email, name)</span>
|
|
160
|
+
</a>
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
<div class="method-description">
|
|
164
|
+
<p>
|
|
165
|
+
A quick method of adding a subscriber to a list. Returns a <a
|
|
166
|
+
href="CampaignMonitor/Result.html">Result</a> object
|
|
167
|
+
</p>
|
|
168
|
+
<p>
|
|
169
|
+
Example
|
|
170
|
+
</p>
|
|
171
|
+
<pre>
|
|
172
|
+
@cm = CampaignMonitor.new()
|
|
173
|
+
result = @cm.add_subscriber(12345, "ralph.wiggum@simpsons.net", "Ralph Wiggum")
|
|
174
|
+
|
|
175
|
+
if result.code == 0
|
|
176
|
+
puts "Subscriber Added to List"
|
|
177
|
+
end
|
|
178
|
+
</pre>
|
|
179
|
+
</div>
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
<div id="method-M000008" class="method-detail">
|
|
183
|
+
<a name="M000008"></a>
|
|
184
|
+
|
|
185
|
+
<div class="method-heading">
|
|
186
|
+
<a href="CampaignMonitor.src/M000008.html" target="Code" class="method-signature"
|
|
187
|
+
onclick="popupCode('CampaignMonitor.src/M000008.html');return false;">
|
|
188
|
+
<span class="method-name">campaigns</span><span class="method-args">(client_id)</span>
|
|
189
|
+
</a>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div class="method-description">
|
|
193
|
+
<p>
|
|
194
|
+
Returns an array of <a href="CampaignMonitor/Campaign.html">Campaign</a>
|
|
195
|
+
objects associated with the specified <a
|
|
196
|
+
href="CampaignMonitor/Client.html">Client</a> ID
|
|
197
|
+
</p>
|
|
198
|
+
<p>
|
|
199
|
+
Example
|
|
200
|
+
</p>
|
|
201
|
+
<pre>
|
|
202
|
+
@cm = CampaignMonitor.new()
|
|
203
|
+
@campaigns = @cm.campaigns(12345)
|
|
204
|
+
|
|
205
|
+
for campaign in @campaigns
|
|
206
|
+
puts campaign.subject
|
|
207
|
+
end
|
|
208
|
+
</pre>
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="method-M000007" class="method-detail">
|
|
213
|
+
<a name="M000007"></a>
|
|
214
|
+
|
|
215
|
+
<div class="method-heading">
|
|
216
|
+
<a href="CampaignMonitor.src/M000007.html" target="Code" class="method-signature"
|
|
217
|
+
onclick="popupCode('CampaignMonitor.src/M000007.html');return false;">
|
|
218
|
+
<span class="method-name">clients</span><span class="method-args">()</span>
|
|
219
|
+
</a>
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
<div class="method-description">
|
|
223
|
+
<p>
|
|
224
|
+
Returns an array of <a href="CampaignMonitor/Client.html">Client</a>
|
|
225
|
+
objects associated with the API Key
|
|
226
|
+
</p>
|
|
227
|
+
<p>
|
|
228
|
+
Example
|
|
229
|
+
</p>
|
|
230
|
+
<pre>
|
|
231
|
+
@cm = CampaignMonitor.new()
|
|
232
|
+
@clients = @cm.clients
|
|
233
|
+
|
|
234
|
+
for client in @clients
|
|
235
|
+
puts client.name
|
|
236
|
+
end
|
|
237
|
+
</pre>
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
<div id="method-M000005" class="method-detail">
|
|
242
|
+
<a name="M000005"></a>
|
|
243
|
+
|
|
244
|
+
<div class="method-heading">
|
|
245
|
+
<a href="CampaignMonitor.src/M000005.html" target="Code" class="method-signature"
|
|
246
|
+
onclick="popupCode('CampaignMonitor.src/M000005.html');return false;">
|
|
247
|
+
<span class="method-name">http_get</span><span class="method-args">(url)</span>
|
|
248
|
+
</a>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div class="method-description">
|
|
252
|
+
<p>
|
|
253
|
+
Does an HTTP GET on a given URL and returns the response body
|
|
254
|
+
</p>
|
|
255
|
+
</div>
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
<div id="method-M000009" class="method-detail">
|
|
259
|
+
<a name="M000009"></a>
|
|
260
|
+
|
|
261
|
+
<div class="method-heading">
|
|
262
|
+
<a href="CampaignMonitor.src/M000009.html" target="Code" class="method-signature"
|
|
263
|
+
onclick="popupCode('CampaignMonitor.src/M000009.html');return false;">
|
|
264
|
+
<span class="method-name">lists</span><span class="method-args">(client_id)</span>
|
|
265
|
+
</a>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
<div class="method-description">
|
|
269
|
+
<p>
|
|
270
|
+
Returns an array of <a
|
|
271
|
+
href="CampaignMonitor/Subscriber.html">Subscriber</a> Lists for the
|
|
272
|
+
specified <a href="CampaignMonitor/Client.html">Client</a> ID
|
|
273
|
+
</p>
|
|
274
|
+
<p>
|
|
275
|
+
Example
|
|
276
|
+
</p>
|
|
277
|
+
<pre>
|
|
278
|
+
@cm = CampaignMonitor.new()
|
|
279
|
+
@lists = @cm.lists(12345)
|
|
280
|
+
|
|
281
|
+
for list in @lists
|
|
282
|
+
puts list.name
|
|
283
|
+
end
|
|
284
|
+
</pre>
|
|
285
|
+
</div>
|
|
286
|
+
</div>
|
|
287
|
+
|
|
288
|
+
<div id="method-M000006" class="method-detail">
|
|
289
|
+
<a name="M000006"></a>
|
|
290
|
+
|
|
291
|
+
<div class="method-heading">
|
|
292
|
+
<a href="CampaignMonitor.src/M000006.html" target="Code" class="method-signature"
|
|
293
|
+
onclick="popupCode('CampaignMonitor.src/M000006.html');return false;">
|
|
294
|
+
<span class="method-name">method_missing</span><span class="method-args">(method_id, *params)</span>
|
|
295
|
+
</a>
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
<div class="method-description">
|
|
299
|
+
<p>
|
|
300
|
+
By overriding the <a href="CampaignMonitor.html#M000006">method_missing</a>
|
|
301
|
+
method, it is possible to easily support all of the methods available in
|
|
302
|
+
the API
|
|
303
|
+
</p>
|
|
304
|
+
</div>
|
|
305
|
+
</div>
|
|
306
|
+
|
|
307
|
+
<div id="method-M000003" class="method-detail">
|
|
308
|
+
<a name="M000003"></a>
|
|
309
|
+
|
|
310
|
+
<div class="method-heading">
|
|
311
|
+
<a href="CampaignMonitor.src/M000003.html" target="Code" class="method-signature"
|
|
312
|
+
onclick="popupCode('CampaignMonitor.src/M000003.html');return false;">
|
|
313
|
+
<span class="method-name">request</span><span class="method-args">(method, *params)</span>
|
|
314
|
+
</a>
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
<div class="method-description">
|
|
318
|
+
<p>
|
|
319
|
+
Takes a <a href="CampaignMonitor.html">CampaignMonitor</a> API method name
|
|
320
|
+
and set of parameters; returns an XmlSimple object with the response
|
|
321
|
+
</p>
|
|
322
|
+
</div>
|
|
323
|
+
</div>
|
|
324
|
+
|
|
325
|
+
<div id="method-M000004" class="method-detail">
|
|
326
|
+
<a name="M000004"></a>
|
|
327
|
+
|
|
328
|
+
<div class="method-heading">
|
|
329
|
+
<a href="CampaignMonitor.src/M000004.html" target="Code" class="method-signature"
|
|
330
|
+
onclick="popupCode('CampaignMonitor.src/M000004.html');return false;">
|
|
331
|
+
<span class="method-name">request_url</span><span class="method-args">(method, *params)</span>
|
|
332
|
+
</a>
|
|
333
|
+
</div>
|
|
334
|
+
|
|
335
|
+
<div class="method-description">
|
|
336
|
+
<p>
|
|
337
|
+
Takes a <a href="CampaignMonitor.html">CampaignMonitor</a> API method name
|
|
338
|
+
and set of parameters; returns the correct URL for the REST API.
|
|
339
|
+
</p>
|
|
340
|
+
</div>
|
|
341
|
+
</div>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<div id="validator-badges">
|
|
351
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
</body>
|
|
355
|
+
</html>
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>new (CampaignMonitor)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 64</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">api_key</span>=<span class="ruby-constant">CAMPAIGN_MONITOR_API_KEY</span>)
|
|
15
|
+
<span class="ruby-ivar">@api_key</span> = <span class="ruby-identifier">api_key</span>
|
|
16
|
+
<span class="ruby-ivar">@host</span> = <span class="ruby-value str">'http://app.campaignmonitor.com'</span>
|
|
17
|
+
<span class="ruby-ivar">@api</span> = <span class="ruby-value str">'/api/api.asmx/'</span>
|
|
18
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
19
|
+
</body>
|
|
20
|
+
</html>
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>new (CampaignMonitor)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 65</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">api_key</span>=<span class="ruby-constant">CAMPAIGN_MONITOR_API_KEY</span>)
|
|
15
|
+
<span class="ruby-ivar">@api_key</span> = <span class="ruby-identifier">api_key</span>
|
|
16
|
+
<span class="ruby-ivar">@host</span> = <span class="ruby-value str">'http://app.campaignmonitor.com'</span>
|
|
17
|
+
<span class="ruby-ivar">@api</span> = <span class="ruby-value str">'/api/api.asmx/'</span>
|
|
18
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
19
|
+
</body>
|
|
20
|
+
</html>
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>request (CampaignMonitor)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 73</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">params</span>)
|
|
15
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">XmlSimple</span>.<span class="ruby-identifier">xml_in</span>(<span class="ruby-identifier">http_get</span>(<span class="ruby-identifier">request_url</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">params</span>)), { <span class="ruby-value str">'ForceArray'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>, <span class="ruby-value str">'ForceArray'</span> =<span class="ruby-operator">></span> <span class="ruby-regexp re">%r(List$|Campaign$|Subscriber$|Client$|SubscriberOpen$|SubscriberUnsubscribe$|SubscriberClick$|SubscriberBounce$)</span>, <span class="ruby-value str">'NoAttr'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span> })
|
|
16
|
+
<span class="ruby-identifier">response</span>
|
|
17
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
18
|
+
</body>
|
|
19
|
+
</html>
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>request_url (CampaignMonitor)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 79</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">request_url</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">params</span>)
|
|
15
|
+
<span class="ruby-identifier">url</span> = <span class="ruby-node">"#{@host}#{@api}/#{method}?ApiKey=#{@api_key}"</span>
|
|
16
|
+
<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">each_key</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">url</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"&#{key}="</span> <span class="ruby-operator">+</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-identifier">escape</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>][<span class="ruby-identifier">key</span>].<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
|
|
17
|
+
<span class="ruby-identifier">url</span>
|
|
18
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
19
|
+
</body>
|
|
20
|
+
</html>
|