dashboard-api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.codeclimate.yml +34 -0
- data/.gitignore +5 -4
- data/.travis.yml +20 -0
- data/Gemfile +9 -5
- data/Gemfile.lock +63 -31
- data/README.md +134 -138
- data/Rakefile +9 -7
- data/dashboard-api.gemspec +28 -28
- data/doc/Admins.html +603 -603
- data/doc/Clients.html +276 -276
- data/doc/DashboardAPI.html +603 -603
- data/doc/DashboardAPIVersion.html +159 -159
- data/doc/Devices.html +879 -879
- data/doc/Networks.html +1382 -1382
- data/doc/Organizations.html +1477 -1477
- data/doc/Phones.html +641 -641
- data/doc/SAML.html +758 -758
- data/doc/SSIDs.html +523 -523
- data/doc/Switchports.html +526 -526
- data/doc/Templates.html +378 -378
- data/doc/VLANs.html +762 -762
- data/doc/_index.html +235 -235
- data/doc/class_list.html +51 -51
- data/doc/css/full_list.css +58 -58
- data/doc/css/style.css +481 -481
- data/doc/file.README.html +248 -248
- data/doc/file_list.html +56 -56
- data/doc/frames.html +17 -17
- data/doc/index.html +248 -248
- data/doc/js/app.js +243 -243
- data/doc/js/full_list.js +216 -216
- data/doc/js/jquery.js +3 -3
- data/doc/method_list.html +523 -523
- data/doc/top-level-namespace.html +113 -113
- data/lib/admins.rb +37 -37
- data/lib/clients.rb +12 -12
- data/lib/dashboard-api.rb +82 -83
- data/lib/dashboard-api/version.rb +6 -6
- data/lib/devices.rb +57 -57
- data/lib/networks.rb +108 -108
- data/lib/organizations.rb +110 -115
- data/lib/phones.rb +40 -40
- data/lib/saml.rb +47 -47
- data/lib/ssids.rb +33 -33
- data/lib/switchports.rb +33 -33
- data/lib/templates.rb +18 -18
- data/lib/vlans.rb +49 -49
- metadata +7 -5
data/doc/Templates.html
CHANGED
|
@@ -1,379 +1,379 @@
|
|
|
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: Templates
|
|
8
|
-
|
|
9
|
-
— 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 = "Templates";
|
|
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 (T)</a> »
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
<span class="title">Templates</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: Templates
|
|
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/templates.rb</dd>
|
|
89
|
-
</dl>
|
|
90
|
-
|
|
91
|
-
</div>
|
|
92
|
-
|
|
93
|
-
<h2>Overview</h2><div class="docstring">
|
|
94
|
-
<div class="discussion">
|
|
95
|
-
|
|
96
|
-
<p>Templates 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="#list_templates-instance_method" title="#list_templates (instance method)">#<strong>list_templates</strong>(org_id) ⇒ Array </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>Return a list of all templates for a specific organization.</p>
|
|
154
|
-
</div></span>
|
|
155
|
-
|
|
156
|
-
</li>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<li class="public ">
|
|
160
|
-
<span class="summary_signature">
|
|
161
|
-
|
|
162
|
-
<a href="#remove_template-instance_method" title="#remove_template (instance method)">#<strong>remove_template</strong>(org_id, template_id) ⇒ Integer </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>Remove a single configuration template.</p>
|
|
178
|
-
</div></span>
|
|
179
|
-
|
|
180
|
-
</li>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
</ul>
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
<div id="instance_method_details" class="method_details_list">
|
|
189
|
-
<h2>Instance Method Details</h2>
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
<div class="method_details first">
|
|
193
|
-
<h3 class="signature first" id="list_templates-instance_method">
|
|
194
|
-
|
|
195
|
-
#<strong>list_templates</strong>(org_id) ⇒ <tt>Array</tt>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
</h3><div class="docstring">
|
|
202
|
-
<div class="discussion">
|
|
203
|
-
|
|
204
|
-
<p>Return a list of all templates for a specific organization</p>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
</div>
|
|
208
|
-
</div>
|
|
209
|
-
<div class="tags">
|
|
210
|
-
<p class="tag_title">Parameters:</p>
|
|
211
|
-
<ul class="param">
|
|
212
|
-
|
|
213
|
-
<li>
|
|
214
|
-
|
|
215
|
-
<span class='name'>org_id</span>
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
—
|
|
223
|
-
<div class='inline'>
|
|
224
|
-
<p>organization ID where that we want to list all of the templates from</p>
|
|
225
|
-
</div>
|
|
226
|
-
|
|
227
|
-
</li>
|
|
228
|
-
|
|
229
|
-
</ul>
|
|
230
|
-
|
|
231
|
-
<p class="tag_title">Returns:</p>
|
|
232
|
-
<ul class="return">
|
|
233
|
-
|
|
234
|
-
<li>
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
—
|
|
242
|
-
<div class='inline'>
|
|
243
|
-
<p>an array of hashes containing the attributes for all configuration
|
|
244
|
-
templates</p>
|
|
245
|
-
</div>
|
|
246
|
-
|
|
247
|
-
</li>
|
|
248
|
-
|
|
249
|
-
</ul>
|
|
250
|
-
|
|
251
|
-
</div><table class="source_code">
|
|
252
|
-
<tr>
|
|
253
|
-
<td>
|
|
254
|
-
<pre class="lines">
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
7
|
|
258
|
-
8
|
|
259
|
-
9</pre>
|
|
260
|
-
</td>
|
|
261
|
-
<td>
|
|
262
|
-
<pre class="code"><span class="info file"># File 'lib/templates.rb', line 7</span>
|
|
263
|
-
|
|
264
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list_templates'>list_templates</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
265
|
-
<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'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
266
|
-
<span class='kw'>end</span></pre>
|
|
267
|
-
</td>
|
|
268
|
-
</tr>
|
|
269
|
-
</table>
|
|
270
|
-
</div>
|
|
271
|
-
|
|
272
|
-
<div class="method_details ">
|
|
273
|
-
<h3 class="signature " id="remove_template-instance_method">
|
|
274
|
-
|
|
275
|
-
#<strong>remove_template</strong>(org_id, template_id) ⇒ <tt>Integer</tt>
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
</h3><div class="docstring">
|
|
282
|
-
<div class="discussion">
|
|
283
|
-
|
|
284
|
-
<p>Remove a single configuration template</p>
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
</div>
|
|
288
|
-
</div>
|
|
289
|
-
<div class="tags">
|
|
290
|
-
<p class="tag_title">Parameters:</p>
|
|
291
|
-
<ul class="param">
|
|
292
|
-
|
|
293
|
-
<li>
|
|
294
|
-
|
|
295
|
-
<span class='name'>org_id</span>
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
—
|
|
303
|
-
<div class='inline'>
|
|
304
|
-
<p>organization ID where that we want to remove the templates from</p>
|
|
305
|
-
</div>
|
|
306
|
-
|
|
307
|
-
</li>
|
|
308
|
-
|
|
309
|
-
<li>
|
|
310
|
-
|
|
311
|
-
<span class='name'>template_id</span>
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
—
|
|
319
|
-
<div class='inline'>
|
|
320
|
-
<p>the template ID we want to delete</p>
|
|
321
|
-
</div>
|
|
322
|
-
|
|
323
|
-
</li>
|
|
324
|
-
|
|
325
|
-
</ul>
|
|
326
|
-
|
|
327
|
-
<p class="tag_title">Returns:</p>
|
|
328
|
-
<ul class="return">
|
|
329
|
-
|
|
330
|
-
<li>
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
—
|
|
338
|
-
<div class='inline'>
|
|
339
|
-
<p>HTTP code</p>
|
|
340
|
-
</div>
|
|
341
|
-
|
|
342
|
-
</li>
|
|
343
|
-
|
|
344
|
-
</ul>
|
|
345
|
-
|
|
346
|
-
</div><table class="source_code">
|
|
347
|
-
<tr>
|
|
348
|
-
<td>
|
|
349
|
-
<pre class="lines">
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
15
|
|
353
|
-
16
|
|
354
|
-
17</pre>
|
|
355
|
-
</td>
|
|
356
|
-
<td>
|
|
357
|
-
<pre class="code"><span class="info file"># File 'lib/templates.rb', line 15</span>
|
|
358
|
-
|
|
359
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_remove_template'>remove_template</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_template_id'>template_id</span><span class='rparen'>)</span>
|
|
360
|
-
<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'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_template_id'>template_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
361
|
-
<span class='kw'>end</span></pre>
|
|
362
|
-
</td>
|
|
363
|
-
</tr>
|
|
364
|
-
</table>
|
|
365
|
-
</div>
|
|
366
|
-
|
|
367
|
-
</div>
|
|
368
|
-
|
|
369
|
-
</div>
|
|
370
|
-
|
|
371
|
-
<div id="footer">
|
|
372
|
-
Generated on Thu Nov 17 22:15:39 2016 by
|
|
373
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
374
|
-
0.9.5 (ruby-2.3.0).
|
|
375
|
-
</div>
|
|
376
|
-
|
|
377
|
-
</div>
|
|
378
|
-
</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: Templates
|
|
8
|
+
|
|
9
|
+
— 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 = "Templates";
|
|
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 (T)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Templates</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: Templates
|
|
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/templates.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>Templates 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="#list_templates-instance_method" title="#list_templates (instance method)">#<strong>list_templates</strong>(org_id) ⇒ Array </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>Return a list of all templates for a specific organization.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#remove_template-instance_method" title="#remove_template (instance method)">#<strong>remove_template</strong>(org_id, template_id) ⇒ Integer </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>Remove a single configuration template.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</ul>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<div id="instance_method_details" class="method_details_list">
|
|
189
|
+
<h2>Instance Method Details</h2>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<div class="method_details first">
|
|
193
|
+
<h3 class="signature first" id="list_templates-instance_method">
|
|
194
|
+
|
|
195
|
+
#<strong>list_templates</strong>(org_id) ⇒ <tt>Array</tt>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</h3><div class="docstring">
|
|
202
|
+
<div class="discussion">
|
|
203
|
+
|
|
204
|
+
<p>Return a list of all templates for a specific organization</p>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</div>
|
|
208
|
+
</div>
|
|
209
|
+
<div class="tags">
|
|
210
|
+
<p class="tag_title">Parameters:</p>
|
|
211
|
+
<ul class="param">
|
|
212
|
+
|
|
213
|
+
<li>
|
|
214
|
+
|
|
215
|
+
<span class='name'>org_id</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
—
|
|
223
|
+
<div class='inline'>
|
|
224
|
+
<p>organization ID where that we want to list all of the templates from</p>
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
</li>
|
|
228
|
+
|
|
229
|
+
</ul>
|
|
230
|
+
|
|
231
|
+
<p class="tag_title">Returns:</p>
|
|
232
|
+
<ul class="return">
|
|
233
|
+
|
|
234
|
+
<li>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
—
|
|
242
|
+
<div class='inline'>
|
|
243
|
+
<p>an array of hashes containing the attributes for all configuration
|
|
244
|
+
templates</p>
|
|
245
|
+
</div>
|
|
246
|
+
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
</ul>
|
|
250
|
+
|
|
251
|
+
</div><table class="source_code">
|
|
252
|
+
<tr>
|
|
253
|
+
<td>
|
|
254
|
+
<pre class="lines">
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
7
|
|
258
|
+
8
|
|
259
|
+
9</pre>
|
|
260
|
+
</td>
|
|
261
|
+
<td>
|
|
262
|
+
<pre class="code"><span class="info file"># File 'lib/templates.rb', line 7</span>
|
|
263
|
+
|
|
264
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_templates'>list_templates</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
265
|
+
<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'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
266
|
+
<span class='kw'>end</span></pre>
|
|
267
|
+
</td>
|
|
268
|
+
</tr>
|
|
269
|
+
</table>
|
|
270
|
+
</div>
|
|
271
|
+
|
|
272
|
+
<div class="method_details ">
|
|
273
|
+
<h3 class="signature " id="remove_template-instance_method">
|
|
274
|
+
|
|
275
|
+
#<strong>remove_template</strong>(org_id, template_id) ⇒ <tt>Integer</tt>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</h3><div class="docstring">
|
|
282
|
+
<div class="discussion">
|
|
283
|
+
|
|
284
|
+
<p>Remove a single configuration template</p>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
<div class="tags">
|
|
290
|
+
<p class="tag_title">Parameters:</p>
|
|
291
|
+
<ul class="param">
|
|
292
|
+
|
|
293
|
+
<li>
|
|
294
|
+
|
|
295
|
+
<span class='name'>org_id</span>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
—
|
|
303
|
+
<div class='inline'>
|
|
304
|
+
<p>organization ID where that we want to remove the templates from</p>
|
|
305
|
+
</div>
|
|
306
|
+
|
|
307
|
+
</li>
|
|
308
|
+
|
|
309
|
+
<li>
|
|
310
|
+
|
|
311
|
+
<span class='name'>template_id</span>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
—
|
|
319
|
+
<div class='inline'>
|
|
320
|
+
<p>the template ID we want to delete</p>
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
</ul>
|
|
326
|
+
|
|
327
|
+
<p class="tag_title">Returns:</p>
|
|
328
|
+
<ul class="return">
|
|
329
|
+
|
|
330
|
+
<li>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
—
|
|
338
|
+
<div class='inline'>
|
|
339
|
+
<p>HTTP code</p>
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
</li>
|
|
343
|
+
|
|
344
|
+
</ul>
|
|
345
|
+
|
|
346
|
+
</div><table class="source_code">
|
|
347
|
+
<tr>
|
|
348
|
+
<td>
|
|
349
|
+
<pre class="lines">
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
15
|
|
353
|
+
16
|
|
354
|
+
17</pre>
|
|
355
|
+
</td>
|
|
356
|
+
<td>
|
|
357
|
+
<pre class="code"><span class="info file"># File 'lib/templates.rb', line 15</span>
|
|
358
|
+
|
|
359
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_template'>remove_template</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_template_id'>template_id</span><span class='rparen'>)</span>
|
|
360
|
+
<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'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_template_id'>template_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
361
|
+
<span class='kw'>end</span></pre>
|
|
362
|
+
</td>
|
|
363
|
+
</tr>
|
|
364
|
+
</table>
|
|
365
|
+
</div>
|
|
366
|
+
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
</div>
|
|
370
|
+
|
|
371
|
+
<div id="footer">
|
|
372
|
+
Generated on Thu Nov 17 22:15:39 2016 by
|
|
373
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
374
|
+
0.9.5 (ruby-2.3.0).
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
</body>
|
|
379
379
|
</html>
|