esp_sdk 1.1.0 → 2.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (199) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.rubocop.yml +53 -6
  4. data/.ruby-version +1 -1
  5. data/.travis.yml +8 -2
  6. data/Gemfile.lock +171 -0
  7. data/Guardfile +47 -0
  8. data/README.md +230 -5
  9. data/Rakefile +14 -1
  10. data/assets/logo.png +0 -0
  11. data/bin/esp_console +71 -0
  12. data/esp_sdk.gemspec +27 -18
  13. data/lib/esp/exceptions.rb +3 -0
  14. data/lib/esp/extensions/active_resource/formats/json_api_format.rb +105 -0
  15. data/lib/esp/extensions/active_resource/paginated_collection.rb +198 -0
  16. data/lib/esp/extensions/active_resource/validations.rb +45 -0
  17. data/lib/esp/resources/alert.rb +135 -0
  18. data/lib/esp/resources/cloud_trail_event.rb +45 -0
  19. data/lib/esp/resources/concerns/stat_totals.rb +79 -0
  20. data/lib/esp/resources/contact_request.rb +42 -0
  21. data/lib/esp/resources/custom_signature.rb +224 -0
  22. data/lib/esp/resources/dashboard.rb +31 -0
  23. data/lib/esp/resources/external_account.rb +89 -0
  24. data/lib/esp/resources/organization.rb +61 -0
  25. data/lib/esp/resources/region.rb +46 -0
  26. data/lib/esp/resources/report.rb +100 -0
  27. data/lib/esp/resources/resource.rb +66 -0
  28. data/lib/esp/resources/service.rb +31 -0
  29. data/lib/esp/resources/signature.rb +106 -0
  30. data/lib/esp/resources/stat.rb +124 -0
  31. data/lib/esp/resources/stat_custom_signature.rb +121 -0
  32. data/lib/esp/resources/stat_region.rb +121 -0
  33. data/lib/esp/resources/stat_service.rb +121 -0
  34. data/lib/esp/resources/stat_signature.rb +121 -0
  35. data/lib/esp/resources/sub_organization.rb +69 -0
  36. data/lib/esp/resources/suppression/region.rb +99 -0
  37. data/lib/esp/resources/suppression/signature.rb +107 -0
  38. data/lib/esp/resources/suppression/unique_identifier.rb +60 -0
  39. data/lib/esp/resources/suppression.rb +86 -0
  40. data/lib/esp/resources/tag.rb +45 -0
  41. data/lib/esp/resources/team.rb +79 -0
  42. data/lib/esp/resources/user.rb +46 -0
  43. data/lib/esp/version.rb +3 -0
  44. data/lib/esp.rb +95 -0
  45. data/lib/esp_sdk.rb +9 -45
  46. data/lib/tasks/rubocop.rake +2 -0
  47. data/lib/tasks/testing.rake +3 -0
  48. data/rdoc/ActiveResource/Formats.html +176 -0
  49. data/rdoc/ActiveResource/PaginatedCollection.html +910 -0
  50. data/rdoc/ActiveResource.html +180 -0
  51. data/rdoc/ESP/Alert.html +771 -0
  52. data/rdoc/ESP/CloudTrailEvent.html +375 -0
  53. data/rdoc/ESP/ContactRequest.html +366 -0
  54. data/rdoc/ESP/CustomSignature.html +746 -0
  55. data/rdoc/ESP/Dashboard.html +355 -0
  56. data/rdoc/ESP/ExternalAccount.html +565 -0
  57. data/rdoc/ESP/Organization.html +590 -0
  58. data/rdoc/ESP/Region.html +399 -0
  59. data/rdoc/ESP/Report.html +622 -0
  60. data/rdoc/ESP/Service.html +380 -0
  61. data/rdoc/ESP/Signature.html +555 -0
  62. data/rdoc/ESP/Stat.html +1778 -0
  63. data/rdoc/ESP/StatCustomSignature.html +1599 -0
  64. data/rdoc/ESP/StatRegion.html +1598 -0
  65. data/rdoc/ESP/StatService.html +1598 -0
  66. data/rdoc/ESP/StatSignature.html +1598 -0
  67. data/rdoc/ESP/SubOrganization.html +540 -0
  68. data/rdoc/ESP/Suppression/Region.html +454 -0
  69. data/rdoc/ESP/Suppression/Signature.html +470 -0
  70. data/rdoc/ESP/Suppression/UniqueIdentifier.html +417 -0
  71. data/rdoc/ESP/Suppression.html +649 -0
  72. data/rdoc/ESP/Tag.html +371 -0
  73. data/rdoc/ESP/Team.html +584 -0
  74. data/rdoc/ESP/User.html +483 -0
  75. data/rdoc/ESP.html +546 -0
  76. data/rdoc/README_md.html +501 -0
  77. data/rdoc/created.rid +30 -0
  78. data/rdoc/images/add.png +0 -0
  79. data/rdoc/images/arrow_up.png +0 -0
  80. data/rdoc/images/brick.png +0 -0
  81. data/rdoc/images/brick_link.png +0 -0
  82. data/rdoc/images/bug.png +0 -0
  83. data/rdoc/images/bullet_black.png +0 -0
  84. data/rdoc/images/bullet_toggle_minus.png +0 -0
  85. data/rdoc/images/bullet_toggle_plus.png +0 -0
  86. data/rdoc/images/date.png +0 -0
  87. data/rdoc/images/delete.png +0 -0
  88. data/rdoc/images/find.png +0 -0
  89. data/rdoc/images/loadingAnimation.gif +0 -0
  90. data/rdoc/images/macFFBgHack.png +0 -0
  91. data/rdoc/images/package.png +0 -0
  92. data/rdoc/images/page_green.png +0 -0
  93. data/rdoc/images/page_white_text.png +0 -0
  94. data/rdoc/images/page_white_width.png +0 -0
  95. data/rdoc/images/plugin.png +0 -0
  96. data/rdoc/images/ruby.png +0 -0
  97. data/rdoc/images/tag_blue.png +0 -0
  98. data/rdoc/images/tag_green.png +0 -0
  99. data/rdoc/images/transparent.png +0 -0
  100. data/rdoc/images/wrench.png +0 -0
  101. data/rdoc/images/wrench_orange.png +0 -0
  102. data/rdoc/images/zoom.png +0 -0
  103. data/rdoc/index.html +134 -0
  104. data/rdoc/js/darkfish.js +155 -0
  105. data/rdoc/js/jquery.js +4 -0
  106. data/rdoc/js/navigation.js +142 -0
  107. data/rdoc/js/search.js +94 -0
  108. data/rdoc/js/search_index.js +1 -0
  109. data/rdoc/js/searcher.js +228 -0
  110. data/rdoc/rdoc.css +595 -0
  111. data/rdoc/table_of_contents.html +927 -0
  112. data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +109 -0
  113. data/test/esp/extensions/active_resource/paginated_collection_test.rb +435 -0
  114. data/test/esp/extensions/active_resource/validations_test.rb +59 -0
  115. data/test/esp/resources/alert_test.rb +263 -0
  116. data/test/esp/resources/cloud_trail_event_test.rb +98 -0
  117. data/test/esp/resources/contact_request_test.rb +73 -0
  118. data/test/esp/resources/custom_signature_test.rb +241 -0
  119. data/test/esp/resources/dashboard_test.rb +71 -0
  120. data/test/esp/resources/external_account_test.rb +125 -0
  121. data/test/esp/resources/organization_test.rb +175 -0
  122. data/test/esp/resources/region_test.rb +84 -0
  123. data/test/esp/resources/report_test.rb +180 -0
  124. data/test/esp/resources/resource_test.rb +183 -0
  125. data/test/esp/resources/service_test.rb +64 -0
  126. data/test/esp/resources/signature_test.rb +177 -0
  127. data/test/esp/resources/stat_custom_signature_test.rb +115 -0
  128. data/test/esp/resources/stat_region_test.rb +114 -0
  129. data/test/esp/resources/stat_service_test.rb +114 -0
  130. data/test/esp/resources/stat_signature_test.rb +115 -0
  131. data/test/esp/resources/stat_test.rb +159 -0
  132. data/test/esp/resources/sub_organization_test.rb +127 -0
  133. data/test/esp/resources/suppression/region_test.rb +115 -0
  134. data/test/esp/resources/suppression/signature_test.rb +117 -0
  135. data/test/esp/resources/suppression/unique_identifier_test.rb +79 -0
  136. data/test/esp/resources/suppression_test.rb +226 -0
  137. data/test/esp/resources/tag_test.rb +98 -0
  138. data/test/esp/resources/team_test.rb +140 -0
  139. data/test/esp/resources/user_test.rb +113 -0
  140. data/test/esp_test.rb +139 -0
  141. data/test/factories/alerts.rb +234 -0
  142. data/test/factories/cloud_trail_events.rb +16 -0
  143. data/test/factories/contact_requests.rb +14 -0
  144. data/test/factories/custom_signatures.rb +30 -0
  145. data/test/factories/dashboards.rb +91 -0
  146. data/test/factories/errors.rb +24 -0
  147. data/test/factories/external_accounts.rb +44 -0
  148. data/test/factories/organizations.rb +48 -0
  149. data/test/factories/regions.rb +9 -0
  150. data/test/factories/reports.rb +56 -0
  151. data/test/factories/services.rb +12 -0
  152. data/test/factories/signatures.rb +28 -0
  153. data/test/factories/stat_custom_signatures.rb +97 -0
  154. data/test/factories/stat_regions.rb +97 -0
  155. data/test/factories/stat_services.rb +97 -0
  156. data/test/factories/stat_signautures.rb +97 -0
  157. data/test/factories/stats.rb +129 -0
  158. data/test/factories/sub_organizations.rb +34 -0
  159. data/test/factories/suppression/regions.rb +90 -0
  160. data/test/factories/suppression/signatures.rb +117 -0
  161. data/test/factories/suppression/unique_identifiers.rb +111 -0
  162. data/test/factories/suppressions.rb +71 -0
  163. data/test/factories/tags.rb +12 -0
  164. data/test/factories/teams.rb +32 -0
  165. data/test/factories/users.rb +54 -0
  166. data/test/json_strategy.rb +25 -0
  167. data/test/test_helper.rb +44 -5
  168. metadata +387 -119
  169. data/bin/esp_repl +0 -60
  170. data/lib/esp_sdk/api.rb +0 -33
  171. data/lib/esp_sdk/client.rb +0 -62
  172. data/lib/esp_sdk/configure.rb +0 -40
  173. data/lib/esp_sdk/end_points/base.rb +0 -102
  174. data/lib/esp_sdk/end_points/contact_requests.rb +0 -6
  175. data/lib/esp_sdk/end_points/custom_signatures.rb +0 -41
  176. data/lib/esp_sdk/end_points/dashboard.rb +0 -35
  177. data/lib/esp_sdk/end_points/external_accounts.rb +0 -9
  178. data/lib/esp_sdk/end_points/organizations.rb +0 -6
  179. data/lib/esp_sdk/end_points/reports.rb +0 -6
  180. data/lib/esp_sdk/end_points/services.rb +0 -6
  181. data/lib/esp_sdk/end_points/signatures.rb +0 -39
  182. data/lib/esp_sdk/end_points/sub_organizations.rb +0 -6
  183. data/lib/esp_sdk/end_points/teams.rb +0 -6
  184. data/lib/esp_sdk/end_points/users.rb +0 -6
  185. data/lib/esp_sdk/exceptions.rb +0 -8
  186. data/lib/esp_sdk/extensions/rest_client/request.rb +0 -9
  187. data/lib/esp_sdk/repl.rb +0 -61
  188. data/lib/esp_sdk/version.rb +0 -3
  189. data/test/esp_sdk/api_test.rb +0 -36
  190. data/test/esp_sdk/client_test.rb +0 -129
  191. data/test/esp_sdk/configure_test.rb +0 -65
  192. data/test/esp_sdk/end_points/.keep +0 -0
  193. data/test/esp_sdk/end_points/base_test.rb +0 -230
  194. data/test/esp_sdk/end_points/custom_signatures_test.rb +0 -90
  195. data/test/esp_sdk/end_points/dashboard_test.rb +0 -55
  196. data/test/esp_sdk/end_points/external_accounts_test.rb +0 -20
  197. data/test/esp_sdk/end_points/signatures_test.rb +0 -83
  198. data/test/esp_sdk/exceptions_test.rb +0 -41
  199. data/test/esp_sdk_test.rb +0 -70
