dashboard-api 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +34 -0
  3. data/.gitignore +5 -4
  4. data/.travis.yml +20 -0
  5. data/Gemfile +9 -5
  6. data/Gemfile.lock +63 -31
  7. data/README.md +134 -138
  8. data/Rakefile +9 -7
  9. data/dashboard-api.gemspec +28 -28
  10. data/doc/Admins.html +603 -603
  11. data/doc/Clients.html +276 -276
  12. data/doc/DashboardAPI.html +603 -603
  13. data/doc/DashboardAPIVersion.html +159 -159
  14. data/doc/Devices.html +879 -879
  15. data/doc/Networks.html +1382 -1382
  16. data/doc/Organizations.html +1477 -1477
  17. data/doc/Phones.html +641 -641
  18. data/doc/SAML.html +758 -758
  19. data/doc/SSIDs.html +523 -523
  20. data/doc/Switchports.html +526 -526
  21. data/doc/Templates.html +378 -378
  22. data/doc/VLANs.html +762 -762
  23. data/doc/_index.html +235 -235
  24. data/doc/class_list.html +51 -51
  25. data/doc/css/full_list.css +58 -58
  26. data/doc/css/style.css +481 -481
  27. data/doc/file.README.html +248 -248
  28. data/doc/file_list.html +56 -56
  29. data/doc/frames.html +17 -17
  30. data/doc/index.html +248 -248
  31. data/doc/js/app.js +243 -243
  32. data/doc/js/full_list.js +216 -216
  33. data/doc/js/jquery.js +3 -3
  34. data/doc/method_list.html +523 -523
  35. data/doc/top-level-namespace.html +113 -113
  36. data/lib/admins.rb +37 -37
  37. data/lib/clients.rb +12 -12
  38. data/lib/dashboard-api.rb +82 -83
  39. data/lib/dashboard-api/version.rb +6 -6
  40. data/lib/devices.rb +57 -57
  41. data/lib/networks.rb +108 -108
  42. data/lib/organizations.rb +110 -115
  43. data/lib/phones.rb +40 -40
  44. data/lib/saml.rb +47 -47
  45. data/lib/ssids.rb +33 -33
  46. data/lib/switchports.rb +33 -33
  47. data/lib/templates.rb +18 -18
  48. data/lib/vlans.rb +49 -49
  49. metadata +7 -5
