katello_api 0.0.1 → 0.0.2

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.
Files changed (111) hide show
  1. data/.gitignore +2 -0
  2. data/Gemfile +2 -0
  3. data/README.rdoc +0 -4
  4. data/doc/KatelloApi/Base.html +831 -0
  5. data/doc/KatelloApi/Generator/Base.html +671 -0
  6. data/doc/KatelloApi/Generator.html +115 -0
  7. data/doc/KatelloApi/Resources/ActivationKey.html +1757 -0
  8. data/doc/KatelloApi/Resources/Architecture.html +1007 -0
  9. data/doc/KatelloApi/Resources/Changeset.html +1413 -0
  10. data/doc/KatelloApi/Resources/ChangesetsContent.html +2674 -0
  11. data/doc/KatelloApi/Resources/ComputeResource.html +1067 -0
  12. data/doc/KatelloApi/Resources/ConfigTemplate.html +1361 -0
  13. data/doc/KatelloApi/Resources/ContentView.html +938 -0
  14. data/doc/KatelloApi/Resources/ContentViewDefinition.html +1629 -0
  15. data/doc/KatelloApi/Resources/Crl.html +367 -0
  16. data/doc/KatelloApi/Resources/Distribution.html +560 -0
  17. data/doc/KatelloApi/Resources/Distributor.html +1892 -0
  18. data/doc/KatelloApi/Resources/Domain.html +1066 -0
  19. data/doc/KatelloApi/Resources/Environment.html +1645 -0
  20. data/doc/KatelloApi/Resources/Erratum.html +632 -0
  21. data/doc/KatelloApi/Resources/GpgKey.html +1220 -0
  22. data/doc/KatelloApi/Resources/HardwareModel.html +1025 -0
  23. data/doc/KatelloApi/Resources/Organization.html +1062 -0
  24. data/doc/KatelloApi/Resources/Package.html +728 -0
  25. data/doc/KatelloApi/Resources/Permission.html +1021 -0
  26. data/doc/KatelloApi/Resources/Ping.html +625 -0
  27. data/doc/KatelloApi/Resources/Product.html +1845 -0
  28. data/doc/KatelloApi/Resources/Provider.html +2237 -0
  29. data/doc/KatelloApi/Resources/Repository.html +1976 -0
  30. data/doc/KatelloApi/Resources/RepositorySet.html +770 -0
  31. data/doc/KatelloApi/Resources/Role.html +1257 -0
  32. data/doc/KatelloApi/Resources/RoleLdapGroup.html +728 -0
  33. data/doc/KatelloApi/Resources/SmartProxy.html +1054 -0
  34. data/doc/KatelloApi/Resources/Statu.html +367 -0
  35. data/doc/KatelloApi/Resources/Subnet.html +1007 -0
  36. data/doc/KatelloApi/Resources/Subscription.html +1064 -0
  37. data/doc/KatelloApi/Resources/Sync.html +826 -0
  38. data/doc/KatelloApi/Resources/SyncPlan.html +1148 -0
  39. data/doc/KatelloApi/Resources/System.html +3576 -0
  40. data/doc/KatelloApi/Resources/SystemGroup.html +2006 -0
  41. data/doc/KatelloApi/Resources/SystemGroupErratum.html +602 -0
  42. data/doc/KatelloApi/Resources/SystemGroupPackage.html +826 -0
  43. data/doc/KatelloApi/Resources/SystemPackage.html +770 -0
  44. data/doc/KatelloApi/Resources/Task.html +546 -0
  45. data/doc/KatelloApi/Resources/Template.html +1573 -0
  46. data/doc/KatelloApi/Resources/TemplatesContent.html +2268 -0
  47. data/doc/KatelloApi/Resources/Uebercert.html +406 -0
  48. data/doc/KatelloApi/Resources/User.html +1846 -0
  49. data/doc/KatelloApi/Resources.html +117 -0
  50. data/doc/KatelloApi.html +365 -0
  51. data/doc/_index.html +539 -0
  52. data/doc/class_list.html +53 -0
  53. data/doc/css/common.css +1 -0
  54. data/doc/css/full_list.css +57 -0
  55. data/doc/css/style.css +338 -0
  56. data/doc/file.README.html +127 -0
  57. data/doc/file_list.html +55 -0
  58. data/doc/frames.html +28 -0
  59. data/doc/index.html +127 -0
  60. data/doc/js/app.js +214 -0
  61. data/doc/js/full_list.js +173 -0
  62. data/doc/js/jquery.js +4 -0
  63. data/doc/method_list.html +2548 -0
  64. data/doc/top-level-namespace.html +112 -0
  65. data/lib/katello_api/base.rb +61 -6
  66. data/lib/katello_api/documentation.json +1 -0
  67. data/lib/katello_api/resources/activation_key.rb +51 -48
  68. data/lib/katello_api/resources/architecture.rb +19 -24
  69. data/lib/katello_api/resources/changeset.rb +39 -37
  70. data/lib/katello_api/resources/changesets_content.rb +64 -57
  71. data/lib/katello_api/resources/compute_resource.rb +37 -42
  72. data/lib/katello_api/resources/config_template.rb +40 -44
  73. data/lib/katello_api/resources/content_view.rb +14 -17
  74. data/lib/katello_api/resources/content_view_definition.rb +34 -42
  75. data/lib/katello_api/resources/crl.rb +3 -4
  76. data/lib/katello_api/resources/distribution.rb +8 -8
  77. data/lib/katello_api/resources/distributor.rb +35 -37
  78. data/lib/katello_api/resources/domain.rb +28 -32
  79. data/lib/katello_api/resources/environment.rb +38 -44
  80. data/lib/katello_api/resources/erratum.rb +9 -8
  81. data/lib/katello_api/resources/gpg_key.rb +28 -33
  82. data/lib/katello_api/resources/hardware_model.rb +25 -30
  83. data/lib/katello_api/resources/organization.rb +24 -26
  84. data/lib/katello_api/resources/package.rb +9 -12
  85. data/lib/katello_api/resources/permission.rb +21 -19
  86. data/lib/katello_api/resources/ping.rb +9 -12
  87. data/lib/katello_api/resources/product.rb +34 -43
  88. data/lib/katello_api/resources/provider.rb +55 -66
  89. data/lib/katello_api/resources/repository.rb +44 -55
  90. data/lib/katello_api/resources/repository_set.rb +9 -12
  91. data/lib/katello_api/resources/role.rb +35 -33
  92. data/lib/katello_api/resources/role_ldap_group.rb +10 -12
  93. data/lib/katello_api/resources/smart_proxy.rb +24 -28
  94. data/lib/katello_api/resources/statu.rb +3 -4
  95. data/lib/katello_api/resources/subnet.rb +19 -24
  96. data/lib/katello_api/resources/subscription.rb +16 -21
  97. data/lib/katello_api/resources/sync.rb +9 -12
  98. data/lib/katello_api/resources/sync_plan.rb +28 -33
  99. data/lib/katello_api/resources/system.rb +81 -90
  100. data/lib/katello_api/resources/system_group.rb +47 -57
  101. data/lib/katello_api/resources/system_group_erratum.rb +6 -8
  102. data/lib/katello_api/resources/system_group_package.rb +15 -18
  103. data/lib/katello_api/resources/system_package.rb +12 -15
  104. data/lib/katello_api/resources/task.rb +6 -8
  105. data/lib/katello_api/resources/template.rb +39 -47
  106. data/lib/katello_api/resources/templates_content.rb +40 -52
  107. data/lib/katello_api/resources/uebercert.rb +4 -4
  108. data/lib/katello_api/resources/user.rb +47 -50
  109. data/lib/katello_api/version.rb +1 -1
  110. data/lib/katello_api.rb +0 -13
  111. metadata +68 -4
