moxiworks_platform 0.13.15 → 0.13.16

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -1
  3. data/Gemfile +2 -0
  4. data/lib/moxiworks_platform/action_log.rb +31 -2
  5. data/lib/moxiworks_platform/company.rb +0 -3
  6. data/lib/moxiworks_platform/contact.rb +5 -6
  7. data/lib/moxiworks_platform/listing.rb +11 -1
  8. data/lib/moxiworks_platform/version.rb +1 -1
  9. data/publish_docs.sh +7 -2
  10. metadata +2 -28
  11. data/MoxiworksPlatform/ActionLog.html +0 -1155
  12. data/MoxiworksPlatform/Agent.html +0 -3668
  13. data/MoxiworksPlatform/Brand.html +0 -2897
  14. data/MoxiworksPlatform/BuyerTransaction.html +0 -4703
  15. data/MoxiworksPlatform/Company.html +0 -678
  16. data/MoxiworksPlatform/Config.html +0 -323
  17. data/MoxiworksPlatform/Contact.html +0 -7540
  18. data/MoxiworksPlatform/Credentials.html +0 -1078
  19. data/MoxiworksPlatform/EmailCampaign.html +0 -1076
  20. data/MoxiworksPlatform/Event.html +0 -2987
  21. data/MoxiworksPlatform/Exception.html +0 -117
  22. data/MoxiworksPlatform/Exception/ArgumentError.html +0 -146
  23. data/MoxiworksPlatform/Exception/AuthorizationError.html +0 -134
  24. data/MoxiworksPlatform/Exception/PlatformError.html +0 -141
  25. data/MoxiworksPlatform/Exception/RemoteRequestFailure.html +0 -134
  26. data/MoxiworksPlatform/Gallery.html +0 -877
  27. data/MoxiworksPlatform/Group.html +0 -941
  28. data/MoxiworksPlatform/Listing.html +0 -6242
  29. data/MoxiworksPlatform/Office.html +0 -2144
  30. data/MoxiworksPlatform/PresentationLog.html +0 -1715
  31. data/MoxiworksPlatform/Resource.html +0 -1906
  32. data/MoxiworksPlatform/SellerTransaction.html +0 -4222
  33. data/MoxiworksPlatform/Session.html +0 -209
  34. data/MoxiworksPlatform/SoldListing.html +0 -5606
  35. data/MoxiworksPlatform/Task.html +0 -2351
  36. data/MoxiworksPlatform/Team.html +0 -2147
