moxiworks_platform 0.13.15 → 0.13.16

Sign up to get free protection for your applications and to get access to all the features.
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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c31fb1a62dbe7e48ab61f876736b1246cc04eee9b262efedbf74478997e4ca38
4
- data.tar.gz: 12e46af0acff351b09169b091effdb2e9a215a6c208b5d87bc273ddae327ab42
3
+ metadata.gz: b97fc625bc374b530535eec6ff3b73cc38480d5137385171f4c5e82f92fb337a
4
+ data.tar.gz: 918f76995404760062c2eff11355564725e850668656a6f45c03059f74c7cbfe
5
5
  SHA512:
6
- metadata.gz: 1e70e382d7e1c041a16e53c17fde27f02389d3df779d4e76d4411e396f8849da34803e0b42481162ec355723d40546d155687776f84d712fedf083cd45bdf8b9
7
- data.tar.gz: 6ce31f8538d61fbbe2f9aec9d4a599de5adfd6b036b3c76e19d2a80e601fc0e6ddbdf4480229f004f7945f2dd6ce7c2fbfac02d76cc7f8673e2e51dddc9801c9
6
+ metadata.gz: 548c457566c3c28f93a64414c1d81f156c0a4d7fe74f0e5814d9b60f9874af7e11b851184f9943236a889d8bd273833f82ed807e192183c22ee59b389a2914ec
7
+ data.tar.gz: 73dd2772d17d0afc46a8d40a9d9361830042f4916b5dbb092c45835fc79a631eb685a92fa3b6399d527f7b56ffd4972274ae2fc1051466397814a3c2ee0b7cee
data/.gitignore CHANGED
@@ -8,4 +8,6 @@
8
8
  /spec/reports/
9
9
  /tmp/
10
10
  /old/
11
- .idea
11
+ /.idea/
12
+ .DS_Store
13
+
data/Gemfile CHANGED
@@ -3,6 +3,8 @@ source 'https://rubygems.org'
3
3
  # Specify your gem's dependencies in moxiworks_platform.gemspec
4
4
  gemspec
5
5
 
6
+ #gem 'moxiworks_platform'
7
+
6
8
  group :test do
7
9
  gem 'vcr', '~> 2.9.3'
8
10
  gem 'webmock'
@@ -1,18 +1,36 @@
1
1
  module MoxiworksPlatform
2
2
  class ActionLog < MoxiworksPlatform::Resource
3
+ # @!attribute agent_uuid
4
+ # agent_uuid is the Moxi Works Platform ID of the agent which an ActionLog entry is
5
+ # or is to be associated with. This will be an RFC 4122 compliant UUID.
6
+ #
7
+ # this or moxi_works_agent_id must be set for any Moxi Works Platform transaction
8
+ #
9
+ # @return [String] the Moxi Works Platform ID of the agent
10
+ attr_accessor :agent_uuid
11
+
3
12
  # @!attribute moxi_works_agent_id
4
13
  # moxi_works_agent_id is the Moxi Works Platform ID of the agent which an ActionLog entry is
5
14
  # or is to be associated with.
6
15
  #
7
- # this must be set for any Moxi Works Platform transaction
16
+ # this or agent_uuid must be set for any Moxi Works Platform transaction
8
17
  #
9
18
  # @return [String] the Moxi Works Platform ID of the agent
10
19
  attr_accessor :moxi_works_agent_id
11
20
 
21
+ # @!attribute moxi_works_contact_id
22
+ # This is the Moxi Works Platform ID of this Contact that this ActionLog entry is about.
23
+ # This will be an RFC 4122 compliant UUID
24
+ #
25
+ # this or partner_contact_id must be set for any Moxi Works Platform transaction
26
+ #
27
+ # @return [String] your system's unique ID for the contact
28
+ attr_accessor :moxi_works_contact_id
29
+
12
30
  # @!attribute partner_contact_id
13
31
  # *your system's* unique ID for the Contact
14
32
  #
15
- # this must be set for any Moxi Works Platform transaction
33
+ # this or moxi_works_contact_id must be set for any Moxi Works Platform transaction
16
34
  #
17
35
  # @return [String] your system's unique ID for the contact
18
36
  attr_accessor :partner_contact_id
@@ -29,6 +47,17 @@ module MoxiworksPlatform
29
47
  # @return [String]
30
48
  attr_accessor :body
31
49
 
50
+ # @!attribute actions
51
+ #
52
+ # @return [Array] array containing any ActionLog entries found by search request
53
+ # {
54
+ # moxi_works_action_log_id: [String] unique identifier for the Moxi Works Platform ActionLog entry,
55
+ # type: [String] the type of ActionLog entry this is. The string should be formatted in lowercase with an underscore between each word,
56
+ # timestamp: [Integer] Unix timestamp for the creation time of the ActionLog entry,
57
+ # log_data: [Dictionary] the payload data of the ActionLog entry. The structure returned is dependent on the kind of ActionLog entry this is
58
+ # }
59
+ attr_accessor :actions
60
+
32
61
  # Creates a new ActionLog entry in Moxi Works Platform
