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
@@ -0,0 +1,21 @@
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>records (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 campaign_monitor_old.rb, line 208</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">records</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">parameters</span>={})
15
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">request</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">parameters</span>).<span class="ruby-identifier">values</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> []
16
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">result</span>[<span class="ruby-identifier">node</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">return</span> []
17
+ <span class="ruby-identifier">result</span> = [<span class="ruby-identifier">result</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Array</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">result</span>
18
+ <span class="ruby-identifier">result</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-constant">Record</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">row</span>) }
19
+ <span class="ruby-keyword kw">end</span></pre>
20
+ </body>
21
+ </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,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 72</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">&gt;</span> <span class="ruby-keyword kw">false</span>, <span class="ruby-value str">'ForceArray'</span> =<span class="ruby-operator">&gt;</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">&gt;</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 78</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">&quot;#{@host}#{@api}/#{method}?ApiKey=#{@api_key}&quot;</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">&quot;&amp;#{key}=&quot;</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>
@@ -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>http_get (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 85</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">http_get</span>(<span class="ruby-identifier">url</span>)
15
+ <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get_response</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">url</span>)).<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
@@ -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>method_missing (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 89</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method_id</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">params</span>)
15
+ <span class="ruby-identifier">request</span>(<span class="ruby-identifier">method_id</span>.<span class="ruby-identifier">id2name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/_/</span>, <span class="ruby-value str">'.'</span>), <span class="ruby-identifier">params</span>[<span class="ruby-value">0</span>])
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
@@ -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>clients (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 93</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clients</span>
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-constant">User_GetClients</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;Client&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">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>[<span class="ruby-value str">&quot;ClientID&quot;</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">c</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>
@@ -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)</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 108</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">campaigns</span>(<span class="ruby-identifier">client_id</span>)
15
+ <span class="ruby-identifier">response</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-identifier">client_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>
@@ -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)</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 117</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lists</span>(<span class="ruby-identifier">client_id</span>)
15
+ <span class="ruby-identifier">response</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-identifier">client_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>
@@ -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>add_subscriber (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 126</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_subscriber</span>(<span class="ruby-identifier">list_id</span>, <span class="ruby-identifier">email</span>, <span class="ruby-identifier">name</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-constant">Subscriber_Add</span>(<span class="ruby-value str">&quot;ListID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">list_id</span>, <span class="ruby-value str">&quot;Email&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">email</span>, <span class="ruby-value str">&quot;Name&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>)
16
+ <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>], <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
@@ -0,0 +1,387 @@
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::Campaign</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::Campaign</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 information about a campaign
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="#M000030">bounces</a>&nbsp;&nbsp;
96
+ <a href="#M000031">clicks</a>&nbsp;&nbsp;
97
+ <a href="#M000028">new</a>&nbsp;&nbsp;
98
+ <a href="#M000037">number_bounced</a>&nbsp;&nbsp;
99
+ <a href="#M000035">number_clicks</a>&nbsp;&nbsp;
100
+ <a href="#M000034">number_opened</a>&nbsp;&nbsp;
101
+ <a href="#M000033">number_recipients</a>&nbsp;&nbsp;
102
+ <a href="#M000036">number_unsubscribed</a>&nbsp;&nbsp;
103
+ <a href="#M000029">opens</a>&nbsp;&nbsp;
104
+ <a href="#M000032">unsubscribes</a>&nbsp;&nbsp;
105
+ </div>
106
+ </div>
107
+
108
+ </div>
109
+
110
+
111
+ <!-- if includes -->
112
+
113
+ <div id="section">
114
+
115
+
116
+
117
+
118
+
119
+ <div id="attribute-list">
120
+ <h3 class="section-bar">Attributes</h3>
121
+
122
+ <div class="name-list">
123
+ <table>
124
+ <tr class="top-aligned-row context-row">
125
+ <td class="context-item-name">id</td>
126
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
127
+ <td class="context-item-desc"></td>
128
+ </tr>
129
+ <tr class="top-aligned-row context-row">
130
+ <td class="context-item-name">sent_date</td>
131
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
132
+ <td class="context-item-desc"></td>
133
+ </tr>
134
+ <tr class="top-aligned-row context-row">
135
+ <td class="context-item-name">subject</td>
136
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
137
+ <td class="context-item-desc"></td>
138
+ </tr>
139
+ <tr class="top-aligned-row context-row">
140
+ <td class="context-item-name">total_recipients</td>
141
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
142
+ <td class="context-item-desc"></td>
143
+ </tr>
144
+ </table>
145
+ </div>
146
+ </div>
147
+
148
+
149
+
150
+ <!-- if method_list -->
151
+ <div id="methods">
152
+ <h3 class="section-bar">Public Class methods</h3>
153
+
154
+ <div id="method-M000028" class="method-detail">
155
+ <a name="M000028"></a>
156
+
157
+ <div class="method-heading">
158
+ <a href="Campaign.src/M000028.html" target="Code" class="method-signature"
159
+ onclick="popupCode('Campaign.src/M000028.html');return false;">
160
+ <span class="method-name">new</span><span class="method-args">(id=nil, subject=nil, sent_date=nil, total_recipients=nil)</span>
161
+ </a>
162
+ </div>
163
+
164
+ <div class="method-description">
165
+ </div>
166
+ </div>
167
+
168
+ <h3 class="section-bar">Public Instance methods</h3>
169
+
170
+ <div id="method-M000030" class="method-detail">
171
+ <a name="M000030"></a>
172
+
173
+ <div class="method-heading">
174
+ <a href="Campaign.src/M000030.html" target="Code" class="method-signature"
175
+ onclick="popupCode('Campaign.src/M000030.html');return false;">
176
+ <span class="method-name">bounces</span><span class="method-args">()</span>
177
+ </a>
178
+ </div>
179
+
180
+ <div class="method-description">
181
+ <p>
182
+ Example
183
+ </p>
184
+ <pre>
185
+ @campaign = Campaign.new(12345)
186
+ @subscriber_bounces = @campaign.bounces
187
+
188
+ for subscriber in @subscriber_bounces
189
+ puts subscriber.email
190
+ end
191
+ </pre>
192
+ </div>
193
+ </div>
194
+
195
+ <div id="method-M000031" class="method-detail">
196
+ <a name="M000031"></a>
197
+
198
+ <div class="method-heading">
199
+ <a href="Campaign.src/M000031.html" target="Code" class="method-signature"
200
+ onclick="popupCode('Campaign.src/M000031.html');return false;">
201
+ <span class="method-name">clicks</span><span class="method-args">()</span>
202
+ </a>
203
+ </div>
204
+
205
+ <div class="method-description">
206
+ <p>
207
+ Example
208
+ </p>
209
+ <pre>
210
+ @campaign = Campaign.new(12345)
211
+ @subscriber_clicks = @campaign.clicks
212
+
213
+ for subscriber in @subscriber_clicks
214
+ puts subscriber.email
215
+ end
216
+ </pre>
217
+ </div>
218
+ </div>
219
+
220
+ <div id="method-M000037" class="method-detail">
221
+ <a name="M000037"></a>
222
+
223
+ <div class="method-heading">
224
+ <a href="Campaign.src/M000037.html" target="Code" class="method-signature"
225
+ onclick="popupCode('Campaign.src/M000037.html');return false;">
226
+ <span class="method-name">number_bounced</span><span class="method-args">()</span>
227
+ </a>
228
+ </div>
229
+
230
+ <div class="method-description">
231
+ <p>
232
+ Example
233
+ </p>
234
+ <pre>
235
+ @campaign = Campaign.new(12345)
236
+ puts @campaign.number_bounced
237
+ </pre>
238
+ </div>
239
+ </div>
240
+
241
+ <div id="method-M000035" class="method-detail">
242
+ <a name="M000035"></a>
243
+
244
+ <div class="method-heading">
245
+ <a href="Campaign.src/M000035.html" target="Code" class="method-signature"
246
+ onclick="popupCode('Campaign.src/M000035.html');return false;">
247
+ <span class="method-name">number_clicks</span><span class="method-args">()</span>
248
+ </a>
249
+ </div>
250
+
251
+ <div class="method-description">
252
+ <p>
253
+ Example
254
+ </p>
255
+ <pre>
256
+ @campaign = Campaign.new(12345)
257
+ puts @campaign.number_clicks
258
+ </pre>
259
+ </div>
260
+ </div>
261
+
262
+ <div id="method-M000034" class="method-detail">
263
+ <a name="M000034"></a>
264
+
265
+ <div class="method-heading">
266
+ <a href="Campaign.src/M000034.html" target="Code" class="method-signature"
267
+ onclick="popupCode('Campaign.src/M000034.html');return false;">
268
+ <span class="method-name">number_opened</span><span class="method-args">()</span>
269
+ </a>
270
+ </div>
271
+
272
+ <div class="method-description">
273
+ <p>
274
+ Example
275
+ </p>
276
+ <pre>
277
+ @campaign = Campaign.new(12345)
278
+ puts @campaign.number_opened
279
+ </pre>
280
+ </div>
281
+ </div>
282
+
283
+ <div id="method-M000033" class="method-detail">
284
+ <a name="M000033"></a>
285
+
286
+ <div class="method-heading">
287
+ <a href="Campaign.src/M000033.html" target="Code" class="method-signature"
288
+ onclick="popupCode('Campaign.src/M000033.html');return false;">
289
+ <span class="method-name">number_recipients</span><span class="method-args">()</span>
290
+ </a>
291
+ </div>
292
+
293
+ <div class="method-description">
294
+ <p>
295
+ Example
296
+ </p>
297
+ <pre>
298
+ @campaign = Campaign.new(12345)
299
+ puts @campaign.number_recipients
300
+ </pre>
301
+ </div>
302
+ </div>
303
+
304
+ <div id="method-M000036" class="method-detail">
305
+ <a name="M000036"></a>
306
+
307
+ <div class="method-heading">
308
+ <a href="Campaign.src/M000036.html" target="Code" class="method-signature"
309
+ onclick="popupCode('Campaign.src/M000036.html');return false;">
310
+ <span class="method-name">number_unsubscribed</span><span class="method-args">()</span>
311
+ </a>
312
+ </div>
313
+
314
+ <div class="method-description">
315
+ <p>
316
+ Example
317
+ </p>
318
+ <pre>
319
+ @campaign = Campaign.new(12345)
320
+ puts @campaign.number_unsubscribed
321
+ </pre>
322
+ </div>
323
+ </div>
324
+
325
+ <div id="method-M000029" class="method-detail">
326
+ <a name="M000029"></a>
327
+
328
+ <div class="method-heading">
329
+ <a href="Campaign.src/M000029.html" target="Code" class="method-signature"
330
+ onclick="popupCode('Campaign.src/M000029.html');return false;">
331
+ <span class="method-name">opens</span><span class="method-args">()</span>
332
+ </a>
333
+ </div>
334
+
335
+ <div class="method-description">
336
+ <p>
337
+ Example
338
+ </p>
339
+ <pre>
340
+ @campaign = Campaign.new(12345)
341
+ @subscriber_opens = @campaign.opens
342
+
343
+ for subscriber in @subscriber_opens
344
+ puts subscriber.email
345
+ end
346
+ </pre>
347
+ </div>
348
+ </div>
349
+
350
+ <div id="method-M000032" class="method-detail">
351
+ <a name="M000032"></a>
352
+
353
+ <div class="method-heading">
354
+ <a href="Campaign.src/M000032.html" target="Code" class="method-signature"
355
+ onclick="popupCode('Campaign.src/M000032.html');return false;">
356
+ <span class="method-name">unsubscribes</span><span class="method-args">()</span>
357
+ </a>
358
+ </div>
359
+
360
+ <div class="method-description">
361
+ <p>
362
+ Example
363
+ </p>
364
+ <pre>
365
+ @campaign = Campaign.new(12345)
366
+ @subscriber_unsubscribes = @campaign.unsubscribes
367
+
368
+ for subscriber in @subscriber_unsubscribes
369
+ puts subscriber.email
370
+ end
371
+ </pre>
372
+ </div>
373
+ </div>
374
+
375
+
376
+ </div>
377
+
378
+
379
+ </div>
380
+
381
+
382
+ <div id="validator-badges">
383
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
384
+ </div>
385
+
386
+ </body>
387
+ </html>