strawberry_api 0.1.0

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 (157) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +9 -0
  3. data/.rubocop.yml +4 -0
  4. data/CODE_OF_CONDUCT.md +74 -0
  5. data/Gemfile +3 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +135 -0
  8. data/Rakefile +2 -0
  9. data/bin/console +14 -0
  10. data/bin/setup +8 -0
  11. data/doc/HTTParty/Response.html +148 -0
  12. data/doc/StrawberryAPI/AccessRight.html +431 -0
  13. data/doc/StrawberryAPI/ApiKey.html +637 -0
  14. data/doc/StrawberryAPI/ArchiveStrategy.html +365 -0
  15. data/doc/StrawberryAPI/ArchiveStrategyState.html +1057 -0
  16. data/doc/StrawberryAPI/Asset.html +1791 -0
  17. data/doc/StrawberryAPI/AssetCopyToStrategy.html +145 -0
  18. data/doc/StrawberryAPI/AssetFeedback.html +370 -0
  19. data/doc/StrawberryAPI/Client/ApiKeys.html +904 -0
  20. data/doc/StrawberryAPI/Client/ArchiveStrategies.html +784 -0
  21. data/doc/StrawberryAPI/Client/AssetCopyToStrategies.html +805 -0
  22. data/doc/StrawberryAPI/Client/AssetFeedbacks.html +232 -0
  23. data/doc/StrawberryAPI/Client/Assets.html +888 -0
  24. data/doc/StrawberryAPI/Client/Collections.html +319 -0
  25. data/doc/StrawberryAPI/Client/CopyToFeedbacks.html +232 -0
  26. data/doc/StrawberryAPI/Client/CustomMetadata.html +210 -0
  27. data/doc/StrawberryAPI/Client/CustomMetadataFields.html +214 -0
  28. data/doc/StrawberryAPI/Client/CustomMetadataOptions.html +214 -0
  29. data/doc/StrawberryAPI/Client/CustomMetadataSets.html +214 -0
  30. data/doc/StrawberryAPI/Client/Edits.html +485 -0
  31. data/doc/StrawberryAPI/Client/Features.html +319 -0
  32. data/doc/StrawberryAPI/Client/Libraries.html +321 -0
  33. data/doc/StrawberryAPI/Client/Markers.html +234 -0
  34. data/doc/StrawberryAPI/Client/ProjectCopyToStrategies.html +857 -0
  35. data/doc/StrawberryAPI/Client/ProjectFeedbacks.html +232 -0
  36. data/doc/StrawberryAPI/Client/Projects.html +2764 -0
  37. data/doc/StrawberryAPI/Client/Roles.html +214 -0
  38. data/doc/StrawberryAPI/Client/Schedules.html +319 -0
  39. data/doc/StrawberryAPI/Client/Searches.html +293 -0
  40. data/doc/StrawberryAPI/Client/Sessions.html +376 -0
  41. data/doc/StrawberryAPI/Client/Settings.html +210 -0
  42. data/doc/StrawberryAPI/Client/StatusFlags.html +315 -0
  43. data/doc/StrawberryAPI/Client/Teams.html +1067 -0
  44. data/doc/StrawberryAPI/Client/Templates.html +319 -0
  45. data/doc/StrawberryAPI/Client/Users.html +1255 -0
  46. data/doc/StrawberryAPI/Client.html +487 -0
  47. data/doc/StrawberryAPI/Collection.html +427 -0
  48. data/doc/StrawberryAPI/Configuration.html +481 -0
  49. data/doc/StrawberryAPI/CopyToFeedback.html +220 -0
  50. data/doc/StrawberryAPI/CustomMetadataField.html +999 -0
  51. data/doc/StrawberryAPI/CustomMetadataOption.html +567 -0
  52. data/doc/StrawberryAPI/CustomMetadataSet.html +649 -0
  53. data/doc/StrawberryAPI/CustomMetadatum.html +718 -0
  54. data/doc/StrawberryAPI/Edit.html +637 -0
  55. data/doc/StrawberryAPI/Feature.html +567 -0
  56. data/doc/StrawberryAPI/Feedback.html +641 -0
  57. data/doc/StrawberryAPI/HttpClient.html +971 -0
  58. data/doc/StrawberryAPI/Library.html +637 -0
  59. data/doc/StrawberryAPI/Marker.html +847 -0
  60. data/doc/StrawberryAPI/Project.html +2395 -0
  61. data/doc/StrawberryAPI/ProjectCopyToStrategy.html +365 -0
  62. data/doc/StrawberryAPI/ProjectFeedback.html +370 -0
  63. data/doc/StrawberryAPI/Proxy.html +1267 -0
  64. data/doc/StrawberryAPI/Role.html +567 -0
  65. data/doc/StrawberryAPI/Schedule.html +2387 -0
  66. data/doc/StrawberryAPI/Session.html +121 -0
  67. data/doc/StrawberryAPI/Setting.html +207 -0
  68. data/doc/StrawberryAPI/StatusFlag.html +207 -0
  69. data/doc/StrawberryAPI/Strategy.html +641 -0
  70. data/doc/StrawberryAPI/Team.html +789 -0
  71. data/doc/StrawberryAPI/Template.html +707 -0
  72. data/doc/StrawberryAPI/User.html +999 -0
  73. data/doc/StrawberryAPI.html +483 -0
  74. data/doc/_index.html +632 -0
  75. data/doc/class_list.html +51 -0
  76. data/doc/css/common.css +1 -0
  77. data/doc/css/full_list.css +58 -0
  78. data/doc/css/style.css +496 -0
  79. data/doc/file.README.html +222 -0
  80. data/doc/file_list.html +56 -0
  81. data/doc/frames.html +17 -0
  82. data/doc/index.html +222 -0
  83. data/doc/js/app.js +292 -0
  84. data/doc/js/full_list.js +216 -0
  85. data/doc/js/jquery.js +4 -0
  86. data/doc/method_list.html +3059 -0
  87. data/doc/top-level-namespace.html +110 -0
  88. data/lib/strawberry_api/access_right.rb +18 -0
  89. data/lib/strawberry_api/api_key.rb +19 -0
  90. data/lib/strawberry_api/asset.rb +51 -0
  91. data/lib/strawberry_api/client/api_keys.rb +49 -0
  92. data/lib/strawberry_api/client/archive_strategies.rb +87 -0
  93. data/lib/strawberry_api/client/asset_copy_to_strategies.rb +83 -0
  94. data/lib/strawberry_api/client/asset_feedbacks.rb +18 -0
  95. data/lib/strawberry_api/client/assets.rb +92 -0
  96. data/lib/strawberry_api/client/collections.rb +29 -0
  97. data/lib/strawberry_api/client/copy_to_feedbacks.rb +18 -0
  98. data/lib/strawberry_api/client/custom_metadata.rb +16 -0
  99. data/lib/strawberry_api/client/custom_metadata_fields.rb +18 -0
  100. data/lib/strawberry_api/client/custom_metadata_options.rb +18 -0
  101. data/lib/strawberry_api/client/custom_metadata_sets.rb +18 -0
  102. data/lib/strawberry_api/client/edits.rb +47 -0
  103. data/lib/strawberry_api/client/features.rb +29 -0
  104. data/lib/strawberry_api/client/libraries.rb +30 -0
  105. data/lib/strawberry_api/client/markers.rb +19 -0
  106. data/lib/strawberry_api/client/project_copy_to_strategies.rb +88 -0
  107. data/lib/strawberry_api/client/project_feedbacks.rb +18 -0
  108. data/lib/strawberry_api/client/projects.rb +305 -0
  109. data/lib/strawberry_api/client/roles.rb +18 -0
  110. data/lib/strawberry_api/client/schedules.rb +29 -0
  111. data/lib/strawberry_api/client/searches.rb +25 -0
  112. data/lib/strawberry_api/client/sessions.rb +33 -0
  113. data/lib/strawberry_api/client/settings.rb +16 -0
  114. data/lib/strawberry_api/client/status_flags.rb +27 -0
  115. data/lib/strawberry_api/client/teams.rb +107 -0
  116. data/lib/strawberry_api/client/templates.rb +29 -0
  117. data/lib/strawberry_api/client/users.rb +125 -0
  118. data/lib/strawberry_api/client.rb +95 -0
  119. data/lib/strawberry_api/collection.rb +16 -0
  120. data/lib/strawberry_api/configuration.rb +19 -0
  121. data/lib/strawberry_api/custom_metadata/custom_metadata_field.rb +30 -0
  122. data/lib/strawberry_api/custom_metadata/custom_metadata_option.rb +18 -0
  123. data/lib/strawberry_api/custom_metadata/custom_metadata_set.rb +25 -0
  124. data/lib/strawberry_api/custom_metadatum.rb +30 -0
  125. data/lib/strawberry_api/edit.rb +19 -0
  126. data/lib/strawberry_api/feature.rb +18 -0
  127. data/lib/strawberry_api/feedback/asset_feedback.rb +15 -0
  128. data/lib/strawberry_api/feedback/copy_to_feedback.rb +12 -0
  129. data/lib/strawberry_api/feedback/project_feedback.rb +15 -0
  130. data/lib/strawberry_api/feedback.rb +19 -0
  131. data/lib/strawberry_api/http_client.rb +135 -0
  132. data/lib/strawberry_api/library.rb +19 -0
  133. data/lib/strawberry_api/marker.rb +22 -0
  134. data/lib/strawberry_api/project.rb +48 -0
  135. data/lib/strawberry_api/proxy.rb +28 -0
  136. data/lib/strawberry_api/role.rb +18 -0
  137. data/lib/strawberry_api/schedule.rb +44 -0
  138. data/lib/strawberry_api/session.rb +7 -0
  139. data/lib/strawberry_api/setting.rb +12 -0
  140. data/lib/strawberry_api/status_flag.rb +12 -0
  141. data/lib/strawberry_api/strategy/archive_strategy.rb +10 -0
  142. data/lib/strawberry_api/strategy/archive_strategy_state.rb +25 -0
  143. data/lib/strawberry_api/strategy/asset_copy_to_strategy.rb +6 -0
  144. data/lib/strawberry_api/strategy/project_copy_to_strategy.rb +9 -0
  145. data/lib/strawberry_api/strategy.rb +19 -0
  146. data/lib/strawberry_api/team.rb +27 -0
  147. data/lib/strawberry_api/template.rb +20 -0
  148. data/lib/strawberry_api/user.rb +30 -0
  149. data/lib/strawberry_api/version.rb +3 -0
  150. data/lib/strawberry_api.rb +36 -0
  151. data/samples/README.md +14 -0
  152. data/samples/list_assets_links.rb +15 -0
  153. data/samples/list_projects.rb +14 -0
  154. data/samples/login.rb +18 -0
  155. data/samples/test.rb +12 -0
  156. data/strawberry_api.gemspec +40 -0
  157. metadata +242 -0