33
62
  # @param [Hash] opts named parameter Hash
34
63
  # @option opts [String] :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this ActionLog entry is to be associated
@@ -20,9 +20,6 @@ module MoxiworksPlatform
20
20
  # @return [Array] the partner data associated with this company
21
21
  attr_accessor :partners
22
22
 
23
-
24
-
25
-
26
23
  # Find a Company by ID in Moxi Works Platform
27
24
  # @param [Hash] opts named parameter Hash
28
25
  # @option opts [String] :moxi_works_company_id *REQUIRED* The Moxi Works Company ID
@@ -515,7 +515,8 @@ module MoxiworksPlatform
515
515
 
516
516
  # Search an Agent's Contacts in Moxi Works Platform
517
517
  # @param [Hash] opts named parameter Hash
518
- # @option opts [String] :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is associated
518
+ # @option opts [String] :moxi_works_agent_id *REQUIRED* -- either :moxi_works_agent_id or :agent_uuid is required -- The Moxi Works Agent ID for the agent
519
+ # @option opts [String] :agent_uuid *REQUIRED* -- either :moxi_works_agent_id or :agent_uuid is required -- The Moxi Works Agent ID for the agent
519
520
  #
520
521
  # optional Search parameters
521
522
  #
@@ -537,11 +538,9 @@ module MoxiworksPlatform
537
538
  #
538
539
  def self.search(opts={})
539
540
  url ||= "#{MoxiworksPlatform::Config.url}/api/contacts"
540
- required_opts = [:moxi_works_agent_id]
541
- required_opts.each do |opt|
542
- raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
543
- opts[opt].nil? or opts[opt].to_s.empty?
544
- end
541
+ agent_identifier = opts[:moxi_works_agent_id] || opts[:agent_uuid]
542
+ raise ::MoxiworksPlatform::Exception::ArgumentError, "#agent_uuid or moxi_works_agent_id required" if
543
+ agent_identifier.blank?
545
544
  results = MoxiResponseArray.new()
