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/Teams.html ADDED
@@ -0,0 +1,1067 @@
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::Teams
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::Teams";
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 (T)</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">Teams</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::Teams
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/teams.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_user_to_team-instance_method" title="#add_user_to_team (instance method)">#<strong>add_user_to_team</strong>(team_id:, user_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 user to a team.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#create_team-instance_method" title="#create_team (instance method)">#<strong>create_team</strong>(name:, quota: nil, quota_mail_sent: false) &#x21d2; StrawberryAPI::Team </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 team.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#destroy_team-instance_method" title="#destroy_team (instance method)">#<strong>destroy_team</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 team.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#remove_user_from_team-instance_method" title="#remove_user_from_team (instance method)">#<strong>remove_user_from_team</strong>(team_id:, user_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 user from a team.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#team-instance_method" title="#team (instance method)">#<strong>team</strong>(id:) &#x21d2; StrawberryAPI::Team </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>Fetches a team.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#teams-instance_method" title="#teams (instance method)">#<strong>teams</strong> &#x21d2; Array&lt;StrawberryAPI::Team&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 teams.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#update_team-instance_method" title="#update_team (instance method)">#<strong>update_team</strong>(id:, **options) &#x21d2; StrawberryAPI::Team </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>Updates a team.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#user_owned_teams-instance_method" title="#user_owned_teams (instance method)">#<strong>user_owned_teams</strong> &#x21d2; Array&lt;StrawberryAPI::Team&gt; </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>Featches the current user team.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ </ul>
299
+
300
+
301
+
302
+
303
+ <div id="instance_method_details" class="method_details_list">
304
+ <h2>Instance Method Details</h2>
305
+
306
+
307
+ <div class="method_details first">
308
+ <h3 class="signature first" id="add_user_to_team-instance_method">
309
+
310
+ #<strong>add_user_to_team</strong>(team_id:, user_id:) &#x21d2; <tt>Boolean</tt>
311
+
312
+
313
+
314
+
315
+
316
+ </h3><div class="docstring">
317
+ <div class="discussion">
318
+
319
+ <p>Adds a user to a team</p>
320
+
321
+
322
+ </div>
323
+ </div>
324
+ <div class="tags">
325
+ <p class="tag_title">Parameters:</p>
326
+ <ul class="param">
327
+
328
+ <li>
329
+
330
+ <span class='name'>team_id</span>
331
+
332
+
333
+ <span class='type'>(<tt>Integer</tt>)</span>
334
+
335
+
336
+
337
+ &mdash;
338
+ <div class='inline'>
339
+ <p>Id of the team the user should be added to</p>
340
+ </div>
341
+
342
+ </li>
343
+
344
+ <li>
345
+
346
+ <span class='name'>user_id</span>
347
+
348
+
349
+ <span class='type'>(<tt>Integer</tt>)</span>
350
+
351
+
352
+
353
+ &mdash;
354
+ <div class='inline'>
355
+ <p>Id of the user to add the team to</p>
356
+ </div>
357
+
358
+ </li>
359
+
360
+ </ul>
361
+
362
+ <p class="tag_title">Returns:</p>
363
+ <ul class="return">
364
+
365
+ <li>
366
+
367
+
368
+ <span class='type'>(<tt>Boolean</tt>)</span>
369
+
370
+
371
+
372
+ &mdash;
373
+ <div class='inline'>
374
+ <p>Success</p>
375
+ </div>
376
+
377
+ </li>
378
+
379
+ </ul>
380
+
381
+ </div><table class="source_code">
382
+ <tr>
383
+ <td>
384
+ <pre class="lines">
385
+
386
+
387
+ 90
388
+ 91
389
+ 92</pre>
390
+ </td>
391
+ <td>
392
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 90</span>
393
+
394
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_user_to_team'>add_user_to_team</span><span class='lparen'>(</span><span class='label'>team_id:</span><span class='comma'>,</span> <span class='label'>user_id:</span><span class='rparen'>)</span>
395
+ <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_team_id'>team_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_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>
396
+ <span class='kw'>end</span></pre>
397
+ </td>
398
+ </tr>
399
+ </table>
400
+ </div>
401
+
402
+ <div class="method_details ">
403
+ <h3 class="signature " id="create_team-instance_method">
404
+
405
+ #<strong>create_team</strong>(name:, quota: nil, quota_mail_sent: false) &#x21d2; <tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>
406
+
407
+
408
+
409
+
410
+
411
+ </h3><div class="docstring">
412
+ <div class="discussion">
413
+
414
+ <p>Creates a new team</p>
415
+
416
+
417
+ </div>
418
+ </div>
419
+ <div class="tags">
420
+ <p class="tag_title">Parameters:</p>
421
+ <ul class="param">
422
+
423
+ <li>
424
+
425
+ <span class='name'>name</span>
426
+
427
+
428
+ <span class='type'>(<tt>String</tt>)</span>
429
+
430
+
431
+
432
+ &mdash;
433
+ <div class='inline'>
434
+ <p>Name of the team to create</p>
435
+ </div>
436
+
437
+ </li>
438
+
439
+ <li>
440
+
441
+ <span class='name'>[Integer]</span>
442
+
443
+
444
+ <span class='type'>(<tt>Hash</tt>)</span>
445
+
446
+
447
+
448
+ &mdash;
449
+ <div class='inline'>
450
+ <p>a customizable set of options</p>
451
+ </div>
452
+
453
+ </li>
454
+
455
+ <li>
456
+
457
+ <span class='name'>[Boolean]</span>
458
+
459
+
460
+ <span class='type'>(<tt>Hash</tt>)</span>
461
+
462
+
463
+
464
+ &mdash;
465
+ <div class='inline'>
466
+ <p>a customizable set of options</p>
467
+ </div>
468
+
469
+ </li>
470
+
471
+ </ul>
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+ <p class="tag_title">Returns:</p>
482
+ <ul class="return">
483
+
484
+ <li>
485
+
486
+
487
+ <span class='type'>(<tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>)</span>
488
+
489
+
490
+
491
+ &mdash;
492
+ <div class='inline'>
493
+ <p>The created team</p>
494
+ </div>
495
+
496
+ </li>
497
+
498
+ </ul>
499
+
500
+ </div><table class="source_code">
501
+ <tr>
502
+ <td>
503
+ <pre class="lines">
504
+
505
+
506
+ 46
507
+ 47
508
+ 48
509
+ 49
510
+ 50
511
+ 51
512
+ 52
513
+ 53
514
+ 54
515
+ 55</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 46</span>
519
+
520
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_team'>create_team</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>quota:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>quota_mail_sent:</span> <span class='kw'>false</span><span class='rparen'>)</span>
521
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
522
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
523
+ <span class='label'>quota:</span> <span class='id identifier rubyid_quota'>quota</span><span class='comma'>,</span>
524
+ <span class='label'>quota_mail_sent:</span> <span class='id identifier rubyid_quota_mail_sent'>quota_mail_sent</span>
525
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
526
+
527
+ <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'>/teams</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'>teams</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
528
+ <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="../Team.html" title="StrawberryAPI::Team (class)">Team</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Team.html#initialize-instance_method" title="StrawberryAPI::Team#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
529
+ <span class='kw'>end</span></pre>
530
+ </td>
531
+ </tr>
532
+ </table>
533
+ </div>
534
+
535
+ <div class="method_details ">
536
+ <h3 class="signature " id="destroy_team-instance_method">
537
+
538
+ #<strong>destroy_team</strong>(id:) &#x21d2; <tt>Boolean</tt>
539
+
540
+
541
+
542
+
543
+
544
+ </h3><div class="docstring">
545
+ <div class="discussion">
546
+
547
+ <p>Deletes a team</p>
548
+
549
+
550
+ </div>
551
+ </div>
552
+ <div class="tags">
553
+ <p class="tag_title">Parameters:</p>
554
+ <ul class="param">
555
+
556
+ <li>
557
+
558
+ <span class='name'>id</span>
559
+
560
+
561
+ <span class='type'>(<tt>Integer</tt>)</span>
562
+
563
+
564
+
565
+ &mdash;
566
+ <div class='inline'>
567
+ <p>Id of the team to delete</p>
568
+ </div>
569
+
570
+ </li>
571
+
572
+ </ul>
573
+
574
+ <p class="tag_title">Returns:</p>
575
+ <ul class="return">
576
+
577
+ <li>
578
+
579
+
580
+ <span class='type'>(<tt>Boolean</tt>)</span>
581
+
582
+
583
+
584
+ &mdash;
585
+ <div class='inline'>
586
+ <p>Success</p>
587
+ </div>
588
+
589
+ </li>
590
+
591
+ </ul>
592
+
593
+ </div><table class="source_code">
594
+ <tr>
595
+ <td>
596
+ <pre class="lines">
597
+
598
+
599
+ 79
600
+ 80
601
+ 81</pre>
602
+ </td>
603
+ <td>
604
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 79</span>
605
+
606
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy_team'>destroy_team</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
607
+ <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'>/teams/</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>
608
+ <span class='kw'>end</span></pre>
609
+ </td>
610
+ </tr>
611
+ </table>
612
+ </div>
613
+
614
+ <div class="method_details ">
615
+ <h3 class="signature " id="remove_user_from_team-instance_method">
616
+
617
+ #<strong>remove_user_from_team</strong>(team_id:, user_id:) &#x21d2; <tt>Boolean</tt>
618
+
619
+
620
+
621
+
622
+
623
+ </h3><div class="docstring">
624
+ <div class="discussion">
625
+
626
+ <p>Removes a user from a team</p>
627
+
628
+
629
+ </div>
630
+ </div>
631
+ <div class="tags">
632
+ <p class="tag_title">Parameters:</p>
633
+ <ul class="param">
634
+
635
+ <li>
636
+
637
+ <span class='name'>team_id</span>
638
+
639
+
640
+ <span class='type'>(<tt>Integer</tt>)</span>
641
+
642
+
643
+
644
+ &mdash;
645
+ <div class='inline'>
646
+ <p>Id of the team the user should be removed from</p>
647
+ </div>
648
+
649
+ </li>
650
+
651
+ <li>
652
+
653
+ <span class='name'>user_id</span>
654
+
655
+
656
+ <span class='type'>(<tt>Integer</tt>)</span>
657
+
658
+
659
+
660
+ &mdash;
661
+ <div class='inline'>
662
+ <p>Id of the user to remove from the team</p>
663
+ </div>
664
+
665
+ </li>
666
+
667
+ </ul>
668
+
669
+ <p class="tag_title">Returns:</p>
670
+ <ul class="return">
671
+
672
+ <li>
673
+
674
+
675
+ <span class='type'>(<tt>Boolean</tt>)</span>
676
+
677
+
678
+
679
+ &mdash;
680
+ <div class='inline'>
681
+ <p>Success</p>
682
+ </div>
683
+
684
+ </li>
685
+
686
+ </ul>
687
+
688
+ </div><table class="source_code">
689
+ <tr>
690
+ <td>
691
+ <pre class="lines">
692
+
693
+
694
+ 101
695
+ 102
696
+ 103</pre>
697
+ </td>
698
+ <td>
699
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 101</span>
700
+
701
+ <span class='kw'>def</span> <span class='id identifier rubyid_remove_user_from_team'>remove_user_from_team</span><span class='lparen'>(</span><span class='label'>team_id:</span><span class='comma'>,</span> <span class='label'>user_id:</span><span class='rparen'>)</span>
702
+ <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_team_id'>team_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_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>
703
+ <span class='kw'>end</span></pre>
704
+ </td>
705
+ </tr>
706
+ </table>
707
+ </div>
708
+
709
+ <div class="method_details ">
710
+ <h3 class="signature " id="team-instance_method">
711
+
712
+ #<strong>team</strong>(id:) &#x21d2; <tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>
713
+
714
+
715
+
716
+
717
+
718
+ </h3><div class="docstring">
719
+ <div class="discussion">
720
+
721
+ <p>Fetches a team</p>
722
+
723
+
724
+ </div>
725
+ </div>
726
+ <div class="tags">
727
+ <p class="tag_title">Parameters:</p>
728
+ <ul class="param">
729
+
730
+ <li>
731
+
732
+ <span class='name'>id</span>
733
+
734
+
735
+ <span class='type'>(<tt>Integer</tt>)</span>
736
+
737
+
738
+
739
+ &mdash;
740
+ <div class='inline'>
741
+ <p>Id of the team to retrieve</p>
742
+ </div>
743
+
744
+ </li>
745
+
746
+ </ul>
747
+
748
+ <p class="tag_title">Returns:</p>
749
+ <ul class="return">
750
+
751
+ <li>
752
+
753
+
754
+ <span class='type'>(<tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>)</span>
755
+
756
+
757
+
758
+ &mdash;
759
+ <div class='inline'>
760
+ <p>The fetched team</p>
761
+ </div>
762
+
763
+ </li>
764
+
765
+ </ul>
766
+
767
+ </div><table class="source_code">
768
+ <tr>
769
+ <td>
770
+ <pre class="lines">
771
+
772
+
773
+ 22
774
+ 23
775
+ 24
776
+ 25</pre>
777
+ </td>
778
+ <td>
779
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 22</span>
780
+
781
+ <span class='kw'>def</span> <span class='id identifier rubyid_team'>team</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
782
+ <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'>/teams/</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_parse'>parse</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>team</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
783
+ <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="../Team.html" title="StrawberryAPI::Team (class)">Team</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Team.html#initialize-instance_method" title="StrawberryAPI::Team#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
784
+ <span class='kw'>end</span></pre>
785
+ </td>
786
+ </tr>
787
+ </table>
788
+ </div>
789
+
790
+ <div class="method_details ">
791
+ <h3 class="signature " id="teams-instance_method">
792
+
793
+ #<strong>teams</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>&gt;</tt>
794
+
795
+
796
+
797
+
798
+
799
+ </h3><div class="docstring">
800
+ <div class="discussion">
801
+
802
+ <p>Fetches all teams</p>
803
+
804
+
805
+ </div>
806
+ </div>
807
+ <div class="tags">
808
+
809
+ <p class="tag_title">Returns:</p>
810
+ <ul class="return">
811
+
812
+ <li>
813
+
814
+
815
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>&gt;</tt>)</span>
816
+
817
+
818
+
819
+ &mdash;
820
+ <div class='inline'>
821
+ <p>A list of teams</p>
822
+ </div>
823
+
824
+ </li>
825
+
826
+ </ul>
827
+
828
+ </div><table class="source_code">
829
+ <tr>
830
+ <td>
831
+ <pre class="lines">
832
+
833
+
834
+ 10
835
+ 11
836
+ 12
837
+ 13
838
+ 14</pre>
839
+ </td>
840
+ <td>
841
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 10</span>
842
+
843
+ <span class='kw'>def</span> <span class='id identifier rubyid_teams'>teams</span>
844
+ <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'>/teams</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'>teams</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_team'>team</span><span class='op'>|</span>
845
+ <span class='const'><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">Team</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Team.html#initialize-instance_method" title="StrawberryAPI::Team#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_team'>team</span><span class='rparen'>)</span>
846
+ <span class='kw'>end</span>
847
+ <span class='kw'>end</span></pre>
848
+ </td>
849
+ </tr>
850
+ </table>
851
+ </div>
852
+
853
+ <div class="method_details ">
854
+ <h3 class="signature " id="update_team-instance_method">
855
+
856
+ #<strong>update_team</strong>(id:, **options) &#x21d2; <tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>
857
+
858
+
859
+
860
+
861
+
862
+ </h3><div class="docstring">
863
+ <div class="discussion">
864
+
865
+ <p>Updates a team</p>
866
+
867
+
868
+ </div>
869
+ </div>
870
+ <div class="tags">
871
+ <p class="tag_title">Parameters:</p>
872
+ <ul class="param">
873
+
874
+ <li>
875
+
876
+ <span class='name'>id</span>
877
+
878
+
879
+ <span class='type'>(<tt>Integer</tt>)</span>
880
+
881
+
882
+
883
+ &mdash;
884
+ <div class='inline'>
885
+ <p>Id of the user to update</p>
886
+ </div>
887
+
888
+ </li>
889
+
890
+ <li>
891
+
892
+ <span class='name'>options</span>
893
+
894
+
895
+ <span class='type'>(<tt>Hash</tt>)</span>
896
+
897
+
898
+
899
+ &mdash;
900
+ <div class='inline'>
901
+ <p>a customizable set of options</p>
902
+ </div>
903
+
904
+ </li>
905
+
906
+ </ul>
907
+
908
+
909
+
910
+
911
+
912
+
913
+ <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
914
+ <ul class="option">
915
+
916
+ <li>
917
+ <span class="name">:name</span>
918
+ <span class="type">(<tt>String</tt>)</span>
919
+ <span class="default">
920
+
921
+ </span>
922
+
923
+ </li>
924
+
925
+ <li>
926
+ <span class="name">:quota</span>
927
+ <span class="type">(<tt>String</tt>)</span>
928
+ <span class="default">
929
+
930
+ </span>
931
+
932
+ </li>
933
+
934
+ <li>
935
+ <span class="name">:quota_mail_sent</span>
936
+ <span class="type">(<tt>String</tt>)</span>
937
+ <span class="default">
938
+
939
+ </span>
940
+
941
+ </li>
942
+
943
+ </ul>
944
+
945
+
946
+ <p class="tag_title">Returns:</p>
947
+ <ul class="return">
948
+
949
+ <li>
950
+
951
+
952
+ <span class='type'>(<tt><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span></tt>)</span>
953
+
954
+
955
+
956
+ &mdash;
957
+ <div class='inline'>
958
+ <p>The updated team</p>
959
+ </div>
960
+
961
+ </li>
962
+
963
+ </ul>
964
+
965
+ </div><table class="source_code">
966
+ <tr>
967
+ <td>
968
+ <pre class="lines">
969
+
970
+
971
+ 66
972
+ 67
973
+ 68
974
+ 69
975
+ 70
976
+ 71</pre>
977
+ </td>
978
+ <td>
979
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 66</span>
980
+
981
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_team'>update_team</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>
982
+ <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>
983
+
984
+ <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'>/teams/</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><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>team</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
985
+ <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="../Team.html" title="StrawberryAPI::Team (class)">Team</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Team.html#initialize-instance_method" title="StrawberryAPI::Team#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
986
+ <span class='kw'>end</span></pre>
987
+ </td>
988
+ </tr>
989
+ </table>
990
+ </div>
991
+
992
+ <div class="method_details ">
993
+ <h3 class="signature " id="user_owned_teams-instance_method">
994
+
995
+ #<strong>user_owned_teams</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>&gt;</tt>
996
+
997
+
998
+
999
+
1000
+
1001
+ </h3><div class="docstring">
1002
+ <div class="discussion">
1003
+
1004
+ <p>Featches the current user team</p>
1005
+
1006
+
1007
+ </div>
1008
+ </div>
1009
+ <div class="tags">
1010
+
1011
+ <p class="tag_title">Returns:</p>
1012
+ <ul class="return">
1013
+
1014
+ <li>
1015
+
1016
+
1017
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>&gt;</tt>)</span>
1018
+
1019
+
1020
+
1021
+ &mdash;
1022
+ <div class='inline'>
1023
+ <p>The fetched current user teams</p>
1024
+ </div>
1025
+
1026
+ </li>
1027
+
1028
+ </ul>
1029
+
1030
+ </div><table class="source_code">
1031
+ <tr>
1032
+ <td>
1033
+ <pre class="lines">
1034
+
1035
+
1036
+ 32
1037
+ 33
1038
+ 34
1039
+ 35
1040
+ 36</pre>
1041
+ </td>
1042
+ <td>
1043
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/teams.rb', line 32</span>
1044
+
1045
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_owned_teams'>user_owned_teams</span>
1046
+ <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'>/teams/user_owned</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'>teams</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_team'>team</span><span class='op'>|</span>
1047
+ <span class='const'><span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">Team</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Team.html#initialize-instance_method" title="StrawberryAPI::Team#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_team'>team</span><span class='rparen'>)</span>
1048
+ <span class='kw'>end</span>
1049
+ <span class='kw'>end</span></pre>
1050
+ </td>
1051
+ </tr>
1052
+ </table>
1053
+ </div>
1054
+
1055
+ </div>
1056
+
1057
+ </div>
1058
+
1059
+ <div id="footer">
1060
+ Generated on Thu Aug 30 12:51:39 2018 by
1061
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1062
+ 0.9.16 (ruby-2.5.0).
1063
+ </div>
1064
+
1065
+ </div>
1066
+ </body>
1067
+ </html>