campaign_monitor 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (137) hide show
  1. data/CHANGELOG +3 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README +30 -0
  4. data/TODO +3 -0
  5. data/doc/classes/CMCampaignSummary.html +170 -0
  6. data/doc/classes/CMCampaignSummary.src/M000003.html +22 -0
  7. data/doc/classes/CMClient.html +111 -0
  8. data/doc/classes/CMResult.html +155 -0
  9. data/doc/classes/CMResult.src/M000004.html +19 -0
  10. data/doc/classes/CampaignMonitor.html +355 -0
  11. data/doc/classes/CampaignMonitor.src/M000001.html +20 -0
  12. data/doc/classes/CampaignMonitor.src/M000002.html +20 -0
  13. data/doc/classes/CampaignMonitor.src/M000003.html +19 -0
  14. data/doc/classes/CampaignMonitor.src/M000004.html +20 -0
  15. data/doc/classes/CampaignMonitor.src/M000005.html +18 -0
  16. data/doc/classes/CampaignMonitor.src/M000006.html +18 -0
  17. data/doc/classes/CampaignMonitor.src/M000007.html +23 -0
  18. data/doc/classes/CampaignMonitor.src/M000008.html +23 -0
  19. data/doc/classes/CampaignMonitor.src/M000009.html +23 -0
  20. data/doc/classes/CampaignMonitor.src/M000010.html +19 -0
  21. data/doc/classes/CampaignMonitor.src/M000011.html +19 -0
  22. data/doc/classes/CampaignMonitor.src/M000012.html +18 -0
  23. data/doc/classes/CampaignMonitor.src/M000013.html +18 -0
  24. data/doc/classes/CampaignMonitor.src/M000014.html +18 -0
  25. data/doc/classes/CampaignMonitor.src/M000015.html +19 -0
  26. data/doc/classes/CampaignMonitor.src/M000016.html +18 -0
  27. data/doc/classes/CampaignMonitor.src/M000017.html +18 -0
  28. data/doc/classes/CampaignMonitor.src/M000018.html +18 -0
  29. data/doc/classes/CampaignMonitor.src/M000019.html +18 -0
  30. data/doc/classes/CampaignMonitor.src/M000020.html +18 -0
  31. data/doc/classes/CampaignMonitor.src/M000021.html +18 -0
  32. data/doc/classes/CampaignMonitor.src/M000022.html +18 -0
  33. data/doc/classes/CampaignMonitor.src/M000023.html +18 -0
  34. data/doc/classes/CampaignMonitor.src/M000024.html +29 -0
  35. data/doc/classes/CampaignMonitor.src/M000025.html +19 -0
  36. data/doc/classes/CampaignMonitor.src/M000026.html +21 -0
  37. data/doc/classes/CampaignMonitor.src/M000027.html +20 -0
  38. data/doc/classes/CampaignMonitor.src/M000028.html +19 -0
  39. data/doc/classes/CampaignMonitor.src/M000029.html +20 -0
  40. data/doc/classes/CampaignMonitor.src/M000030.html +18 -0
  41. data/doc/classes/CampaignMonitor.src/M000031.html +18 -0
  42. data/doc/classes/CampaignMonitor.src/M000032.html +23 -0
  43. data/doc/classes/CampaignMonitor.src/M000033.html +23 -0
  44. data/doc/classes/CampaignMonitor.src/M000034.html +23 -0
  45. data/doc/classes/CampaignMonitor.src/M000035.html +19 -0
  46. data/doc/classes/CampaignMonitor/Campaign.html +387 -0
  47. data/doc/classes/CampaignMonitor/Campaign.src/M000027.html +22 -0
  48. data/doc/classes/CampaignMonitor/Campaign.src/M000028.html +22 -0
  49. data/doc/classes/CampaignMonitor/Campaign.src/M000029.html +23 -0
  50. data/doc/classes/CampaignMonitor/Campaign.src/M000030.html +23 -0
  51. data/doc/classes/CampaignMonitor/Campaign.src/M000031.html +23 -0
  52. data/doc/classes/CampaignMonitor/Campaign.src/M000032.html +23 -0
  53. data/doc/classes/CampaignMonitor/Campaign.src/M000033.html +18 -0
  54. data/doc/classes/CampaignMonitor/Campaign.src/M000034.html +18 -0
  55. data/doc/classes/CampaignMonitor/Campaign.src/M000035.html +18 -0
  56. data/doc/classes/CampaignMonitor/Campaign.src/M000036.html +18 -0
  57. data/doc/classes/CampaignMonitor/Campaign.src/M000037.html +18 -0
  58. data/doc/classes/CampaignMonitor/Campaign.src/M000053.html +22 -0
  59. data/doc/classes/CampaignMonitor/Campaign.src/M000054.html +23 -0
  60. data/doc/classes/CampaignMonitor/Campaign.src/M000055.html +23 -0
  61. data/doc/classes/CampaignMonitor/Campaign.src/M000056.html +23 -0
  62. data/doc/classes/CampaignMonitor/Campaign.src/M000057.html +23 -0
  63. data/doc/classes/CampaignMonitor/Campaign.src/M000058.html +18 -0
  64. data/doc/classes/CampaignMonitor/Campaign.src/M000059.html +18 -0
  65. data/doc/classes/CampaignMonitor/Campaign.src/M000060.html +18 -0
  66. data/doc/classes/CampaignMonitor/Campaign.src/M000061.html +18 -0
  67. data/doc/classes/CampaignMonitor/Campaign.src/M000062.html +18 -0
  68. data/doc/classes/CampaignMonitor/Client.html +226 -0
  69. data/doc/classes/CampaignMonitor/Client.src/M000016.html +20 -0
  70. data/doc/classes/CampaignMonitor/Client.src/M000017.html +20 -0
  71. data/doc/classes/CampaignMonitor/Client.src/M000018.html +23 -0
  72. data/doc/classes/CampaignMonitor/Client.src/M000019.html +23 -0
  73. data/doc/classes/CampaignMonitor/Client.src/M000042.html +20 -0
  74. data/doc/classes/CampaignMonitor/Client.src/M000043.html +23 -0
  75. data/doc/classes/CampaignMonitor/Client.src/M000044.html +23 -0
  76. data/doc/classes/CampaignMonitor/List.html +308 -0
  77. data/doc/classes/CampaignMonitor/List.src/M000021.html +20 -0
  78. data/doc/classes/CampaignMonitor/List.src/M000022.html +20 -0
  79. data/doc/classes/CampaignMonitor/List.src/M000023.html +19 -0
  80. data/doc/classes/CampaignMonitor/List.src/M000024.html +19 -0
  81. data/doc/classes/CampaignMonitor/List.src/M000025.html +23 -0
  82. data/doc/classes/CampaignMonitor/List.src/M000026.html +23 -0
  83. data/doc/classes/CampaignMonitor/List.src/M000027.html +23 -0
  84. data/doc/classes/CampaignMonitor/List.src/M000047.html +20 -0
  85. data/doc/classes/CampaignMonitor/List.src/M000048.html +19 -0
  86. data/doc/classes/CampaignMonitor/List.src/M000049.html +19 -0
  87. data/doc/classes/CampaignMonitor/List.src/M000050.html +23 -0
  88. data/doc/classes/CampaignMonitor/List.src/M000051.html +23 -0
  89. data/doc/classes/CampaignMonitor/List.src/M000052.html +23 -0
  90. data/doc/classes/CampaignMonitor/Result.html +162 -0
  91. data/doc/classes/CampaignMonitor/Result.src/M000020.html +19 -0
  92. data/doc/classes/CampaignMonitor/Result.src/M000021.html +19 -0
  93. data/doc/classes/CampaignMonitor/Result.src/M000046.html +19 -0
  94. data/doc/classes/CampaignMonitor/Subscriber.html +212 -0
  95. data/doc/classes/CampaignMonitor/Subscriber.src/M000012.html +21 -0
  96. data/doc/classes/CampaignMonitor/Subscriber.src/M000013.html +21 -0
  97. data/doc/classes/CampaignMonitor/Subscriber.src/M000014.html +19 -0
  98. data/doc/classes/CampaignMonitor/Subscriber.src/M000015.html +19 -0
  99. data/doc/classes/CampaignMonitor/Subscriber.src/M000038.html +21 -0
  100. data/doc/classes/CampaignMonitor/Subscriber.src/M000039.html +19 -0
  101. data/doc/classes/CampaignMonitor/Subscriber.src/M000040.html +19 -0
  102. data/doc/classes/CampaignMonitor/SubscriberBounce.html +166 -0
  103. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html +20 -0
  104. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000020.html +20 -0
  105. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html +20 -0
  106. data/doc/classes/CampaignMonitor/SubscriberClick.html +166 -0
  107. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html +20 -0
  108. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000011.html +20 -0
  109. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html +20 -0
  110. data/doc/classes/CampaignMonitor/SubscriberOpen.html +166 -0
  111. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html +20 -0
  112. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000012.html +20 -0
  113. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html +20 -0
  114. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html +161 -0
  115. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html +19 -0
  116. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000016.html +19 -0
  117. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html +19 -0
  118. data/doc/classes/CampaignMonitorTest.html +137 -0
  119. data/doc/classes/CampaignMonitorTest.src/M000001.html +18 -0
  120. data/doc/classes/Hash.html +137 -0
  121. data/doc/classes/Hash.src/M000002.html +18 -0
  122. data/doc/classes/Symbol.html +143 -0
  123. data/doc/classes/Symbol.src/M000001.html +18 -0
  124. data/doc/created.rid +1 -0
  125. data/doc/files/campaign_monitor_old_rb.html +119 -0
  126. data/doc/files/init_rb.html +108 -0
  127. data/doc/files/install_rb.html +101 -0
  128. data/doc/files/lib/campaign_monitor_rb.html +184 -0
  129. data/doc/files/test/campaign_monitor_test_rb.html +101 -0
  130. data/doc/fr_class_index.html +37 -0
  131. data/doc/fr_file_index.html +28 -0
  132. data/doc/fr_method_index.html +63 -0
  133. data/doc/index.html +24 -0
  134. data/doc/rdoc-style.css +208 -0
  135. data/lib/campaign_monitor.rb +503 -0
  136. data/test/campaign_monitor_test.rb +6 -0
  137. metadata +175 -0
