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/ArchiveStrategies.html ADDED
@@ -0,0 +1,784 @@
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::ArchiveStrategies
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::ArchiveStrategies";
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">ArchiveStrategies</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::ArchiveStrategies
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/archive_strategies.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="#archive_strategies-instance_method" title="#archive_strategies (instance method)">#<strong>archive_strategies</strong> &#x21d2; Array&lt;StrawberryAPI::ArchiveStrategy&gt; </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 all archive strategies.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#archive_strategies_configuration-instance_method" title="#archive_strategies_configuration (instance method)">#<strong>archive_strategies_configuration</strong> &#x21d2; Hash </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>Featches archive strategies configuration.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#archive_strategy-instance_method" title="#archive_strategy (instance method)">#<strong>archive_strategy</strong>(id:) &#x21d2; StrawberryAPI::ArchiveStrategy </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 archive strategy.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#create_archive_strategy-instance_method" title="#create_archive_strategy (instance method)">#<strong>create_archive_strategy</strong>(name:, destination:, format: &#39;plain&#39;, admin_only: true, includes: &#39;none&#39;, transmission_check: &#39;fingerprint&#39;, enabled: true, strategy_type: &#39;native&#39;) &#x21d2; StrawberryAPI::ArchiveStrategy </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>Creates an archive strategy.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#update_archive_strategy-instance_method" title="#update_archive_strategy (instance method)">#<strong>update_archive_strategy</strong>(id:, **options) &#x21d2; StrawberryAPI::ArchiveStrategy </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 an archive strategy.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ </ul>
227
+
228
+
229
+
230
+
231
+ <div id="instance_method_details" class="method_details_list">
232
+ <h2>Instance Method Details</h2>
233
+
234
+
235
+ <div class="method_details first">
236
+ <h3 class="signature first" id="archive_strategies-instance_method">
237
+
238
+ #<strong>archive_strategies</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span>&gt;</tt>
239
+
240
+
241
+
242
+
243
+
244
+ </h3><div class="docstring">
245
+ <div class="discussion">
246
+
247
+ <p>Fetches all archive strategies</p>
248
+
249
+
250
+ </div>
251
+ </div>
252
+ <div class="tags">
253
+
254
+ <p class="tag_title">Returns:</p>
255
+ <ul class="return">
256
+
257
+ <li>
258
+
259
+
260
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span>&gt;</tt>)</span>
261
+
262
+
263
+
264
+ &mdash;
265
+ <div class='inline'>
266
+ <p>A list of archive strategies</p>
267
+ </div>
268
+
269
+ </li>
270
+
271
+ </ul>
272
+
273
+ </div><table class="source_code">
274
+ <tr>
275
+ <td>
276
+ <pre class="lines">
277
+
278
+
279
+ 10
280
+ 11
281
+ 12
282
+ 13
283
+ 14</pre>
284
+ </td>
285
+ <td>
286
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/archive_strategies.rb', line 10</span>
287
+
288
+ <span class='kw'>def</span> <span class='id identifier rubyid_archive_strategies'>archive_strategies</span>
289
+ <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'>/archive_strategies</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><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_archive_strategy'>archive_strategy</span><span class='op'>|</span>
290
+ <span class='const'><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">ArchiveStrategy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Strategy.html#initialize-instance_method" title="StrawberryAPI::Strategy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_archive_strategy'>archive_strategy</span><span class='rparen'>)</span>
291
+ <span class='kw'>end</span>
292
+ <span class='kw'>end</span></pre>
293
+ </td>
294
+ </tr>
295
+ </table>
296
+ </div>
297
+
298
+ <div class="method_details ">
299
+ <h3 class="signature " id="archive_strategies_configuration-instance_method">
300
+
301
+ #<strong>archive_strategies_configuration</strong> &#x21d2; <tt>Hash</tt>
302
+
303
+
304
+
305
+
306
+
307
+ </h3><div class="docstring">
308
+ <div class="discussion">
309
+
310
+ <p>Featches archive strategies configuration</p>
311
+
312
+
313
+ </div>
314
+ </div>
315
+ <div class="tags">
316
+
317
+ <p class="tag_title">Returns:</p>
318
+ <ul class="return">
319
+
320
+ <li>
321
+
322
+
323
+ <span class='type'>(<tt>Hash</tt>)</span>
324
+
325
+
326
+
327
+ &mdash;
328
+ <div class='inline'>
329
+ <p>The fetched archive strategies configuration</p>
330
+ </div>
331
+
332
+ </li>
333
+
334
+ </ul>
335
+
336
+ </div><table class="source_code">
337
+ <tr>
338
+ <td>
339
+ <pre class="lines">
340
+
341
+
342
+ 81
343
+ 82
344
+ 83</pre>
345
+ </td>
346
+ <td>
347
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/archive_strategies.rb', line 81</span>
348
+
349
+ <span class='kw'>def</span> <span class='id identifier rubyid_archive_strategies_configuration'>archive_strategies_configuration</span>
350
+ <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'>/archive_strategies/configuration</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'>hash</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
351
+ <span class='kw'>end</span></pre>
352
+ </td>
353
+ </tr>
354
+ </table>
355
+ </div>
356
+
357
+ <div class="method_details ">
358
+ <h3 class="signature " id="archive_strategy-instance_method">
359
+
360
+ #<strong>archive_strategy</strong>(id:) &#x21d2; <tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>
361
+
362
+
363
+
364
+
365
+
366
+ </h3><div class="docstring">
367
+ <div class="discussion">
368
+
369
+ <p>Fetches an archive strategy</p>
370
+
371
+
372
+ </div>
373
+ </div>
374
+ <div class="tags">
375
+ <p class="tag_title">Parameters:</p>
376
+ <ul class="param">
377
+
378
+ <li>
379
+
380
+ <span class='name'>id</span>
381
+
382
+
383
+ <span class='type'>(<tt>Integer</tt>)</span>
384
+
385
+
386
+
387
+ &mdash;
388
+ <div class='inline'>
389
+ <p>Id of the archive strategy to retrieve</p>
390
+ </div>
391
+
392
+ </li>
393
+
394
+ </ul>
395
+
396
+ <p class="tag_title">Returns:</p>
397
+ <ul class="return">
398
+
399
+ <li>
400
+
401
+
402
+ <span class='type'>(<tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>)</span>
403
+
404
+
405
+
406
+ &mdash;
407
+ <div class='inline'>
408
+ <p>The fetched archive strategy</p>
409
+ </div>
410
+
411
+ </li>
412
+
413
+ </ul>
414
+
415
+ </div><table class="source_code">
416
+ <tr>
417
+ <td>
418
+ <pre class="lines">
419
+
420
+
421
+ 22
422
+ 23
423
+ 24
424
+ 25</pre>
425
+ </td>
426
+ <td>
427
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/archive_strategies.rb', line 22</span>
428
+
429
+ <span class='kw'>def</span> <span class='id identifier rubyid_archive_strategy'>archive_strategy</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
430
+ <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'>/archive_strategies/</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'>archivestrategy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
431
+ <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="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">ArchiveStrategy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Strategy.html#initialize-instance_method" title="StrawberryAPI::Strategy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
432
+ <span class='kw'>end</span></pre>
433
+ </td>
434
+ </tr>
435
+ </table>
436
+ </div>
437
+
438
+ <div class="method_details ">
439
+ <h3 class="signature " id="create_archive_strategy-instance_method">
440
+
441
+ #<strong>create_archive_strategy</strong>(name:, destination:, format: &#39;plain&#39;, admin_only: true, includes: &#39;none&#39;, transmission_check: &#39;fingerprint&#39;, enabled: true, strategy_type: &#39;native&#39;) &#x21d2; <tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>
442
+
443
+
444
+
445
+
446
+
447
+ </h3><div class="docstring">
448
+ <div class="discussion">
449
+
450
+ <p>Creates an archive strategy</p>
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+ <p class="tag_title">Parameters:</p>
457
+ <ul class="param">
458
+
459
+ <li>
460
+
461
+ <span class='name'>name</span>
462
+
463
+
464
+ <span class='type'>(<tt>String</tt>)</span>
465
+
466
+
467
+
468
+ </li>
469
+
470
+ <li>
471
+
472
+ <span class='name'>destination</span>
473
+
474
+
475
+ <span class='type'>(<tt>String</tt>)</span>
476
+
477
+
478
+
479
+ </li>
480
+
481
+ <li>
482
+
483
+ <span class='name'>[String]</span>
484
+
485
+
486
+ <span class='type'>(<tt>Hash</tt>)</span>
487
+
488
+
489
+
490
+ &mdash;
491
+ <div class='inline'>
492
+ <p>a customizable set of options</p>
493
+ </div>
494
+
495
+ </li>
496
+
497
+ <li>
498
+
499
+ <span class='name'>[Boolean]</span>
500
+
501
+
502
+ <span class='type'>(<tt>Hash</tt>)</span>
503
+
504
+
505
+
506
+ &mdash;
507
+ <div class='inline'>
508
+ <p>a customizable set of options</p>
509
+ </div>
510
+
511
+ </li>
512
+
513
+ </ul>
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+ <p class="tag_title">Returns:</p>
534
+ <ul class="return">
535
+
536
+ <li>
537
+
538
+
539
+ <span class='type'>(<tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>)</span>
540
+
541
+
542
+
543
+ &mdash;
544
+ <div class='inline'>
545
+ <p>The created archive strategy</p>
546
+ </div>
547
+
548
+ </li>
549
+
550
+ </ul>
551
+
552
+ </div><table class="source_code">
553
+ <tr>
554
+ <td>
555
+ <pre class="lines">
556
+
557
+
558
+ 40
559
+ 41
560
+ 42
561
+ 43
562
+ 44
563
+ 45
564
+ 46
565
+ 47
566
+ 48
567
+ 49
568
+ 50
569
+ 51
570
+ 52
571
+ 53
572
+ 54</pre>
573
+ </td>
574
+ <td>
575
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/archive_strategies.rb', line 40</span>
576
+
577
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_archive_strategy'>create_archive_strategy</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>destination:</span><span class='comma'>,</span> <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>plain</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>admin_only:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>includes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>none</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>transmission_check:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>fingerprint</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>strategy_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>native</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
578
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
579
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
580
+ <span class='label'>destination:</span> <span class='id identifier rubyid_destination'>destination</span><span class='comma'>,</span>
581
+ <span class='label'>format:</span> <span class='id identifier rubyid_format'>format</span><span class='comma'>,</span>
582
+ <span class='label'>admin_only:</span> <span class='id identifier rubyid_admin_only'>admin_only</span><span class='comma'>,</span>
583
+ <span class='label'>includes:</span> <span class='id identifier rubyid_includes'>includes</span><span class='comma'>,</span>
584
+ <span class='label'>transmission_check:</span> <span class='id identifier rubyid_transmission_check'>transmission_check</span><span class='comma'>,</span>
585
+ <span class='label'>enabled:</span> <span class='id identifier rubyid_enabled'>enabled</span><span class='comma'>,</span>
586
+ <span class='label'>strategy_type:</span> <span class='id identifier rubyid_strategy_type'>strategy_type</span>
587
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
588
+
589
+ <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'>/archive_strategies</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'>archivestrategy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
590
+ <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="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">ArchiveStrategy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Strategy.html#initialize-instance_method" title="StrawberryAPI::Strategy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
591
+ <span class='kw'>end</span></pre>
592
+ </td>
593
+ </tr>
594
+ </table>
595
+ </div>
596
+
597
+ <div class="method_details ">
598
+ <h3 class="signature " id="update_archive_strategy-instance_method">
599
+
600
+ #<strong>update_archive_strategy</strong>(id:, **options) &#x21d2; <tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>
601
+
602
+
603
+
604
+
605
+
606
+ </h3><div class="docstring">
607
+ <div class="discussion">
608
+
609
+ <p>Updates an archive strategy</p>
610
+
611
+
612
+ </div>
613
+ </div>
614
+ <div class="tags">
615
+ <p class="tag_title">Parameters:</p>
616
+ <ul class="param">
617
+
618
+ <li>
619
+
620
+ <span class='name'>id</span>
621
+
622
+
623
+ <span class='type'>(<tt>Integer</tt>)</span>
624
+
625
+
626
+
627
+ &mdash;
628
+ <div class='inline'>
629
+ <p>Id of the user to update</p>
630
+ </div>
631
+
632
+ </li>
633
+
634
+ <li>
635
+
636
+ <span class='name'>options</span>
637
+
638
+
639
+ <span class='type'>(<tt>Hash</tt>)</span>
640
+
641
+
642
+
643
+ &mdash;
644
+ <div class='inline'>
645
+ <p>a customizable set of options</p>
646
+ </div>
647
+
648
+ </li>
649
+
650
+ </ul>
651
+
652
+
653
+
654
+
655
+
656
+
657
+ <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
658
+ <ul class="option">
659
+
660
+ <li>
661
+ <span class="name">name</span>
662
+ <span class="type">(<tt>String</tt>)</span>
663
+ <span class="default">
664
+
665
+ </span>
666
+
667
+ </li>
668
+
669
+ <li>
670
+ <span class="name">destination</span>
671
+ <span class="type">(<tt>String</tt>)</span>
672
+ <span class="default">
673
+
674
+ </span>
675
+
676
+ </li>
677
+
678
+ <li>
679
+ <span class="name">format</span>
680
+ <span class="type">(<tt>String</tt>)</span>
681
+ <span class="default">
682
+
683
+ </span>
684
+
685
+ </li>
686
+
687
+ <li>
688
+ <span class="name">admin_only</span>
689
+ <span class="type">(<tt>String</tt>)</span>
690
+ <span class="default">
691
+
692
+ </span>
693
+
694
+ </li>
695
+
696
+ <li>
697
+ <span class="name">enabled</span>
698
+ <span class="type">(<tt>String</tt>)</span>
699
+ <span class="default">
700
+
701
+ </span>
702
+
703
+ </li>
704
+
705
+ <li>
706
+ <span class="name">includes</span>
707
+ <span class="type">(<tt>String</tt>)</span>
708
+ <span class="default">
709
+
710
+ </span>
711
+
712
+ </li>
713
+
714
+ <li>
715
+ <span class="name">transmission_check</span>
716
+ <span class="type">(<tt>String</tt>)</span>
717
+ <span class="default">
718
+
719
+ </span>
720
+
721
+ </li>
722
+
723
+ </ul>
724
+
725
+
726
+ <p class="tag_title">Returns:</p>
727
+ <ul class="return">
728
+
729
+ <li>
730
+
731
+
732
+ <span class='type'>(<tt><span class='object_link'><a href="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">StrawberryAPI::ArchiveStrategy</a></span></tt>)</span>
733
+
734
+
735
+
736
+ &mdash;
737
+ <div class='inline'>
738
+ <p>The updated archive strategy</p>
739
+ </div>
740
+
741
+ </li>
742
+
743
+ </ul>
744
+
745
+ </div><table class="source_code">
746
+ <tr>
747
+ <td>
748
+ <pre class="lines">
749
+
750
+
751
+ 69
752
+ 70
753
+ 71
754
+ 72
755
+ 73
756
+ 74</pre>
757
+ </td>
758
+ <td>
759
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api/client/archive_strategies.rb', line 69</span>
760
+
761
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_archive_strategy'>update_archive_strategy</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>
762
+ <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>
763
+
764
+ <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'>/archive_strategies/</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'>archivestrategy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
765
+ <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="../ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">ArchiveStrategy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Strategy.html#initialize-instance_method" title="StrawberryAPI::Strategy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
766
+ <span class='kw'>end</span></pre>
767
+ </td>
768
+ </tr>
769
+ </table>
770
+ </div>
771
+
772
+ </div>
773
+
774
+ </div>
775
+
776
+ <div id="footer">
777
+ Generated on Thu Aug 30 12:51:41 2018 by
778
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
779
+ 0.9.16 (ruby-2.5.0).
780
+ </div>
781
+
782
+ </div>
783
+ </body>
784
+ </html>