546
545
  RestClient::Request.execute(method: :get,
547
546
  url: url,
@@ -67,6 +67,11 @@ module MoxiworksPlatform
67
67
  # @return [String] city of property address
68
68
  attr_accessor :city
69
69
 
70
+ # @!attribute company_listing_attributes
71
+ #
72
+ # @return [String] the community the property is located in.
73
+ attr_accessor :community
74
+
70
75
  # @!attribute company_listing_attributes
71
76
  #
72
77
  # @return [Array] company specific attributes
@@ -152,6 +157,11 @@ module MoxiworksPlatform
152
157
  # @return [String] MLS the listing is listed with
153
158
  attr_accessor :list_office_aor
154
159
 
160
+ # @!attribute list_office_aor
161
+ #
162
+ # @return [String] MLS area the listing is listed with
163
+ attr_accessor :list_office_aor_area
164
+
155
165
  # @!attribute listing_contract_date
156
166
  #
157
167
  # @return [String] string representing date in format 'MM/DD/YYYY'
@@ -323,7 +333,7 @@ module MoxiworksPlatform
323
333
  # @!attribute title
324
334
  #
325
335
  # @return [String] Title of the listing
326
- attr_accessor :title
336
+ attr_accessor :public_title
327
337
 
328
338
 
329
339
  # Find a listing on the Moxi Works Platform
@@ -1,3 +1,3 @@
1
1
  module MoxiworksPlatform
2
- VERSION = '0.13.15'
2
+ VERSION = '0.13.16'
3
3
  end
@@ -2,8 +2,12 @@
2
2
 
3
3
  mv doc /tmp/doc/
4
4
 
5
+ git fetch upstream
6
+
5
7
  git checkout master
6
8
 
9
+ git merge upstream/master
10
+
7
11
  git commit -a -m "Documentation Update"
8
12
 
9
13
  yard doc
@@ -20,11 +24,12 @@ done
20
24
 
21
25
  cd -
22
26
  git add MoxiworksPlatform
27
+ git add *.html
23
28
 
24
29
  git commit -a -m "Documentation Update"
25
30
 
26
- git push origin gh-pages
27
- git push upstream gh-pages
31
+ git push origin gh-pages --force
32
+ git push upstream gh-pages --force
28
33
 
29
34
  git checkout master
30
35
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: moxiworks_platform
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.15
4
+ version: 0.13.16
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tres Wong-Godfrey
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-10-11 00:00:00.000000000 Z
11
+ date: 2019-05-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rest-client
@@ -78,32 +78,6 @@ files:
78
78
  - ".rspec"
79
79
  - ".travis.yml"
80
80
  - Gemfile
81
- - MoxiworksPlatform/ActionLog.html
82
- - MoxiworksPlatform/Agent.html
83
- - MoxiworksPlatform/Brand.html
84
- - MoxiworksPlatform/BuyerTransaction.html
85
- - MoxiworksPlatform/Company.html
86
- - MoxiworksPlatform/Config.html
87
- - MoxiworksPlatform/Contact.html
88
- - MoxiworksPlatform/Credentials.html
89
- - MoxiworksPlatform/EmailCampaign.html
90
- - MoxiworksPlatform/Event.html
91
- - MoxiworksPlatform/Exception.html
92
- - MoxiworksPlatform/Exception/ArgumentError.html
93
- - MoxiworksPlatform/Exception/AuthorizationError.html
94
- - MoxiworksPlatform/Exception/PlatformError.html
95
- - MoxiworksPlatform/Exception/RemoteRequestFailure.html
96
- - MoxiworksPlatform/Gallery.html
97
- - MoxiworksPlatform/Group.html
98
- - MoxiworksPlatform/Listing.html
99
- - MoxiworksPlatform/Office.html
100
- - MoxiworksPlatform/PresentationLog.html
101
- - MoxiworksPlatform/Resource.html
102
- - MoxiworksPlatform/SellerTransaction.html
103
- - MoxiworksPlatform/Session.html
104
- - MoxiworksPlatform/SoldListing.html
105
- - MoxiworksPlatform/Task.html
106
- - MoxiworksPlatform/Team.html
107
81
  - README.md
108
82
  - Rakefile
109
83
  - bin/console
@@ -1,1155 +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::ActionLog
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::ActionLog";
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 (A)</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">ActionLog</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::ActionLog
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::ActionLog</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/action_log.rb</dd>
102
- </dl>
103
-
104
- </div>
105
-
106
-
107
-
108
-
109
-
110
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
111
- <ul class="summary">
112
-
113
- <li class="public ">
114
- <span class="summary_signature">
115
-
116
- <a href="#body-instance_method" title="#body (instance method)">#<strong>body</strong> &#x21d2; String </a>
117
-
118
-
119
-
120
- </span>
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
- <span class="summary_desc"><div class='inline'>
134
- <p>the body of the log entry to be displayed for this ActionLog Entry.</p>
135
- </div></span>
136
-
137
- </li>
138
-
139
-
140
- <li class="public ">
141
- <span class="summary_signature">
142
-
143
- <a href="#moxi_works_agent_id-instance_method" title="#moxi_works_agent_id (instance method)">#<strong>moxi_works_agent_id</strong> &#x21d2; String </a>
144
-
145
-
146
-
147
- </span>
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <span class="summary_desc"><div class='inline'>
161
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which an
162
- ActionLog entry is or is to be associated with.</p>
163
- </div></span>
164
-
165
- </li>
166
-
167
-
168
- <li class="public ">
169
- <span class="summary_signature">
170
-
171
- <a href="#partner_contact_id-instance_method" title="#partner_contact_id (instance method)">#<strong>partner_contact_id</strong> &#x21d2; String </a>
172
-
173
-
174
-
175
- </span>
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
- <span class="summary_desc"><div class='inline'>
189
- <p>*your system&#39;s* unique ID for the Contact.</p>
190
- </div></span>
191
-
192
- </li>
193
-
194
-
195
- <li class="public ">
196
- <span class="summary_signature">
197
-
198
- <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; String </a>
199
-
200
-
201
-
202
- </span>
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
- <span class="summary_desc"><div class='inline'>
216
- <p>the title to be displayed for this ActionLog Entry.</p>
217
- </div></span>
218
-
219
- </li>
220
-
221
-
222
- </ul>
223
-
224
-
225
-
226
-
227
-
228
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
229
- <p class="inherited"><span class='object_link'><a href="Resource.html#headers-instance_method" title="MoxiworksPlatform::Resource#headers (method)">#headers</a></span></p>
230
-
231
-
232
-
233
- <h2>
234
- Class Method Summary
235
- <small><a href="#" class="summary_toggle">collapse</a></small>
236
- </h2>
237
-
238
- <ul class="summary">
239
-
240
- <li class="public ">
241
- <span class="summary_signature">
242
-
243
- <a href="#create-class_method" title="create (class method)">.<strong>create</strong>(opts = {}) &#x21d2; MoxiworksPlatform::ActionLog </a>
244
-
245
-
246
-
247
- </span>
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
- <span class="summary_desc"><div class='inline'>
258
- <p>Creates a new ActionLog entry in Moxi Works Platform.</p>
259
- </div></span>
260
-
261
- </li>
262
-
263
-
264
- <li class="public ">
265
- <span class="summary_signature">
266
-
267
- <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(opts = {}) &#x21d2; Array </a>
268
-
269
-
270
-
271
- </span>
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
- <span class="summary_desc"><div class='inline'>
282
- <p>Search an Agent&#39;s ActionLog entries in Moxi Works Platform.</p>
283
- </div></span>
284
-
285
- </li>
286
-
287
-
288
- <li class="public ">
289
- <span class="summary_signature">
290
-
291
- <a href="#send_request-class_method" title="send_request (class method)">.<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; MoxiworksPlatform::ActionLog </a>
292
-
293
-
294
-
295
- </span>
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
- <span class="summary_desc"><div class='inline'>
306
- <p>Send our remote request to the Moxi Works Platform.</p>
307
- </div></span>
308
-
309
- </li>
310
-
311
-
312
- </ul>
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="MoxiworksPlatform::Resource (class)">Resource</a></span></h3>
325
- <p class="inherited"><span class='object_link'><a href="Resource.html#accept_header-class_method" title="MoxiworksPlatform::Resource.accept_header (method)">accept_header</a></span>, <span class='object_link'><a href="Resource.html#attr_accessor-class_method" title="MoxiworksPlatform::Resource.attr_accessor (method)">attr_accessor</a></span>, <span class='object_link'><a href="Resource.html#attributes-class_method" title="MoxiworksPlatform::Resource.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Resource.html#attributes-instance_method" title="MoxiworksPlatform::Resource#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Resource.html#auth_header-class_method" title="MoxiworksPlatform::Resource.auth_header (method)">auth_header</a></span>, <span class='object_link'><a href="Resource.html#check_for_error_in_response-class_method" title="MoxiworksPlatform::Resource.check_for_error_in_response (method)">check_for_error_in_response</a></span>, <span class='object_link'><a href="Resource.html#content_type_header-class_method" title="MoxiworksPlatform::Resource.content_type_header (method)">content_type_header</a></span>, <span class='object_link'><a href="Resource.html#float_attrs-instance_method" title="MoxiworksPlatform::Resource#float_attrs (method)">#float_attrs</a></span>, <span class='object_link'><a href="Resource.html#headers-class_method" title="MoxiworksPlatform::Resource.headers (method)">headers</a></span>, <span class='object_link'><a href="Resource.html#init_attrs_from_hash-instance_method" title="MoxiworksPlatform::Resource#init_attrs_from_hash (method)">#init_attrs_from_hash</a></span>, <span class='object_link'><a href="Resource.html#initialize-instance_method" title="MoxiworksPlatform::Resource#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Resource.html#int_attrs-instance_method" title="MoxiworksPlatform::Resource#int_attrs (method)">#int_attrs</a></span>, <span class='object_link'><a href="Resource.html#method_missing-instance_method" title="MoxiworksPlatform::Resource#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Resource.html#numeric_attrs-instance_method" title="MoxiworksPlatform::Resource#numeric_attrs (method)">#numeric_attrs</a></span>, <span class='object_link'><a href="Resource.html#numeric_value_for-instance_method" title="MoxiworksPlatform::Resource#numeric_value_for (method)">#numeric_value_for</a></span>, <span class='object_link'><a href="Resource.html#to_hash-instance_method" title="MoxiworksPlatform::Resource#to_hash (method)">#to_hash</a></span>, <span class='object_link'><a href="Resource.html#underscore-class_method" title="MoxiworksPlatform::Resource.underscore (method)">underscore</a></span>, <span class='object_link'><a href="Resource.html#underscore_array-class_method" title="MoxiworksPlatform::Resource.underscore_array (method)">underscore_array</a></span>, <span class='object_link'><a href="Resource.html#underscore_attribute_names-class_method" title="MoxiworksPlatform::Resource.underscore_attribute_names (method)">underscore_attribute_names</a></span>, <span class='object_link'><a href="Resource.html#underscore_hash-class_method" title="MoxiworksPlatform::Resource.underscore_hash (method)">underscore_hash</a></span>, <span class='object_link'><a href="Resource.html#user_agent_header-class_method" title="MoxiworksPlatform::Resource.user_agent_header (method)">user_agent_header</a></span></p>
326
- <div id="constructor_details" class="method_details_list">
327
- <h2>Constructor Details</h2>
328
-
329
- <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>
330
-
331
- </div>
332
- <div id="method_missing_details" class="method_details_list">
333
- <h2>Dynamic Method Handling</h2>
334
- <p class="notice super">
335
- This class handles dynamic methods through the <tt>method_missing</tt> method
336
-
337
- 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>
338
-
339
- </p>
340
-
341
- </div>
342
-
343
- <div id="instance_attr_details" class="attr_details">
344
- <h2>Instance Attribute Details</h2>
345
-
346
-
347
- <span id="body=-instance_method"></span>
348
- <div class="method_details first">
349
- <h3 class="signature first" id="body-instance_method">
350
-
351
- #<strong>body</strong> &#x21d2; <tt>String</tt>
352
-
353
-
354
-
355
-
356
-
357
- </h3><div class="docstring">
358
- <div class="discussion">
359
-
360
- <p>the body of the log entry to be displayed for this ActionLog Entry</p>
361
-
362
-
363
- </div>
364
- </div>
365
- <div class="tags">
366
-
367
- <p class="tag_title">Returns:</p>
368
- <ul class="return">
369
-
370
- <li>
371
-
372
-
373
- <span class='type'>(<tt>String</tt>)</span>
374
-
375
-
376
-
377
- </li>
378
-
379
- </ul>
380
-
381
- </div><table class="source_code">
382
- <tr>
383
- <td>
384
- <pre class="lines">
385
-
386
-
387
- 30
388
- 31
389
- 32</pre>
390
- </td>
391
- <td>
392
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 30</span>
393
-
394
- <span class='kw'>def</span> <span class='id identifier rubyid_body'>body</span>
395
- <span class='ivar'>@body</span>
396
- <span class='kw'>end</span></pre>
397
- </td>
398
- </tr>
399
- </table>
400
- </div>
401
-
402
-
403
- <span id="moxi_works_agent_id=-instance_method"></span>
404
- <div class="method_details ">
405
- <h3 class="signature " id="moxi_works_agent_id-instance_method">
406
-
407
- #<strong>moxi_works_agent_id</strong> &#x21d2; <tt>String</tt>
408
-
409
-
410
-
411
-
412
-
413
- </h3><div class="docstring">
414
- <div class="discussion">
415
-
416
- <p>moxi_works_agent_id is the Moxi Works Platform ID of the agent which an
417
- ActionLog entry is or is to be associated with.</p>
418
-
419
- <p>this must be set for any Moxi Works Platform transaction</p>
420
-
421
-
422
- </div>
423
- </div>
424
- <div class="tags">
425
-
426
- <p class="tag_title">Returns:</p>
427
- <ul class="return">
428
-
429
- <li>
430
-
431
-
432
- <span class='type'>(<tt>String</tt>)</span>
433
-
434
-
435
-
436
- &mdash;
437
- <div class='inline'>
438
- <p>the Moxi Works Platform ID of the agent</p>
439
- </div>
440
-
441
- </li>
442
-
443
- </ul>
444
-
445
- </div><table class="source_code">
446
- <tr>
447
- <td>
448
- <pre class="lines">
449
-
450
-
451
- 10
452
- 11
453
- 12</pre>
454
- </td>
455
- <td>
456
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 10</span>
457
-
458
- <span class='kw'>def</span> <span class='id identifier rubyid_moxi_works_agent_id'>moxi_works_agent_id</span>
459
- <span class='ivar'>@moxi_works_agent_id</span>
460
- <span class='kw'>end</span></pre>
461
- </td>
462
- </tr>
463
- </table>
464
- </div>
465
-
466
-
467
- <span id="partner_contact_id=-instance_method"></span>
468
- <div class="method_details ">
469
- <h3 class="signature " id="partner_contact_id-instance_method">
470
-
471
- #<strong>partner_contact_id</strong> &#x21d2; <tt>String</tt>
472
-
473
-
474
-
475
-
476
-
477
- </h3><div class="docstring">
478
- <div class="discussion">
479
-
480
- <p>*your system&#39;s* unique ID for the Contact</p>
481
-
482
- <p>this must be set for any Moxi Works Platform transaction</p>
483
-
484
-
485
- </div>
486
- </div>
487
- <div class="tags">
488
-
489
- <p class="tag_title">Returns:</p>
490
- <ul class="return">
491
-
492
- <li>
493
-
494
-
495
- <span class='type'>(<tt>String</tt>)</span>
496
-
497
-
498
-
499
- &mdash;
500
- <div class='inline'>
501
- <p>your system&#39;s unique ID for the contact</p>
502
- </div>
503
-
504
- </li>
505
-
506
- </ul>
507
-
508
- </div><table class="source_code">
509
- <tr>
510
- <td>
511
- <pre class="lines">
512
-
513
-
514
- 18
515
- 19
516
- 20</pre>
517
- </td>
518
- <td>
519
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 18</span>
520
-
521
- <span class='kw'>def</span> <span class='id identifier rubyid_partner_contact_id'>partner_contact_id</span>
522
- <span class='ivar'>@partner_contact_id</span>
523
- <span class='kw'>end</span></pre>
524
- </td>
525
- </tr>
526
- </table>
527
- </div>
528
-
529
-
530
- <span id="title=-instance_method"></span>
531
- <div class="method_details ">
532
- <h3 class="signature " id="title-instance_method">
533
-
534
- #<strong>title</strong> &#x21d2; <tt>String</tt>
535
-
536
-
537
-
538
-
539
-
540
- </h3><div class="docstring">
541
- <div class="discussion">
542
-
543
- <p>the title to be displayed for this ActionLog Entry</p>
544
-
545
-
546
- </div>
547
- </div>
548
- <div class="tags">
549
-
550
- <p class="tag_title">Returns:</p>
551
- <ul class="return">
552
-
553
- <li>
554
-
555
-
556
- <span class='type'>(<tt>String</tt>)</span>
557
-
558
-
559
-
560
- </li>
561
-
562
- </ul>
563
-
564
- </div><table class="source_code">
565
- <tr>
566
- <td>
567
- <pre class="lines">
568
-
569
-
570
- 24
571
- 25
572
- 26</pre>
573
- </td>
574
- <td>
575
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 24</span>
576
-
577
- <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
578
- <span class='ivar'>@title</span>
579
- <span class='kw'>end</span></pre>
580
- </td>
581
- </tr>
582
- </table>
583
- </div>
584
-
585
- </div>
586
-
587
-
588
- <div id="class_method_details" class="method_details_list">
589
- <h2>Class Method Details</h2>
590
-
591
-
592
- <div class="method_details first">
593
- <h3 class="signature first" id="create-class_method">
594
-
595
- .<strong>create</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::ActionLog (class)">MoxiworksPlatform::ActionLog</a></span></tt>
596
-
597
-
598
-
599
-
600
-
601
- </h3><div class="docstring">
602
- <div class="discussion">
603
-
604
- <p>Creates a new ActionLog entry in Moxi Works Platform</p>
605
-
606
-
607
- </div>
608
- </div>
609
- <div class="tags">
610
-
611
- <div class="examples">
612
- <p class="tag_title">Examples:</p>
613
-
614
-
615
- <pre class="example code"><code><span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>ActionLog</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
616
- <span class='label'>moxi_works_agent_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc123</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
617
- <span class='label'>partner_contact_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mySystemsUniqueContactID</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
618
- <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New home keys were delivered to Firstname Lastname</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
619
- <span class='label'>body:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Firstname Lastname were delivered their keys to1234 there ave</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
620
- <span class='rparen'>)</span></code></pre>
621
-
622
- </div>
623
- <p class="tag_title">Parameters:</p>
624
- <ul class="param">
625
-
626
- <li>
627
-
628
- <span class='name'>opts</span>
629
-
630
-
631
- <span class='type'>(<tt>Hash</tt>)</span>
632
-
633
-
634
- <em class="default">(defaults to: <tt>{}</tt>)</em>
635
-
636
-
637
- &mdash;
638
- <div class='inline'>
639
- <p>named parameter Hash</p>
640
- </div>
641
-
642
- </li>
643
-
644
- </ul>
645
-
646
-
647
-
648
-
649
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
650
- <ul class="option">
651
-
652
- <li>
653
- <span class="name">:moxi_works_agent_id</span>
654
- <span class="type">(<tt>String</tt>)</span>
655
- <span class="default">
656
-
657
- </span>
658
-
659
- &mdash; <div class='inline'>
660
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
661
- this ActionLog entry is to be associated</p>
662
- </div>
663
-
664
- </li>
665
-
666
- <li>
667
- <span class="name">:partner_contact_id</span>
668
- <span class="type">(<tt>String</tt>)</span>
669
- <span class="default">
670
-
671
- </span>
672
-
673
- &mdash; <div class='inline'>
674
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for the contact for
675
- whom the ActionLog entry is being created.</p>
676
- </div>
677
-
678
- </li>
679
-
680
- <li>
681
- <span class="name">:title</span>
682
- <span class="type">(<tt>String</tt>)</span>
683
- <span class="default">
684
-
685
- </span>
686
-
687
- &mdash; <div class='inline'>
688
- <p><strong>REQUIRED</strong> A brief title for this ActionLog entry (85
689
- characters or less)</p>
690
- </div>
691
-
692
- </li>
693
-
694
- <li>
695
- <span class="name">:body</span>
696
- <span class="type">(<tt>String</tt>)</span>
697
- <span class="default">
698
-
699
- </span>
700
-
701
- &mdash; <div class='inline'>
702
- <p><strong>REQUIRED</strong> The body of this ActionLog entry (255 characters
703
- or less)</p>
704
- </div>
705
-
706
- </li>
707
-
708
- </ul>
709
-
710
-
711
- <p class="tag_title">Returns:</p>
712
- <ul class="return">
713
-
714
- <li>
715
-
716
-
717
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::ActionLog (class)">MoxiworksPlatform::ActionLog</a></span></tt>)</span>
718
-
719
-
720
-
721
- </li>
722
-
723
- </ul>
724
- <p class="tag_title">Raises:</p>
725
- <ul class="raise">
726
-
727
- <li>
728
-
729
-
730
- <span class='type'></span>
731
-
732
-
733
-
734
-
735
- <div class='inline'>
736
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
737
- aren&#39;t included</p>
738
- </div>
739
-
740
- </li>
741
-
742
- </ul>
743
-
744
- </div><table class="source_code">
745
- <tr>
746
- <td>
747
- <pre class="lines">
748
-
749
-
750
- 52
751
- 53
752
- 54</pre>
753
- </td>
754
- <td>
755
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 52</span>
756
-
757
- <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>
758
- <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>
759
- <span class='kw'>end</span></pre>
760
- </td>
761
- </tr>
762
- </table>
763
- </div>
764
-
765
- <div class="method_details ">
766
- <h3 class="signature " id="search-class_method">
767
-
768
- .<strong>search</strong>(opts = {}) &#x21d2; <tt>Array</tt>
769
-
770
-
771
-
772
-
773
-
774
- </h3><div class="docstring">
775
- <div class="discussion">
776
-
777
- <p>Search an Agent&#39;s ActionLog entries in Moxi Works Platform</p>
778
-
779
-
780
- </div>
781
- </div>
782
- <div class="tags">
783
-
784
- <div class="examples">
785
- <p class="tag_title">Examples:</p>
786
-
787
-
788
- <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'>ActionLog</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
789
- <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>
790
- <span class='rparen'>)</span></code></pre>
791
-
792
- </div>
793
- <p class="tag_title">Parameters:</p>
794
- <ul class="param">
795
-
796
- <li>
797
-
798
- <span class='name'>opts</span>
799
-
800
-
801
- <span class='type'>(<tt>Hash</tt>)</span>
802
-
803
-
804
- <em class="default">(defaults to: <tt>{}</tt>)</em>
805
-
806
-
807
- &mdash;
808
- <div class='inline'>
809
- <p>named parameter Hash</p>
810
- </div>
811
-
812
- </li>
813
-
814
- </ul>
815
-
816
-
817
-
818
-
819
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
820
- <ul class="option">
821
-
822
- <li>
823
- <span class="name">:moxi_works_agent_id</span>
824
- <span class="type">(<tt>String</tt>)</span>
825
- <span class="default">
826
-
827
- </span>
828
-
829
- &mdash; <div class='inline'>
830
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
831
- this ActionLog is associated</p>
832
- </div>
833
-
834
- </li>
835
-
836
- <li>
837
- <span class="name">:partner_contact_id</span>
838
- <span class="type">(<tt>String</tt>)</span>
839
- <span class="default">
840
-
841
- </span>
842
-
843
- &mdash; <div class='inline'>
844
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for the contact for
845
- whom the ActionLog entry is being created.</p>
846
- </div>
847
-
848
- </li>
849
-
850
- </ul>
851
-
852
-
853
- <p class="tag_title">Returns:</p>
854
- <ul class="return">
855
-
856
- <li>
857
-
858
-
859
- <span class='type'>(<tt>Array</tt>)</span>
860
-
861
-
862
-
863
- &mdash;
864
- <div class='inline'>
865
- <p>containing MoxiworksPlatform::ActionLog objects</p>
866
- </div>
867
-
868
- </li>
869
-
870
- </ul>
871
- <p class="tag_title">Raises:</p>
872
- <ul class="raise">
873
-
874
- <li>
875
-
876
-
877
- <span class='type'></span>
878
-
879
-
880
-
881
-
882
- <div class='inline'>
883
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
884
- aren&#39;t included</p>
885
- </div>
886
-
887
- </li>
888
-
889
- </ul>
890
-
891
- </div><table class="source_code">
892
- <tr>
893
- <td>
894
- <pre class="lines">
895
-
896
-
897
- 71
898
- 72
899
- 73
900
- 74
901
- 75
902
- 76
903
- 77
904
- 78
905
- 79
906
- 80
907
- 81
908
- 82
909
- 83
910
- 84
911
- 85
912
- 86
913
- 87
914
- 88
915
- 89
916
- 90
917
- 91
918
- 92
919
- 93</pre>
920
- </td>
921
- <td>
922
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 71</span>
923
-
924
- <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>
925
- <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>
926
- <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>
927
- <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/action_logs</span><span class='tstring_end'>&quot;</span></span>
928
- <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_contact_id</span><span class='rbracket'>]</span>
929
- <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>
930
- <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>
931
- <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>
932
- <span class='kw'>end</span>
933
- <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>
934
- <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>
935
- <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
936
- <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>
937
- <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>
938
- <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>
939
- <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>
940
- <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>
941
- <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'>actions</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</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>
942
- <span class='id identifier rubyid_results'>results</span> <span class='op'>&lt;&lt;</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>ActionLog</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>
943
- <span class='kw'>end</span>
944
- <span class='kw'>end</span>
945
- <span class='id identifier rubyid_results'>results</span>
946
- <span class='kw'>end</span></pre>
947
- </td>
948
- </tr>
949
- </table>
950
- </div>
951
-
952
- <div class="method_details ">
953
- <h3 class="signature " id="send_request-class_method">
954
-
955
- .<strong>send_request</strong>(method, opts = {}, url = nil) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::ActionLog (class)">MoxiworksPlatform::ActionLog</a></span></tt>
956
-
957
-
958
-
959
-
960
-
961
- </h3><div class="docstring">
962
- <div class="discussion">
963
-
964
- <p>Send our remote request to the Moxi Works Platform</p>
965
-
966
-
967
- </div>
968
- </div>
969
- <div class="tags">
970
- <p class="tag_title">Parameters:</p>
971
- <ul class="param">
972
-
973
- <li>
974
-
975
- <span class='name'>method</span>
976
-
977
-
978
- <span class='type'>(<tt>String</tt>)</span>
979
-
980
-
981
-
982
- &mdash;
983
- <div class='inline'>
984
- <p>The HTTP method to be used when connecting; ex: :put, :post, :get</p>
985
- </div>
986
-
987
- </li>
988
-
989
- <li>
990
-
991
- <span class='name'>opts</span>
992
-
993
-
994
- <span class='type'>(<tt>Hash</tt>)</span>
995
-
996
-
997
- <em class="default">(defaults to: <tt>{}</tt>)</em>
998
-
999
-
1000
- </li>
1001
-
1002
- </ul>
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1010
- <ul class="option">
1011
-
1012
- <li>
1013
- <span class="name">:moxi_works_agent_id</span>
1014
- <span class="type">(<tt>String</tt>)</span>
1015
- <span class="default">
1016
-
1017
- </span>
1018
-
1019
- &mdash; <div class='inline'>
1020
- <p><strong>REQUIRED</strong> The Moxi Works Agent ID for the agent to which
1021
- this ActionLog entry is associated</p>
1022
- </div>
1023
-
1024
- </li>
1025
-
1026
- <li>
1027
- <span class="name">:partner_contact_id</span>
1028
- <span class="type">(<tt>String</tt>)</span>
1029
- <span class="default">
1030
-
1031
- </span>
1032
-
1033
- &mdash; <div class='inline'>
1034
- <p><strong>REQUIRED</strong> Your system&#39;s unique ID for the contact for
1035
- whom the ActionLog entry is being created.</p>
1036
- </div>
1037
-
1038
- </li>
1039
-
1040
- <li>
1041
- <span class="name">:title</span>
1042
- <span class="type">(<tt>String</tt>)</span>
1043
- <span class="default">
1044
-
1045
- </span>
1046
-
1047
- &mdash; <div class='inline'>
1048
- <p><strong>REQUIRED</strong> A brief title for this ActionLog entry (85
1049
- characters or less)</p>
1050
- </div>
1051
-
1052
- </li>
1053
-
1054
- <li>
1055
- <span class="name">:body</span>
1056
- <span class="type">(<tt>String</tt>)</span>
1057
- <span class="default">
1058
-
1059
- </span>
1060
-
1061
- &mdash; <div class='inline'>
1062
- <p><strong>REQUIRED</strong> The body of this ActionLog entry (255 characters
1063
- or less)</p>
1064
- </div>
1065
-
1066
- </li>
1067
-
1068
- </ul>
1069
-
1070
-
1071
-
1072
-
1073
- <p class="tag_title">Returns:</p>
1074
- <ul class="return">
1075
-
1076
- <li>
1077
-
1078
-
1079
- <span class='type'>(<tt><span class='object_link'><a href="" title="MoxiworksPlatform::ActionLog (class)">MoxiworksPlatform::ActionLog</a></span></tt>)</span>
1080
-
1081
-
1082
-
1083
- </li>
1084
-
1085
- </ul>
1086
- <p class="tag_title">Raises:</p>
1087
- <ul class="raise">
1088
-
1089
- <li>
1090
-
1091
-
1092
- <span class='type'></span>
1093
-
1094
-
1095
-
1096
-
1097
- <div class='inline'>
1098
- <p>::MoxiworksPlatform::Exception::ArgumentError if required named parameters
1099
- aren&#39;t included</p>
1100
- </div>
1101
-
1102
- </li>
1103
-
1104
- </ul>
1105
-
1106
- </div><table class="source_code">
1107
- <tr>
1108
- <td>
1109
- <pre class="lines">
1110
-
1111
-
1112
- 110
1113
- 111
1114
- 112
1115
- 113
1116
- 114
1117
- 115
1118
- 116
1119
- 117
1120
- 118
1121
- 119
1122
- 120</pre>
1123
- </td>
1124
- <td>
1125
- <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/action_log.rb', line 110</span>
1126
-
1127
- <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>
1128
- <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>
1129
- <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>
1130
- <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/action_logs</span><span class='tstring_end'>&quot;</span></span>
1131
- <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_contact_id</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='comma'>,</span> <span class='symbol'>:body</span><span class='rbracket'>]</span>
1132
- <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>
1133
- <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>
1134
- <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>
1135
- <span class='kw'>end</span>
1136
- <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>
1137
- <span class='kw'>end</span></pre>
1138
- </td>
1139
- </tr>
1140
- </table>
1141
- </div>
1142
-
1143
- </div>
1144
-
1145
- </div>
1146
-
1147
- <div id="footer">
1148
- Generated on Fri Apr 20 10:00:19 2018 by
1149
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1150
- 0.9.5 (ruby-2.2.4).
1151
- </div>
1152
-
1153
- </div>
1154
- </body>
1155
- </html>