data/doc/StrawberryAPI/Client/Users.html ADDED
@@ -0,0 +1,1255 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: StrawberryAPI::Client::Users
8
+
9
+ &mdash; Documentation by YARD 0.9.16
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 = "StrawberryAPI::Client::Users";
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?1"></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 (U)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../StrawberryAPI.html" title="StrawberryAPI (module)">StrawberryAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Client.html" title="StrawberryAPI::Client (class)">Client</a></span></span>
41
+ &raquo;
42
+ <span class="title">Users</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
+ <div id="content"><h1>Module: StrawberryAPI::Client::Users
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../Client.html" title="StrawberryAPI::Client (class)">StrawberryAPI::Client</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/strawberry_api/client/users.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small><a href="#" class="summary_toggle">collapse</a></small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#add_team_to_user-instance_method" title="#add_team_to_user (instance method)">#<strong>add_team_to_user</strong>(user_id:, team_id:) &#x21d2; Boolean </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Adds a team to a user.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#create_user-instance_method" title="#create_user (instance method)">#<strong>create_user</strong>(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil) &#x21d2; StrawberryAPI::User </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Creates a new user.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#destroy_user-instance_method" title="#destroy_user (instance method)">#<strong>destroy_user</strong>(id:) &#x21d2; Boolean </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Deletes a user.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#remove_team_from_user-instance_method" title="#remove_team_from_user (instance method)">#<strong>remove_team_from_user</strong>(user_id:, team_id:) &#x21d2; Boolean </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Removes a team from a user.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#update_user-instance_method" title="#update_user (instance method)">#<strong>update_user</strong>(id:, **options) &#x21d2; StrawberryAPI::User </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>Updates a user.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#user-instance_method" title="#user (instance method)">#<strong>user</strong>(id:) &#x21d2; Array&lt;StrawberryAPI::User&gt; </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ <span class="summary_desc"><div class='inline'>
244
+ <p>Fetches all users.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#user_api_keys-instance_method" title="#user_api_keys (instance method)">#<strong>user_api_keys</strong>(id:) &#x21d2; StrawberryAPI::ApiKey </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Fetches a user API keys.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#user_settings-instance_method" title="#user_settings (instance method)">#<strong>user_settings</strong>(id:) &#x21d2; Hash </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'>
292
+ <p>Fetches a user settings.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ <li class="public ">
299
+ <span class="summary_signature">
300
+
301
+ <a href="#users-instance_method" title="#users (instance method)">#<strong>users</strong> &#x21d2; Array&lt;StrawberryAPI::User&gt; </a>
302
+
303
+
304
+
305
+ </span>
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+ <span class="summary_desc"><div class='inline'>
316
+ <p>Fetches all users.</p>
317
+ </div></span>
318
+
319
+ </li>
320
+
321
+
322
+ </ul>
323
+
324
+
325
+
326
+
327
+ <div id="instance_method_details" class="method_details_list">
328
+ <h2>Instance Method Details</h2>
329
+
330
+
331
+ <div class="method_details first">
332
+ <h3 class="signature first" id="add_team_to_user-instance_method">
333
+
334
+ #<strong>add_team_to_user</strong>(user_id:, team_id:) &#x21d2; <tt>Boolean</tt>
335
+
336
+
337
+
338
+
339
+
340
+ </h3><div class="docstring">
341
+ <div class="discussion">
342
+
343
+ <p>Adds a team to a user</p>
344
+
345
+
346
+ </div>
347
+ </div>
348
+ <div class="tags">
349
+ <p class="tag_title">Parameters:</p>
350
+ <ul class="param">
351
+
352
+ <li>
353
+
354
+ <span class='name'>user_id</span>
355
+
356
+
357
+ <span class='type'>(<tt>Integer</tt>)</span>
358
+
359
+
360
+
361
+ &mdash;
362
+ <div class='inline'>
363
+ <p>Id of the user the team should be added to</p>
364
+ </div>
365
+
366
+ </li>
367
+
368
+ <li>
369
+
370
+ <span class='name'>team_id</span>
371
+
372
+
373
+ <span class='type'>(<tt>Integer</tt>)</span>
374
+
375
+
376
+
377
+ &mdash;
378
+ <div class='inline'>
379
+ <p>Id of the team to add the user to</p>
380
+ </div>
381
+
382
+ </li>
383
+
384
+ </ul>
385
+
386
+ <p class="tag_title">Returns:</p>
387
+ <ul class="return">
388
+
389
+ <li>
390
+
391
+
392
+ <span class='type'>(<tt>Boolean</tt>)</span>
393
+
394
+
395
+
396
+ &mdash;
397
+ <div class='inline'>
398
+ <p>Success</p>
399
+ </div>
400
+
401
+ </li>
402
+
403
+ </ul>
404
+
405
+ </div><table class="source_code">
406
+ <tr>
407
+ <td>
408
+ <pre class="lines">
409
+
410
+
411
+ 88
412
+ 89
413
+ 90</pre>
414
+ </td>
415
+ <td>
416
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 88</span>
417
+
418
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_team_to_user'>add_team_to_user</span><span class='lparen'>(</span><span class='label'>user_id:</span><span class='comma'>,</span> <span class='label'>team_id:</span><span class='rparen'>)</span>
419
+ <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_team_id'>team_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
420
+ <span class='kw'>end</span></pre>
421
+ </td>
422
+ </tr>
423
+ </table>
424
+ </div>
425
+
426
+ <div class="method_details ">
427
+ <h3 class="signature " id="create_user-instance_method">
428
+
429
+ #<strong>create_user</strong>(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil) &#x21d2; <tt><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span></tt>
430
+
431
+
432
+
433
+
434
+
435
+ </h3><div class="docstring">
436
+ <div class="discussion">
437
+
438
+ <p>Creates a new user</p>
439
+
440
+
441
+ </div>
442
+ </div>
443
+ <div class="tags">
444
+ <p class="tag_title">Parameters:</p>
445
+ <ul class="param">
446
+
447
+ <li>
448
+
449
+ <span class='name'>username</span>
450
+
451
+
452
+ <span class='type'>(<tt>String</tt>)</span>
453
+
454
+
455
+
456
+ &mdash;
457
+ <div class='inline'>
458
+ <p>Username of the user to create</p>
459
+ </div>
460
+
461
+ </li>
462
+
463
+ <li>
464
+
465
+ <span class='name'>firstname</span>
466
+
467
+
468
+ <span class='type'>(<tt>String</tt>)</span>
469
+
470
+
471
+
472
+ &mdash;
473
+ <div class='inline'>
474
+ <p>nil Firstname of the user to create</p>
475
+ </div>
476
+
477
+ </li>
478
+
479
+ <li>
480
+
481
+ <span class='name'>lastname</span>
482
+
483
+
484
+ <span class='type'>(<tt>String</tt>)</span>
485
+
486
+
487
+
488
+ &mdash;
489
+ <div class='inline'>
490
+ <p>nil Lastname of the user to create</p>
491
+ </div>
492
+
493
+ </li>
494
+
495
+ <li>
496
+
497
+ <span class='name'>password</span>
498
+
499
+
500
+ <span class='type'>(<tt>String</tt>)</span>
501
+
502
+
503
+
504
+ &mdash;
505
+ <div class='inline'>
506
+ <p>Password of the user to create</p>
507
+ </div>
508
+
509
+ </li>
510
+
511
+ <li>
512
+
513
+ <span class='name'>role_id</span>
514
+
515
+
516
+ <span class='type'>(<tt>Integer</tt>)</span>
517
+
518
+
519
+
520
+ &mdash;
521
+ <div class='inline'>
522
+ <p>Id of the role to assign the the user to</p>
523
+ </div>
524
+
525
+ </li>
526
+
527
+ <li>
528
+
529
+ <span class='name'>[String]</span>
530
+
531
+
532
+ <span class='type'>(<tt>Hash</tt>)</span>
533
+
534
+
535
+
536
+ &mdash;
537
+ <div class='inline'>
538
+ <p>a customizable set of options</p>
539
+ </div>
540
+
541
+ </li>
542
+
543
+ </ul>
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+ <p class="tag_title">Returns:</p>
560
+ <ul class="return">
561
+
562
+ <li>
563
+
564
+
565
+ <span class='type'>(<tt><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span></tt>)</span>
566
+
567
+
568
+
569
+ &mdash;
570
+ <div class='inline'>
571
+ <p>The created user</p>
572
+ </div>
573
+
574
+ </li>
575
+
576
+ </ul>
577
+
578
+ </div><table class="source_code">
579
+ <tr>
580
+ <td>
581
+ <pre class="lines">
582
+
583
+
584
+ 37
585
+ 38
586
+ 39
587
+ 40
588
+ 41
589
+ 42
590
+ 43
591
+ 44
592
+ 45
593
+ 46
594
+ 47
595
+ 48
596
+ 49
597
+ 50</pre>
598
+ </td>
599
+ <td>
600
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 37</span>
601
+
602
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='label'>username:</span><span class='comma'>,</span> <span class='label'>firstname:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>lastname:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>password:</span><span class='comma'>,</span> <span class='label'>role_id:</span><span class='comma'>,</span> <span class='label'>user_matrix_attributes:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
603
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
604
+ <span class='label'>username:</span> <span class='id identifier rubyid_username'>username</span><span class='comma'>,</span>
605
+ <span class='label'>firstname:</span> <span class='id identifier rubyid_firstname'>firstname</span><span class='comma'>,</span>
606
+ <span class='label'>lastname:</span> <span class='id identifier rubyid_lastname'>lastname</span><span class='comma'>,</span>
607
+ <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
608
+ <span class='label'>password_confirmation:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
609
+ <span class='label'>role_id:</span> <span class='id identifier rubyid_role_id'>role_id</span><span class='comma'>,</span>
610
+ <span class='label'>user_matrix_attributes:</span> <span class='id identifier rubyid_user_matrix_attributes'>user_matrix_attributes</span>
611
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
612
+
613
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
614
+ <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../User.html#initialize-instance_method" title="StrawberryAPI::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
615
+ <span class='kw'>end</span></pre>
616
+ </td>
617
+ </tr>
618
+ </table>
619
+ </div>
620
+
621
+ <div class="method_details ">
622
+ <h3 class="signature " id="destroy_user-instance_method">
623
+
624
+ #<strong>destroy_user</strong>(id:) &#x21d2; <tt>Boolean</tt>
625
+
626
+
627
+
628
+
629
+
630
+ </h3><div class="docstring">
631
+ <div class="discussion">
632
+
633
+ <p>Deletes a user</p>
634
+
635
+
636
+ </div>
637
+ </div>
638
+ <div class="tags">
639
+ <p class="tag_title">Parameters:</p>
640
+ <ul class="param">
641
+
642
+ <li>
643
+
644
+ <span class='name'>id</span>
645
+
646
+
647
+ <span class='type'>(<tt>Integer</tt>)</span>
648
+
649
+
650
+
651
+ &mdash;
652
+ <div class='inline'>
653
+ <p>Id of the user to delete</p>
654
+ </div>
655
+
656
+ </li>
657
+
658
+ </ul>
659
+
660
+ <p class="tag_title">Returns:</p>
661
+ <ul class="return">
662
+
663
+ <li>
664
+
665
+
666
+ <span class='type'>(<tt>Boolean</tt>)</span>
667
+
668
+
669
+
670
+ &mdash;
671
+ <div class='inline'>
672
+ <p>Success</p>
673
+ </div>
674
+
675
+ </li>
676
+
677
+ </ul>
678
+
679
+ </div><table class="source_code">
680
+ <tr>
681
+ <td>
682
+ <pre class="lines">
683
+
684
+
685
+ 77
686
+ 78
687
+ 79</pre>
688
+ </td>
689
+ <td>
690
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 77</span>
691
+
692
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy_user'>destroy_user</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
693
+ <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
694
+ <span class='kw'>end</span></pre>
695
+ </td>
696
+ </tr>
697
+ </table>
698
+ </div>
699
+
700
+ <div class="method_details ">
701
+ <h3 class="signature " id="remove_team_from_user-instance_method">
702
+
703
+ #<strong>remove_team_from_user</strong>(user_id:, team_id:) &#x21d2; <tt>Boolean</tt>
704
+
705
+
706
+
707
+
708
+
709
+ </h3><div class="docstring">
710
+ <div class="discussion">
711
+
712
+ <p>Removes a team from a user</p>
713
+
714
+
715
+ </div>
716
+ </div>
717
+ <div class="tags">
718
+ <p class="tag_title">Parameters:</p>
719
+ <ul class="param">
720
+
721
+ <li>
722
+
723
+ <span class='name'>user_id</span>
724
+
725
+
726
+ <span class='type'>(<tt>Integer</tt>)</span>
727
+
728
+
729
+
730
+ &mdash;
731
+ <div class='inline'>
732
+ <p>Id of the user to remove the team from</p>
733
+ </div>
734
+
735
+ </li>
736
+
737
+ <li>
738
+
739
+ <span class='name'>team_id</span>
740
+
741
+
742
+ <span class='type'>(<tt>Integer</tt>)</span>
743
+
744
+
745
+
746
+ &mdash;
747
+ <div class='inline'>
748
+ <p>Id of the team the user should be removed from</p>
749
+ </div>
750
+
751
+ </li>
752
+
753
+ </ul>
754
+
755
+ <p class="tag_title">Returns:</p>
756
+ <ul class="return">
757
+
758
+ <li>
759
+
760
+
761
+ <span class='type'>(<tt>Boolean</tt>)</span>
762
+
763
+
764
+
765
+ &mdash;
766
+ <div class='inline'>
767
+ <p>Success</p>
768
+ </div>
769
+
770
+ </li>
771
+
772
+ </ul>
773
+
774
+ </div><table class="source_code">
775
+ <tr>
776
+ <td>
777
+ <pre class="lines">
778
+
779
+
780
+ 99
781
+ 100
782
+ 101</pre>
783
+ </td>
784
+ <td>
785
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 99</span>
786
+
787
+ <span class='kw'>def</span> <span class='id identifier rubyid_remove_team_from_user'>remove_team_from_user</span><span class='lparen'>(</span><span class='label'>user_id:</span><span class='comma'>,</span> <span class='label'>team_id:</span><span class='rparen'>)</span>
788
+ <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_team_id'>team_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
789
+ <span class='kw'>end</span></pre>
790
+ </td>
791
+ </tr>
792
+ </table>
793
+ </div>
794
+
795
+ <div class="method_details ">
796
+ <h3 class="signature " id="update_user-instance_method">
797
+
798
+ #<strong>update_user</strong>(id:, **options) &#x21d2; <tt><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span></tt>
799
+
800
+
801
+
802
+
803
+
804
+ </h3><div class="docstring">
805
+ <div class="discussion">
806
+
807
+ <p>Updates a user</p>
808
+
809
+
810
+ </div>
811
+ </div>
812
+ <div class="tags">
813
+ <p class="tag_title">Parameters:</p>
814
+ <ul class="param">
815
+
816
+ <li>
817
+
818
+ <span class='name'>id</span>
819
+
820
+
821
+ <span class='type'>(<tt>Integer</tt>)</span>
822
+
823
+
824
+
825
+ &mdash;
826
+ <div class='inline'>
827
+ <p>Id of the user to update</p>
828
+ </div>
829
+
830
+ </li>
831
+
832
+ <li>
833
+
834
+ <span class='name'>options</span>
835
+
836
+
837
+ <span class='type'>(<tt>Hash</tt>)</span>
838
+
839
+
840
+
841
+ &mdash;
842
+ <div class='inline'>
843
+ <p>a customizable set of options</p>
844
+ </div>
845
+
846
+ </li>
847
+
848
+ </ul>
849
+
850
+
851
+
852
+
853
+
854
+
855
+ <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
856
+ <ul class="option">
857
+
858
+ <li>
859
+ <span class="name">:username</span>
860
+ <span class="type">(<tt>String</tt>)</span>
861
+ <span class="default">
862
+
863
+ </span>
864
+
865
+ </li>
866
+
867
+ <li>
868
+ <span class="name">:firstname</span>
869
+ <span class="type">(<tt>String</tt>)</span>
870
+ <span class="default">
871
+
872
+ </span>
873
+
874
+ </li>
875
+
876
+ <li>
877
+ <span class="name">:lastname</span>
878
+ <span class="type">(<tt>String</tt>)</span>
879
+ <span class="default">
880
+
881
+ </span>
882
+
883
+ </li>
884
+
885
+ <li>
886
+ <span class="name">:password</span>
887
+ <span class="type">(<tt>String</tt>)</span>
888
+ <span class="default">
889
+
890
+ </span>
891
+
892
+ </li>
893
+
894
+ <li>
895
+ <span class="name">:role_id</span>
896
+ <span class="type">(<tt>String</tt>)</span>
897
+ <span class="default">
898
+
899
+ </span>
900
+
901
+ </li>
902
+
903
+ <li>
904
+ <span class="name">:user_matrix_attributes</span>
905
+ <span class="type">(<tt>String</tt>)</span>
906
+ <span class="default">
907
+
908
+ </span>
909
+
910
+ </li>
911
+
912
+ </ul>
913
+
914
+
915
+ <p class="tag_title">Returns:</p>
916
+ <ul class="return">
917
+
918
+ <li>
919
+
920
+
921
+ <span class='type'>(<tt><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span></tt>)</span>
922
+
923
+
924
+
925
+ &mdash;
926
+ <div class='inline'>
927
+ <p>The updated user</p>
928
+ </div>
929
+
930
+ </li>
931
+
932
+ </ul>
933
+
934
+ </div><table class="source_code">
935
+ <tr>
936
+ <td>
937
+ <pre class="lines">
938
+
939
+
940
+ 64
941
+ 65
942
+ 66
943
+ 67
944
+ 68
945
+ 69</pre>
946
+ </td>
947
+ <td>
948
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 64</span>
949
+
950
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_user'>update_user</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
951
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
952
+
953
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span>
954
+ <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../User.html#initialize-instance_method" title="StrawberryAPI::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
955
+ <span class='kw'>end</span></pre>
956
+ </td>
957
+ </tr>
958
+ </table>
959
+ </div>
960
+
961
+ <div class="method_details ">
962
+ <h3 class="signature " id="user-instance_method">
963
+
964
+ #<strong>user</strong>(id:) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span>&gt;</tt>
965
+
966
+
967
+
968
+
969
+
970
+ </h3><div class="docstring">
971
+ <div class="discussion">
972
+
973
+ <p>Fetches all users</p>
974
+
975
+
976
+ </div>
977
+ </div>
978
+ <div class="tags">
979
+
980
+ <p class="tag_title">Returns:</p>
981
+ <ul class="return">
982
+
983
+ <li>
984
+
985
+
986
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span>&gt;</tt>)</span>
987
+
988
+
989
+
990
+ &mdash;
991
+ <div class='inline'>
992
+ <p>A list of users</p>
993
+ </div>
994
+
995
+ </li>
996
+
997
+ </ul>
998
+
999
+ </div><table class="source_code">
1000
+ <tr>
1001
+ <td>
1002
+ <pre class="lines">
1003
+
1004
+
1005
+ 21
1006
+ 22
1007
+ 23
1008
+ 24</pre>
1009
+ </td>
1010
+ <td>
1011
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 21</span>
1012
+
1013
+ <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
1014
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>?with_teams=true</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1015
+ <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../User.html#initialize-instance_method" title="StrawberryAPI::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1016
+ <span class='kw'>end</span></pre>
1017
+ </td>
1018
+ </tr>
1019
+ </table>
1020
+ </div>
1021
+
1022
+ <div class="method_details ">
1023
+ <h3 class="signature " id="user_api_keys-instance_method">
1024
+
1025
+ #<strong>user_api_keys</strong>(id:) &#x21d2; <tt><span class='object_link'><a href="../ApiKey.html" title="StrawberryAPI::ApiKey (class)">StrawberryAPI::ApiKey</a></span></tt>
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+ </h3><div class="docstring">
1032
+ <div class="discussion">
1033
+
1034
+ <p>Fetches a user API keys</p>
1035
+
1036
+
1037
+ </div>
1038
+ </div>
1039
+ <div class="tags">
1040
+ <p class="tag_title">Parameters:</p>
1041
+ <ul class="param">
1042
+
1043
+ <li>
1044
+
1045
+ <span class='name'>id</span>
1046
+
1047
+
1048
+ <span class='type'>(<tt>Integer</tt>)</span>
1049
+
1050
+
1051
+
1052
+ &mdash;
1053
+ <div class='inline'>
1054
+ <p>Id of the user to retrieve API keys</p>
1055
+ </div>
1056
+
1057
+ </li>
1058
+
1059
+ </ul>
1060
+
1061
+ <p class="tag_title">Returns:</p>
1062
+ <ul class="return">
1063
+
1064
+ <li>
1065
+
1066
+
1067
+ <span class='type'>(<tt><span class='object_link'><a href="../ApiKey.html" title="StrawberryAPI::ApiKey (class)">StrawberryAPI::ApiKey</a></span></tt>)</span>
1068
+
1069
+
1070
+
1071
+ &mdash;
1072
+ <div class='inline'>
1073
+ <p>The fetched user API key</p>
1074
+ </div>
1075
+
1076
+ </li>
1077
+
1078
+ </ul>
1079
+
1080
+ </div><table class="source_code">
1081
+ <tr>
1082
+ <td>
1083
+ <pre class="lines">
1084
+
1085
+
1086
+ 119
1087
+ 120
1088
+ 121</pre>
1089
+ </td>
1090
+ <td>
1091
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 119</span>
1092
+
1093
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_api_keys'>user_api_keys</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
1094
+ <span class='const'><span class='object_link'><a href="../ApiKey.html" title="StrawberryAPI::ApiKey (class)">ApiKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>user_id:</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1095
+ <span class='kw'>end</span></pre>
1096
+ </td>
1097
+ </tr>
1098
+ </table>
1099
+ </div>
1100
+
1101
+ <div class="method_details ">
1102
+ <h3 class="signature " id="user_settings-instance_method">
1103
+
1104
+ #<strong>user_settings</strong>(id:) &#x21d2; <tt>Hash</tt>
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+ </h3><div class="docstring">
1111
+ <div class="discussion">
1112
+
1113
+ <p>Fetches a user settings</p>
1114
+
1115
+
1116
+ </div>
1117
+ </div>
1118
+ <div class="tags">
1119
+ <p class="tag_title">Parameters:</p>
1120
+ <ul class="param">
1121
+
1122
+ <li>
1123
+
1124
+ <span class='name'>id</span>
1125
+
1126
+
1127
+ <span class='type'>(<tt>Integer</tt>)</span>
1128
+
1129
+
1130
+
1131
+ &mdash;
1132
+ <div class='inline'>
1133
+ <p>Id of the user to retrieve settings</p>
1134
+ </div>
1135
+
1136
+ </li>
1137
+
1138
+ </ul>
1139
+
1140
+ <p class="tag_title">Returns:</p>
1141
+ <ul class="return">
1142
+
1143
+ <li>
1144
+
1145
+
1146
+ <span class='type'>(<tt>Hash</tt>)</span>
1147
+
1148
+
1149
+
1150
+ &mdash;
1151
+ <div class='inline'>
1152
+ <p>The fetched user settings</p>
1153
+ </div>
1154
+
1155
+ </li>
1156
+
1157
+ </ul>
1158
+
1159
+ </div><table class="source_code">
1160
+ <tr>
1161
+ <td>
1162
+ <pre class="lines">
1163
+
1164
+
1165
+ 109
1166
+ 110
1167
+ 111</pre>
1168
+ </td>
1169
+ <td>
1170
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 109</span>
1171
+
1172
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_settings'>user_settings</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
1173
+ <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/settings</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user_settings</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1174
+ <span class='kw'>end</span></pre>
1175
+ </td>
1176
+ </tr>
1177
+ </table>
1178
+ </div>
1179
+
1180
+ <div class="method_details ">
1181
+ <h3 class="signature " id="users-instance_method">
1182
+
1183
+ #<strong>users</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span>&gt;</tt>
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+ </h3><div class="docstring">
1190
+ <div class="discussion">
1191
+
1192
+ <p>Fetches all users</p>
1193
+
1194
+
1195
+ </div>
1196
+ </div>
1197
+ <div class="tags">
1198
+
1199
+ <p class="tag_title">Returns:</p>
1200
+ <ul class="return">
1201
+
1202
+ <li>
1203
+
1204
+
1205
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">StrawberryAPI::User</a></span>&gt;</tt>)</span>
1206
+
1207
+
1208
+
1209
+ &mdash;
1210
+ <div class='inline'>
1211
+ <p>A list of users</p>
1212
+ </div>
1213
+
1214
+ </li>
1215
+
1216
+ </ul>
1217
+
1218
+ </div><table class="source_code">
1219
+ <tr>
1220
+ <td>
1221
+ <pre class="lines">
1222
+
1223
+
1224
+ 10
1225
+ 11
1226
+ 12
1227
+ 13
1228
+ 14</pre>
1229
+ </td>
1230
+ <td>
1231
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/users.rb', line 10</span>
1232
+
1233
+ <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span>
1234
+ <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/users</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='op'>&amp;.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_user'>user</span><span class='op'>|</span>
1235
+ <span class='const'><span class='object_link'><a href="../User.html" title="StrawberryAPI::User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../User.html#initialize-instance_method" title="StrawberryAPI::User#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
1236
+ <span class='kw'>end</span>
1237
+ <span class='kw'>end</span></pre>
1238
+ </td>
1239
+ </tr>
1240
+ </table>
1241
+ </div>
1242
+
1243
+ </div>
1244
+
1245
+ </div>
1246
+
1247
+ <div id="footer">
1248
+ Generated on Thu Aug 30 12:51:39 2018 by
1249
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1250
+ 0.9.16 (ruby-2.5.0).
1251
+ </div>
1252
+
1253
+ </div>
1254
+ </body>
1255
+ </html>