data/doc/classes/CampaignMonitor/Campaign.src/M000062.html ADDED
@@ -0,0 +1,18 @@
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>number_bounced (CampaignMonitor::Campaign)</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 286</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">number_bounced</span>
15
+ <span class="ruby-ivar">@number_bounced</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">getInfo</span>.<span class="ruby-identifier">number_bounced</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@number_bounced</span>
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
data/doc/classes/CampaignMonitor/Client.html ADDED
@@ -0,0 +1,226 @@
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::Client</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::Client</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
+ <div id="description">
82
+ <p>
83
+ Provides access to the lists and campaigns associated with a client
84
+ </p>
85
+
86
+ </div>
87
+
88
+
89
+ </div>
90
+
91
+ <div id="method-list">
92
+ <h3 class="section-bar">Methods</h3>
93
+
94
+ <div class="name-list">
95
+ <a href="#M000019">campaigns</a>&nbsp;&nbsp;
96
+ <a href="#M000018">lists</a>&nbsp;&nbsp;
97
+ <a href="#M000017">new</a>&nbsp;&nbsp;
98
+ </div>
99
+ </div>
100
+
101
+ </div>
102
+
103
+
104
+ <!-- if includes -->
105
+
106
+ <div id="section">
107
+
108
+
109
+
110
+
111
+
112
+ <div id="attribute-list">
113
+ <h3 class="section-bar">Attributes</h3>
114
+
115
+ <div class="name-list">
116
+ <table>
117
+ <tr class="top-aligned-row context-row">
118
+ <td class="context-item-name">cm_client</td>
119
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
120
+ <td class="context-item-desc"></td>
121
+ </tr>
122
+ <tr class="top-aligned-row context-row">
123
+ <td class="context-item-name">id</td>
124
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
125
+ <td class="context-item-desc"></td>
126
+ </tr>
127
+ <tr class="top-aligned-row context-row">
128
+ <td class="context-item-name">name</td>
129
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
130
+ <td class="context-item-desc"></td>
131
+ </tr>
132
+ </table>
133
+ </div>
134
+ </div>
135
+
136
+
137
+
138
+ <!-- if method_list -->
139
+ <div id="methods">
140
+ <h3 class="section-bar">Public Class methods</h3>
141
+
142
+ <div id="method-M000017" class="method-detail">
143
+ <a name="M000017"></a>
144
+
145
+ <div class="method-heading">
146
+ <a href="Client.src/M000017.html" target="Code" class="method-signature"
147
+ onclick="popupCode('Client.src/M000017.html');return false;">
148
+ <span class="method-name">new</span><span class="method-args">(id, name=nil)</span>
149
+ </a>
150
+ </div>
151
+
152
+ <div class="method-description">
153
+ <p>
154
+ Example
155
+ </p>
156
+ <pre>
157
+ @client = new Client(12345)
158
+ </pre>
159
+ </div>
160
+ </div>
161
+
162
+ <h3 class="section-bar">Public Instance methods</h3>
163
+
164
+ <div id="method-M000019" class="method-detail">
165
+ <a name="M000019"></a>
166
+
167
+ <div class="method-heading">
168
+ <a href="Client.src/M000019.html" target="Code" class="method-signature"
169
+ onclick="popupCode('Client.src/M000019.html');return false;">
170
+ <span class="method-name">campaigns</span><span class="method-args">()</span>
171
+ </a>
172
+ </div>
173
+
174
+ <div class="method-description">
175
+ <p>
176
+ Example
177
+ </p>
178
+ <pre>
179
+ @client = new Client(12345)
180
+ @campaigns = @client.campaigns
181
+
182
+ for campaign in @campaigns
183
+ puts campaign.subject
184
+ end
185
+ </pre>
186
+ </div>
187
+ </div>
188
+
189
+ <div id="method-M000018" class="method-detail">
190
+ <a name="M000018"></a>
191
+
192
+ <div class="method-heading">
193
+ <a href="Client.src/M000018.html" target="Code" class="method-signature"
194
+ onclick="popupCode('Client.src/M000018.html');return false;">
195
+ <span class="method-name">lists</span><span class="method-args">()</span>
196
+ </a>
197
+ </div>
198
+
199
+ <div class="method-description">
200
+ <p>
201
+ Example
202
+ </p>
203
+ <pre>
204
+ @client = new Client(12345)
205
+ @lists = @client.lists
206
+
207
+ for list in @lists
208
+ puts list.name
209
+ end
210
+ </pre>
211
+ </div>
212
+ </div>
213
+
214
+
215
+ </div>
216
+
217
+
218
+ </div>
219
+
220
+
221
+ <div id="validator-badges">
222
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
223
+ </div>
224
+
225
+ </body>
226
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000016.html ADDED
@@ -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::Client)</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 141</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000017.html ADDED
@@ -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::Client)</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 170</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000018.html ADDED
@@ -0,0 +1,23 @@
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>lists (CampaignMonitor::Client)</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 183</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lists</span>
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Client_GetLists</span>(<span class="ruby-value str">&quot;ClientID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>)
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;List&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">List</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">l</span>[<span class="ruby-value str">&quot;ListID&quot;</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">l</span>[<span class="ruby-value str">&quot;Name&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000019.html ADDED
@@ -0,0 +1,23 @@
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>campaigns (CampaignMonitor::Client)</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 199</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">campaigns</span>
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Client_GetCampaigns</span>(<span class="ruby-value str">&quot;ClientID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>)
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Campaign&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Campaign</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;CampaignID&quot;</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;Subject&quot;</span>], <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;SentDate&quot;</span>], <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;TotalRecipients&quot;</span>].<span class="ruby-identifier">to_i</span>)}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000042.html ADDED
@@ -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::Client)</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 139</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000043.html ADDED
@@ -0,0 +1,23 @@
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>lists (CampaignMonitor::Client)</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 145</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lists</span>
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Client_GetLists</span>(<span class="ruby-value str">&quot;ClientID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>)
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;List&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-constant">List</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">l</span>[<span class="ruby-value str">&quot;ListID&quot;</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">l</span>[<span class="ruby-value str">&quot;Name&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
data/doc/classes/CampaignMonitor/Client.src/M000044.html ADDED
@@ -0,0 +1,23 @@
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>campaigns (CampaignMonitor::Client)</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 154</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">campaigns</span>
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Client_GetCampaigns</span>(<span class="ruby-value str">&quot;ClientID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>)
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Campaign&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Campaign</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;CampaignID&quot;</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;Subject&quot;</span>], <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;SentDate&quot;</span>], <span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;TotalRecipients&quot;</span>].<span class="ruby-identifier">to_i</span>)}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
data/doc/classes/CampaignMonitor/List.html ADDED
@@ -0,0 +1,308 @@
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::List</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::List</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
+ <div id="description">
82
+ <p>
83
+ Provides access to the subscribers and info about subscribers associated
84
+ with a Mailing <a href="List.html">List</a>
85
+ </p>
86
+
87
+ </div>
88
+
89
+
90
+ </div>
91
+
92
+ <div id="method-list">
93
+ <h3 class="section-bar">Methods</h3>
94
+
95
+ <div class="name-list">
96
+ <a href="#M000025">active_subscribers</a>&nbsp;&nbsp;
97
+ <a href="#M000023">add_subscriber</a>&nbsp;&nbsp;
98
+ <a href="#M000027">bounced</a>&nbsp;&nbsp;
99
+ <a href="#M000022">new</a>&nbsp;&nbsp;
100
+ <a href="#M000024">remove_subscriber</a>&nbsp;&nbsp;
101
+ <a href="#M000026">unsubscribed</a>&nbsp;&nbsp;
102
+ </div>
103
+ </div>
104
+
105
+ </div>
106
+
107
+
108
+ <!-- if includes -->
109
+
110
+ <div id="section">
111
+
112
+
113
+
114
+
115
+
116
+ <div id="attribute-list">
117
+ <h3 class="section-bar">Attributes</h3>
118
+
119
+ <div class="name-list">
120
+ <table>
121
+ <tr class="top-aligned-row context-row">
122
+ <td class="context-item-name">cm_client</td>
123
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
124
+ <td class="context-item-desc"></td>
125
+ </tr>
126
+ <tr class="top-aligned-row context-row">
127
+ <td class="context-item-name">id</td>
128
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
129
+ <td class="context-item-desc"></td>
130
+ </tr>
131
+ <tr class="top-aligned-row context-row">
132
+ <td class="context-item-name">name</td>
133
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
134
+ <td class="context-item-desc"></td>
135
+ </tr>
136
+ </table>
137
+ </div>
138
+ </div>
139
+
140
+
141
+
142
+ <!-- if method_list -->
143
+ <div id="methods">
144
+ <h3 class="section-bar">Public Class methods</h3>
145
+
146
+ <div id="method-M000022" class="method-detail">
147
+ <a name="M000022"></a>
148
+
149
+ <div class="method-heading">
150
+ <a href="List.src/M000022.html" target="Code" class="method-signature"
151
+ onclick="popupCode('List.src/M000022.html');return false;">
152
+ <span class="method-name">new</span><span class="method-args">(id=nil, name=nil)</span>
153
+ </a>
154
+ </div>
155
+
156
+ <div class="method-description">
157
+ <p>
158
+ Example
159
+ </p>
160
+ <pre>
161
+ @list = new List(12345)
162
+ </pre>
163
+ </div>
164
+ </div>
165
+
166
+ <h3 class="section-bar">Public Instance methods</h3>
167
+
168
+ <div id="method-M000025" class="method-detail">
169
+ <a name="M000025"></a>
170
+
171
+ <div class="method-heading">
172
+ <a href="List.src/M000025.html" target="Code" class="method-signature"
173
+ onclick="popupCode('List.src/M000025.html');return false;">
174
+ <span class="method-name">active_subscribers</span><span class="method-args">(date)</span>
175
+ </a>
176
+ </div>
177
+
178
+ <div class="method-description">
179
+ <p>
180
+ Example
181
+ </p>
182
+ <pre>
183
+ current_date = DateTime.new
184
+ @list = new List(12345)
185
+ @subscribers = @list.active_subscribers(current_date)
186
+
187
+ for subscriber in @subscribers
188
+ puts subscriber.email
189
+ end
190
+ </pre>
191
+ </div>
192
+ </div>
193
+
194
+ <div id="method-M000023" class="method-detail">
195
+ <a name="M000023"></a>
196
+
197
+ <div class="method-heading">
198
+ <a href="List.src/M000023.html" target="Code" class="method-signature"
199
+ onclick="popupCode('List.src/M000023.html');return false;">
200
+ <span class="method-name">add_subscriber</span><span class="method-args">(email, name = nil)</span>
201
+ </a>
202
+ </div>
203
+
204
+ <div class="method-description">
205
+ <p>
206
+ Example
207
+ </p>
208
+ <pre>
209
+ @list = new List(12345)
210
+ result = @list.add_subscriber(&quot;ralph.wiggum@simpsons.net&quot;)
211
+
212
+ if result.code == 0
213
+ puts &quot;Added Subscriber&quot;
214
+ end
215
+ </pre>
216
+ </div>
217
+ </div>
218
+
219
+ <div id="method-M000027" class="method-detail">
220
+ <a name="M000027"></a>
221
+
222
+ <div class="method-heading">
223
+ <a href="List.src/M000027.html" target="Code" class="method-signature"
224
+ onclick="popupCode('List.src/M000027.html');return false;">
225
+ <span class="method-name">bounced</span><span class="method-args">(date)</span>
226
+ </a>
227
+ </div>
228
+
229
+ <div class="method-description">
230
+ <p>
231
+ Example
232
+ </p>
233
+ <pre>
234
+ current_date = DateTime.new
235
+ @list = new List(12345)
236
+ @subscribers = @list.bounced(current_date)
237
+
238
+ for subscriber in @subscribers
239
+ puts subscriber.email
240
+ end
241
+ </pre>
242
+ </div>
243
+ </div>
244
+
245
+ <div id="method-M000024" class="method-detail">
246
+ <a name="M000024"></a>
247
+
248
+ <div class="method-heading">
249
+ <a href="List.src/M000024.html" target="Code" class="method-signature"
250
+ onclick="popupCode('List.src/M000024.html');return false;">
251
+ <span class="method-name">remove_subscriber</span><span class="method-args">(email)</span>
252
+ </a>
253
+ </div>
254
+
255
+ <div class="method-description">
256
+ <p>
257
+ Example
258
+ </p>
259
+ <pre>
260
+ @list = new List(12345)
261
+ result = @list.remove_subscriber(&quot;ralph.wiggum@simpsons.net&quot;)
262
+
263
+ if result.code == 0
264
+ puts &quot;Deleted Subscriber&quot;
265
+ end
266
+ </pre>
267
+ </div>
268
+ </div>
269
+
270
+ <div id="method-M000026" class="method-detail">
271
+ <a name="M000026"></a>
272
+
273
+ <div class="method-heading">
274
+ <a href="List.src/M000026.html" target="Code" class="method-signature"
275
+ onclick="popupCode('List.src/M000026.html');return false;">
276
+ <span class="method-name">unsubscribed</span><span class="method-args">(date)</span>
277
+ </a>
278
+ </div>
279
+
280
+ <div class="method-description">
281
+ <p>
282
+ Example
283
+ </p>
284
+ <pre>
285
+ current_date = DateTime.new
286
+ @list = new List(12345)
287
+ @subscribers = @list.unsubscribed(current_date)
288
+
289
+ for subscriber in @subscribers
290
+ puts subscriber.email
291
+ end
292
+ </pre>
293
+ </div>
294
+ </div>
295
+
296
+
297
+ </div>
298
+
299
+
300
+ </div>
301
+
302
+
303
+ <div id="validator-badges">
304
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
305
+ </div>
306
+
307
+ </body>
308
+ </html>