moxiworks_platform 0.13.7 → 0.13.8

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,941 @@
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
+ Class: MoxiworksPlatform::Group
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 = "MoxiworksPlatform::Group";
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 (G)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span>
41
+ &raquo;
42
+ <span class="title">Group</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>Class: MoxiworksPlatform::Group
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></li>
80
+
81
+ <li class="next">MoxiworksPlatform::Group</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/moxiworks_platform/group.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <h1 id="label-Moxi+Works+Platform+Group">Moxi Works Platform Group</h1>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#contacts-instance_method" title="#contacts (instance method)">#<strong>contacts</strong> &#x21d2; Array </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>the contacts in the group.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong> &#x21d2; String </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which the
173
+ group is associated with.</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#moxi_works_group_id-instance_method" title="#moxi_works_group_id (instance method)">#<strong>moxi_works_group_id</strong> &#x21d2; String </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>your system&#39;s group ID for the group.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#moxi_works_group_name-instance_method" title="#moxi_works_group_name (instance method)">#<strong>moxi_works_group_name</strong> &#x21d2; String </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <span class="summary_desc"><div class='inline'>
227
+ <p>your system&#39;s group ID for the group.</p>
228
+ </div></span>
229
+
230
+ </li>
231
+
232
+
233
+ </ul>
234
+
235
+
236
+
237
+
238
+
239
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
240
+ <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
241
+
242
+
243
+
244
+ <h2>
245
+ Class Method Summary
246
+ <small><a href="#" class="summary_toggle">collapse</a></small>
247
+ </h2>
248
+
249
+ <ul class="summary">
250
+
251
+ <li class="public ">
252
+ <span class="summary_signature">
253
+
254
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Group </a>
255
+
256
+
257
+
258
+ </span>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+ <span class="summary_desc"><div class='inline'>
269
+ <p>Find a Group your system has previously created in Moxi Works Platform.</p>
270
+ </div></span>
271
+
272
+ </li>
273
+
274
+
275
+ <li class="public ">
276
+ <span class="summary_signature">
277
+
278
+ <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Array </a>
279
+
280
+
281
+
282
+ </span>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+ <span class="summary_desc"><div class='inline'>
293
+ <p>Search an Agent&#39;s Groups in Moxi Works Platform.</p>
294
+ </div></span>
295
+
296
+ </li>
297
+
298
+
299
+ </ul>
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
312
+ <p class="inherited"><span class='object_link'><a href="Resource.html#accept_header-class_method" title="MoxiworksPlatform::Resource.accept_header (method)">accept_header</a></span>, <span class='object_link'><a href="Resource.html#attr_accessor-class_method" title="MoxiworksPlatform::Resource.attr_accessor (method)">attr_accessor</a></span>, <span class='object_link'><a href="Resource.html#attributes-class_method" title="MoxiworksPlatform::Resource.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Resource.html#attributes-instance_method" title="MoxiworksPlatform::Resource#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Resource.html#auth_header-class_method" title="MoxiworksPlatform::Resource.auth_header (method)">auth_header</a></span>, <span class='object_link'><a href="Resource.html#check_for_error_in_response-class_method" title="MoxiworksPlatform::Resource.check_for_error_in_response (method)">check_for_error_in_response</a></span>, <span class='object_link'><a href="Resource.html#content_type_header-class_method" title="MoxiworksPlatform::Resource.content_type_header (method)">content_type_header</a></span>, <span class='object_link'><a href="Resource.html#float_attrs-instance_method" title="MoxiworksPlatform::Resource#float_attrs (method)">#float_attrs</a></span>, <span class='object_link'><a href="Resource.html#headers-class_method" title="MoxiworksPlatform::Resource.headers (method)">headers</a></span>, <span class='object_link'><a href="Resource.html#init_attrs_from_hash-instance_method" title="MoxiworksPlatform::Resource#init_attrs_from_hash (method)">#init_attrs_from_hash</a></span>, <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Resource.html#int_attrs-instance_method" title="MoxiworksPlatform::Resource#int_attrs (method)">#int_attrs</a></span>, <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Resource.html#numeric_attrs-instance_method" title="MoxiworksPlatform::Resource#numeric_attrs (method)">#numeric_attrs</a></span>, <span class='object_link'><a href="Resource.html#numeric_value_for-instance_method" title="MoxiworksPlatform::Resource#numeric_value_for (method)">#numeric_value_for</a></span>, <span class='object_link'><a href="Resource.html#to_hash-instance_method" title="MoxiworksPlatform::Resource#to_hash (method)">#to_hash</a></span>, <span class='object_link'><a href="Resource.html#underscore-class_method" title="MoxiworksPlatform::Resource.underscore (method)">underscore</a></span>, <span class='object_link'><a href="Resource.html#underscore_array-class_method" title="MoxiworksPlatform::Resource.underscore_array (method)">underscore_array</a></span>, <span class='object_link'><a href="Resource.html#underscore_attribute_names-class_method" title="MoxiworksPlatform::Resource.underscore_attribute_names (method)">underscore_attribute_names</a></span>, <span class='object_link'><a href="Resource.html#underscore_hash-class_method" title="MoxiworksPlatform::Resource.underscore_hash (method)">underscore_hash</a></span>, <span class='object_link'><a href="Resource.html#user_agent_header-class_method" title="MoxiworksPlatform::Resource.user_agent_header (method)">user_agent_header</a></span></p>
313
+ <div id="constructor_details" class="method_details_list">
314
+ <h2>Constructor Details</h2>
315
+
316
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">MoxiworksPlatform::Resource</a></span></p>
317
+
318
+ </div>
319
+ <div id="method_missing_details" class="method_details_list">
320
+ <h2>Dynamic Method Handling</h2>
321
+ <p class="notice super">
322
+ This class handles dynamic methods through the <tt>method_missing</tt> method
323
+
324
+ in the class <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">MoxiworksPlatform::Resource</a></span>
325
+
326
+ </p>
327
+
328
+ </div>
329
+
330
+ <div id="instance_attr_details" class="attr_details">
331
+ <h2>Instance Attribute Details</h2>
332
+
333
+
334
+ <span id="contacts=-instance_method"></span>
335
+ <div class="method_details first">
336
+ <h3 class="signature first" id="contacts-instance_method">
337
+
338
+ #<strong>contacts</strong> &#x21d2; <tt>Array</tt>
339
+
340
+
341
+
342
+
343
+
344
+ </h3><div class="docstring">
345
+ <div class="discussion">
346
+
347
+ <p>the contacts in the group</p>
348
+
349
+
350
+ </div>
351
+ </div>
352
+ <div class="tags">
353
+
354
+ <p class="tag_title">Returns:</p>
355
+ <ul class="return">
356
+
357
+ <li>
358
+
359
+
360
+ <span class='type'>(<tt>Array</tt>)</span>
361
+
362
+
363
+
364
+ &mdash;
365
+ <div class='inline'>
366
+ <p>of MoxiworksPlatform::Contact objects</p>
367
+ </div>
368
+
369
+ </li>
370
+
371
+ </ul>
372
+
373
+ </div><table class="source_code">
374
+ <tr>
375
+ <td>
376
+ <pre class="lines">
377
+
378
+
379
+ 23
380
+ 24
381
+ 25</pre>
382
+ </td>
383
+ <td>
384
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 23</span>
385
+
386
+ <span class='kw'>def</span> <span class='id identifier rubyid_contacts'>contacts</span>
387
+ <span class='ivar'>@contacts</span>
388
+ <span class='kw'>end</span></pre>
389
+ </td>
390
+ </tr>
391
+ </table>
392
+ </div>
393
+
394
+
395
+ <span id="moxi_works_agent_id=-instance_method"></span>
396
+ <div class="method_details ">
397
+ <h3 class="signature " id="moxi_works_agent_id-instance_method">
398
+
399
+ #<strong>moxi_works_agent_id</strong> &#x21d2; <tt>String</tt>
400
+
401
+
402
+
403
+
404
+
405
+ </h3><div class="docstring">
406
+ <div class="discussion">
407
+
408
+ <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which the
409
+ group is associated with.</p>
410
+
411
+ <p>this must be set for any Moxi Works Platform transaction</p>
412
+
413
+
414
+ </div>
415
+ </div>
416
+ <div class="tags">
417
+
418
+ <p class="tag_title">Returns:</p>
419
+ <ul class="return">
420
+
421
+ <li>
422
+
423
+
424
+ <span class='type'>(<tt>String</tt>)</span>
425
+
426
+
427
+
428
+ &mdash;
429
+ <div class='inline'>
430
+ <p>the Moxi Works Platform ID of the agent</p>
431
+ </div>
432
+
433
+ </li>
434
+
435
+ </ul>
436
+
437
+ </div><table class="source_code">
438
+ <tr>
439
+ <td>
440
+ <pre class="lines">
441
+
442
+
443
+ 11
444
+ 12
445
+ 13</pre>
446
+ </td>
447
+ <td>
448
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 11</span>
449
+
450
+ <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
451
+ <span class='ivar'>@moxi_works_agent_id</span>
452
+ <span class='kw'>end</span></pre>
453
+ </td>
454
+ </tr>
455
+ </table>
456
+ </div>
457
+
458
+
459
+ <span id="moxi_works_group_id=-instance_method"></span>
460
+ <div class="method_details ">
461
+ <h3 class="signature " id="moxi_works_group_id-instance_method">
462
+
463
+ #<strong>moxi_works_group_id</strong> &#x21d2; <tt>String</tt>
464
+
465
+
466
+
467
+
468
+
469
+ </h3><div class="docstring">
470
+ <div class="discussion">
471
+
472
+ <p>your system&#39;s group ID for the group</p>
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+
479
+ <p class="tag_title">Returns:</p>
480
+ <ul class="return">
481
+
482
+ <li>
483
+
484
+
485
+ <span class='type'>(<tt>String</tt>)</span>
486
+
487
+
488
+
489
+ &mdash;
490
+ <div class='inline'>
491
+ <p>representing the name of the group on the Moxi Works Platform</p>
492
+ </div>
493
+
494
+ </li>
495
+
496
+ </ul>
497
+
498
+ </div><table class="source_code">
499
+ <tr>
500
+ <td>
501
+ <pre class="lines">
502
+
503
+
504
+ 17</pre>
505
+ </td>
506
+ <td>
507
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 17</span>
508
+
509
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:moxi_works_group_name</span></pre>
510
+ </td>
511
+ </tr>
512
+ </table>
513
+ </div>
514
+
515
+
516
+ <span id="moxi_works_group_name=-instance_method"></span>
517
+ <div class="method_details ">
518
+ <h3 class="signature " id="moxi_works_group_name-instance_method">
519
+
520
+ #<strong>moxi_works_group_name</strong> &#x21d2; <tt>String</tt>
521
+
522
+
523
+
524
+
525
+
526
+ </h3><div class="docstring">
527
+ <div class="discussion">
528
+
529
+ <p>your system&#39;s group ID for the group</p>
530
+
531
+
532
+ </div>
533
+ </div>
534
+ <div class="tags">
535
+
536
+ <p class="tag_title">Returns:</p>
537
+ <ul class="return">
538
+
539
+ <li>
540
+
541
+
542
+ <span class='type'>(<tt>String</tt>)</span>
543
+
544
+
545
+
546
+ &mdash;
547
+ <div class='inline'>
548
+ <p>representing the name of the group on the Moxi Works Platform</p>
549
+ </div>
550
+
551
+ </li>
552
+
553
+ </ul>
554
+
555
+ </div><table class="source_code">
556
+ <tr>
557
+ <td>
558
+ <pre class="lines">
559
+
560
+
561
+ 17
562
+ 18
563
+ 19</pre>
564
+ </td>
565
+ <td>
566
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 17</span>
567
+
568
+ <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_group_name'>moxi_works_group_name</span>
569
+ <span class='ivar'>@moxi_works_group_name</span>
570
+ <span class='kw'>end</span></pre>
571
+ </td>
572
+ </tr>
573
+ </table>
574
+ </div>
575
+
576
+ </div>
577
+
578
+
579
+ <div id="class_method_details" class="method_details_list">
580
+ <h2>Class Method Details</h2>
581
+
582
+
583
+ <div class="method_details first">
584
+ <h3 class="signature first" id="find-class_method">
585
+
586
+ .<strong>find</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Group (class)">MoxiworksPlatform::Group</a></span></tt>
587
+
588
+
589
+
590
+
591
+
592
+ </h3><div class="docstring">
593
+ <div class="discussion">
594
+
595
+ <p>Find a Group your system has previously created in Moxi Works Platform</p>
596
+
597
+
598
+ </div>
599
+ </div>
600
+ <div class="tags">
601
+
602
+ <div class="examples">
603
+ <p class="tag_title">Examples:</p>
604
+
605
+
606
+ <pre class="example code"><code><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Group</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span>
607
+ <span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abc</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
608
+ <span class='label'>moxi_works_group_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foobar</span><span class='tstring_end'>&#39;</span></span>
609
+ <span class='rparen'>)</span></code></pre>
610
+
611
+ </div>
612
+ <p class="tag_title">Parameters:</p>
613
+ <ul class="param">
614
+
615
+ <li>
616
+
617
+ <span class='name'>opts</span>
618
+
619
+
620
+ <span class='type'>(<tt>Hash</tt>)</span>
621
+
622
+
623
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
624
+
625
+
626
+ &mdash;
627
+ <div class='inline'>
628
+ <p>named parameter Hash</p>
629
+ </div>
630
+
631
+ </li>
632
+
633
+ </ul>
634
+
635
+
636
+
637
+
638
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
639
+ <ul class="option">
640
+
641
+ <li>
642
+ <span class="name">:moxi_works_agent_id</span>
643
+ <span class="type">(<tt>String</tt>)</span>
644
+ <span class="default">
645
+
646
+ </span>
647
+
648
+ &mdash; <div class='inline'>
649
+ <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
650
+ this group is associated</p>
651
+ </div>
652
+
653
+ </li>
654
+
655
+ <li>
656
+ <span class="name">:moxi_works_group_id</span>
657
+ <span class="type">(<tt>Integer</tt>)</span>
658
+ <span class="default">
659
+
660
+ </span>
661
+
662
+ &mdash; <div class='inline'>
663
+ <p><strong>REQUIRED</strong> The Moxi Works Group ID for this group.</p>
664
+ </div>
665
+
666
+ </li>
667
+
668
+ </ul>
669
+
670
+
671
+ <p class="tag_title">Returns:</p>
672
+ <ul class="return">
673
+
674
+ <li>
675
+
676
+
677
+ <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Group (class)">MoxiworksPlatform::Group</a></span></tt>)</span>
678
+
679
+
680
+
681
+ </li>
682
+
683
+ </ul>
684
+ <p class="tag_title">Raises:</p>
685
+ <ul class="raise">
686
+
687
+ <li>
688
+
689
+
690
+ <span class='type'></span>
691
+
692
+
693
+
694
+
695
+ <div class='inline'>
696
+ <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
697
+ aren&#39;t included</p>
698
+ </div>
699
+
700
+ </li>
701
+
702
+ <li>
703
+
704
+
705
+ <span class='type'></span>
706
+
707
+
708
+
709
+
710
+ <div class='inline'>
711
+ <p>::MoxiworksPlatform::Exception::ArgumentError if moxi_works_group_id is not
712
+ an Integer or an integer as a String</p>
713
+ </div>
714
+
715
+ </li>
716
+
717
+ </ul>
718
+
719
+ </div><table class="source_code">
720
+ <tr>
721
+ <td>
722
+ <pre class="lines">
723
+
724
+
725
+ 44
726
+ 45
727
+ 46
728
+ 47</pre>
729
+ </td>
730
+ <td>
731
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 44</span>
732
+
733
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
734
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:moxi_works_group_name</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
735
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
736
+ <span class='kw'>end</span></pre>
737
+ </td>
738
+ </tr>
739
+ </table>
740
+ </div>
741
+
742
+ <div class="method_details ">
743
+ <h3 class="signature " id="search-class_method">
744
+
745
+ .<strong>search</strong>(opts = {}) &#x21d2; <tt>Array</tt>
746
+
747
+
748
+
749
+
750
+
751
+ </h3><div class="docstring">
752
+ <div class="discussion">
753
+
754
+ <p>Search an Agent&#39;s Groups in Moxi Works Platform</p>
755
+
756
+
757
+ </div>
758
+ </div>
759
+ <div class="tags">
760
+
761
+ <div class="examples">
762
+ <p class="tag_title">Examples:</p>
763
+
764
+
765
+ <pre class="example code"><code><span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Group</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
766
+ <span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abc</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
767
+ <span class='rparen'>)</span></code></pre>
768
+
769
+ </div>
770
+ <p class="tag_title">Parameters:</p>
771
+ <ul class="param">
772
+
773
+ <li>
774
+
775
+ <span class='name'>opts</span>
776
+
777
+
778
+ <span class='type'>(<tt>Hash</tt>)</span>
779
+
780
+
781
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
782
+
783
+
784
+ &mdash;
785
+ <div class='inline'>
786
+ <p>named parameter Hash</p>
787
+ </div>
788
+
789
+ </li>
790
+
791
+ </ul>
792
+
793
+
794
+
795
+
796
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
797
+ <ul class="option">
798
+
799
+ <li>
800
+ <span class="name">:moxi_works_agent_id</span>
801
+ <span class="type">(<tt>String</tt>)</span>
802
+ <span class="default">
803
+
804
+ </span>
805
+
806
+ &mdash; <div class='inline'>
807
+ <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
808
+ this group is associated</p>
809
+ </div>
810
+
811
+ </li>
812
+
813
+ <li>
814
+ <span class="name">:name</span>
815
+ <span class="type">(<tt>String</tt>)</span>
816
+ <span class="default">
817
+
818
+ </span>
819
+
820
+ &mdash; <div class='inline'>
821
+ <p>optional name to search for. If no name is provided, all of the Agent&#39;s
822
+ Groups will be returned</p>
823
+ </div>
824
+
825
+ </li>
826
+
827
+ </ul>
828
+
829
+
830
+ <p class="tag_title">Returns:</p>
831
+ <ul class="return">
832
+
833
+ <li>
834
+
835
+
836
+ <span class='type'>(<tt>Array</tt>)</span>
837
+
838
+
839
+
840
+ &mdash;
841
+ <div class='inline'>
842
+ <p>containing MoxiworksPlatform::Group objects formatted as follows:</p>
843
+ </div>
844
+
845
+ </li>
846
+
847
+ </ul>
848
+ <p class="tag_title">Raises:</p>
849
+ <ul class="raise">
850
+
851
+ <li>
852
+
853
+
854
+ <span class='type'></span>
855
+
856
+
857
+
858
+
859
+ <div class='inline'>
860
+ <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
861
+ aren&#39;t included</p>
862
+ </div>
863
+
864
+ </li>
865
+
866
+ </ul>
867
+
868
+ </div><table class="source_code">
869
+ <tr>
870
+ <td>
871
+ <pre class="lines">
872
+
873
+
874
+ 64
875
+ 65
876
+ 66
877
+ 67
878
+ 68
879
+ 69
880
+ 70
881
+ 71
882
+ 72
883
+ 73
884
+ 74
885
+ 75
886
+ 76
887
+ 77
888
+ 78
889
+ 79
890
+ 80
891
+ 81
892
+ 82
893
+ 83
894
+ 84
895
+ 85
896
+ 86</pre>
897
+ </td>
898
+ <td>
899
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/group.rb', line 64</span>
900
+
901
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
902
+ <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span>
903
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>arguments must be passed as named parameters</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
904
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/groups</span><span class='tstring_end'>&quot;</span></span>
905
+ <span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:moxi_works_agent_id</span><span class='rbracket'>]</span>
906
+ <span class='id identifier rubyid_required_opts'>required_opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_opt'>opt</span><span class='op'>|</span>
907
+ <span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Exception</span><span class='op'>::</span><span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'> required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span>
908
+ <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
909
+ <span class='kw'>end</span>
910
+ <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>MoxiResponseArray</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
911
+ <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span>
912
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
913
+ <span class='label'>payload:</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_response'>response</span><span class='op'>|</span>
914
+ <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_response'>response</span> <span class='kw'>if</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span>
915
+ <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span>
916
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_for_error_in_response'>check_for_error_in_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
917
+ <span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
918
+ <span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
919
+ <span class='id identifier rubyid_results'>results</span> <span class='op'>&lt;&lt;</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Group</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
920
+ <span class='kw'>end</span>
921
+ <span class='kw'>end</span>
922
+ <span class='id identifier rubyid_results'>results</span>
923
+ <span class='kw'>end</span></pre>
924
+ </td>
925
+ </tr>
926
+ </table>
927
+ </div>
928
+
929
+ </div>
930
+
931
+ </div>
932
+
933
+ <div id="footer">
934
+ Generated on Fri Apr 20 10:00:17 2018 by
935
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
936
+ 0.9.5 (ruby-2.2.4).
937
+ </div>
938
+
939
+ </div>
940
+ </body>
941
+ </html>