data/doc/KatelloApi/Resources/SyncPlan.html ADDED
@@ -0,0 +1,1148 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: KatelloApi::Resources::SyncPlan
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="KatelloApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">SyncPlan</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: KatelloApi::Resources::SyncPlan
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></li>
82
+
83
+ <li class="next">KatelloApi::Resources::SyncPlan</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/katello_api/resources/sync_plan.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+ <h2>Constant Summary</h2>
106
+
107
+
108
+
109
+
110
+ <h2>Constant Summary</h2>
111
+
112
+ <h3 class="inherited">Constants inherited
113
+ from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
114
+ <p class="inherited"><span class='object_link'><a href="../Base.html#API_VERSION-constant" title="KatelloApi::Base::API_VERSION (constant)">Base::API_VERSION</a></span></p>
115
+
116
+
117
+
118
+
119
+ <h2>Instance Attribute Summary</h2>
120
+
121
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
122
+ <p class="inherited"><span class='object_link'><a href="../Base.html#client-instance_method" title="KatelloApi::Base#client (method)">#client</a></span>, <span class='object_link'><a href="../Base.html#config-instance_method" title="KatelloApi::Base#config (method)">#config</a></span></p>
123
+
124
+
125
+
126
+ <h2>
127
+ Class Method Summary
128
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
129
+ </h2>
130
+
131
+ <ul class="summary">
132
+
133
+ <li class="public ">
134
+ <span class="summary_signature">
135
+
136
+ <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
137
+
138
+
139
+
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'></div></span>
151
+
152
+ </li>
153
+
154
+
155
+ </ul>
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'><p>
182
+ First item: parsed data; second item: raw body.
183
+ </p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'><p>
207
+ First item: parsed data; second item: raw body.
208
+ </p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'><p>
232
+ First item: parsed data; second item: raw body.
233
+ </p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'><p>
257
+ First item: parsed data; second item: raw body.
258
+ </p>
259
+ </div></span>
260
+
261
+ </li>
262
+
263
+
264
+ <li class="public ">
265
+ <span class="summary_signature">
266
+
267
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
268
+
269
+
270
+
271
+ </span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'><p>
282
+ First item: parsed data; second item: raw body.
283
+ </p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ </ul>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
302
+ <p class="inherited"><span class='object_link'><a href="../Base.html#http_call-instance_method" title="KatelloApi::Base#http_call (method)">#http_call</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Base.html#method_doc-class_method" title="KatelloApi::Base.method_doc (method)">method_doc</a></span>, <span class='object_link'><a href="../Base.html#perform_call-instance_method" title="KatelloApi::Base#perform_call (method)">#perform_call</a></span>, <span class='object_link'><a href="../Base.html#validate_params%21-instance_method" title="KatelloApi::Base#validate_params! (method)">#validate_params!</a></span>, <span class='object_link'><a href="../Base.html#validation_hash-class_method" title="KatelloApi::Base.validation_hash (method)">validation_hash</a></span></p>
303
+ <div id="constructor_details" class="method_details_list">
304
+ <h2>Constructor Details</h2>
305
+
306
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">KatelloApi::Base</a></span></p>
307
+
308
+ </div>
309
+
310
+
311
+ <div id="class_method_details" class="method_details_list">
312
+ <h2>Class Method Details</h2>
313
+
314
+
315
+ <div class="method_details first">
316
+ <h3 class="signature first" id="doc-class_method">
317
+
318
+ + (<tt>Object</tt>) <strong>doc</strong>
319
+
320
+
321
+
322
+
323
+
324
+ </h3><table class="source_code">
325
+ <tr>
326
+ <td>
327
+ <pre class="lines">
328
+
329
+
330
+ 4
331
+ 5
332
+ 6</pre>
333
+ </td>
334
+ <td>
335
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 4</span>
336
+
337
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
338
+ <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_KatelloApi constant id'>KatelloApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;sync_plans&quot;</span><span class='rbrack token'>]</span>
339
+ <span class='rubyid_end end kw'>end</span>
340
+ </pre>
341
+ </td>
342
+ </tr>
343
+ </table>
344
+ </div>
345
+
346
+ </div>
347
+
348
+ <div id="instance_method_details" class="method_details_list">
349
+ <h2>Instance Method Details</h2>
350
+
351
+
352
+ <div class="method_details first">
353
+ <h3 class="signature first" id="create-instance_method">
354
+
355
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
356
+
357
+
358
+
359
+
360
+
361
+ </h3><div class="docstring">
362
+ <div class="discussion">
363
+ <p>
364
+ First item: parsed data; second item: raw body
365
+ </p>
366
+
367
+
368
+ </div>
369
+ </div>
370
+ <div class="tags">
371
+ <p class="tag_title">Parameters:</p>
372
+ <ul class="param">
373
+
374
+ <li>
375
+
376
+ <span class='name'>params</span>
377
+
378
+
379
+ <span class='type'>(<tt>Hash</tt>)</span>
380
+
381
+
382
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
383
+
384
+
385
+ &mdash;
386
+ <div class='inline'><p>
387
+ a hash of params to be passed to the service
388
+ </p>
389
+ </div>
390
+
391
+ </li>
392
+
393
+ <li>
394
+
395
+ <span class='name'>headers</span>
396
+
397
+
398
+ <span class='type'>(<tt>Hash</tt>)</span>
399
+
400
+
401
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'><p>
406
+ additional http headers
407
+ </p>
408
+ </div>
409
+
410
+ </li>
411
+
412
+ </ul>
413
+
414
+
415
+
416
+
417
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
418
+ <ul class="option">
419
+
420
+ <li>
421
+ <span class="name">organization_id</span>
422
+ <span class="type">(<tt>String</tt>)</span>
423
+ <span class="default">
424
+
425
+ </span>
426
+
427
+ &mdash; <div class='inline'><p>
428
+ oranization identifier
429
+ </p>
430
+ </div>
431
+
432
+ </li>
433
+
434
+ <li>
435
+ <span class="name">sync_plan</span>
436
+ <span class="type">(<tt>Hash</tt>)</span>
437
+ <span class="default">
438
+
439
+ </span>
440
+
441
+ &mdash; <div class='inline'><p>
442
+ allowed keys are:
443
+ </p>
444
+ <ul>
445
+ <li>description [String, nil] sync plan description
446
+
447
+ </li>
448
+ <li>interval [String, nil] how often synchronization should run
449
+
450
+ </li>
451
+ <li>name [String] sync plan name
452
+
453
+ </li>
454
+ <li>sync_date [String, nil] start datetime of synchronization
455
+
456
+ </li>
457
+ </ul>
458
+ </div>
459
+
460
+ </li>
461
+
462
+ </ul>
463
+
464
+
465
+
466
+
467
+ <p class="tag_title">Returns:</p>
468
+ <ul class="return">
469
+
470
+ <li>
471
+
472
+
473
+ <span class='type'>(<tt>Array</tt>)</span>
474
+
475
+
476
+
477
+ &mdash;
478
+ <div class='inline'><p>
479
+ First item: parsed data; second item: raw body
480
+ </p>
481
+ </div>
482
+
483
+ </li>
484
+
485
+ </ul>
486
+
487
+ </div><table class="source_code">
488
+ <tr>
489
+ <td>
490
+ <pre class="lines">
491
+
492
+
493
+ 41
494
+ 42
495
+ 43</pre>
496
+ </td>
497
+ <td>
498
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 41</span>
499
+
500
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
501
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
502
+ <span class='rubyid_end end kw'>end</span>
503
+ </pre>
504
+ </td>
505
+ </tr>
506
+ </table>
507
+ </div>
508
+
509
+ <div class="method_details ">
510
+ <h3 class="signature " id="destroy-instance_method">
511
+
512
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
513
+
514
+
515
+
516
+
517
+
518
+ </h3><div class="docstring">
519
+ <div class="discussion">
520
+ <p>
521
+ First item: parsed data; second item: raw body
522
+ </p>
523
+
524
+
525
+ </div>
526
+ </div>
527
+ <div class="tags">
528
+ <p class="tag_title">Parameters:</p>
529
+ <ul class="param">
530
+
531
+ <li>
532
+
533
+ <span class='name'>params</span>
534
+
535
+
536
+ <span class='type'>(<tt>Hash</tt>)</span>
537
+
538
+
539
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
540
+
541
+
542
+ &mdash;
543
+ <div class='inline'><p>
544
+ a hash of params to be passed to the service
545
+ </p>
546
+ </div>
547
+
548
+ </li>
549
+
550
+ <li>
551
+
552
+ <span class='name'>headers</span>
553
+
554
+
555
+ <span class='type'>(<tt>Hash</tt>)</span>
556
+
557
+
558
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
559
+
560
+
561
+ &mdash;
562
+ <div class='inline'><p>
563
+ additional http headers
564
+ </p>
565
+ </div>
566
+
567
+ </li>
568
+
569
+ </ul>
570
+
571
+
572
+
573
+
574
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
575
+ <ul class="option">
576
+
577
+ <li>
578
+ <span class="name">id</span>
579
+ <span class="type">(<tt>String</tt>)</span>
580
+ <span class="default">
581
+
582
+ </span>
583
+
584
+ &mdash; <div class='inline'><p>
585
+ sync plan numeric identifier
586
+ </p>
587
+ </div>
588
+
589
+ </li>
590
+
591
+ <li>
592
+ <span class="name">organization_id</span>
593
+ <span class="type">(<tt>String</tt>)</span>
594
+ <span class="default">
595
+
596
+ </span>
597
+
598
+ &mdash; <div class='inline'><p>
599
+ oranization identifier
600
+ </p>
601
+ </div>
602
+
603
+ </li>
604
+
605
+ </ul>
606
+
607
+
608
+
609
+
610
+ <p class="tag_title">Returns:</p>
611
+ <ul class="return">
612
+
613
+ <li>
614
+
615
+
616
+ <span class='type'>(<tt>Array</tt>)</span>
617
+
618
+
619
+
620
+ &mdash;
621
+ <div class='inline'><p>
622
+ First item: parsed data; second item: raw body
623
+ </p>
624
+ </div>
625
+
626
+ </li>
627
+
628
+ </ul>
629
+
630
+ </div><table class="source_code">
631
+ <tr>
632
+ <td>
633
+ <pre class="lines">
634
+
635
+
636
+ 67
637
+ 68
638
+ 69</pre>
639
+ </td>
640
+ <td>
641
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 67</span>
642
+
643
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
644
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
645
+ <span class='rubyid_end end kw'>end</span>
646
+ </pre>
647
+ </td>
648
+ </tr>
649
+ </table>
650
+ </div>
651
+
652
+ <div class="method_details ">
653
+ <h3 class="signature " id="index-instance_method">
654
+
655
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
656
+
657
+
658
+
659
+
660
+
661
+ </h3><div class="docstring">
662
+ <div class="discussion">
663
+ <p>
664
+ First item: parsed data; second item: raw body
665
+ </p>
666
+
667
+
668
+ </div>
669
+ </div>
670
+ <div class="tags">
671
+ <p class="tag_title">Parameters:</p>
672
+ <ul class="param">
673
+
674
+ <li>
675
+
676
+ <span class='name'>params</span>
677
+
678
+
679
+ <span class='type'>(<tt>Hash</tt>)</span>
680
+
681
+
682
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
683
+
684
+
685
+ &mdash;
686
+ <div class='inline'><p>
687
+ a hash of params to be passed to the service
688
+ </p>
689
+ </div>
690
+
691
+ </li>
692
+
693
+ <li>
694
+
695
+ <span class='name'>headers</span>
696
+
697
+
698
+ <span class='type'>(<tt>Hash</tt>)</span>
699
+
700
+
701
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
702
+
703
+
704
+ &mdash;
705
+ <div class='inline'><p>
706
+ additional http headers
707
+ </p>
708
+ </div>
709
+
710
+ </li>
711
+
712
+ </ul>
713
+
714
+
715
+
716
+
717
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
718
+ <ul class="option">
719
+
720
+ <li>
721
+ <span class="name">organization_id</span>
722
+ <span class="type">(<tt>String</tt>)</span>
723
+ <span class="default">
724
+
725
+ </span>
726
+
727
+ &mdash; <div class='inline'><p>
728
+ oranization identifier
729
+ </p>
730
+ </div>
731
+
732
+ </li>
733
+
734
+ <li>
735
+ <span class="name">interval</span>
736
+ <span class="type">(<tt>String</tt>)</span>
737
+ <span class="default">
738
+
739
+ </span>
740
+
741
+ &mdash; <div class='inline'><p>
742
+ filter by interval
743
+ </p>
744
+ </div>
745
+
746
+ </li>
747
+
748
+ <li>
749
+ <span class="name">name</span>
750
+ <span class="type">(<tt>String</tt>)</span>
751
+ <span class="default">
752
+
753
+ </span>
754
+
755
+ &mdash; <div class='inline'><p>
756
+ filter by name
757
+ </p>
758
+ </div>
759
+
760
+ </li>
761
+
762
+ <li>
763
+ <span class="name">sync_date</span>
764
+ <span class="type">(<tt>String</tt>)</span>
765
+ <span class="default">
766
+
767
+ </span>
768
+
769
+ &mdash; <div class='inline'><p>
770
+ filter by sync date
771
+ </p>
772
+ </div>
773
+
774
+ </li>
775
+
776
+ </ul>
777
+
778
+
779
+
780
+
781
+ <p class="tag_title">Returns:</p>
782
+ <ul class="return">
783
+
784
+ <li>
785
+
786
+
787
+ <span class='type'>(<tt>Array</tt>)</span>
788
+
789
+
790
+
791
+ &mdash;
792
+ <div class='inline'><p>
793
+ First item: parsed data; second item: raw body
794
+ </p>
795
+ </div>
796
+
797
+ </li>
798
+
799
+ </ul>
800
+
801
+ </div><table class="source_code">
802
+ <tr>
803
+ <td>
804
+ <pre class="lines">
805
+
806
+
807
+ 16
808
+ 17
809
+ 18</pre>
810
+ </td>
811
+ <td>
812
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 16</span>
813
+
814
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
815
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
816
+ <span class='rubyid_end end kw'>end</span>
817
+ </pre>
818
+ </td>
819
+ </tr>
820
+ </table>
821
+ </div>
822
+
823
+ <div class="method_details ">
824
+ <h3 class="signature " id="show-instance_method">
825
+
826
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
827
+
828
+
829
+
830
+
831
+
832
+ </h3><div class="docstring">
833
+ <div class="discussion">
834
+ <p>
835
+ First item: parsed data; second item: raw body
836
+ </p>
837
+
838
+
839
+ </div>
840
+ </div>
841
+ <div class="tags">
842
+ <p class="tag_title">Parameters:</p>
843
+ <ul class="param">
844
+
845
+ <li>
846
+
847
+ <span class='name'>params</span>
848
+
849
+
850
+ <span class='type'>(<tt>Hash</tt>)</span>
851
+
852
+
853
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
854
+
855
+
856
+ &mdash;
857
+ <div class='inline'><p>
858
+ a hash of params to be passed to the service
859
+ </p>
860
+ </div>
861
+
862
+ </li>
863
+
864
+ <li>
865
+
866
+ <span class='name'>headers</span>
867
+
868
+
869
+ <span class='type'>(<tt>Hash</tt>)</span>
870
+
871
+
872
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
873
+
874
+
875
+ &mdash;
876
+ <div class='inline'><p>
877
+ additional http headers
878
+ </p>
879
+ </div>
880
+
881
+ </li>
882
+
883
+ </ul>
884
+
885
+
886
+
887
+
888
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
889
+ <ul class="option">
890
+
891
+ <li>
892
+ <span class="name">id</span>
893
+ <span class="type">(<tt>String</tt>)</span>
894
+ <span class="default">
895
+
896
+ </span>
897
+
898
+ &mdash; <div class='inline'><p>
899
+ sync plan numeric identifier
900
+ </p>
901
+ </div>
902
+
903
+ </li>
904
+
905
+ <li>
906
+ <span class="name">organization_id</span>
907
+ <span class="type">(<tt>String</tt>)</span>
908
+ <span class="default">
909
+
910
+ </span>
911
+
912
+ &mdash; <div class='inline'><p>
913
+ oranization identifier
914
+ </p>
915
+ </div>
916
+
917
+ </li>
918
+
919
+ </ul>
920
+
921
+
922
+
923
+
924
+ <p class="tag_title">Returns:</p>
925
+ <ul class="return">
926
+
927
+ <li>
928
+
929
+
930
+ <span class='type'>(<tt>Array</tt>)</span>
931
+
932
+
933
+
934
+ &mdash;
935
+ <div class='inline'><p>
936
+ First item: parsed data; second item: raw body
937
+ </p>
938
+ </div>
939
+
940
+ </li>
941
+
942
+ </ul>
943
+
944
+ </div><table class="source_code">
945
+ <tr>
946
+ <td>
947
+ <pre class="lines">
948
+
949
+
950
+ 26
951
+ 27
952
+ 28</pre>
953
+ </td>
954
+ <td>
955
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 26</span>
956
+
957
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
958
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
959
+ <span class='rubyid_end end kw'>end</span>
960
+ </pre>
961
+ </td>
962
+ </tr>
963
+ </table>
964
+ </div>
965
+
966
+ <div class="method_details ">
967
+ <h3 class="signature " id="update-instance_method">
968
+
969
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
970
+
971
+
972
+
973
+
974
+
975
+ </h3><div class="docstring">
976
+ <div class="discussion">
977
+ <p>
978
+ First item: parsed data; second item: raw body
979
+ </p>
980
+
981
+
982
+ </div>
983
+ </div>
984
+ <div class="tags">
985
+ <p class="tag_title">Parameters:</p>
986
+ <ul class="param">
987
+
988
+ <li>
989
+
990
+ <span class='name'>params</span>
991
+
992
+
993
+ <span class='type'>(<tt>Hash</tt>)</span>
994
+
995
+
996
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
997
+
998
+
999
+ &mdash;
1000
+ <div class='inline'><p>
1001
+ a hash of params to be passed to the service
1002
+ </p>
1003
+ </div>
1004
+
1005
+ </li>
1006
+
1007
+ <li>
1008
+
1009
+ <span class='name'>headers</span>
1010
+
1011
+
1012
+ <span class='type'>(<tt>Hash</tt>)</span>
1013
+
1014
+
1015
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1016
+
1017
+
1018
+ &mdash;
1019
+ <div class='inline'><p>
1020
+ additional http headers
1021
+ </p>
1022
+ </div>
1023
+
1024
+ </li>
1025
+
1026
+ </ul>
1027
+
1028
+
1029
+
1030
+
1031
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
1032
+ <ul class="option">
1033
+
1034
+ <li>
1035
+ <span class="name">id</span>
1036
+ <span class="type">(<tt>String</tt>)</span>
1037
+ <span class="default">
1038
+
1039
+ </span>
1040
+
1041
+ &mdash; <div class='inline'><p>
1042
+ sync plan numeric identifier
1043
+ </p>
1044
+ </div>
1045
+
1046
+ </li>
1047
+
1048
+ <li>
1049
+ <span class="name">organization_id</span>
1050
+ <span class="type">(<tt>String</tt>)</span>
1051
+ <span class="default">
1052
+
1053
+ </span>
1054
+
1055
+ &mdash; <div class='inline'><p>
1056
+ oranization identifier
1057
+ </p>
1058
+ </div>
1059
+
1060
+ </li>
1061
+
1062
+ <li>
1063
+ <span class="name">sync_plan</span>
1064
+ <span class="type">(<tt>Hash</tt>)</span>
1065
+ <span class="default">
1066
+
1067
+ </span>
1068
+
1069
+ &mdash; <div class='inline'><p>
1070
+ allowed keys are:
1071
+ </p>
1072
+ <ul>
1073
+ <li>description [String, nil] sync plan description
1074
+
1075
+ </li>
1076
+ <li>interval [String, nil] how often synchronization should run
1077
+
1078
+ </li>
1079
+ <li>name [String] sync plan name
1080
+
1081
+ </li>
1082
+ <li>sync_date [String, nil] start datetime of synchronization
1083
+
1084
+ </li>
1085
+ </ul>
1086
+ </div>
1087
+
1088
+ </li>
1089
+
1090
+ </ul>
1091
+
1092
+
1093
+
1094
+
1095
+ <p class="tag_title">Returns:</p>
1096
+ <ul class="return">
1097
+
1098
+ <li>
1099
+
1100
+
1101
+ <span class='type'>(<tt>Array</tt>)</span>
1102
+
1103
+
1104
+
1105
+ &mdash;
1106
+ <div class='inline'><p>
1107
+ First item: parsed data; second item: raw body
1108
+ </p>
1109
+ </div>
1110
+
1111
+ </li>
1112
+
1113
+ </ul>
1114
+
1115
+ </div><table class="source_code">
1116
+ <tr>
1117
+ <td>
1118
+ <pre class="lines">
1119
+
1120
+
1121
+ 57
1122
+ 58
1123
+ 59</pre>
1124
+ </td>
1125
+ <td>
1126
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/sync_plan.rb', line 57</span>
1127
+
1128
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
1129
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
1130
+ <span class='rubyid_end end kw'>end</span>
1131
+ </pre>
1132
+ </td>
1133
+ </tr>
1134
+ </table>
1135
+ </div>
1136
+
1137
+ </div>
1138
+
1139
+ </div>
1140
+
1141
+ <div id="footer">
1142
+ Generated on Mon Mar 18 14:17:45 2013 by
1143
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1144
+ 0.8.5.2 (ruby-1.8.7).
1145
+ </div>
1146
+
1147
+ </body>
1148
+ </html>