@@ -1,524 +1,524 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Module: SSIDs
8
-
9
- &mdash; Documentation by YARD 0.9.5
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "SSIDs";
19
- relpath = '';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="class_list.html"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="_index.html">Index (S)</a> &raquo;
40
-
41
-
42
- <span class="title">SSIDs</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <iframe id="search_frame" src="class_list.html"></iframe>
63
-
64
- <div id="content"><h1>Module: SSIDs
65
-
66
-
67
-
68
- </h1>
69
- <div class="box_info">
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Included in:</dt>
81
- <dd><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span></dd>
82
- </dl>
83
-
84
-
85
-
86
- <dl>
87
- <dt>Defined in:</dt>
88
- <dd>lib/ssids.rb</dd>
89
- </dl>
90
-
91
- </div>
92
-
93
- <h2>Overview</h2><div class="docstring">
94
- <div class="discussion">
95
-
96
- <p>SSIDs section of the Meraki Dashboard API</p>
97
-
98
-
99
- </div>
100
- </div>
101
- <div class="tags">
102
-
103
- <p class="tag_title">Author:</p>
104
- <ul class="author">
105
-
106
- <li>
107
-
108
-
109
-
110
-
111
-
112
- <div class='inline'>
113
- <p>Joe Letizia</p>
114
- </div>
115
-
116
- </li>
117
-
118
- </ul>
119
-
120
- </div>
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
- <h2>
129
- Instance Method Summary
130
- <small><a href="#" class="summary_toggle">collapse</a></small>
131
- </h2>
132
-
133
- <ul class="summary">
134
-
135
- <li class="public ">
136
- <span class="summary_signature">
137
-
138
- <a href="#get_single_ssid-instance_method" title="#get_single_ssid (instance method)">#<strong>get_single_ssid</strong>(network_id, ssid_number) &#x21d2; Hash </a>
139
-
140
-
141
-
142
- </span>
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
- <span class="summary_desc"><div class='inline'>
153
- <p>Get the attributes for a single SSID.</p>
154
- </div></span>
155
-
156
- </li>
157
-
158
-
159
- <li class="public ">
160
- <span class="summary_signature">
161
-
162
- <a href="#list_ssids_in_network-instance_method" title="#list_ssids_in_network (instance method)">#<strong>list_ssids_in_network</strong>(network_id) &#x21d2; Array </a>
163
-
164
-
165
-
166
- </span>
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
- <span class="summary_desc"><div class='inline'>
177
- <p>Get a list of the SSIDs and their attributes for a network.</p>
178
- </div></span>
179
-
180
- </li>
181
-
182
-
183
- <li class="public ">
184
- <span class="summary_signature">
185
-
186
- <a href="#update_single_ssid-instance_method" title="#update_single_ssid (instance method)">#<strong>update_single_ssid</strong>(network_id, ssid_number, options) &#x21d2; Hash </a>
187
-
188
-
189
-
190
- </span>
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
- <span class="summary_desc"><div class='inline'>
201
- <p>Update the attributes for a single SSID.</p>
202
- </div></span>
203
-
204
- </li>
205
-
206
-
207
- </ul>
208
-
209
-
210
-
211
-
212
- <div id="instance_method_details" class="method_details_list">
213
- <h2>Instance Method Details</h2>
214
-
215
-
216
- <div class="method_details first">
217
- <h3 class="signature first" id="get_single_ssid-instance_method">
218
-
219
- #<strong>get_single_ssid</strong>(network_id, ssid_number) &#x21d2; <tt>Hash</tt>
220
-
221
-
222
-
223
-
224
-
225
- </h3><div class="docstring">
226
- <div class="discussion">
227
-
228
- <p>Get the attributes for a single SSID</p>
229
-
230
-
231
- </div>
232
- </div>
233
- <div class="tags">
234
- <p class="tag_title">Parameters:</p>
235
- <ul class="param">
236
-
237
- <li>
238
-
239
- <span class='name'>network_id</span>
240
-
241
-
242
- <span class='type'>(<tt>String</tt>)</span>
243
-
244
-
245
-
246
- &mdash;
247
- <div class='inline'>
248
- <p>network id where the SSID you want to list is</p>
249
- </div>
250
-
251
- </li>
252
-
253
- <li>
254
-
255
- <span class='name'>ssid_number</span>
256
-
257
-
258
- <span class='type'>(<tt>Integer</tt>)</span>
259
-
260
-
261
-
262
- &mdash;
263
- <div class='inline'>
264
- <p>the SSID number you want to change. Range is from 0-14</p>
265
- </div>
266
-
267
- </li>
268
-
269
- </ul>
270
-
271
- <p class="tag_title">Returns:</p>
272
- <ul class="return">
273
-
274
- <li>
275
-
276
-
277
- <span class='type'>(<tt>Hash</tt>)</span>
278
-
279
-
280
-
281
- &mdash;
282
- <div class='inline'>
283
- <p>the attributes for the requested SSID</p>
284
- </div>
285
-
286
- </li>
287
-
288
- </ul>
289
-
290
- </div><table class="source_code">
291
- <tr>
292
- <td>
293
- <pre class="lines">
294
-
295
-
296
- 15
297
- 16
298
- 17
299
- 18</pre>
300
- </td>
301
- <td>
302
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 15</span>
303
-
304
- <span class='kw'>def</span> <span class='id identifier rubyid_get_single_ssid'>get_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='rparen'>)</span>
305
- <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'>&lt;=</span> <span class='int'>14</span><span class='rparen'>)</span>
306
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
307
- <span class='kw'>end</span></pre>
308
- </td>
309
- </tr>
310
- </table>
311
- </div>
312
-
313
- <div class="method_details ">
314
- <h3 class="signature " id="list_ssids_in_network-instance_method">
315
-
316
- #<strong>list_ssids_in_network</strong>(network_id) &#x21d2; <tt>Array</tt>
317
-
318
-
319
-
320
-
321
-
322
- </h3><div class="docstring">
323
- <div class="discussion">
324
-
325
- <p>Get a list of the SSIDs and their attributes for a network</p>
326
-
327
-
328
- </div>
329
- </div>
330
- <div class="tags">
331
- <p class="tag_title">Parameters:</p>
332
- <ul class="param">
333
-
334
- <li>
335
-
336
- <span class='name'>network_id</span>
337
-
338
-
339
- <span class='type'>(<tt>String</tt>)</span>
340
-
341
-
342
-
343
- &mdash;
344
- <div class='inline'>
345
- <p>network id where the SSIDs you exists are</p>
346
- </div>
347
-
348
- </li>
349
-
350
- </ul>
351
-
352
- <p class="tag_title">Returns:</p>
353
- <ul class="return">
354
-
355
- <li>
356
-
357
-
358
- <span class='type'>(<tt>Array</tt>)</span>
359
-
360
-
361
-
362
- &mdash;
363
- <div class='inline'>
364
- <p>an array of Hashes containing the SSID attributes</p>
365
- </div>
366
-
367
- </li>
368
-
369
- </ul>
370
-
371
- </div><table class="source_code">
372
- <tr>
373
- <td>
374
- <pre class="lines">
375
-
376
-
377
- 7
378
- 8
379
- 9</pre>
380
- </td>
381
- <td>
382
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 7</span>
383
-
384
- <span class='kw'>def</span> <span class='id identifier rubyid_list_ssids_in_network'>list_ssids_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
385
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
386
- <span class='kw'>end</span></pre>
387
- </td>
388
- </tr>
389
- </table>
390
- </div>
391
-
392
- <div class="method_details ">
393
- <h3 class="signature " id="update_single_ssid-instance_method">
394
-
395
- #<strong>update_single_ssid</strong>(network_id, ssid_number, options) &#x21d2; <tt>Hash</tt>
396
-
397
-
398
-
399
-
400
-
401
- </h3><div class="docstring">
402
- <div class="discussion">
403
-
404
- <p>Update the attributes for a single SSID</p>
405
-
406
-
407
- </div>
408
- </div>
409
- <div class="tags">
410
- <p class="tag_title">Parameters:</p>
411
- <ul class="param">
412
-
413
- <li>
414
-
415
- <span class='name'>network_id</span>
416
-
417
-
418
- <span class='type'>(<tt>String</tt>)</span>
419
-
420
-
421
-
422
- &mdash;
423
- <div class='inline'>
424
- <p>network id where the SSID you want to change is</p>
425
- </div>
426
-
427
- </li>
428
-
429
- <li>
430
-
431
- <span class='name'>ssid_number</span>
432
-
433
-
434
- <span class='type'>(<tt>Integer</tt>)</span>
435
-
436
-
437
-
438
- &mdash;
439
- <div class='inline'>
440
- <p>the SSID number you want to change. Range is from 0-14</p>
441
- </div>
442
-
443
- </li>
444
-
445
- <li>
446
-
447
- <span class='name'>options</span>
448
-
449
-
450
- <span class='type'>(<tt>Hash</tt>)</span>
451
-
452
-
453
-
454
- &mdash;
455
- <div class='inline'>
456
- <p>hash containing the attributes to update. Can include name, enabled,
457
- authMode, encryptionMode and psk</p>
458
- </div>
459
-
460
- </li>
461
-
462
- </ul>
463
-
464
- <p class="tag_title">Returns:</p>
465
- <ul class="return">
466
-
467
- <li>
468
-
469
-
470
- <span class='type'>(<tt>Hash</tt>)</span>
471
-
472
-
473
-
474
- &mdash;
475
- <div class='inline'>
476
- <p>the updated attributes for the SSID</p>
477
- </div>
478
-
479
- </li>
480
-
481
- </ul>
482
-
483
- </div><table class="source_code">
484
- <tr>
485
- <td>
486
- <pre class="lines">
487
-
488
-
489
- 25
490
- 26
491
- 27
492
- 28
493
- 29
494
- 30
495
- 31</pre>
496
- </td>
497
- <td>
498
- <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 25</span>
499
-
500
- <span class='kw'>def</span> <span class='id identifier rubyid_update_single_ssid'>update_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
501
- <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
502
- <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'>&lt;=</span> <span class='int'>14</span><span class='rparen'>)</span>
503
- <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
504
-
505
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PUT</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
506
- <span class='kw'>end</span></pre>
507
- </td>
508
- </tr>
509
- </table>
510
- </div>
511
-
512
- </div>
513
-
514
- </div>
515
-
516
- <div id="footer">
517
- Generated on Thu Nov 17 22:15:39 2016 by
518
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
519
- 0.9.5 (ruby-2.3.0).
520
- </div>
521
-
522
- </div>
523
- </body>
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: SSIDs
8
+
9
+ &mdash; Documentation by YARD 0.9.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "SSIDs";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (S)</a> &raquo;
40
+
41
+
42
+ <span class="title">SSIDs</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame" src="class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Module: SSIDs
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Included in:</dt>
81
+ <dd><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span></dd>
82
+ </dl>
83
+
84
+
85
+
86
+ <dl>
87
+ <dt>Defined in:</dt>
88
+ <dd>lib/ssids.rb</dd>
89
+ </dl>
90
+
91
+ </div>
92
+
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>SSIDs section of the Meraki Dashboard API</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
119
+
120
+ </div>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <h2>
129
+ Instance Method Summary
130
+ <small><a href="#" class="summary_toggle">collapse</a></small>
131
+ </h2>
132
+
133
+ <ul class="summary">
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#get_single_ssid-instance_method" title="#get_single_ssid (instance method)">#<strong>get_single_ssid</strong>(network_id, ssid_number) &#x21d2; Hash </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'>
153
+ <p>Get the attributes for a single SSID.</p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#list_ssids_in_network-instance_method" title="#list_ssids_in_network (instance method)">#<strong>list_ssids_in_network</strong>(network_id) &#x21d2; Array </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'>
177
+ <p>Get a list of the SSIDs and their attributes for a network.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#update_single_ssid-instance_method" title="#update_single_ssid (instance method)">#<strong>update_single_ssid</strong>(network_id, ssid_number, options) &#x21d2; Hash </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Update the attributes for a single SSID.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ </ul>
208
+
209
+
210
+
211
+
212
+ <div id="instance_method_details" class="method_details_list">
213
+ <h2>Instance Method Details</h2>
214
+
215
+
216
+ <div class="method_details first">
217
+ <h3 class="signature first" id="get_single_ssid-instance_method">
218
+
219
+ #<strong>get_single_ssid</strong>(network_id, ssid_number) &#x21d2; <tt>Hash</tt>
220
+
221
+
222
+
223
+
224
+
225
+ </h3><div class="docstring">
226
+ <div class="discussion">
227
+
228
+ <p>Get the attributes for a single SSID</p>
229
+
230
+
231
+ </div>
232
+ </div>
233
+ <div class="tags">
234
+ <p class="tag_title">Parameters:</p>
235
+ <ul class="param">
236
+
237
+ <li>
238
+
239
+ <span class='name'>network_id</span>
240
+
241
+
242
+ <span class='type'>(<tt>String</tt>)</span>
243
+
244
+
245
+
246
+ &mdash;
247
+ <div class='inline'>
248
+ <p>network id where the SSID you want to list is</p>
249
+ </div>
250
+
251
+ </li>
252
+
253
+ <li>
254
+
255
+ <span class='name'>ssid_number</span>
256
+
257
+
258
+ <span class='type'>(<tt>Integer</tt>)</span>
259
+
260
+
261
+
262
+ &mdash;
263
+ <div class='inline'>
264
+ <p>the SSID number you want to change. Range is from 0-14</p>
265
+ </div>
266
+
267
+ </li>
268
+
269
+ </ul>
270
+
271
+ <p class="tag_title">Returns:</p>
272
+ <ul class="return">
273
+
274
+ <li>
275
+
276
+
277
+ <span class='type'>(<tt>Hash</tt>)</span>
278
+
279
+
280
+
281
+ &mdash;
282
+ <div class='inline'>
283
+ <p>the attributes for the requested SSID</p>
284
+ </div>
285
+
286
+ </li>
287
+
288
+ </ul>
289
+
290
+ </div><table class="source_code">
291
+ <tr>
292
+ <td>
293
+ <pre class="lines">
294
+
295
+
296
+ 15
297
+ 16
298
+ 17
299
+ 18</pre>
300
+ </td>
301
+ <td>
302
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 15</span>
303
+
304
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_single_ssid'>get_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='rparen'>)</span>
305
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'>&lt;=</span> <span class='int'>14</span><span class='rparen'>)</span>
306
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
307
+ <span class='kw'>end</span></pre>
308
+ </td>
309
+ </tr>
310
+ </table>
311
+ </div>
312
+
313
+ <div class="method_details ">
314
+ <h3 class="signature " id="list_ssids_in_network-instance_method">
315
+
316
+ #<strong>list_ssids_in_network</strong>(network_id) &#x21d2; <tt>Array</tt>
317
+
318
+
319
+
320
+
321
+
322
+ </h3><div class="docstring">
323
+ <div class="discussion">
324
+
325
+ <p>Get a list of the SSIDs and their attributes for a network</p>
326
+
327
+
328
+ </div>
329
+ </div>
330
+ <div class="tags">
331
+ <p class="tag_title">Parameters:</p>
332
+ <ul class="param">
333
+
334
+ <li>
335
+
336
+ <span class='name'>network_id</span>
337
+
338
+
339
+ <span class='type'>(<tt>String</tt>)</span>
340
+
341
+
342
+
343
+ &mdash;
344
+ <div class='inline'>
345
+ <p>network id where the SSIDs you exists are</p>
346
+ </div>
347
+
348
+ </li>
349
+
350
+ </ul>
351
+
352
+ <p class="tag_title">Returns:</p>
353
+ <ul class="return">
354
+
355
+ <li>
356
+
357
+
358
+ <span class='type'>(<tt>Array</tt>)</span>
359
+
360
+
361
+
362
+ &mdash;
363
+ <div class='inline'>
364
+ <p>an array of Hashes containing the SSID attributes</p>
365
+ </div>
366
+
367
+ </li>
368
+
369
+ </ul>
370
+
371
+ </div><table class="source_code">
372
+ <tr>
373
+ <td>
374
+ <pre class="lines">
375
+
376
+
377
+ 7
378
+ 8
379
+ 9</pre>
380
+ </td>
381
+ <td>
382
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 7</span>
383
+
384
+ <span class='kw'>def</span> <span class='id identifier rubyid_list_ssids_in_network'>list_ssids_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
385
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
386
+ <span class='kw'>end</span></pre>
387
+ </td>
388
+ </tr>
389
+ </table>
390
+ </div>
391
+
392
+ <div class="method_details ">
393
+ <h3 class="signature " id="update_single_ssid-instance_method">
394
+
395
+ #<strong>update_single_ssid</strong>(network_id, ssid_number, options) &#x21d2; <tt>Hash</tt>
396
+
397
+
398
+
399
+
400
+
401
+ </h3><div class="docstring">
402
+ <div class="discussion">
403
+
404
+ <p>Update the attributes for a single SSID</p>
405
+
406
+
407
+ </div>
408
+ </div>
409
+ <div class="tags">
410
+ <p class="tag_title">Parameters:</p>
411
+ <ul class="param">
412
+
413
+ <li>
414
+
415
+ <span class='name'>network_id</span>
416
+
417
+
418
+ <span class='type'>(<tt>String</tt>)</span>
419
+
420
+
421
+
422
+ &mdash;
423
+ <div class='inline'>
424
+ <p>network id where the SSID you want to change is</p>
425
+ </div>
426
+
427
+ </li>
428
+
429
+ <li>
430
+
431
+ <span class='name'>ssid_number</span>
432
+
433
+
434
+ <span class='type'>(<tt>Integer</tt>)</span>
435
+
436
+
437
+
438
+ &mdash;
439
+ <div class='inline'>
440
+ <p>the SSID number you want to change. Range is from 0-14</p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ <li>
446
+
447
+ <span class='name'>options</span>
448
+
449
+
450
+ <span class='type'>(<tt>Hash</tt>)</span>
451
+
452
+
453
+
454
+ &mdash;
455
+ <div class='inline'>
456
+ <p>hash containing the attributes to update. Can include name, enabled,
457
+ authMode, encryptionMode and psk</p>
458
+ </div>
459
+
460
+ </li>
461
+
462
+ </ul>
463
+
464
+ <p class="tag_title">Returns:</p>
465
+ <ul class="return">
466
+
467
+ <li>
468
+
469
+
470
+ <span class='type'>(<tt>Hash</tt>)</span>
471
+
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'>
476
+ <p>the updated attributes for the SSID</p>
477
+ </div>
478
+
479
+ </li>
480
+
481
+ </ul>
482
+
483
+ </div><table class="source_code">
484
+ <tr>
485
+ <td>
486
+ <pre class="lines">
487
+
488
+
489
+ 25
490
+ 26
491
+ 27
492
+ 28
493
+ 29
494
+ 30
495
+ 31</pre>
496
+ </td>
497
+ <td>
498
+ <pre class="code"><span class="info file"># File 'lib/ssids.rb', line 25</span>
499
+
500
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_single_ssid'>update_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
501
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
502
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'>&lt;=</span> <span class='int'>14</span><span class='rparen'>)</span>
503
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
504
+
505
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PUT</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
506
+ <span class='kw'>end</span></pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+ </div>
513
+
514
+ </div>
515
+
516
+ <div id="footer">
517
+ Generated on Thu Nov 17 22:15:39 2016 by
518
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
519
+ 0.9.5 (ruby-2.3.0).
520
+ </div>
521
+
522
+ </div>
523
+ </body>
524
524
  </html>