data/rdoc/ESP/Suppression.html ADDED
@@ -0,0 +1,649 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class ESP::Suppression - ESPSDK</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/esp.rb
53
+ <li>lib/esp/resources/alert.rb
54
+ <li>lib/esp/resources/custom_signature.rb
55
+ <li>lib/esp/resources/region.rb
56
+ <li>lib/esp/resources/signature.rb
57
+ <li>lib/esp/resources/suppression.rb
58
+ <li>lib/esp/resources/suppression/region.rb
59
+ <li>lib/esp/resources/suppression/signature.rb
60
+ <li>lib/esp/resources/suppression/unique_identifier.rb
61
+ </ul>
62
+ </nav>
63
+
64
+
65
+ </div>
66
+
67
+ <div id="class-metadata">
68
+
69
+ <nav id="parent-class-section" class="section">
70
+ <h3 class="section-header">Parent</h3>
71
+
72
+ <p class="link">ESP::Resource
73
+
74
+ </nav>
75
+
76
+
77
+
78
+ <!-- Method Quickref -->
79
+ <nav id="method-list-section" class="section">
80
+ <h3 class="section-header">Methods</h3>
81
+
82
+ <ul class="link-list">
83
+
84
+ <li ><a href="#method-c-all">::all</a>
85
+
86
+ <li ><a href="#method-c-find">::find</a>
87
+
88
+ <li ><a href="#method-i-created_by">#created_by</a>
89
+
90
+ <li ><a href="#method-i-custom_signatures">#custom_signatures</a>
91
+
92
+ <li ><a href="#method-i-deactivate">#deactivate</a>
93
+
94
+ <li ><a href="#method-i-deactivate-21">#deactivate!</a>
95
+
96
+ <li ><a href="#method-i-destroy">#destroy</a>
97
+
98
+ <li ><a href="#method-i-external_accounts">#external_accounts</a>
99
+
100
+ <li ><a href="#method-i-organization">#organization</a>
101
+
102
+ <li ><a href="#method-i-regions">#regions</a>
103
+
104
+ <li ><a href="#method-i-save">#save</a>
105
+
106
+ <li ><a href="#method-i-signatures">#signatures</a>
107
+
108
+ </ul>
109
+ </nav>
110
+
111
+ </div>
112
+
113
+ <div id="project-metadata">
114
+ <nav id="fileindex-section" class="section project-section">
115
+ <h3 class="section-header">Pages</h3>
116
+
117
+ <ul>
118
+
119
+ <li class="file"><a href="../README_md.html">README</a>
120
+
121
+ </ul>
122
+ </nav>
123
+
124
+ <nav id="classindex-section" class="section project-section">
125
+ <h3 class="section-header">Class and Module Index</h3>
126
+
127
+ <ul class="link-list">
128
+
129
+ <li><a href="../ActiveResource.html">ActiveResource</a>
130
+
131
+ <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
132
+
133
+ <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
134
+
135
+ <li><a href="../ESP.html">ESP</a>
136
+
137
+ <li><a href="../ESP/Alert.html">ESP::Alert</a>
138
+
139
+ <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
140
+
141
+ <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
142
+
143
+ <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
144
+
145
+ <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
146
+
147
+ <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
148
+
149
+ <li><a href="../ESP/Organization.html">ESP::Organization</a>
150
+
151
+ <li><a href="../ESP/Region.html">ESP::Region</a>
152
+
153
+ <li><a href="../ESP/Report.html">ESP::Report</a>
154
+
155
+ <li><a href="../ESP/Service.html">ESP::Service</a>
156
+
157
+ <li><a href="../ESP/Signature.html">ESP::Signature</a>
158
+
159
+ <li><a href="../ESP/Stat.html">ESP::Stat</a>
160
+
161
+ <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
162
+
163
+ <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
164
+
165
+ <li><a href="../ESP/StatService.html">ESP::StatService</a>
166
+
167
+ <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
168
+
169
+ <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
170
+
171
+ <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
172
+
173
+ <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
174
+
175
+ <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
176
+
177
+ <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
178
+
179
+ <li><a href="../ESP/Tag.html">ESP::Tag</a>
180
+
181
+ <li><a href="../ESP/Team.html">ESP::Team</a>
182
+
183
+ <li><a href="../ESP/User.html">ESP::User</a>
184
+
185
+ </ul>
186
+ </nav>
187
+
188
+ </div>
189
+ </nav>
190
+
191
+ <div id="documentation">
192
+ <h1 class="class">class ESP::Suppression</h1>
193
+
194
+ <div id="description" class="description">
195
+
196
+ </div><!-- description -->
197
+
198
+
199
+
200
+
201
+ <section id="5Buntitled-5D" class="documentation-section">
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <!-- Methods -->
211
+
212
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
213
+ <h3 class="section-header">Public Class Methods</h3>
214
+
215
+
216
+ <div id="method-c-all" class="method-detail ">
217
+
218
+ <div class="method-heading">
219
+ <span class="method-name">all</span><span
220
+ class="method-args">()</span>
221
+
222
+ <span class="method-click-advice">click to toggle source</span>
223
+
224
+ </div>
225
+
226
+
227
+ <div class="method-description">
228
+
229
+ <p>Return a paginated <a href="Suppression.html">Suppression</a> list</p>
230
+
231
+
232
+
233
+
234
+ <div class="method-source-code" id="all-source">
235
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 85</span>
236
+ </pre>
237
+ </div><!-- all-source -->
238
+
239
+ </div>
240
+
241
+
242
+
243
+
244
+ </div><!-- all-method -->
245
+
246
+
247
+ <div id="method-c-find" class="method-detail ">
248
+
249
+
250
+ <div class="method-heading">
251
+ <span class="method-callseq">
252
+ find(id)
253
+ </span>
254
+
255
+ <span class="method-click-advice">click to toggle source</span>
256
+
257
+ </div>
258
+
259
+
260
+
261
+ <div class="method-description">
262
+
263
+ <p>Find a <a href="Suppression.html">Suppression</a> by id</p>
264
+
265
+ <h4 id="method-c-find-label-Parameter">Parameter<span><a href="#method-c-find-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
266
+
267
+ <p><code>id</code> | Required | The ID of the suppression to retrieve</p>
268
+
269
+
270
+
271
+
272
+ <div class="method-source-code" id="find-source">
273
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 83</span>
274
+ </pre>
275
+ </div><!-- find-source -->
276
+
277
+ </div>
278
+
279
+
280
+
281
+
282
+ </div><!-- find-method -->
283
+
284
+
285
+ </section><!-- public-class-method-details -->
286
+
287
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
288
+ <h3 class="section-header">Public Instance Methods</h3>
289
+
290
+
291
+ <div id="method-i-created_by" class="method-detail ">
292
+
293
+ <div class="method-heading">
294
+ <span class="method-name">created_by</span><span
295
+ class="method-args">()</span>
296
+
297
+ <span class="method-click-advice">click to toggle source</span>
298
+
299
+ </div>
300
+
301
+
302
+ <div class="method-description">
303
+
304
+ <p>The user who created the suppression.</p>
305
+
306
+
307
+
308
+
309
+ <div class="method-source-code" id="created_by-source">
310
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 9</span>
311
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:created_by</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::User&#39;</span>
312
+ </pre>
313
+ </div><!-- created_by-source -->
314
+
315
+ </div>
316
+
317
+
318
+
319
+
320
+ </div><!-- created_by-method -->
321
+
322
+
323
+ <div id="method-i-custom_signatures" class="method-detail ">
324
+
325
+ <div class="method-heading">
326
+ <span class="method-name">custom_signatures</span><span
327
+ class="method-args">()</span>
328
+
329
+ <span class="method-click-advice">click to toggle source</span>
330
+
331
+ </div>
332
+
333
+
334
+ <div class="method-description">
335
+
336
+ <p>The custom signatures being suppressed.</p>
337
+
338
+
339
+
340
+
341
+ <div class="method-source-code" id="custom_signatures-source">
342
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 28</span>
343
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">custom_signatures</span>
344
+ <span class="ruby-keyword">return</span> [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:custom_signature_ids</span>
345
+ <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">CustomSignature</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value">:all</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">custom_signature_ids</span> })
346
+ <span class="ruby-keyword">end</span></pre>
347
+ </div><!-- custom_signatures-source -->
348
+
349
+ </div>
350
+
351
+
352
+
353
+
354
+ </div><!-- custom_signatures-method -->
355
+
356
+
357
+ <div id="method-i-deactivate" class="method-detail ">
358
+
359
+ <div class="method-heading">
360
+ <span class="method-name">deactivate</span><span
361
+ class="method-args">()</span>
362
+
363
+ <span class="method-click-advice">click to toggle source</span>
364
+
365
+ </div>
366
+
367
+
368
+ <div class="method-description">
369
+
370
+ <p>Deactivate the current suppression instance. The current object will be
371
+ updated with the new status if successful. If not successful, populates its
372
+ errors object.</p>
373
+
374
+ <h3 id="method-i-deactivate-label-Once+deactivated+the+suppression+cannot+be+reactivated.">Once deactivated the suppression cannot be reactivated.<span><a href="#method-i-deactivate-label-Once+deactivated+the+suppression+cannot+be+reactivated.">&para;</a> <a href="#documentation">&uarr;</a></span></h3>
375
+
376
+
377
+
378
+
379
+ <div class="method-source-code" id="deactivate-source">
380
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 62</span>
381
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">deactivate</span>
382
+ <span class="ruby-identifier">patch</span>(<span class="ruby-value">:deactivate</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">response</span><span class="ruby-operator">|</span>
383
+ <span class="ruby-identifier">load_attributes_from_response</span>(<span class="ruby-identifier">response</span>)
384
+ <span class="ruby-keyword">end</span>
385
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ActiveResource</span><span class="ruby-operator">::</span><span class="ruby-constant">BadRequest</span>, <span class="ruby-constant">ActiveResource</span><span class="ruby-operator">::</span><span class="ruby-constant">ResourceInvalid</span>, <span class="ruby-constant">ActiveResource</span><span class="ruby-operator">::</span><span class="ruby-constant">UnauthorizedAccess</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">error</span>
386
+ <span class="ruby-identifier">load_remote_errors</span>(<span class="ruby-identifier">error</span>, <span class="ruby-keyword">true</span>)
387
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">code</span> = <span class="ruby-identifier">error</span>.<span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>
388
+ <span class="ruby-keyword">false</span>
389
+ <span class="ruby-keyword">end</span></pre>
390
+ </div><!-- deactivate-source -->
391
+
392
+ </div>
393
+
394
+
395
+
396
+
397
+ </div><!-- deactivate-method -->
398
+
399
+
400
+ <div id="method-i-deactivate-21" class="method-detail ">
401
+
402
+ <div class="method-heading">
403
+ <span class="method-name">deactivate!</span><span
404
+ class="method-args">()</span>
405
+
406
+ <span class="method-click-advice">click to toggle source</span>
407
+
408
+ </div>
409
+
410
+
411
+ <div class="method-description">
412
+
413
+ <p>Deactivate the current suppression instance. The current object will be
414
+ updated with the new status if successful. Throws an error if not
415
+ successful.</p>
416
+
417
+ <h3 id="method-i-deactivate-21-label-Once+deactivated+the+suppression+cannot+be+reactivated.">Once deactivated the suppression cannot be reactivated.<span><a href="#method-i-deactivate-21-label-Once+deactivated+the+suppression+cannot+be+reactivated.">&para;</a> <a href="#documentation">&uarr;</a></span></h3>
418
+
419
+
420
+
421
+
422
+ <div class="method-source-code" id="deactivate-21-source">
423
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 52</span>
424
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">deactivate!</span>
425
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">deactivate</span>
426
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">message</span> = <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">full_messages</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>)
427
+ <span class="ruby-identifier">fail</span>(<span class="ruby-constant">ActiveResource</span><span class="ruby-operator">::</span><span class="ruby-constant">ResourceInvalid</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>)) <span class="ruby-comment"># rubocop:disable Style/RaiseArgs</span>
428
+ <span class="ruby-keyword">end</span></pre>
429
+ </div><!-- deactivate-21-source -->
430
+
431
+ </div>
432
+
433
+
434
+
435
+
436
+ </div><!-- deactivate-21-method -->
437
+
438
+
439
+ <div id="method-i-destroy" class="method-detail ">
440
+
441
+ <div class="method-heading">
442
+ <span class="method-name">destroy</span><span
443
+ class="method-args">()</span>
444
+
445
+ <span class="method-click-advice">click to toggle source</span>
446
+
447
+ </div>
448
+
449
+
450
+ <div class="method-description">
451
+
452
+ <p>Not Implemented. You cannot destroy a <a
453
+ href="Suppression.html">Suppression</a>.</p>
454
+
455
+
456
+
457
+
458
+ <div class="method-source-code" id="destroy-source">
459
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 44</span>
460
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
461
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
462
+ <span class="ruby-keyword">end</span></pre>
463
+ </div><!-- destroy-source -->
464
+
465
+ </div>
466
+
467
+
468
+
469
+
470
+ </div><!-- destroy-method -->
471
+
472
+
473
+ <div id="method-i-external_accounts" class="method-detail ">
474
+
475
+ <div class="method-heading">
476
+ <span class="method-name">external_accounts</span><span
477
+ class="method-args">()</span>
478
+
479
+ <span class="method-click-advice">click to toggle source</span>
480
+
481
+ </div>
482
+
483
+
484
+ <div class="method-description">
485
+
486
+ <p>The external accounts affected by this suppression.</p>
487
+
488
+
489
+
490
+
491
+ <div class="method-source-code" id="external_accounts-source">
492
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 17</span>
493
+ <span class="ruby-identifier">has_many</span> <span class="ruby-value">:external_accounts</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::ExternalAccount&#39;</span>
494
+ </pre>
495
+ </div><!-- external_accounts-source -->
496
+
497
+ </div>
498
+
499
+
500
+
501
+
502
+ </div><!-- external_accounts-method -->
503
+
504
+
505
+ <div id="method-i-organization" class="method-detail ">
506
+
507
+ <div class="method-heading">
508
+ <span class="method-name">organization</span><span
509
+ class="method-args">()</span>
510
+
511
+ <span class="method-click-advice">click to toggle source</span>
512
+
513
+ </div>
514
+
515
+
516
+ <div class="method-description">
517
+
518
+ <p>The organization this sub organization belongs to.</p>
519
+
520
+
521
+
522
+
523
+ <div class="method-source-code" id="organization-source">
524
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 5</span>
525
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:organization</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Organization&#39;</span>
526
+ </pre>
527
+ </div><!-- organization-source -->
528
+
529
+ </div>
530
+
531
+
532
+
533
+
534
+ </div><!-- organization-method -->
535
+
536
+
537
+ <div id="method-i-regions" class="method-detail ">
538
+
539
+ <div class="method-heading">
540
+ <span class="method-name">regions</span><span
541
+ class="method-args">()</span>
542
+
543
+ <span class="method-click-advice">click to toggle source</span>
544
+
545
+ </div>
546
+
547
+
548
+ <div class="method-description">
549
+
550
+ <p>The regions affected by this suppression.</p>
551
+
552
+
553
+
554
+
555
+ <div class="method-source-code" id="regions-source">
556
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 13</span>
557
+ <span class="ruby-identifier">has_many</span> <span class="ruby-value">:regions</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Region&#39;</span>
558
+ </pre>
559
+ </div><!-- regions-source -->
560
+
561
+ </div>
562
+
563
+
564
+
565
+
566
+ </div><!-- regions-method -->
567
+
568
+
569
+ <div id="method-i-save" class="method-detail ">
570
+
571
+ <div class="method-heading">
572
+ <span class="method-name">save</span><span
573
+ class="method-args">()</span>
574
+
575
+ <span class="method-click-advice">click to toggle source</span>
576
+
577
+ </div>
578
+
579
+
580
+ <div class="method-description">
581
+
582
+ <p>Not Implemented. You cannot create or update a <a
583
+ href="Suppression.html">Suppression</a>.</p>
584
+
585
+
586
+
587
+
588
+ <div class="method-source-code" id="save-source">
589
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 39</span>
590
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>
591
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
592
+ <span class="ruby-keyword">end</span></pre>
593
+ </div><!-- save-source -->
594
+
595
+ </div>
596
+
597
+
598
+
599
+
600
+ </div><!-- save-method -->
601
+
602
+
603
+ <div id="method-i-signatures" class="method-detail ">
604
+
605
+ <div class="method-heading">
606
+ <span class="method-name">signatures</span><span
607
+ class="method-args">()</span>
608
+
609
+ <span class="method-click-advice">click to toggle source</span>
610
+
611
+ </div>
612
+
613
+
614
+ <div class="method-description">
615
+
616
+ <p>The signatures being suppressed.</p>
617
+
618
+
619
+
620
+
621
+ <div class="method-source-code" id="signatures-source">
622
+ <pre><span class="ruby-comment"># File lib/esp/resources/suppression.rb, line 21</span>
623
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">signatures</span>
624
+ <span class="ruby-keyword">return</span> [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:signature_ids</span>
625
+ <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">Signature</span>.<span class="ruby-identifier">find</span>(<span class="ruby-value">:all</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">signature_ids</span> })
626
+ <span class="ruby-keyword">end</span></pre>
627
+ </div><!-- signatures-source -->
628
+
629
+ </div>
630
+
631
+
632
+
633
+
634
+ </div><!-- signatures-method -->
635
+
636
+
637
+ </section><!-- public-instance-method-details -->
638
+
639
+ </section><!-- 5Buntitled-5D -->
640
+
641
+ </div><!-- documentation -->
642
+
643
+
644
+ <footer id="validator-badges">
645
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
646
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
647
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
648
+ </footer>
649
+