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/Assets.html ADDED
@@ -0,0 +1,888 @@
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::Assets
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::Assets";
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 (A)</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">Assets</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::Assets
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/assets.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="#asset-instance_method" title="#asset (instance method)">#<strong>asset</strong>(id:, path: nil) &#x21d2; StrawberryAPI::Asset </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>Fetches an asset.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#asset_custom_metadata-instance_method" title="#asset_custom_metadata (instance method)">#<strong>asset_custom_metadata</strong>(id:) &#x21d2; Array&lt;Hash&gt; </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>Fetches an asset custom metadata.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#asset_links-instance_method" title="#asset_links (instance method)">#<strong>asset_links</strong>(ids:) &#x21d2; Array&lt;Hash&gt; </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>Fetches an asset links.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#asset_marker_descriptions-instance_method" title="#asset_marker_descriptions (instance method)">#<strong>asset_marker_descriptions</strong>(id:) &#x21d2; Array&lt;StrawberryAPI::Marker&gt; </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>Fetches an asset marker descriptions.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#assets-instance_method" title="#assets (instance method)">#<strong>assets</strong> &#x21d2; Array&lt;StrawberryAPI::Asset&gt; </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 all assets.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#destroy_assets-instance_method" title="#destroy_assets (instance method)">#<strong>destroy_assets</strong>(project_id:, asset_ids:) &#x21d2; Boolean </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>Deletes a project assets.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#update_asset_custom_metadata-instance_method" title="#update_asset_custom_metadata (instance method)">#<strong>update_asset_custom_metadata</strong>(id:, custom_metadata:) &#x21d2; Boolean </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 an asset custom metadata.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ </ul>
275
+
276
+
277
+
278
+
279
+ <div id="instance_method_details" class="method_details_list">
280
+ <h2>Instance Method Details</h2>
281
+
282
+
283
+ <div class="method_details first">
284
+ <h3 class="signature first" id="asset-instance_method">
285
+
286
+ #<strong>asset</strong>(id:, path: nil) &#x21d2; <tt><span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span></tt>
287
+
288
+
289
+
290
+
291
+
292
+ </h3><div class="docstring">
293
+ <div class="discussion">
294
+
295
+ <p>Fetches an asset</p>
296
+
297
+
298
+ </div>
299
+ </div>
300
+ <div class="tags">
301
+ <p class="tag_title">Parameters:</p>
302
+ <ul class="param">
303
+
304
+ <li>
305
+
306
+ <span class='name'>id</span>
307
+
308
+
309
+ <span class='type'>(<tt>Integer</tt>)</span>
310
+
311
+
312
+
313
+ &mdash;
314
+ <div class='inline'>
315
+ <p>Id of the asset to retrieve</p>
316
+ </div>
317
+
318
+ </li>
319
+
320
+ </ul>
321
+
322
+ <p class="tag_title">Returns:</p>
323
+ <ul class="return">
324
+
325
+ <li>
326
+
327
+
328
+ <span class='type'>(<tt><span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span></tt>)</span>
329
+
330
+
331
+
332
+ &mdash;
333
+ <div class='inline'>
334
+ <p>The fetched asset</p>
335
+ </div>
336
+
337
+ </li>
338
+
339
+ </ul>
340
+
341
+ </div><table class="source_code">
342
+ <tr>
343
+ <td>
344
+ <pre class="lines">
345
+
346
+
347
+ 22
348
+ 23
349
+ 24
350
+ 25
351
+ 26
352
+ 27
353
+ 28
354
+ 29
355
+ 30</pre>
356
+ </td>
357
+ <td>
358
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 22</span>
359
+
360
+ <span class='kw'>def</span> <span class='id identifier rubyid_asset'>asset</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
361
+ <span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
362
+ <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'>/assets/</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'>asset</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
363
+ <span class='kw'>else</span>
364
+ <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'>/assets/by_path</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</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'>asset</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
365
+ <span class='kw'>end</span>
366
+
367
+ <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="../Asset.html" title="StrawberryAPI::Asset (class)">Asset</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Asset.html#initialize-instance_method" title="StrawberryAPI::Asset#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
368
+ <span class='kw'>end</span></pre>
369
+ </td>
370
+ </tr>
371
+ </table>
372
+ </div>
373
+
374
+ <div class="method_details ">
375
+ <h3 class="signature " id="asset_custom_metadata-instance_method">
376
+
377
+ #<strong>asset_custom_metadata</strong>(id:) &#x21d2; <tt>Array&lt;Hash&gt;</tt>
378
+
379
+
380
+
381
+
382
+
383
+ </h3><div class="docstring">
384
+ <div class="discussion">
385
+
386
+ <p>Fetches an asset custom metadata</p>
387
+
388
+
389
+ </div>
390
+ </div>
391
+ <div class="tags">
392
+ <p class="tag_title">Parameters:</p>
393
+ <ul class="param">
394
+
395
+ <li>
396
+
397
+ <span class='name'>id</span>
398
+
399
+
400
+ <span class='type'>(<tt>Integer</tt>)</span>
401
+
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'>
406
+ <p>Id of the asset to retrieve metadata from</p>
407
+ </div>
408
+
409
+ </li>
410
+
411
+ </ul>
412
+
413
+ <p class="tag_title">Returns:</p>
414
+ <ul class="return">
415
+
416
+ <li>
417
+
418
+
419
+ <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
420
+
421
+
422
+
423
+ &mdash;
424
+ <div class='inline'>
425
+ <p>The fetched asset custom metadata</p>
426
+ </div>
427
+
428
+ </li>
429
+
430
+ </ul>
431
+
432
+ </div><table class="source_code">
433
+ <tr>
434
+ <td>
435
+ <pre class="lines">
436
+
437
+
438
+ 74
439
+ 75
440
+ 76</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 74</span>
444
+
445
+ <span class='kw'>def</span> <span class='id identifier rubyid_asset_custom_metadata'>asset_custom_metadata</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
446
+ <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'>/assets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/custom_metadata</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'>array</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+ <div class="method_details ">
454
+ <h3 class="signature " id="asset_links-instance_method">
455
+
456
+ #<strong>asset_links</strong>(ids:) &#x21d2; <tt>Array&lt;Hash&gt;</tt>
457
+
458
+
459
+
460
+
461
+
462
+ </h3><div class="docstring">
463
+ <div class="discussion">
464
+
465
+ <p>Fetches an asset links</p>
466
+
467
+
468
+ </div>
469
+ </div>
470
+ <div class="tags">
471
+ <p class="tag_title">Parameters:</p>
472
+ <ul class="param">
473
+
474
+ <li>
475
+
476
+ <span class='name'>ids</span>
477
+
478
+
479
+ <span class='type'>(<tt>Integer</tt>)</span>
480
+
481
+
482
+
483
+ &mdash;
484
+ <div class='inline'>
485
+ <p>Ids of the asset to retrieve links from</p>
486
+ </div>
487
+
488
+ </li>
489
+
490
+ </ul>
491
+
492
+ <p class="tag_title">Returns:</p>
493
+ <ul class="return">
494
+
495
+ <li>
496
+
497
+
498
+ <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
499
+
500
+
501
+
502
+ &mdash;
503
+ <div class='inline'>
504
+ <p>The retrieved asset links</p>
505
+ </div>
506
+
507
+ </li>
508
+
509
+ </ul>
510
+
511
+ </div><table class="source_code">
512
+ <tr>
513
+ <td>
514
+ <pre class="lines">
515
+
516
+
517
+ 38
518
+ 39
519
+ 40
520
+ 41
521
+ 42</pre>
522
+ </td>
523
+ <td>
524
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 38</span>
525
+
526
+ <span class='kw'>def</span> <span class='id identifier rubyid_asset_links'>asset_links</span><span class='lparen'>(</span><span class='label'>ids:</span><span class='rparen'>)</span>
527
+ <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'>/assets/links</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='lbrace'>{</span><span class='label'>asset_ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</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'>links</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_link'>link</span><span class='op'>|</span>
528
+ <span class='id identifier rubyid_link'>link</span>
529
+ <span class='kw'>end</span>
530
+ <span class='kw'>end</span></pre>
531
+ </td>
532
+ </tr>
533
+ </table>
534
+ </div>
535
+
536
+ <div class="method_details ">
537
+ <h3 class="signature " id="asset_marker_descriptions-instance_method">
538
+
539
+ #<strong>asset_marker_descriptions</strong>(id:) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../Marker.html" title="StrawberryAPI::Marker (class)">StrawberryAPI::Marker</a></span>&gt;</tt>
540
+
541
+
542
+
543
+
544
+
545
+ </h3><div class="docstring">
546
+ <div class="discussion">
547
+
548
+ <p>Fetches an asset marker descriptions</p>
549
+
550
+
551
+ </div>
552
+ </div>
553
+ <div class="tags">
554
+ <p class="tag_title">Parameters:</p>
555
+ <ul class="param">
556
+
557
+ <li>
558
+
559
+ <span class='name'>id</span>
560
+
561
+
562
+ <span class='type'>(<tt>Integer</tt>)</span>
563
+
564
+
565
+
566
+ &mdash;
567
+ <div class='inline'>
568
+ <p>Id of the asset to retrieve marker descriptions from</p>
569
+ </div>
570
+
571
+ </li>
572
+
573
+ </ul>
574
+
575
+ <p class="tag_title">Returns:</p>
576
+ <ul class="return">
577
+
578
+ <li>
579
+
580
+
581
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Marker.html" title="StrawberryAPI::Marker (class)">StrawberryAPI::Marker</a></span>&gt;</tt>)</span>
582
+
583
+
584
+
585
+ &mdash;
586
+ <div class='inline'>
587
+ <p>The retrieved asset marker descriptions</p>
588
+ </div>
589
+
590
+ </li>
591
+
592
+ </ul>
593
+
594
+ </div><table class="source_code">
595
+ <tr>
596
+ <td>
597
+ <pre class="lines">
598
+
599
+
600
+ 50
601
+ 51
602
+ 52
603
+ 53
604
+ 54
605
+ 55</pre>
606
+ </td>
607
+ <td>
608
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 50</span>
609
+
610
+ <span class='kw'>def</span> <span class='id identifier rubyid_asset_marker_descriptions'>asset_marker_descriptions</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
611
+ <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'>/assets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/marker_descriptions</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'>array</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
612
+ <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_marker'>marker</span><span class='op'>|</span>
613
+ <span class='id identifier rubyid_marker'>marker</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="../Marker.html" title="StrawberryAPI::Marker (class)">Marker</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Marker.html#initialize-instance_method" title="StrawberryAPI::Marker#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_marker'>marker</span><span class='rparen'>)</span>
614
+ <span class='kw'>end</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="assets-instance_method">
623
+
624
+ #<strong>assets</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span>&gt;</tt>
625
+
626
+
627
+
628
+
629
+
630
+ </h3><div class="docstring">
631
+ <div class="discussion">
632
+
633
+ <p>Fetches all assets</p>
634
+
635
+
636
+ </div>
637
+ </div>
638
+ <div class="tags">
639
+
640
+ <p class="tag_title">Returns:</p>
641
+ <ul class="return">
642
+
643
+ <li>
644
+
645
+
646
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span>&gt;</tt>)</span>
647
+
648
+
649
+
650
+ &mdash;
651
+ <div class='inline'>
652
+ <p>A list of assets</p>
653
+ </div>
654
+
655
+ </li>
656
+
657
+ </ul>
658
+
659
+ </div><table class="source_code">
660
+ <tr>
661
+ <td>
662
+ <pre class="lines">
663
+
664
+
665
+ 10
666
+ 11
667
+ 12
668
+ 13
669
+ 14</pre>
670
+ </td>
671
+ <td>
672
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 10</span>
673
+
674
+ <span class='kw'>def</span> <span class='id identifier rubyid_assets'>assets</span>
675
+ <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'>/assets</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'>assets</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_asset'>asset</span><span class='op'>|</span>
676
+ <span class='const'><span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">Asset</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Asset.html#initialize-instance_method" title="StrawberryAPI::Asset#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_asset'>asset</span><span class='rparen'>)</span>
677
+ <span class='kw'>end</span>
678
+ <span class='kw'>end</span></pre>
679
+ </td>
680
+ </tr>
681
+ </table>
682
+ </div>
683
+
684
+ <div class="method_details ">
685
+ <h3 class="signature " id="destroy_assets-instance_method">
686
+
687
+ #<strong>destroy_assets</strong>(project_id:, asset_ids:) &#x21d2; <tt>Boolean</tt>
688
+
689
+
690
+
691
+
692
+
693
+ </h3><div class="docstring">
694
+ <div class="discussion">
695
+
696
+ <p>Deletes a project assets</p>
697
+
698
+
699
+ </div>
700
+ </div>
701
+ <div class="tags">
702
+ <p class="tag_title">Parameters:</p>
703
+ <ul class="param">
704
+
705
+ <li>
706
+
707
+ <span class='name'>project_id</span>
708
+
709
+
710
+ <span class='type'>(<tt>Integer</tt>)</span>
711
+
712
+
713
+
714
+ &mdash;
715
+ <div class='inline'>
716
+ <p>Id of the project to delete assets from</p>
717
+ </div>
718
+
719
+ </li>
720
+
721
+ <li>
722
+
723
+ <span class='name'>asset_ids</span>
724
+
725
+
726
+ <span class='type'>(<tt>Array&lt;Integer&gt;</tt>)</span>
727
+
728
+
729
+
730
+ &mdash;
731
+ <div class='inline'>
732
+ <p>Ids of the assets to delete</p>
733
+ </div>
734
+
735
+ </li>
736
+
737
+ </ul>
738
+
739
+ <p class="tag_title">Returns:</p>
740
+ <ul class="return">
741
+
742
+ <li>
743
+
744
+
745
+ <span class='type'>(<tt>Boolean</tt>)</span>
746
+
747
+
748
+
749
+ &mdash;
750
+ <div class='inline'>
751
+ <p>Success</p>
752
+ </div>
753
+
754
+ </li>
755
+
756
+ </ul>
757
+
758
+ </div><table class="source_code">
759
+ <tr>
760
+ <td>
761
+ <pre class="lines">
762
+
763
+
764
+ 64
765
+ 65
766
+ 66</pre>
767
+ </td>
768
+ <td>
769
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 64</span>
770
+
771
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy_assets'>destroy_assets</span><span class='lparen'>(</span><span class='label'>project_id:</span><span class='comma'>,</span> <span class='label'>asset_ids:</span><span class='rparen'>)</span>
772
+ <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'>/assets/destroy</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='lbrace'>{</span><span class='label'>data:</span> <span class='lbrace'>{</span><span class='id identifier rubyid_project_id'>project_id</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='label'>asset_ids:</span> <span class='id identifier rubyid_asset_ids'>asset_ids</span><span class='rbrace'>}</span><span class='rbrace'>}</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
773
+ <span class='kw'>end</span></pre>
774
+ </td>
775
+ </tr>
776
+ </table>
777
+ </div>
778
+
779
+ <div class="method_details ">
780
+ <h3 class="signature " id="update_asset_custom_metadata-instance_method">
781
+
782
+ #<strong>update_asset_custom_metadata</strong>(id:, custom_metadata:) &#x21d2; <tt>Boolean</tt>
783
+
784
+
785
+
786
+
787
+
788
+ </h3><div class="docstring">
789
+ <div class="discussion">
790
+
791
+ <p>Updates an asset custom metadata</p>
792
+
793
+
794
+ </div>
795
+ </div>
796
+ <div class="tags">
797
+ <p class="tag_title">Parameters:</p>
798
+ <ul class="param">
799
+
800
+ <li>
801
+
802
+ <span class='name'>id</span>
803
+
804
+
805
+ <span class='type'>(<tt>Integer</tt>)</span>
806
+
807
+
808
+
809
+ &mdash;
810
+ <div class='inline'>
811
+ <p>Id of the asset which to update custom metadata</p>
812
+ </div>
813
+
814
+ </li>
815
+
816
+ <li>
817
+
818
+ <span class='name'>custom_metadata</span>
819
+
820
+
821
+ <span class='type'>(<tt>Hash</tt>)</span>
822
+
823
+
824
+
825
+ &mdash;
826
+ <div class='inline'>
827
+ <p>Custom metadata to update the asset with</p>
828
+ </div>
829
+
830
+ </li>
831
+
832
+ </ul>
833
+
834
+ <p class="tag_title">Returns:</p>
835
+ <ul class="return">
836
+
837
+ <li>
838
+
839
+
840
+ <span class='type'>(<tt>Boolean</tt>)</span>
841
+
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'>
846
+ <p>Success</p>
847
+ </div>
848
+
849
+ </li>
850
+
851
+ </ul>
852
+
853
+ </div><table class="source_code">
854
+ <tr>
855
+ <td>
856
+ <pre class="lines">
857
+
858
+
859
+ 85
860
+ 86
861
+ 87
862
+ 88</pre>
863
+ </td>
864
+ <td>
865
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/assets.rb', line 85</span>
866
+
867
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_asset_custom_metadata'>update_asset_custom_metadata</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>custom_metadata:</span><span class='rparen'>)</span>
868
+ <span class='id identifier rubyid_filthy_hash'>filthy_hash</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../StrawberryAPI.html" title="StrawberryAPI (module)">StrawberryAPI</a></span></span><span class='op'>::</span><span class='const'>CustomMetadata</span><span class='period'>.</span><span class='id identifier rubyid_filthify'>filthify</span><span class='lparen'>(</span><span class='label'>custom_metadata:</span> <span class='id identifier rubyid_custom_metadata'>custom_metadata</span><span class='rparen'>)</span>
869
+ <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'>/assets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/update_metadata</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_filthy_hash'>filthy_hash</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
870
+ <span class='kw'>end</span></pre>
871
+ </td>
872
+ </tr>
873
+ </table>
874
+ </div>
875
+
876
+ </div>
877
+
878
+ </div>
879
+
880
+ <div id="footer">
881
+ Generated on Thu Aug 30 12:51:39 2018 by
882
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
883
+ 0.9.16 (ruby-2.5.0).
884
+ </div>
885
+
886
+ </div>
887
+ </body>
888
+ </html>