@@ -1,2987 +0,0 @@
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::Event
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::Event";
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 (E)</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">Event</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::Event
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::Event</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/event.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+Event">Moxi Works Platform Event</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="#all_day-instance_method" title="#all_day (instance method)">#<strong>all_day</strong> &#x21d2; Boolean </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>whether the event is an all day event.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#attendees-instance_method" title="#attendees (instance method)">#<strong>attendees</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>a comma separated list of attendee IDs.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#event_end-instance_method" title="#event_end (instance method)">#<strong>event_end</strong> &#x21d2; Integer </a>
182
-
183
-
184
-
185
- </span>
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
- <span class="summary_desc"><div class='inline'>
199
- <p>a unix timestamp representing the end time of the event.</p>
200
- </div></span>
201
-
202
- </li>
203
-
204
-
205
- <li class="public ">
206
- <span class="summary_signature">
207
-
208
- <a href="#event_location-instance_method" title="#event_location (instance method)">#<strong>event_location</strong> &#x21d2; String </a>
209
-
210
-
211
-
212
- </span>
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
- <span class="summary_desc"><div class='inline'>
226
- <p>a short description of the location of the event.</p>
227
- </div></span>
228
-
229
- </li>
230
-
231
-
232
- <li class="public ">
233
- <span class="summary_signature">
234
-
235
- <a href="#event_start-instance_method" title="#event_start (instance method)">#<strong>event_start</strong> &#x21d2; Integer </a>
236
-
237
-
238
-
239
- </span>
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
- <span class="summary_desc"><div class='inline'>
253
- <p>a unix timestamp representing the start time of the event.</p>
254
- </div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#event_subject-instance_method" title="#event_subject (instance method)">#<strong>event_subject</strong> &#x21d2; String </a>
263
-
264
-
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
- <span class="summary_desc"><div class='inline'>
280
- <p>a short description of the event.</p>
281
- </div></span>
282
-
283
- </li>
284
-
285
-
286
- <li class="public ">
287
- <span class="summary_signature">
288
-
289
- <a href="#is_meeting-instance_method" title="#is_meeting (instance method)">#<strong>is_meeting</strong> &#x21d2; Boolean </a>
290
-
291
-
292
-
293
- </span>
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
- <span class="summary_desc"><div class='inline'>
307
- <p>whether this event is a meeting.</p>
308
- </div></span>
309
-
310
- </li>
311
-
312
-
313
- <li class="public ">
314
- <span class="summary_signature">
315
-
316
- <a href="#location-instance_method" title="#location (instance method)">#<strong>location</strong> &#x21d2; String </a>
317
-
318
-
319
-
320
- </span>
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
- <span class="summary_desc"><div class='inline'>
334
- <p>a short description of the location of the event.</p>
335
- </div></span>
336
-
337
- </li>
338
-
339
-
340
- <li class="public ">
341
- <span class="summary_signature">
342
-
343
- <a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong> &#x21d2; String </a>
344
-
345
-
346
-
347
- </span>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
- <span class="summary_desc"><div class='inline'>
361
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
362
- event is or is to be associated with.</p>
363
- </div></span>
364
-
365
- </li>
366
-
367
-
368
- <li class="public ">
369
- <span class="summary_signature">
370
-
371
- <a href="#note-instance_method" title="#note (instance method)">#<strong>note</strong> &#x21d2; String </a>
372
-
373
-
374
-
375
- </span>
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
- <span class="summary_desc"><div class='inline'>
389
- <p>a more detailed description of the event.</p>
390
- </div></span>
391
-
392
- </li>
393
-
394
-
395
- <li class="public ">
396
- <span class="summary_signature">
397
-
398
- <a href="#partner_event_id-instance_method" title="#partner_event_id (instance method)">#<strong>partner_event_id</strong> &#x21d2; String </a>
399
-
400
-
401
-
402
- </span>
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
- <span class="summary_desc"><div class='inline'>
416
- <p>your system&#39;s event ID for the event.</p>
417
- </div></span>
418
-
419
- </li>
420
-
421
-
422
- <li class="public ">
423
- <span class="summary_signature">
424
-
425
- <a href="#remind_minutes_before-instance_method" title="#remind_minutes_before (instance method)">#<strong>remind_minutes_before</strong> &#x21d2; Integer </a>
426
-
427
-
428
-
429
- </span>
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
- <span class="summary_desc"><div class='inline'>
443
- <p>how many minutes before the event a reminder should be sent.</p>
444
- </div></span>
445
-
446
- </li>
447
-
448
-
449
- <li class="public ">
450
- <span class="summary_signature">
451
-
452
- <a href="#send_reminder-instance_method" title="#send_reminder (instance method)">#<strong>send_reminder</strong> &#x21d2; Boolean </a>
453
-
454
-
455
-
456
- </span>
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
- <span class="summary_desc"><div class='inline'>
470
- <p>whether to send a reminder to attendees.</p>
471
- </div></span>
472
-
473
- </li>
474
-
475
-
476
- </ul>
477
-
478
-
479
-
480
-
481
-
482
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
483
- <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
484
-
485
-
486
-
487
- <h2>
488
- Class Method Summary
489
- <small><a href="#" class="summary_toggle">collapse</a></small>
490
- </h2>
491
-
492
- <ul class="summary">
493
-
494
- <li class="public ">
495
- <span class="summary_signature">
496
-
497
- <a href="#create-class_method" title="create (class method)">.<strong>create</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Event </a>
498
-
499
-
500
-
501
- </span>
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
- <span class="summary_desc"><div class='inline'>
512
- <p>Creates a new Event in Moxi Works Platform.</p>
513
- </div></span>
514
-
515
- </li>
516
-
517
-
518
- <li class="public ">
519
- <span class="summary_signature">
520
-
521
- <a href="#delete-class_method" title="delete (class method)">.<strong>delete</strong>(opts = {}) &#x21d2; Boolean </a>
522
-
523
-
524
-
525
- </span>
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
- <span class="summary_desc"><div class='inline'>
536
- <p>Delete an Event your system has previously created in Moxi Works Platform.</p>
537
- </div></span>
538
-
539
- </li>
540
-
541
-
542
- <li class="public ">
543
- <span class="summary_signature">
544
-
545
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Event </a>
546
-
547
-
548
-
549
- </span>
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
- <span class="summary_desc"><div class='inline'>
560
- <p>Find an Event your system has previously created in Moxi Works Platform.</p>
561
- </div></span>
562
-
563
- </li>
564
-
565
-
566
- <li class="public ">
567
- <span class="summary_signature">
568
-
569
- <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Array </a>
570
-
571
-
572
-
573
- </span>
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
- <span class="summary_desc"><div class='inline'>
584
- <p>Search an Agent&#39;s Events in Moxi Works Platform.</p>
585
- </div></span>
586
-
587
- </li>
588
-
589
-
590
- <li class="public ">
591
- <span class="summary_signature">
592
-
593
- <a href="#send_request-class_method" title="send_request (class method)">.<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; MoxiworksPlatform::Event </a>
594
-
595
-
596
-
597
- </span>
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
- <span class="summary_desc"><div class='inline'>
608
- <p>Send our remote request to the Moxi Works Platform.</p>
609
- </div></span>
610
-
611
- </li>
612
-
613
-
614
- <li class="public ">
615
- <span class="summary_signature">
616
-
617
- <a href="#update-class_method" title="update (class method)">.<strong>update</strong>(opts = {}) &#x21d2; MoxiworksPlatform::Event </a>
618
-
619
-
620
-
621
- </span>
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
- <span class="summary_desc"><div class='inline'>
632
- <p>Updates a new Event in Moxi Works Platform.</p>
633
- </div></span>
634
-
635
- </li>
636
-
637
-
638
- </ul>
639
-
640
- <h2>
641
- Instance Method Summary
642
- <small><a href="#" class="summary_toggle">collapse</a></small>
643
- </h2>
644
-
645
- <ul class="summary">
646
-
647
- <li class="public ">
648
- <span class="summary_signature">
649
-
650
- <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> &#x21d2; Boolean </a>
651
-
652
-
653
-
654
- </span>
655
-
656
-
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
- <span class="summary_desc"><div class='inline'>
665
- <p>Delete an instance of MoxiWorksPlatform::Event from Moxi Works Platform
666
- that your system has previously created.</p>
667
- </div></span>
668
-
669
- </li>
670
-
671
-
672
- <li class="public ">
673
- <span class="summary_signature">
674
-
675
- <a href="#save-instance_method" title="#save (instance method)">#<strong>save</strong> &#x21d2; MoxiWorksPlatform:Event </a>
676
-
677
-
678
-
679
- </span>
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
- <span class="summary_desc"><div class='inline'>
690
- <p>Save an instance of MoxiWorksPlatform::Event to Moxi Works Platform.</p>
691
- </div></span>
692
-
693
- </li>
694
-
695
-
696
- </ul>
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
709
- <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#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>
710
- <div id="constructor_details" class="method_details_list">
711
- <h2>Constructor Details</h2>
712
-
713
- <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>
714
-
715
- </div>
716
- <div id="method_missing_details" class="method_details_list">
717
- <h2>Dynamic Method Handling</h2>
718
- <p class="notice super">
719
- This class handles dynamic methods through the <tt>method_missing</tt> method
720
-
721
- 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>
722
-
723
- </p>
724
-
725
- </div>
726
-
727
- <div id="instance_attr_details" class="attr_details">
728
- <h2>Instance Attribute Details</h2>
729
-
730
-
731
- <span id="all_day=-instance_method"></span>
732
- <div class="method_details first">
733
- <h3 class="signature first" id="all_day-instance_method">
734
-
735
- #<strong>all_day</strong> &#x21d2; <tt>Boolean</tt>
736
-
737
-
738
-
739
-
740
-
741
- </h3><div class="docstring">
742
- <div class="discussion">
743
-
744
- <p>whether the event is an all day event</p>
745
-
746
-
747
- </div>
748
- </div>
749
- <div class="tags">
750
-
751
- <p class="tag_title">Returns:</p>
752
- <ul class="return">
753
-
754
- <li>
755
-
756
-
757
- <span class='type'>(<tt>Boolean</tt>)</span>
758
-
759
-
760
-
761
- </li>
762
-
763
- </ul>
764
-
765
- </div><table class="source_code">
766
- <tr>
767
- <td>
768
- <pre class="lines">
769
-
770
-
771
- 9
772
- 10
773
- 11</pre>
774
- </td>
775
- <td>
776
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 9</span>
777
-
778
- <span class='kw'>def</span> <span class='id identifier rubyid_all_day'>all_day</span>
779
- <span class='ivar'>@all_day</span>
780
- <span class='kw'>end</span></pre>
781
- </td>
782
- </tr>
783
- </table>
784
- </div>
785
-
786
-
787
- <span id="attendees=-instance_method"></span>
788
- <div class="method_details ">
789
- <h3 class="signature " id="attendees-instance_method">
790
-
791
- #<strong>attendees</strong> &#x21d2; <tt>String</tt>
792
-
793
-
794
-
795
-
796
-
797
- </h3><div class="docstring">
798
- <div class="discussion">
799
-
800
- <p>a comma separated list of attendee IDs</p>
801
-
802
-
803
- </div>
804
- </div>
805
- <div class="tags">
806
-
807
- <p class="tag_title">Returns:</p>
808
- <ul class="return">
809
-
810
- <li>
811
-
812
-
813
- <span class='type'>(<tt>String</tt>)</span>
814
-
815
-
816
-
817
- </li>
818
-
819
- </ul>
820
-
821
- </div><table class="source_code">
822
- <tr>
823
- <td>
824
- <pre class="lines">
825
-
826
-
827
- 15
828
- 16
829
- 17</pre>
830
- </td>
831
- <td>
832
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 15</span>
833
-
834
- <span class='kw'>def</span> <span class='id identifier rubyid_attendees'>attendees</span>
835
- <span class='ivar'>@attendees</span>
836
- <span class='kw'>end</span></pre>
837
- </td>
838
- </tr>
839
- </table>
840
- </div>
841
-
842
-
843
- <span id="event_end=-instance_method"></span>
844
- <div class="method_details ">
845
- <h3 class="signature " id="event_end-instance_method">
846
-
847
- #<strong>event_end</strong> &#x21d2; <tt>Integer</tt>
848
-
849
-
850
-
851
-
852
-
853
- </h3><div class="docstring">
854
- <div class="discussion">
855
-
856
- <p>a unix timestamp representing the end time of the event</p>
857
-
858
-
859
- </div>
860
- </div>
861
- <div class="tags">
862
-
863
- <p class="tag_title">Returns:</p>
864
- <ul class="return">
865
-
866
- <li>
867
-
868
-
869
- <span class='type'>(<tt>Integer</tt>)</span>
870
-
871
-
872
-
873
- </li>
874
-
875
- </ul>
876
-
877
- </div><table class="source_code">
878
- <tr>
879
- <td>
880
- <pre class="lines">
881
-
882
-
883
- 21</pre>
884
- </td>
885
- <td>
886
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 21</span>
887
-
888
- <span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:event_end</span></pre>
889
- </td>
890
- </tr>
891
- </table>
892
- </div>
893
-
894
-
895
- <span id="event_location=-instance_method"></span>
896
- <div class="method_details ">
897
- <h3 class="signature " id="event_location-instance_method">
898
-
899
- #<strong>event_location</strong> &#x21d2; <tt>String</tt>
900
-
901
-
902
-
903
-
904
-
905
- </h3><div class="docstring">
906
- <div class="discussion">
907
-
908
- <p>a short description of the location of the event</p>
909
-
910
-
911
- </div>
912
- </div>
913
- <div class="tags">
914
-
915
- <p class="tag_title">Returns:</p>
916
- <ul class="return">
917
-
918
- <li>
919
-
920
-
921
- <span class='type'>(<tt>String</tt>)</span>
922
-
923
-
924
-
925
- </li>
926
-
927
- </ul>
928
-
929
- </div><table class="source_code">
930
- <tr>
931
- <td>
932
- <pre class="lines">
933
-
934
-
935
- 27
936
- 28
937
- 29</pre>
938
- </td>
939
- <td>
940
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 27</span>
941
-
942
- <span class='kw'>def</span> <span class='id identifier rubyid_event_location'>event_location</span>
943
- <span class='ivar'>@event_location</span>
944
- <span class='kw'>end</span></pre>
945
- </td>
946
- </tr>
947
- </table>
948
- </div>
949
-
950
-
951
- <span id="event_start=-instance_method"></span>
952
- <div class="method_details ">
953
- <h3 class="signature " id="event_start-instance_method">
954
-
955
- #<strong>event_start</strong> &#x21d2; <tt>Integer</tt>
956
-
957
-
958
-
959
-
960
-
961
- </h3><div class="docstring">
962
- <div class="discussion">
963
-
964
- <p>a unix timestamp representing the start time of the event</p>
965
-
966
-
967
- </div>
968
- </div>
969
- <div class="tags">
970
-
971
- <p class="tag_title">Returns:</p>
972
- <ul class="return">
973
-
974
- <li>
975
-
976
-
977
- <span class='type'>(<tt>Integer</tt>)</span>
978
-
979
-
980
-
981
- </li>
982
-
983
- </ul>
984
-
985
- </div><table class="source_code">
986
- <tr>
987
- <td>
988
- <pre class="lines">
989
-
990
-
991
- 33</pre>
992
- </td>
993
- <td>
994
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 33</span>
995
-
996
- <span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:event_start</span></pre>
997
- </td>
998
- </tr>
999
- </table>
1000
- </div>
1001
-
1002
-
1003
- <span id="event_subject=-instance_method"></span>
1004
- <div class="method_details ">
1005
- <h3 class="signature " id="event_subject-instance_method">
1006
-
1007
- #<strong>event_subject</strong> &#x21d2; <tt>String</tt>
1008
-
1009
-
1010
-
1011
-
1012
-
1013
- </h3><div class="docstring">
1014
- <div class="discussion">
1015
-
1016
- <p>a short description of the event</p>
1017
-
1018
-
1019
- </div>
1020
- </div>
1021
- <div class="tags">
1022
-
1023
- <p class="tag_title">Returns:</p>
1024
- <ul class="return">
1025
-
1026
- <li>
1027
-
1028
-
1029
- <span class='type'>(<tt>String</tt>)</span>
1030
-
1031
-
1032
-
1033
- </li>
1034
-
1035
- </ul>
1036
-
1037
- </div><table class="source_code">
1038
- <tr>
1039
- <td>
1040
- <pre class="lines">
1041
-
1042
-
1043
- 39
1044
- 40
1045
- 41</pre>
1046
- </td>
1047
- <td>
1048
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 39</span>
1049
-
1050
- <span class='kw'>def</span> <span class='id identifier rubyid_event_subject'>event_subject</span>
1051
- <span class='ivar'>@event_subject</span>
1052
- <span class='kw'>end</span></pre>
1053
- </td>
1054
- </tr>
1055
- </table>
1056
- </div>
1057
-
1058
-
1059
- <span id="is_meeting=-instance_method"></span>
1060
- <div class="method_details ">
1061
- <h3 class="signature " id="is_meeting-instance_method">
1062
-
1063
- #<strong>is_meeting</strong> &#x21d2; <tt>Boolean</tt>
1064
-
1065
-
1066
-
1067
-
1068
-
1069
- </h3><div class="docstring">
1070
- <div class="discussion">
1071
-
1072
- <p>whether this event is a meeting</p>
1073
-
1074
-
1075
- </div>
1076
- </div>
1077
- <div class="tags">
1078
-
1079
- <p class="tag_title">Returns:</p>
1080
- <ul class="return">
1081
-
1082
- <li>
1083
-
1084
-
1085
- <span class='type'>(<tt>Boolean</tt>)</span>
1086
-
1087
-
1088
-
1089
- </li>
1090
-
1091
- </ul>
1092
-
1093
- </div><table class="source_code">
1094
- <tr>
1095
- <td>
1096
- <pre class="lines">
1097
-
1098
-
1099
- 45
1100
- 46
1101
- 47</pre>
1102
- </td>
1103
- <td>
1104
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 45</span>
1105
-
1106
- <span class='kw'>def</span> <span class='id identifier rubyid_is_meeting'>is_meeting</span>
1107
- <span class='ivar'>@is_meeting</span>
1108
- <span class='kw'>end</span></pre>
1109
- </td>
1110
- </tr>
1111
- </table>
1112
- </div>
1113
-
1114
-
1115
- <span id="location=-instance_method"></span>
1116
- <div class="method_details ">
1117
- <h3 class="signature " id="location-instance_method">
1118
-
1119
- #<strong>location</strong> &#x21d2; <tt>String</tt>
1120
-
1121
-
1122
-
1123
-
1124
-
1125
- </h3><div class="docstring">
1126
- <div class="discussion">
1127
-
1128
- <p>a short description of the location of the event</p>
1129
-
1130
-
1131
- </div>
1132
- </div>
1133
- <div class="tags">
1134
-
1135
- <p class="tag_title">Returns:</p>
1136
- <ul class="return">
1137
-
1138
- <li>
1139
-
1140
-
1141
- <span class='type'>(<tt>String</tt>)</span>
1142
-
1143
-
1144
-
1145
- </li>
1146
-
1147
- </ul>
1148
-
1149
- </div><table class="source_code">
1150
- <tr>
1151
- <td>
1152
- <pre class="lines">
1153
-
1154
-
1155
- 27</pre>
1156
- </td>
1157
- <td>
1158
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 27</span>
1159
-
1160
- <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:event_location</span></pre>
1161
- </td>
1162
- </tr>
1163
- </table>
1164
- </div>
1165
-
1166
-
1167
- <span id="moxi_works_agent_id=-instance_method"></span>
1168
- <div class="method_details ">
1169
- <h3 class="signature " id="moxi_works_agent_id-instance_method">
1170
-
1171
- #<strong>moxi_works_agent_id</strong> &#x21d2; <tt>String</tt>
1172
-
1173
-
1174
-
1175
-
1176
-
1177
- </h3><div class="docstring">
1178
- <div class="discussion">
1179
-
1180
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which a
1181
- event is or is to be associated with.</p>
1182
-
1183
- <p>this must be set for any Moxi Works Platform transaction</p>
1184
-
1185
-
1186
- </div>
1187
- </div>
1188
- <div class="tags">
1189
-
1190
- <p class="tag_title">Returns:</p>
1191
- <ul class="return">
1192
-
1193
- <li>
1194
-
1195
-
1196
- <span class='type'>(<tt>String</tt>)</span>
1197
-
1198
-
1199
-
1200
- &mdash;
1201
- <div class='inline'>
1202
- <p>the Moxi Works Platform ID of the agent</p>
1203
- </div>
1204
-
1205
- </li>
1206
-
1207
- </ul>
1208
-
1209
- </div><table class="source_code">
1210
- <tr>
1211
- <td>
1212
- <pre class="lines">
1213
-
1214
-
1215
- 54
1216
- 55
1217
- 56</pre>
1218
- </td>
1219
- <td>
1220
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 54</span>
1221
-
1222
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
1223
- <span class='ivar'>@moxi_works_agent_id</span>
1224
- <span class='kw'>end</span></pre>
1225
- </td>
1226
- </tr>
1227
- </table>
1228
- </div>
1229
-
1230
-
1231
- <span id="note=-instance_method"></span>
1232
- <div class="method_details ">
1233
- <h3 class="signature " id="note-instance_method">
1234
-
1235
- #<strong>note</strong> &#x21d2; <tt>String</tt>
1236
-
1237
-
1238
-
1239
-
1240
-
1241
- </h3><div class="docstring">
1242
- <div class="discussion">
1243
-
1244
- <p>a more detailed description of the event</p>
1245
-
1246
-
1247
- </div>
1248
- </div>
1249
- <div class="tags">
1250
-
1251
- <p class="tag_title">Returns:</p>
1252
- <ul class="return">
1253
-
1254
- <li>
1255
-
1256
-
1257
- <span class='type'>(<tt>String</tt>)</span>
1258
-
1259
-
1260
-
1261
- </li>
1262
-
1263
- </ul>
1264
-
1265
- </div><table class="source_code">
1266
- <tr>
1267
- <td>
1268
- <pre class="lines">
1269
-
1270
-
1271
- 60
1272
- 61
1273
- 62</pre>
1274
- </td>
1275
- <td>
1276
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 60</span>
1277
-
1278
- <span class='kw'>def</span> <span class='id identifier rubyid_note'>note</span>
1279
- <span class='ivar'>@note</span>
1280
- <span class='kw'>end</span></pre>
1281
- </td>
1282
- </tr>
1283
- </table>
1284
- </div>
1285
-
1286
-
1287
- <span id="partner_event_id=-instance_method"></span>
1288
- <div class="method_details ">
1289
- <h3 class="signature " id="partner_event_id-instance_method">
1290
-
1291
- #<strong>partner_event_id</strong> &#x21d2; <tt>String</tt>
1292
-
1293
-
1294
-
1295
-
1296
-
1297
- </h3><div class="docstring">
1298
- <div class="discussion">
1299
-
1300
- <p>your system&#39;s event ID for the event</p>
1301
-
1302
-
1303
- </div>
1304
- </div>
1305
- <div class="tags">
1306
-
1307
- <p class="tag_title">Returns:</p>
1308
- <ul class="return">
1309
-
1310
- <li>
1311
-
1312
-
1313
- <span class='type'>(<tt>String</tt>)</span>
1314
-
1315
-
1316
-
1317
- &mdash;
1318
- <div class='inline'>
1319
- <p>representing the ID of the event in your system</p>
1320
- </div>
1321
-
1322
- </li>
1323
-
1324
- </ul>
1325
-
1326
- </div><table class="source_code">
1327
- <tr>
1328
- <td>
1329
- <pre class="lines">
1330
-
1331
-
1332
- 66
1333
- 67
1334
- 68</pre>
1335
- </td>
1336
- <td>
1337
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 66</span>
1338
-
1339
- <span class='kw'>def</span> <span class='id identifier rubyid_partner_event_id'>partner_event_id</span>
1340
- <span class='ivar'>@partner_event_id</span>
1341
- <span class='kw'>end</span></pre>
1342
- </td>
1343
- </tr>
1344
- </table>
1345
- </div>
1346
-
1347
-
1348
- <span id="remind_minutes_before=-instance_method"></span>
1349
- <div class="method_details ">
1350
- <h3 class="signature " id="remind_minutes_before-instance_method">
1351
-
1352
- #<strong>remind_minutes_before</strong> &#x21d2; <tt>Integer</tt>
1353
-
1354
-
1355
-
1356
-
1357
-
1358
- </h3><div class="docstring">
1359
- <div class="discussion">
1360
-
1361
- <p>how many minutes before the event a reminder should be sent</p>
1362
-
1363
-
1364
- </div>
1365
- </div>
1366
- <div class="tags">
1367
-
1368
- <p class="tag_title">Returns:</p>
1369
- <ul class="return">
1370
-
1371
- <li>
1372
-
1373
-
1374
- <span class='type'>(<tt>Integer</tt>)</span>
1375
-
1376
-
1377
-
1378
- </li>
1379
-
1380
- </ul>
1381
-
1382
- </div><table class="source_code">
1383
- <tr>
1384
- <td>
1385
- <pre class="lines">
1386
-
1387
-
1388
- 72</pre>
1389
- </td>
1390
- <td>
1391
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 72</span>
1392
-
1393
- <span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:remind_minutes_before</span></pre>
1394
- </td>
1395
- </tr>
1396
- </table>
1397
- </div>
1398
-
1399
-
1400
- <span id="send_reminder=-instance_method"></span>
1401
- <div class="method_details ">
1402
- <h3 class="signature " id="send_reminder-instance_method">
1403
-
1404
- #<strong>send_reminder</strong> &#x21d2; <tt>Boolean</tt>
1405
-
1406
-
1407
-
1408
-
1409
-
1410
- </h3><div class="docstring">
1411
- <div class="discussion">
1412
-
1413
- <p>whether to send a reminder to attendees</p>
1414
-
1415
-
1416
- </div>
1417
- </div>
1418
- <div class="tags">
1419
-
1420
- <p class="tag_title">Returns:</p>
1421
- <ul class="return">
1422
-
1423
- <li>
1424
-
1425
-
1426
- <span class='type'>(<tt>Boolean</tt>)</span>
1427
-
1428
-
1429
-
1430
- </li>
1431
-
1432
- </ul>
1433
-
1434
- </div><table class="source_code">
1435
- <tr>
1436
- <td>
1437
- <pre class="lines">
1438
-
1439
-
1440
- 78
1441
- 79
1442
- 80</pre>
1443
- </td>
1444
- <td>
1445
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 78</span>
1446
-
1447
- <span class='kw'>def</span> <span class='id identifier rubyid_send_reminder'>send_reminder</span>
1448
- <span class='ivar'>@send_reminder</span>
1449
- <span class='kw'>end</span></pre>
1450
- </td>
1451
- </tr>
1452
- </table>
1453
- </div>
1454
-
1455
- </div>
1456
-
1457
-
1458
- <div id="class_method_details" class="method_details_list">
1459
- <h2>Class Method Details</h2>
1460
-
1461
-
1462
- <div class="method_details first">
1463
- <h3 class="signature first" id="create-class_method">
1464
-
1465
- .<strong>create</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>
1466
-
1467
-
1468
-
1469
-
1470
-
1471
- </h3><div class="docstring">
1472
- <div class="discussion">
1473
-
1474
- <p>Creates a new Event in Moxi Works Platform</p>
1475
-
1476
-
1477
- </div>
1478
- </div>
1479
- <div class="tags">
1480
-
1481
- <div class="examples">
1482
- <p class="tag_title">Examples:</p>
1483
-
1484
-
1485
- <pre class="example code"><code><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
1486
- <span class='label'>partner_event_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mySystemsUniqueEventID</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1487
- <span class='label'>event_subject:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foo deeaz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1488
- <span class='label'>event_location:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1234 there ave</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1489
- <span class='label'>note:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>yo, whatup?</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1490
- <span class='label'>remind_minutes_before:</span> <span class='int'>10</span><span class='comma'>,</span>
1491
- <span class='label'>is_meeting:</span> <span class='kw'>true</span><span class='comma'>,</span>
1492
- <span class='label'>event_start:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span>
1493
- <span class='label'>event_end:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>+</span> <span class='int'>86400</span><span class='comma'>,</span>
1494
- <span class='label'>all_day:</span> <span class='kw'>false</span>
1495
- <span class='rparen'>)</span></code></pre>
1496
-
1497
- </div>
1498
- <p class="tag_title">Parameters:</p>
1499
- <ul class="param">
1500
-
1501
- <li>
1502
-
1503
- <span class='name'>opts</span>
1504
-
1505
-
1506
- <span class='type'>(<tt>Hash</tt>)</span>
1507
-
1508
-
1509
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1510
-
1511
-
1512
- &mdash;
1513
- <div class='inline'>
1514
- <p>named parameter Hash</p>
1515
- </div>
1516
-
1517
- </li>
1518
-
1519
- </ul>
1520
-
1521
-
1522
-
1523
-
1524
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1525
- <ul class="option">
1526
-
1527
- <li>
1528
- <span class="name">:moxi_works_agent_id</span>
1529
- <span class="type">(<tt>String</tt>)</span>
1530
- <span class="default">
1531
-
1532
- </span>
1533
-
1534
- &mdash; <div class='inline'>
1535
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
1536
- this event is to be associated</p>
1537
- </div>
1538
-
1539
- </li>
1540
-
1541
- <li>
1542
- <span class="name">:partner_event_id</span>
1543
- <span class="type">(<tt>String</tt>)</span>
1544
- <span class="default">
1545
-
1546
- </span>
1547
-
1548
- &mdash; <div class='inline'>
1549
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for this event.</p>
1550
-
1551
- <p>optional Event parameters</p>
1552
- </div>
1553
-
1554
- </li>
1555
-
1556
- <li>
1557
- <span class="name">:event_subject</span>
1558
- <span class="type">(<tt>String</tt>)</span>
1559
- <span class="default">
1560
-
1561
- </span>
1562
-
1563
- &mdash; <div class='inline'>
1564
- <p>a brief human-readable description of the event</p>
1565
- </div>
1566
-
1567
- </li>
1568
-
1569
- <li>
1570
- <span class="name">:event_location</span>
1571
- <span class="type">(<tt>String</tt>)</span>
1572
- <span class="default">
1573
-
1574
- </span>
1575
-
1576
- &mdash; <div class='inline'>
1577
- <p>human-readable description of the event&#39;s location</p>
1578
- </div>
1579
-
1580
- </li>
1581
-
1582
- <li>
1583
- <span class="name">:note</span>
1584
- <span class="type">(<tt>String</tt>)</span>
1585
- <span class="default">
1586
-
1587
- </span>
1588
-
1589
- &mdash; <div class='inline'>
1590
- <p>human-readable details regarding the event</p>
1591
- </div>
1592
-
1593
- </li>
1594
-
1595
- <li>
1596
- <span class="name">:remind_minutes_before</span>
1597
- <span class="type">(<tt>Integer</tt>)</span>
1598
- <span class="default">
1599
-
1600
- </span>
1601
-
1602
- &mdash; <div class='inline'>
1603
- <p>how many minutes before the event the reminder should be sent</p>
1604
- </div>
1605
-
1606
- </li>
1607
-
1608
- <li>
1609
- <span class="name">:is_meeting</span>
1610
- <span class="type">(<tt>Boolean</tt>)</span>
1611
- <span class="default">
1612
-
1613
- </span>
1614
-
1615
- &mdash; <div class='inline'>
1616
- <p>whether the event is a meeting</p>
1617
- </div>
1618
-
1619
- </li>
1620
-
1621
- <li>
1622
- <span class="name">:event_start</span>
1623
- <span class="type">(<tt>Integer</tt>)</span>
1624
- <span class="default">
1625
-
1626
- </span>
1627
-
1628
- &mdash; <div class='inline'>
1629
- <p>Unix timestamp representing the start time of the event</p>
1630
- </div>
1631
-
1632
- </li>
1633
-
1634
- <li>
1635
- <span class="name">:event_end</span>
1636
- <span class="type">(<tt>Integer</tt>)</span>
1637
- <span class="default">
1638
-
1639
- </span>
1640
-
1641
- &mdash; <div class='inline'>
1642
- <p>Unix timestamp representing the end time of the event</p>
1643
- </div>
1644
-
1645
- </li>
1646
-
1647
- <li>
1648
- <span class="name">:all_day</span>
1649
- <span class="type">(<tt>Boolean</tt>)</span>
1650
- <span class="default">
1651
-
1652
- </span>
1653
-
1654
- &mdash; <div class='inline'>
1655
- <p>whether the event is an all day event</p>
1656
- </div>
1657
-
1658
- </li>
1659
-
1660
- <li>
1661
- <span class="name">:attendees</span>
1662
- <span class="type">(<tt>String</tt>)</span>
1663
- <span class="default">
1664
-
1665
- </span>
1666
-
1667
- &mdash; <div class='inline'>
1668
- <p>comma separated list of attendee IDs using Contact IDs from your system
1669
- (partner_contact_id) that have already been added to The Moxi Works
1670
- Platform as a Contact</p>
1671
- </div>
1672
-
1673
- </li>
1674
-
1675
- </ul>
1676
-
1677
-
1678
- <p class="tag_title">Returns:</p>
1679
- <ul class="return">
1680
-
1681
- <li>
1682
-
1683
-
1684
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>)</span>
1685
-
1686
-
1687
-
1688
- </li>
1689
-
1690
- </ul>
1691
- <p class="tag_title">Raises:</p>
1692
- <ul class="raise">
1693
-
1694
- <li>
1695
-
1696
-
1697
- <span class='type'></span>
1698
-
1699
-
1700
-
1701
-
1702
- <div class='inline'>
1703
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
1704
- aren&#39;t included</p>
1705
- </div>
1706
-
1707
- </li>
1708
-
1709
- </ul>
1710
-
1711
- </div><table class="source_code">
1712
- <tr>
1713
- <td>
1714
- <pre class="lines">
1715
-
1716
-
1717
- 115
1718
- 116
1719
- 117</pre>
1720
- </td>
1721
- <td>
1722
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 115</span>
1723
-
1724
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</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>
1725
- <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'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
1726
- <span class='kw'>end</span></pre>
1727
- </td>
1728
- </tr>
1729
- </table>
1730
- </div>
1731
-
1732
- <div class="method_details ">
1733
- <h3 class="signature " id="delete-class_method">
1734
-
1735
- .<strong>delete</strong>(opts = {}) &#x21d2; <tt>Boolean</tt>
1736
-
1737
-
1738
-
1739
-
1740
-
1741
- </h3><div class="docstring">
1742
- <div class="discussion">
1743
-
1744
- <p>Delete an Event your system has previously created in Moxi Works Platform</p>
1745
-
1746
-
1747
- </div>
1748
- </div>
1749
- <div class="tags">
1750
-
1751
- <div class="examples">
1752
- <p class="tag_title">Examples:</p>
1753
-
1754
-
1755
- <pre class="example code"><code><span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='const'>MoxiWorksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abcd</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>partner_event_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myUniqueEventId</span><span class='tstring_end'>&#39;</span></span> <span class='rparen'>)</span></code></pre>
1756
-
1757
- </div>
1758
- <p class="tag_title">Parameters:</p>
1759
- <ul class="param">
1760
-
1761
- <li>
1762
-
1763
- <span class='name'>opts</span>
1764
-
1765
-
1766
- <span class='type'>(<tt>Hash</tt>)</span>
1767
-
1768
-
1769
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1770
-
1771
-
1772
- &mdash;
1773
- <div class='inline'>
1774
- <p>named parameter Hash</p>
1775
-
1776
- <p>required parameters</p>
1777
- </div>
1778
-
1779
- </li>
1780
-
1781
- </ul>
1782
-
1783
-
1784
-
1785
-
1786
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1787
- <ul class="option">
1788
-
1789
- <li>
1790
- <span class="name">:moxi_works_agent_id</span>
1791
- <span class="type">(<tt>String</tt>)</span>
1792
- <span class="default">
1793
-
1794
- </span>
1795
-
1796
- &mdash; <div class='inline'>
1797
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
1798
- this event is associated</p>
1799
- </div>
1800
-
1801
- </li>
1802
-
1803
- <li>
1804
- <span class="name">:partner_event_id</span>
1805
- <span class="type">(<tt>String</tt>)</span>
1806
- <span class="default">
1807
-
1808
- </span>
1809
-
1810
- &mdash; <div class='inline'>
1811
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for this event.</p>
1812
- </div>
1813
-
1814
- </li>
1815
-
1816
- </ul>
1817
-
1818
-
1819
- <p class="tag_title">Returns:</p>
1820
- <ul class="return">
1821
-
1822
- <li>
1823
-
1824
-
1825
- <span class='type'>(<tt>Boolean</tt>)</span>
1826
-
1827
-
1828
-
1829
- &mdash;
1830
- <div class='inline'>
1831
- <p>– success of the delete action</p>
1832
- </div>
1833
-
1834
- </li>
1835
-
1836
- </ul>
1837
- <p class="tag_title">Raises:</p>
1838
- <ul class="raise">
1839
-
1840
- <li>
1841
-
1842
-
1843
- <span class='type'></span>
1844
-
1845
-
1846
-
1847
-
1848
- <div class='inline'>
1849
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
1850
- aren&#39;t included</p>
1851
- </div>
1852
-
1853
- </li>
1854
-
1855
- </ul>
1856
-
1857
- </div><table class="source_code">
1858
- <tr>
1859
- <td>
1860
- <pre class="lines">
1861
-
1862
-
1863
- 243
1864
- 244
1865
- 245
1866
- 246
1867
- 247
1868
- 248
1869
- 249
1870
- 250
1871
- 251
1872
- 252
1873
- 253
1874
- 254
1875
- 255
1876
- 256
1877
- 257
1878
- 258
1879
- 259
1880
- 260
1881
- 261</pre>
1882
- </td>
1883
- <td>
1884
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 243</span>
1885
-
1886
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</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>
1887
- <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>
1888
- <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>
1889
- <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/events/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1890
- <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='comma'>,</span> <span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span>
1891
- <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>
1892
- <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>
1893
- <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>
1894
- <span class='kw'>end</span>
1895
- <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'>:delete</span><span class='comma'>,</span>
1896
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1897
- <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>
1898
- <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>
1899
- <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>
1900
- <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'>RemoteRequestFailure</span><span class='comma'>,</span>
1901
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unable to delete</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>status</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span>
1902
- <span class='id identifier rubyid_json'>json</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>status</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span>
1903
- <span class='kw'>end</span>
1904
- <span class='kw'>end</span></pre>
1905
- </td>
1906
- </tr>
1907
- </table>
1908
- </div>
1909
-
1910
- <div class="method_details ">
1911
- <h3 class="signature " id="find-class_method">
1912
-
1913
- .<strong>find</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>
1914
-
1915
-
1916
-
1917
-
1918
-
1919
- </h3><div class="docstring">
1920
- <div class="discussion">
1921
-
1922
- <p>Find an Event your system has previously created in Moxi Works Platform</p>
1923
-
1924
-
1925
- </div>
1926
- </div>
1927
- <div class="tags">
1928
- <p class="tag_title">Parameters:</p>
1929
- <ul class="param">
1930
-
1931
- <li>
1932
-
1933
- <span class='name'>opts</span>
1934
-
1935
-
1936
- <span class='type'>(<tt>Hash</tt>)</span>
1937
-
1938
-
1939
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1940
-
1941
-
1942
- &mdash;
1943
- <div class='inline'>
1944
- <p>named parameter Hash</p>
1945
- </div>
1946
-
1947
- </li>
1948
-
1949
- </ul>
1950
-
1951
-
1952
-
1953
-
1954
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1955
- <ul class="option">
1956
-
1957
- <li>
1958
- <span class="name">:moxi_works_agent_id</span>
1959
- <span class="type">(<tt>String</tt>)</span>
1960
- <span class="default">
1961
-
1962
- </span>
1963
-
1964
- &mdash; <div class='inline'>
1965
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
1966
- this event is associated</p>
1967
- </div>
1968
-
1969
- </li>
1970
-
1971
- <li>
1972
- <span class="name">:partner_event_id</span>
1973
- <span class="type">(<tt>String</tt>)</span>
1974
- <span class="default">
1975
-
1976
- </span>
1977
-
1978
- &mdash; <div class='inline'>
1979
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for this event.</p>
1980
- </div>
1981
-
1982
- </li>
1983
-
1984
- </ul>
1985
-
1986
-
1987
- <p class="tag_title">Returns:</p>
1988
- <ul class="return">
1989
-
1990
- <li>
1991
-
1992
-
1993
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>)</span>
1994
-
1995
-
1996
-
1997
- </li>
1998
-
1999
- </ul>
2000
- <p class="tag_title">Raises:</p>
2001
- <ul class="raise">
2002
-
2003
- <li>
2004
-
2005
-
2006
- <span class='type'></span>
2007
-
2008
-
2009
-
2010
-
2011
- <div class='inline'>
2012
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
2013
- aren&#39;t included</p>
2014
- </div>
2015
-
2016
- </li>
2017
-
2018
- </ul>
2019
-
2020
- </div><table class="source_code">
2021
- <tr>
2022
- <td>
2023
- <pre class="lines">
2024
-
2025
-
2026
- 129
2027
- 130
2028
- 131
2029
- 132</pre>
2030
- </td>
2031
- <td>
2032
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 129</span>
2033
-
2034
- <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>
2035
- <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/events/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
2036
- <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>
2037
- <span class='kw'>end</span></pre>
2038
- </td>
2039
- </tr>
2040
- </table>
2041
- </div>
2042
-
2043
- <div class="method_details ">
2044
- <h3 class="signature " id="search-class_method">
2045
-
2046
- .<strong>search</strong>(opts = {}) &#x21d2; <tt>Array</tt>
2047
-
2048
-
2049
-
2050
-
2051
-
2052
- </h3><div class="docstring">
2053
- <div class="discussion">
2054
-
2055
- <p>Search an Agent&#39;s Events in Moxi Works Platform</p>
2056
-
2057
-
2058
- </div>
2059
- </div>
2060
- <div class="tags">
2061
-
2062
- <div class="examples">
2063
- <p class="tag_title">Examples:</p>
2064
-
2065
-
2066
- <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'>Contact</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
2067
- <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>
2068
- <span class='label'>date_start:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span> <span class='op'>-</span> <span class='int'>60</span> <span class='op'>*</span> <span class='int'>60</span> <span class='op'>*</span> <span class='int'>24</span> <span class='op'>*</span> <span class='int'>7</span><span class='comma'>,</span> <span class='comment'># 1 week
2069
- </span><span class='label'>date_end:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
2070
- <span class='rparen'>)</span></code></pre>
2071
-
2072
- </div>
2073
- <p class="tag_title">Parameters:</p>
2074
- <ul class="param">
2075
-
2076
- <li>
2077
-
2078
- <span class='name'>opts</span>
2079
-
2080
-
2081
- <span class='type'>(<tt>Hash</tt>)</span>
2082
-
2083
-
2084
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2085
-
2086
-
2087
- &mdash;
2088
- <div class='inline'>
2089
- <p>named parameter Hash</p>
2090
- </div>
2091
-
2092
- </li>
2093
-
2094
- </ul>
2095
-
2096
-
2097
-
2098
-
2099
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2100
- <ul class="option">
2101
-
2102
- <li>
2103
- <span class="name">:moxi_works_agent_id</span>
2104
- <span class="type">(<tt>String</tt>)</span>
2105
- <span class="default">
2106
-
2107
- </span>
2108
-
2109
- &mdash; <div class='inline'>
2110
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
2111
- this event is associated</p>
2112
- </div>
2113
-
2114
- </li>
2115
-
2116
- <li>
2117
- <span class="name">:date_start</span>
2118
- <span class="type">(<tt>Integer</tt>)</span>
2119
- <span class="default">
2120
-
2121
- </span>
2122
-
2123
- &mdash; <div class='inline'>
2124
- <p><strong>REQUIRED</strong> The Unix timestamp representing the date after
2125
- which to search</p>
2126
- </div>
2127
-
2128
- </li>
2129
-
2130
- <li>
2131
- <span class="name">:date_end</span>
2132
- <span class="type">(<tt>Integer</tt>)</span>
2133
- <span class="default">
2134
-
2135
- </span>
2136
-
2137
- &mdash; <div class='inline'>
2138
- <p><strong>REQUIRED</strong> The Unix timestamp representing the date before
2139
- which to search</p>
2140
- </div>
2141
-
2142
- </li>
2143
-
2144
- </ul>
2145
-
2146
-
2147
- <p class="tag_title">Returns:</p>
2148
- <ul class="return">
2149
-
2150
- <li>
2151
-
2152
-
2153
- <span class='type'>(<tt>Array</tt>)</span>
2154
-
2155
-
2156
-
2157
- &mdash;
2158
- <div class='inline'>
2159
- <p>containing Hash objects formatted as follows: { “date” =&gt; “MM/DD/YY”,</p>
2160
-
2161
- <pre class="code ruby"><code class="ruby">&quot;events&quot; =&gt; [ MoxiworkPlatform::Event, MoxiworkPlatform::Event ]</code></pre>
2162
-
2163
- <p>}</p>
2164
- </div>
2165
-
2166
- </li>
2167
-
2168
- </ul>
2169
- <p class="tag_title">Raises:</p>
2170
- <ul class="raise">
2171
-
2172
- <li>
2173
-
2174
-
2175
- <span class='type'></span>
2176
-
2177
-
2178
-
2179
-
2180
- <div class='inline'>
2181
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
2182
- aren&#39;t included</p>
2183
- </div>
2184
-
2185
- </li>
2186
-
2187
- </ul>
2188
-
2189
- </div><table class="source_code">
2190
- <tr>
2191
- <td>
2192
- <pre class="lines">
2193
-
2194
-
2195
- 156
2196
- 157
2197
- 158
2198
- 159
2199
- 160
2200
- 161
2201
- 162
2202
- 163
2203
- 164
2204
- 165
2205
- 166
2206
- 167
2207
- 168
2208
- 169
2209
- 170
2210
- 171
2211
- 172
2212
- 173
2213
- 174
2214
- 175
2215
- 176
2216
- 177
2217
- 178
2218
- 179
2219
- 180
2220
- 181
2221
- 182
2222
- 183
2223
- 184</pre>
2224
- </td>
2225
- <td>
2226
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 156</span>
2227
-
2228
- <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>
2229
- <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>
2230
- <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>
2231
- <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/events</span><span class='tstring_end'>&quot;</span></span>
2232
- <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='comma'>,</span> <span class='symbol'>:date_start</span><span class='comma'>,</span> <span class='symbol'>:date_end</span><span class='rbracket'>]</span>
2233
- <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>
2234
- <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>
2235
- <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>
2236
- <span class='kw'>end</span>
2237
- <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>
2238
- <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>
2239
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
2240
- <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>
2241
- <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>
2242
- <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>
2243
- <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>
2244
- <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>
2245
- <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_events_for_date'>events_for_date</span><span class='op'>|</span>
2246
- <span class='id identifier rubyid_events'>events</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
2247
- <span class='id identifier rubyid_events_for_date'>events_for_date</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_date'>date</span><span class='comma'>,</span> <span class='id identifier rubyid_event_array'>event_array</span><span class='op'>|</span>
2248
- <span class='id identifier rubyid_event_array'>event_array</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>
2249
- <span class='id identifier rubyid_events'>events</span> <span class='op'>&lt;&lt;</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Event</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>
2250
- <span class='kw'>end</span>
2251
- <span class='id identifier rubyid_results'>results</span> <span class='op'>&lt;&lt;</span> <span class='lbrace'>{</span><span class='label'>date:</span> <span class='id identifier rubyid_date'>date</span><span class='comma'>,</span> <span class='label'>events:</span> <span class='id identifier rubyid_events'>events</span><span class='rbrace'>}</span>
2252
- <span class='kw'>end</span>
2253
- <span class='kw'>end</span>
2254
- <span class='kw'>end</span>
2255
- <span class='id identifier rubyid_results'>results</span>
2256
- <span class='kw'>end</span></pre>
2257
- </td>
2258
- </tr>
2259
- </table>
2260
- </div>
2261
-
2262
- <div class="method_details ">
2263
- <h3 class="signature " id="send_request-class_method">
2264
-
2265
- .<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>
2266
-
2267
-
2268
-
2269
-
2270
-
2271
- </h3><div class="docstring">
2272
- <div class="discussion">
2273
-
2274
- <p>Send our remote request to the Moxi Works Platform</p>
2275
-
2276
-
2277
- </div>
2278
- </div>
2279
- <div class="tags">
2280
- <p class="tag_title">Parameters:</p>
2281
- <ul class="param">
2282
-
2283
- <li>
2284
-
2285
- <span class='name'>method</span>
2286
-
2287
-
2288
- <span class='type'>(<tt>String</tt>)</span>
2289
-
2290
-
2291
-
2292
- &mdash;
2293
- <div class='inline'>
2294
- <p>The HTTP method to be used when connecting; ex: :put, :post, :get</p>
2295
- </div>
2296
-
2297
- </li>
2298
-
2299
- <li>
2300
-
2301
- <span class='name'>opts</span>
2302
-
2303
-
2304
- <span class='type'>(<tt>Hash</tt>)</span>
2305
-
2306
-
2307
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2308
-
2309
-
2310
- </li>
2311
-
2312
- </ul>
2313
-
2314
-
2315
-
2316
-
2317
-
2318
-
2319
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2320
- <ul class="option">
2321
-
2322
- <li>
2323
- <span class="name">:moxi_works_agent_id</span>
2324
- <span class="type">(<tt>String</tt>)</span>
2325
- <span class="default">
2326
-
2327
- </span>
2328
-
2329
- &mdash; <div class='inline'>
2330
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
2331
- this event is associated</p>
2332
- </div>
2333
-
2334
- </li>
2335
-
2336
- <li>
2337
- <span class="name">:partner_event_id</span>
2338
- <span class="type">(<tt>String</tt>)</span>
2339
- <span class="default">
2340
-
2341
- </span>
2342
-
2343
- &mdash; <div class='inline'>
2344
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for this event.</p>
2345
-
2346
- <p>optional Event parameters</p>
2347
- </div>
2348
-
2349
- </li>
2350
-
2351
- <li>
2352
- <span class="name">:event_subject</span>
2353
- <span class="type">(<tt>String</tt>)</span>
2354
- <span class="default">
2355
-
2356
- </span>
2357
-
2358
- &mdash; <div class='inline'>
2359
- <p>a brief human-readable description of the event</p>
2360
- </div>
2361
-
2362
- </li>
2363
-
2364
- <li>
2365
- <span class="name">:event_location</span>
2366
- <span class="type">(<tt>String</tt>)</span>
2367
- <span class="default">
2368
-
2369
- </span>
2370
-
2371
- &mdash; <div class='inline'>
2372
- <p>human-readable description of the event&#39;s location</p>
2373
- </div>
2374
-
2375
- </li>
2376
-
2377
- <li>
2378
- <span class="name">:note</span>
2379
- <span class="type">(<tt>String</tt>)</span>
2380
- <span class="default">
2381
-
2382
- </span>
2383
-
2384
- &mdash; <div class='inline'>
2385
- <p>human-readable details regarding the event</p>
2386
- </div>
2387
-
2388
- </li>
2389
-
2390
- <li>
2391
- <span class="name">:remind_minutes_before</span>
2392
- <span class="type">(<tt>Integer</tt>)</span>
2393
- <span class="default">
2394
-
2395
- </span>
2396
-
2397
- &mdash; <div class='inline'>
2398
- <p>how many minutes before the event the reminder should be sent</p>
2399
- </div>
2400
-
2401
- </li>
2402
-
2403
- <li>
2404
- <span class="name">:is_meeting</span>
2405
- <span class="type">(<tt>Boolean</tt>)</span>
2406
- <span class="default">
2407
-
2408
- </span>
2409
-
2410
- &mdash; <div class='inline'>
2411
- <p>whether the event is a meeting</p>
2412
- </div>
2413
-
2414
- </li>
2415
-
2416
- <li>
2417
- <span class="name">:event_start</span>
2418
- <span class="type">(<tt>Integer</tt>)</span>
2419
- <span class="default">
2420
-
2421
- </span>
2422
-
2423
- &mdash; <div class='inline'>
2424
- <p>Unix timestamp representing the start time of the event</p>
2425
- </div>
2426
-
2427
- </li>
2428
-
2429
- <li>
2430
- <span class="name">:event_end</span>
2431
- <span class="type">(<tt>Integer</tt>)</span>
2432
- <span class="default">
2433
-
2434
- </span>
2435
-
2436
- &mdash; <div class='inline'>
2437
- <p>Unix timestamp representing the end time of the event</p>
2438
- </div>
2439
-
2440
- </li>
2441
-
2442
- <li>
2443
- <span class="name">:recurring</span>
2444
- <span class="type">(<tt>Boolean</tt>)</span>
2445
- <span class="default">
2446
-
2447
- </span>
2448
-
2449
- &mdash; <div class='inline'>
2450
- <p>whether the event is a recurring event</p>
2451
- </div>
2452
-
2453
- </li>
2454
-
2455
- <li>
2456
- <span class="name">:all_day</span>
2457
- <span class="type">(<tt>Boolean</tt>)</span>
2458
- <span class="default">
2459
-
2460
- </span>
2461
-
2462
- &mdash; <div class='inline'>
2463
- <p>whether the event is an all day event</p>
2464
- </div>
2465
-
2466
- </li>
2467
-
2468
- <li>
2469
- <span class="name">:attendees</span>
2470
- <span class="type">(<tt>String</tt>)</span>
2471
- <span class="default">
2472
-
2473
- </span>
2474
-
2475
- &mdash; <div class='inline'>
2476
- <p>comma separated list of attendee IDs using Contact IDs from your system
2477
- (partner_contact_id) that have already been added to The Moxi Works
2478
- Platform as a Contact</p>
2479
- </div>
2480
-
2481
- </li>
2482
-
2483
- </ul>
2484
-
2485
-
2486
-
2487
-
2488
- <p class="tag_title">Returns:</p>
2489
- <ul class="return">
2490
-
2491
- <li>
2492
-
2493
-
2494
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>)</span>
2495
-
2496
-
2497
-
2498
- </li>
2499
-
2500
- </ul>
2501
- <p class="tag_title">Raises:</p>
2502
- <ul class="raise">
2503
-
2504
- <li>
2505
-
2506
-
2507
- <span class='type'></span>
2508
-
2509
-
2510
-
2511
-
2512
- <div class='inline'>
2513
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
2514
- aren&#39;t included</p>
2515
- </div>
2516
-
2517
- </li>
2518
-
2519
- </ul>
2520
-
2521
- </div><table class="source_code">
2522
- <tr>
2523
- <td>
2524
- <pre class="lines">
2525
-
2526
-
2527
- 288
2528
- 289
2529
- 290
2530
- 291
2531
- 292
2532
- 293
2533
- 294
2534
- 295
2535
- 296
2536
- 297
2537
- 298
2538
- 299</pre>
2539
- </td>
2540
- <td>
2541
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 288</span>
2542
-
2543
- <span class='kw'>def</span> <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='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
2544
- <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>
2545
- <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>
2546
- <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/events</span><span class='tstring_end'>&quot;</span></span>
2547
- <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='comma'>,</span> <span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span>
2548
- <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>
2549
- <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>
2550
- <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>
2551
- <span class='kw'>end</span>
2552
- <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:event_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span>
2553
- <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</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>
2554
- <span class='kw'>end</span></pre>
2555
- </td>
2556
- </tr>
2557
- </table>
2558
- </div>
2559
-
2560
- <div class="method_details ">
2561
- <h3 class="signature " id="update-class_method">
2562
-
2563
- .<strong>update</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>
2564
-
2565
-
2566
-
2567
-
2568
-
2569
- </h3><div class="docstring">
2570
- <div class="discussion">
2571
-
2572
- <p>Updates a new Event in Moxi Works Platform</p>
2573
-
2574
-
2575
- </div>
2576
- </div>
2577
- <div class="tags">
2578
-
2579
- <div class="examples">
2580
- <p class="tag_title">Examples:</p>
2581
-
2582
-
2583
- <pre class="example code"><code><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2584
- <span class='label'>partner_event_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mySystemsUniqueEventID</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2585
- <span class='label'>event_subject:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foo deeaz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2586
- <span class='label'>event_location:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1234 there ave</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2587
- <span class='label'>note:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>yo, whatup?</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2588
- <span class='label'>remind_minutes_before:</span> <span class='int'>10</span><span class='comma'>,</span>
2589
- <span class='label'>is_meeting:</span> <span class='kw'>true</span><span class='comma'>,</span>
2590
- <span class='label'>event_start:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span>
2591
- <span class='label'>event_end:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>+</span> <span class='int'>86400</span><span class='comma'>,</span>
2592
- <span class='label'>all_day:</span> <span class='kw'>false</span>
2593
- <span class='rparen'>)</span></code></pre>
2594
-
2595
- </div>
2596
- <p class="tag_title">Parameters:</p>
2597
- <ul class="param">
2598
-
2599
- <li>
2600
-
2601
- <span class='name'>opts</span>
2602
-
2603
-
2604
- <span class='type'>(<tt>Hash</tt>)</span>
2605
-
2606
-
2607
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2608
-
2609
-
2610
- &mdash;
2611
- <div class='inline'>
2612
- <p>named parameter Hash</p>
2613
- </div>
2614
-
2615
- </li>
2616
-
2617
- </ul>
2618
-
2619
-
2620
-
2621
-
2622
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2623
- <ul class="option">
2624
-
2625
- <li>
2626
- <span class="name">:moxi_works_agent_id</span>
2627
- <span class="type">(<tt>String</tt>)</span>
2628
- <span class="default">
2629
-
2630
- </span>
2631
-
2632
- &mdash; <div class='inline'>
2633
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
2634
- this event is to be associated</p>
2635
- </div>
2636
-
2637
- </li>
2638
-
2639
- <li>
2640
- <span class="name">:partner_event_id</span>
2641
- <span class="type">(<tt>String</tt>)</span>
2642
- <span class="default">
2643
-
2644
- </span>
2645
-
2646
- &mdash; <div class='inline'>
2647
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for this event.</p>
2648
-
2649
- <p>optional Event parameters</p>
2650
- </div>
2651
-
2652
- </li>
2653
-
2654
- <li>
2655
- <span class="name">:event_subject</span>
2656
- <span class="type">(<tt>String</tt>)</span>
2657
- <span class="default">
2658
-
2659
- </span>
2660
-
2661
- &mdash; <div class='inline'>
2662
- <p>a brief human-readable description of the event</p>
2663
- </div>
2664
-
2665
- </li>
2666
-
2667
- <li>
2668
- <span class="name">:event_location</span>
2669
- <span class="type">(<tt>String</tt>)</span>
2670
- <span class="default">
2671
-
2672
- </span>
2673
-
2674
- &mdash; <div class='inline'>
2675
- <p>human-readable description of the event&#39;s location</p>
2676
- </div>
2677
-
2678
- </li>
2679
-
2680
- <li>
2681
- <span class="name">:note</span>
2682
- <span class="type">(<tt>String</tt>)</span>
2683
- <span class="default">
2684
-
2685
- </span>
2686
-
2687
- &mdash; <div class='inline'>
2688
- <p>human-readable details regarding the event</p>
2689
- </div>
2690
-
2691
- </li>
2692
-
2693
- <li>
2694
- <span class="name">:remind_minutes_before</span>
2695
- <span class="type">(<tt>Integer</tt>)</span>
2696
- <span class="default">
2697
-
2698
- </span>
2699
-
2700
- &mdash; <div class='inline'>
2701
- <p>how many minutes before the event the reminder should be sent</p>
2702
- </div>
2703
-
2704
- </li>
2705
-
2706
- <li>
2707
- <span class="name">:is_meeting</span>
2708
- <span class="type">(<tt>Boolean</tt>)</span>
2709
- <span class="default">
2710
-
2711
- </span>
2712
-
2713
- &mdash; <div class='inline'>
2714
- <p>whether the event is a meeting</p>
2715
- </div>
2716
-
2717
- </li>
2718
-
2719
- <li>
2720
- <span class="name">:event_start</span>
2721
- <span class="type">(<tt>Integer</tt>)</span>
2722
- <span class="default">
2723
-
2724
- </span>
2725
-
2726
- &mdash; <div class='inline'>
2727
- <p>Unix timestamp representing the start time of the event</p>
2728
- </div>
2729
-
2730
- </li>
2731
-
2732
- <li>
2733
- <span class="name">:event_end</span>
2734
- <span class="type">(<tt>Integer</tt>)</span>
2735
- <span class="default">
2736
-
2737
- </span>
2738
-
2739
- &mdash; <div class='inline'>
2740
- <p>Unix timestamp representing the end time of the event</p>
2741
- </div>
2742
-
2743
- </li>
2744
-
2745
- <li>
2746
- <span class="name">:all_day</span>
2747
- <span class="type">(<tt>Boolean</tt>)</span>
2748
- <span class="default">
2749
-
2750
- </span>
2751
-
2752
- &mdash; <div class='inline'>
2753
- <p>whether the event is an all day event</p>
2754
- </div>
2755
-
2756
- </li>
2757
-
2758
- <li>
2759
- <span class="name">:attendees</span>
2760
- <span class="type">(<tt>String</tt>)</span>
2761
- <span class="default">
2762
-
2763
- </span>
2764
-
2765
- &mdash; <div class='inline'>
2766
- <p>comma separated list of attendee IDs using Contact IDs from your system
2767
- (partner_contact_id) that have already been added to The Moxi Works
2768
- Platform as a Contact</p>
2769
- </div>
2770
-
2771
- </li>
2772
-
2773
- </ul>
2774
-
2775
-
2776
- <p class="tag_title">Returns:</p>
2777
- <ul class="return">
2778
-
2779
- <li>
2780
-
2781
-
2782
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::Event (class)">MoxiworksPlatform::Event</a></span></tt>)</span>
2783
-
2784
-
2785
-
2786
- </li>
2787
-
2788
- </ul>
2789
- <p class="tag_title">Raises:</p>
2790
- <ul class="raise">
2791
-
2792
- <li>
2793
-
2794
-
2795
- <span class='type'></span>
2796
-
2797
-
2798
-
2799
-
2800
- <div class='inline'>
2801
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
2802
- aren&#39;t included</p>
2803
- </div>
2804
-
2805
- </li>
2806
-
2807
- </ul>
2808
-
2809
- </div><table class="source_code">
2810
- <tr>
2811
- <td>
2812
- <pre class="lines">
2813
-
2814
-
2815
- 221
2816
- 222
2817
- 223
2818
- 224
2819
- 225</pre>
2820
- </td>
2821
- <td>
2822
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 221</span>
2823
-
2824
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</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>
2825
- <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:event_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span>
2826
- <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/events/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:partner_event_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
2827
- <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'>:put</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>
2828
- <span class='kw'>end</span></pre>
2829
- </td>
2830
- </tr>
2831
- </table>
2832
- </div>
2833
-
2834
- </div>
2835
-
2836
- <div id="instance_method_details" class="method_details_list">
2837
- <h2>Instance Method Details</h2>
2838
-
2839
-
2840
- <div class="method_details first">
2841
- <h3 class="signature first" id="delete-instance_method">
2842
-
2843
- #<strong>delete</strong> &#x21d2; <tt>Boolean</tt>
2844
-
2845
-
2846
-
2847
-
2848
-
2849
- </h3><div class="docstring">
2850
- <div class="discussion">
2851
-
2852
- <p>Delete an instance of MoxiWorksPlatform::Event from Moxi Works Platform
2853
- that your system has previously created</p>
2854
-
2855
-
2856
- </div>
2857
- </div>
2858
- <div class="tags">
2859
-
2860
- <div class="examples">
2861
- <p class="tag_title">Examples:</p>
2862
-
2863
-
2864
- <pre class="example code"><code><span class='id identifier rubyid_event'>event</span> <span class='op'>=</span> <span class='const'>MoxiWorksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abcd</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>partner_event_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myUniqueEventtId</span><span class='tstring_end'>&#39;</span></span> <span class='rparen'>)</span>
2865
- <span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span></code></pre>
2866
-
2867
- </div>
2868
-
2869
- <p class="tag_title">Returns:</p>
2870
- <ul class="return">
2871
-
2872
- <li>
2873
-
2874
-
2875
- <span class='type'>(<tt>Boolean</tt>)</span>
2876
-
2877
-
2878
-
2879
- &mdash;
2880
- <div class='inline'>
2881
- <p>– success of the delete action</p>
2882
- </div>
2883
-
2884
- </li>
2885
-
2886
- </ul>
2887
-
2888
- </div><table class="source_code">
2889
- <tr>
2890
- <td>
2891
- <pre class="lines">
2892
-
2893
-
2894
- 323
2895
- 324
2896
- 325</pre>
2897
- </td>
2898
- <td>
2899
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 323</span>
2900
-
2901
- <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
2902
- <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span>
2903
- <span class='kw'>end</span></pre>
2904
- </td>
2905
- </tr>
2906
- </table>
2907
- </div>
2908
-
2909
- <div class="method_details ">
2910
- <h3 class="signature " id="save-instance_method">
2911
-
2912
- #<strong>save</strong> &#x21d2; <tt>MoxiWorksPlatform:Event</tt>
2913
-
2914
-
2915
-
2916
-
2917
-
2918
- </h3><div class="docstring">
2919
- <div class="discussion">
2920
-
2921
- <p>Save an instance of MoxiWorksPlatform::Event to Moxi Works Platform</p>
2922
-
2923
-
2924
- </div>
2925
- </div>
2926
- <div class="tags">
2927
-
2928
- <div class="examples">
2929
- <p class="tag_title">Examples:</p>
2930
-
2931
-
2932
- <pre class="example code"><code><span class='id identifier rubyid_event'>event</span> <span class='op'>=</span> <span class='const'>MoxiWorksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
2933
- <span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>123abcd</span><span class='tstring_end'>&#39;</span></span>
2934
- <span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_partner_event_id'>partner_event_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myUniqueEventdentifier</span><span class='tstring_end'>&#39;</span></span>
2935
- <span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_event_start'>event_start</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
2936
- <span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span></code></pre>
2937
-
2938
- </div>
2939
-
2940
- <p class="tag_title">Returns:</p>
2941
- <ul class="return">
2942
-
2943
- <li>
2944
-
2945
-
2946
- <span class='type'>(<tt>MoxiWorksPlatform:Event</tt>)</span>
2947
-
2948
-
2949
-
2950
- </li>
2951
-
2952
- </ul>
2953
-
2954
- </div><table class="source_code">
2955
- <tr>
2956
- <td>
2957
- <pre class="lines">
2958
-
2959
-
2960
- 311
2961
- 312
2962
- 313</pre>
2963
- </td>
2964
- <td>
2965
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/event.rb', line 311</span>
2966
-
2967
- <span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span>
2968
- <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span>
2969
- <span class='kw'>end</span></pre>
2970
- </td>
2971
- </tr>
2972
- </table>
2973
- </div>
2974
-
2975
- </div>
2976
-
2977
- </div>
2978
-
2979
- <div id="footer">
2980
- Generated on Fri Apr 20 10:00:17 2018 by
2981
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2982
- 0.9.5 (ruby-2.2.4).
2983
- </div>
2984
-
2985
- </div>
2986
- </body>
2987
- </html>