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.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +4 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +3 -0
- data/LICENSE.txt +21 -0
- data/README.md +135 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/HTTParty/Response.html +148 -0
- data/doc/StrawberryAPI/AccessRight.html +431 -0
- data/doc/StrawberryAPI/ApiKey.html +637 -0
- data/doc/StrawberryAPI/ArchiveStrategy.html +365 -0
- data/doc/StrawberryAPI/ArchiveStrategyState.html +1057 -0
- data/doc/StrawberryAPI/Asset.html +1791 -0
- data/doc/StrawberryAPI/AssetCopyToStrategy.html +145 -0
- data/doc/StrawberryAPI/AssetFeedback.html +370 -0
- data/doc/StrawberryAPI/Client/ApiKeys.html +904 -0
- data/doc/StrawberryAPI/Client/ArchiveStrategies.html +784 -0
- data/doc/StrawberryAPI/Client/AssetCopyToStrategies.html +805 -0
- data/doc/StrawberryAPI/Client/AssetFeedbacks.html +232 -0
- data/doc/StrawberryAPI/Client/Assets.html +888 -0
- data/doc/StrawberryAPI/Client/Collections.html +319 -0
- data/doc/StrawberryAPI/Client/CopyToFeedbacks.html +232 -0
- data/doc/StrawberryAPI/Client/CustomMetadata.html +210 -0
- data/doc/StrawberryAPI/Client/CustomMetadataFields.html +214 -0
- data/doc/StrawberryAPI/Client/CustomMetadataOptions.html +214 -0
- data/doc/StrawberryAPI/Client/CustomMetadataSets.html +214 -0
- data/doc/StrawberryAPI/Client/Edits.html +485 -0
- data/doc/StrawberryAPI/Client/Features.html +319 -0
- data/doc/StrawberryAPI/Client/Libraries.html +321 -0
- data/doc/StrawberryAPI/Client/Markers.html +234 -0
- data/doc/StrawberryAPI/Client/ProjectCopyToStrategies.html +857 -0
- data/doc/StrawberryAPI/Client/ProjectFeedbacks.html +232 -0
- data/doc/StrawberryAPI/Client/Projects.html +2764 -0
- data/doc/StrawberryAPI/Client/Roles.html +214 -0
- data/doc/StrawberryAPI/Client/Schedules.html +319 -0
- data/doc/StrawberryAPI/Client/Searches.html +293 -0
- data/doc/StrawberryAPI/Client/Sessions.html +376 -0
- data/doc/StrawberryAPI/Client/Settings.html +210 -0
- data/doc/StrawberryAPI/Client/StatusFlags.html +315 -0
- data/doc/StrawberryAPI/Client/Teams.html +1067 -0
- data/doc/StrawberryAPI/Client/Templates.html +319 -0
- data/doc/StrawberryAPI/Client/Users.html +1255 -0
- data/doc/StrawberryAPI/Client.html +487 -0
- data/doc/StrawberryAPI/Collection.html +427 -0
- data/doc/StrawberryAPI/Configuration.html +481 -0
- data/doc/StrawberryAPI/CopyToFeedback.html +220 -0
- data/doc/StrawberryAPI/CustomMetadataField.html +999 -0
- data/doc/StrawberryAPI/CustomMetadataOption.html +567 -0
- data/doc/StrawberryAPI/CustomMetadataSet.html +649 -0
- data/doc/StrawberryAPI/CustomMetadatum.html +718 -0
- data/doc/StrawberryAPI/Edit.html +637 -0
- data/doc/StrawberryAPI/Feature.html +567 -0
- data/doc/StrawberryAPI/Feedback.html +641 -0
- data/doc/StrawberryAPI/HttpClient.html +971 -0
- data/doc/StrawberryAPI/Library.html +637 -0
- data/doc/StrawberryAPI/Marker.html +847 -0
- data/doc/StrawberryAPI/Project.html +2395 -0
- data/doc/StrawberryAPI/ProjectCopyToStrategy.html +365 -0
- data/doc/StrawberryAPI/ProjectFeedback.html +370 -0
- data/doc/StrawberryAPI/Proxy.html +1267 -0
- data/doc/StrawberryAPI/Role.html +567 -0
- data/doc/StrawberryAPI/Schedule.html +2387 -0
- data/doc/StrawberryAPI/Session.html +121 -0
- data/doc/StrawberryAPI/Setting.html +207 -0
- data/doc/StrawberryAPI/StatusFlag.html +207 -0
- data/doc/StrawberryAPI/Strategy.html +641 -0
- data/doc/StrawberryAPI/Team.html +789 -0
- data/doc/StrawberryAPI/Template.html +707 -0
- data/doc/StrawberryAPI/User.html +999 -0
- data/doc/StrawberryAPI.html +483 -0
- data/doc/_index.html +632 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +222 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +222 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +3059 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/strawberry_api/access_right.rb +18 -0
- data/lib/strawberry_api/api_key.rb +19 -0
- data/lib/strawberry_api/asset.rb +51 -0
- data/lib/strawberry_api/client/api_keys.rb +49 -0
- data/lib/strawberry_api/client/archive_strategies.rb +87 -0
- data/lib/strawberry_api/client/asset_copy_to_strategies.rb +83 -0
- data/lib/strawberry_api/client/asset_feedbacks.rb +18 -0
- data/lib/strawberry_api/client/assets.rb +92 -0
- data/lib/strawberry_api/client/collections.rb +29 -0
- data/lib/strawberry_api/client/copy_to_feedbacks.rb +18 -0
- data/lib/strawberry_api/client/custom_metadata.rb +16 -0
- data/lib/strawberry_api/client/custom_metadata_fields.rb +18 -0
- data/lib/strawberry_api/client/custom_metadata_options.rb +18 -0
- data/lib/strawberry_api/client/custom_metadata_sets.rb +18 -0
- data/lib/strawberry_api/client/edits.rb +47 -0
- data/lib/strawberry_api/client/features.rb +29 -0
- data/lib/strawberry_api/client/libraries.rb +30 -0
- data/lib/strawberry_api/client/markers.rb +19 -0
- data/lib/strawberry_api/client/project_copy_to_strategies.rb +88 -0
- data/lib/strawberry_api/client/project_feedbacks.rb +18 -0
- data/lib/strawberry_api/client/projects.rb +305 -0
- data/lib/strawberry_api/client/roles.rb +18 -0
- data/lib/strawberry_api/client/schedules.rb +29 -0
- data/lib/strawberry_api/client/searches.rb +25 -0
- data/lib/strawberry_api/client/sessions.rb +33 -0
- data/lib/strawberry_api/client/settings.rb +16 -0
- data/lib/strawberry_api/client/status_flags.rb +27 -0
- data/lib/strawberry_api/client/teams.rb +107 -0
- data/lib/strawberry_api/client/templates.rb +29 -0
- data/lib/strawberry_api/client/users.rb +125 -0
- data/lib/strawberry_api/client.rb +95 -0
- data/lib/strawberry_api/collection.rb +16 -0
- data/lib/strawberry_api/configuration.rb +19 -0
- data/lib/strawberry_api/custom_metadata/custom_metadata_field.rb +30 -0
- data/lib/strawberry_api/custom_metadata/custom_metadata_option.rb +18 -0
- data/lib/strawberry_api/custom_metadata/custom_metadata_set.rb +25 -0
- data/lib/strawberry_api/custom_metadatum.rb +30 -0
- data/lib/strawberry_api/edit.rb +19 -0
- data/lib/strawberry_api/feature.rb +18 -0
- data/lib/strawberry_api/feedback/asset_feedback.rb +15 -0
- data/lib/strawberry_api/feedback/copy_to_feedback.rb +12 -0
- data/lib/strawberry_api/feedback/project_feedback.rb +15 -0
- data/lib/strawberry_api/feedback.rb +19 -0
- data/lib/strawberry_api/http_client.rb +135 -0
- data/lib/strawberry_api/library.rb +19 -0
- data/lib/strawberry_api/marker.rb +22 -0
- data/lib/strawberry_api/project.rb +48 -0
- data/lib/strawberry_api/proxy.rb +28 -0
- data/lib/strawberry_api/role.rb +18 -0
- data/lib/strawberry_api/schedule.rb +44 -0
- data/lib/strawberry_api/session.rb +7 -0
- data/lib/strawberry_api/setting.rb +12 -0
- data/lib/strawberry_api/status_flag.rb +12 -0
- data/lib/strawberry_api/strategy/archive_strategy.rb +10 -0
- data/lib/strawberry_api/strategy/archive_strategy_state.rb +25 -0
- data/lib/strawberry_api/strategy/asset_copy_to_strategy.rb +6 -0
- data/lib/strawberry_api/strategy/project_copy_to_strategy.rb +9 -0
- data/lib/strawberry_api/strategy.rb +19 -0
- data/lib/strawberry_api/team.rb +27 -0
- data/lib/strawberry_api/template.rb +20 -0
- data/lib/strawberry_api/user.rb +30 -0
- data/lib/strawberry_api/version.rb +3 -0
- data/lib/strawberry_api.rb +36 -0
- data/samples/README.md +14 -0
- data/samples/list_assets_links.rb +15 -0
- data/samples/list_projects.rb +14 -0
- data/samples/login.rb +18 -0
- data/samples/test.rb +12 -0
- data/strawberry_api.gemspec +40 -0
- metadata +242 -0
@@ -0,0 +1,2764 @@
|
|
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::Projects
|
8
|
+
|
9
|
+
— 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::Projects";
|
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 (P)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../StrawberryAPI.html" title="StrawberryAPI (module)">StrawberryAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Client.html" title="StrawberryAPI::Client (class)">Client</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Projects</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::Projects
|
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/projects.rb</dd>
|
87
|
+
</dl>
|
88
|
+
|
89
|
+
</div>
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
<h2>
|
100
|
+
Instance Method Summary
|
101
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
102
|
+
</h2>
|
103
|
+
|
104
|
+
<ul class="summary">
|
105
|
+
|
106
|
+
<li class="public ">
|
107
|
+
<span class="summary_signature">
|
108
|
+
|
109
|
+
<a href="#add_team_to_project-instance_method" title="#add_team_to_project (instance method)">#<strong>add_team_to_project</strong>(id:, team_id:, write: false) ⇒ 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>Assigns a team to a project.</p>
|
125
|
+
</div></span>
|
126
|
+
|
127
|
+
</li>
|
128
|
+
|
129
|
+
|
130
|
+
<li class="public ">
|
131
|
+
<span class="summary_signature">
|
132
|
+
|
133
|
+
<a href="#archive_project-instance_method" title="#archive_project (instance method)">#<strong>archive_project</strong>(id:, archive_strategy_id:, exclude_linked_files: false) ⇒ StrawberryAPI::ProjectFeedback </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>Archives a project.</p>
|
149
|
+
</div></span>
|
150
|
+
|
151
|
+
</li>
|
152
|
+
|
153
|
+
|
154
|
+
<li class="public ">
|
155
|
+
<span class="summary_signature">
|
156
|
+
|
157
|
+
<a href="#archived_projects-instance_method" title="#archived_projects (instance method)">#<strong>archived_projects</strong> ⇒ Array<StrawberryAPI::Project> </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 all archived projects.</p>
|
173
|
+
</div></span>
|
174
|
+
|
175
|
+
</li>
|
176
|
+
|
177
|
+
|
178
|
+
<li class="public ">
|
179
|
+
<span class="summary_signature">
|
180
|
+
|
181
|
+
<a href="#close_project-instance_method" title="#close_project (instance method)">#<strong>close_project</strong>(id:, edit:) ⇒ StrawberryAPI::ProjectFeedback </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>Closes a project.</p>
|
197
|
+
</div></span>
|
198
|
+
|
199
|
+
</li>
|
200
|
+
|
201
|
+
|
202
|
+
<li class="public ">
|
203
|
+
<span class="summary_signature">
|
204
|
+
|
205
|
+
<a href="#create_project-instance_method" title="#create_project (instance method)">#<strong>create_project</strong>(name:, templatename:) ⇒ StrawberryAPI::Project </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>Creates a project.</p>
|
221
|
+
</div></span>
|
222
|
+
|
223
|
+
</li>
|
224
|
+
|
225
|
+
|
226
|
+
<li class="public ">
|
227
|
+
<span class="summary_signature">
|
228
|
+
|
229
|
+
<a href="#destroy_project-instance_method" title="#destroy_project (instance method)">#<strong>destroy_project</strong>(id:) ⇒ 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.</p>
|
245
|
+
</div></span>
|
246
|
+
|
247
|
+
</li>
|
248
|
+
|
249
|
+
|
250
|
+
<li class="public ">
|
251
|
+
<span class="summary_signature">
|
252
|
+
|
253
|
+
<a href="#forceclose_project-instance_method" title="#forceclose_project (instance method)">#<strong>forceclose_project</strong>(id:, edit:) ⇒ StrawberryAPI::ProjectFeedback </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>Forcecloses a project.</p>
|
269
|
+
</div></span>
|
270
|
+
|
271
|
+
</li>
|
272
|
+
|
273
|
+
|
274
|
+
<li class="public ">
|
275
|
+
<span class="summary_signature">
|
276
|
+
|
277
|
+
<a href="#library_projects-instance_method" title="#library_projects (instance method)">#<strong>library_projects</strong> ⇒ Array<StrawberryAPI::Project> </a>
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
</span>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
<span class="summary_desc"><div class='inline'>
|
292
|
+
<p>Fetches all library projects.</p>
|
293
|
+
</div></span>
|
294
|
+
|
295
|
+
</li>
|
296
|
+
|
297
|
+
|
298
|
+
<li class="public ">
|
299
|
+
<span class="summary_signature">
|
300
|
+
|
301
|
+
<a href="#mount_project-instance_method" title="#mount_project (instance method)">#<strong>mount_project</strong>(id:, edit:) ⇒ StrawberryAPI::ProjectFeedback </a>
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
</span>
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
<span class="summary_desc"><div class='inline'>
|
316
|
+
<p>Mounts a project.</p>
|
317
|
+
</div></span>
|
318
|
+
|
319
|
+
</li>
|
320
|
+
|
321
|
+
|
322
|
+
<li class="public ">
|
323
|
+
<span class="summary_signature">
|
324
|
+
|
325
|
+
<a href="#online_projects-instance_method" title="#online_projects (instance method)">#<strong>online_projects</strong> ⇒ Array<StrawberryAPI::Project> </a>
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
</span>
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
<span class="summary_desc"><div class='inline'>
|
340
|
+
<p>Fetches all online projects.</p>
|
341
|
+
</div></span>
|
342
|
+
|
343
|
+
</li>
|
344
|
+
|
345
|
+
|
346
|
+
<li class="public ">
|
347
|
+
<span class="summary_signature">
|
348
|
+
|
349
|
+
<a href="#open_project-instance_method" title="#open_project (instance method)">#<strong>open_project</strong>(id:) ⇒ Boolean </a>
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
</span>
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
<span class="summary_desc"><div class='inline'>
|
364
|
+
<p>Opens a project.</p>
|
365
|
+
</div></span>
|
366
|
+
|
367
|
+
</li>
|
368
|
+
|
369
|
+
|
370
|
+
<li class="public ">
|
371
|
+
<span class="summary_signature">
|
372
|
+
|
373
|
+
<a href="#project-instance_method" title="#project (instance method)">#<strong>project</strong>(id:) ⇒ StrawberryAPI::Project </a>
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
</span>
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
<span class="summary_desc"><div class='inline'>
|
388
|
+
<p>Fetches a project.</p>
|
389
|
+
</div></span>
|
390
|
+
|
391
|
+
</li>
|
392
|
+
|
393
|
+
|
394
|
+
<li class="public ">
|
395
|
+
<span class="summary_signature">
|
396
|
+
|
397
|
+
<a href="#project_assets-instance_method" title="#project_assets (instance method)">#<strong>project_assets</strong>(id:) ⇒ Array<StrawberryAPI::Asset> </a>
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
</span>
|
402
|
+
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
<span class="summary_desc"><div class='inline'>
|
412
|
+
<p>Fetches a project assets.</p>
|
413
|
+
</div></span>
|
414
|
+
|
415
|
+
</li>
|
416
|
+
|
417
|
+
|
418
|
+
<li class="public ">
|
419
|
+
<span class="summary_signature">
|
420
|
+
|
421
|
+
<a href="#project_custom_metadata-instance_method" title="#project_custom_metadata (instance method)">#<strong>project_custom_metadata</strong>(id:) ⇒ Array<StrawberryAPI::CustomMetadata> </a>
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
</span>
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
<span class="summary_desc"><div class='inline'>
|
436
|
+
<p>Fetches a project custom metadata.</p>
|
437
|
+
</div></span>
|
438
|
+
|
439
|
+
</li>
|
440
|
+
|
441
|
+
|
442
|
+
<li class="public ">
|
443
|
+
<span class="summary_signature">
|
444
|
+
|
445
|
+
<a href="#project_effective_access_rights-instance_method" title="#project_effective_access_rights (instance method)">#<strong>project_effective_access_rights</strong>(id:) ⇒ Array<StrawberryAPI::AccessRight> </a>
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
</span>
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
<span class="summary_desc"><div class='inline'>
|
460
|
+
<p>Fetches all access rights of a project.</p>
|
461
|
+
</div></span>
|
462
|
+
|
463
|
+
</li>
|
464
|
+
|
465
|
+
|
466
|
+
<li class="public ">
|
467
|
+
<span class="summary_signature">
|
468
|
+
|
469
|
+
<a href="#project_status_flags-instance_method" title="#project_status_flags (instance method)">#<strong>project_status_flags</strong>(id:) ⇒ Hash </a>
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
</span>
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
<span class="summary_desc"><div class='inline'>
|
484
|
+
<p>Fetches a project status flags.</p>
|
485
|
+
</div></span>
|
486
|
+
|
487
|
+
</li>
|
488
|
+
|
489
|
+
|
490
|
+
<li class="public ">
|
491
|
+
<span class="summary_signature">
|
492
|
+
|
493
|
+
<a href="#project_teams-instance_method" title="#project_teams (instance method)">#<strong>project_teams</strong>(id:) ⇒ Array<StrawberryAPI::Team> </a>
|
494
|
+
|
495
|
+
|
496
|
+
|
497
|
+
</span>
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
<span class="summary_desc"><div class='inline'>
|
508
|
+
<p>Fetches all teams assigned to a project.</p>
|
509
|
+
</div></span>
|
510
|
+
|
511
|
+
</li>
|
512
|
+
|
513
|
+
|
514
|
+
<li class="public ">
|
515
|
+
<span class="summary_signature">
|
516
|
+
|
517
|
+
<a href="#projects-instance_method" title="#projects (instance method)">#<strong>projects</strong> ⇒ Array<StrawberryAPI::Project> </a>
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
</span>
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
<span class="summary_desc"><div class='inline'>
|
532
|
+
<p>Fetches all projects.</p>
|
533
|
+
</div></span>
|
534
|
+
|
535
|
+
</li>
|
536
|
+
|
537
|
+
|
538
|
+
<li class="public ">
|
539
|
+
<span class="summary_signature">
|
540
|
+
|
541
|
+
<a href="#projects_report-instance_method" title="#projects_report (instance method)">#<strong>projects_report</strong> ⇒ Hash </a>
|
542
|
+
|
543
|
+
|
544
|
+
|
545
|
+
</span>
|
546
|
+
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
|
555
|
+
<span class="summary_desc"><div class='inline'>
|
556
|
+
<p>Fetches projects report.</p>
|
557
|
+
</div></span>
|
558
|
+
|
559
|
+
</li>
|
560
|
+
|
561
|
+
|
562
|
+
<li class="public ">
|
563
|
+
<span class="summary_signature">
|
564
|
+
|
565
|
+
<a href="#refresh_mounted_project-instance_method" title="#refresh_mounted_project (instance method)">#<strong>refresh_mounted_project</strong>(id:) ⇒ StrawberryAPI::ProjectFeedback </a>
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
</span>
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
<span class="summary_desc"><div class='inline'>
|
580
|
+
<p>Refreshes a mounted project.</p>
|
581
|
+
</div></span>
|
582
|
+
|
583
|
+
</li>
|
584
|
+
|
585
|
+
|
586
|
+
<li class="public ">
|
587
|
+
<span class="summary_signature">
|
588
|
+
|
589
|
+
<a href="#remove_team_from_project-instance_method" title="#remove_team_from_project (instance method)">#<strong>remove_team_from_project</strong>(id:, team_id:) ⇒ Boolean </a>
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
</span>
|
594
|
+
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
<span class="summary_desc"><div class='inline'>
|
604
|
+
<p>Removes a team from a project.</p>
|
605
|
+
</div></span>
|
606
|
+
|
607
|
+
</li>
|
608
|
+
|
609
|
+
|
610
|
+
<li class="public ">
|
611
|
+
<span class="summary_signature">
|
612
|
+
|
613
|
+
<a href="#search_project-instance_method" title="#search_project (instance method)">#<strong>search_project</strong>(name:) ⇒ Array<StrawberryAPI::Project> </a>
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
</span>
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
<span class="summary_desc"><div class='inline'>
|
628
|
+
<p>Searches for a substring in project names.</p>
|
629
|
+
</div></span>
|
630
|
+
|
631
|
+
</li>
|
632
|
+
|
633
|
+
|
634
|
+
<li class="public ">
|
635
|
+
<span class="summary_signature">
|
636
|
+
|
637
|
+
<a href="#sync_project-instance_method" title="#sync_project (instance method)">#<strong>sync_project</strong>(id:) ⇒ StrawberryAPI::ProjectFeedback </a>
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
</span>
|
642
|
+
|
643
|
+
|
644
|
+
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
<span class="summary_desc"><div class='inline'>
|
652
|
+
<p>Syncs a project.</p>
|
653
|
+
</div></span>
|
654
|
+
|
655
|
+
</li>
|
656
|
+
|
657
|
+
|
658
|
+
<li class="public ">
|
659
|
+
<span class="summary_signature">
|
660
|
+
|
661
|
+
<a href="#umount_project-instance_method" title="#umount_project (instance method)">#<strong>umount_project</strong>(id:, edit:) ⇒ StrawberryAPI::ProjectFeedback </a>
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
</span>
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
|
673
|
+
|
674
|
+
|
675
|
+
<span class="summary_desc"><div class='inline'>
|
676
|
+
<p>Unmounts a project.</p>
|
677
|
+
</div></span>
|
678
|
+
|
679
|
+
</li>
|
680
|
+
|
681
|
+
|
682
|
+
<li class="public ">
|
683
|
+
<span class="summary_signature">
|
684
|
+
|
685
|
+
<a href="#unarchive_project-instance_method" title="#unarchive_project (instance method)">#<strong>unarchive_project</strong>(id:) ⇒ StrawberryAPI::ArchiveStrategyState </a>
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
</span>
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
|
698
|
+
|
699
|
+
<span class="summary_desc"><div class='inline'>
|
700
|
+
<p>Unarchives a project.</p>
|
701
|
+
</div></span>
|
702
|
+
|
703
|
+
</li>
|
704
|
+
|
705
|
+
|
706
|
+
</ul>
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
<div id="instance_method_details" class="method_details_list">
|
712
|
+
<h2>Instance Method Details</h2>
|
713
|
+
|
714
|
+
|
715
|
+
<div class="method_details first">
|
716
|
+
<h3 class="signature first" id="add_team_to_project-instance_method">
|
717
|
+
|
718
|
+
#<strong>add_team_to_project</strong>(id:, team_id:, write: false) ⇒ <tt>Boolean</tt>
|
719
|
+
|
720
|
+
|
721
|
+
|
722
|
+
|
723
|
+
|
724
|
+
</h3><div class="docstring">
|
725
|
+
<div class="discussion">
|
726
|
+
|
727
|
+
<p>Assigns a team to a project</p>
|
728
|
+
|
729
|
+
|
730
|
+
</div>
|
731
|
+
</div>
|
732
|
+
<div class="tags">
|
733
|
+
<p class="tag_title">Parameters:</p>
|
734
|
+
<ul class="param">
|
735
|
+
|
736
|
+
<li>
|
737
|
+
|
738
|
+
<span class='name'>id</span>
|
739
|
+
|
740
|
+
|
741
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
—
|
746
|
+
<div class='inline'>
|
747
|
+
<p>Id of the project to which the team should be added</p>
|
748
|
+
</div>
|
749
|
+
|
750
|
+
</li>
|
751
|
+
|
752
|
+
<li>
|
753
|
+
|
754
|
+
<span class='name'>team_id</span>
|
755
|
+
|
756
|
+
|
757
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
—
|
762
|
+
<div class='inline'>
|
763
|
+
<p>Id of the team to add to the project</p>
|
764
|
+
</div>
|
765
|
+
|
766
|
+
</li>
|
767
|
+
|
768
|
+
<li>
|
769
|
+
|
770
|
+
<span class='name'>write</span>
|
771
|
+
|
772
|
+
|
773
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
774
|
+
|
775
|
+
|
776
|
+
|
777
|
+
—
|
778
|
+
<div class='inline'>
|
779
|
+
<p>false Write access to the project</p>
|
780
|
+
</div>
|
781
|
+
|
782
|
+
</li>
|
783
|
+
|
784
|
+
</ul>
|
785
|
+
|
786
|
+
<p class="tag_title">Returns:</p>
|
787
|
+
<ul class="return">
|
788
|
+
|
789
|
+
<li>
|
790
|
+
|
791
|
+
|
792
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
—
|
797
|
+
<div class='inline'>
|
798
|
+
<p>Success</p>
|
799
|
+
</div>
|
800
|
+
|
801
|
+
</li>
|
802
|
+
|
803
|
+
</ul>
|
804
|
+
|
805
|
+
</div><table class="source_code">
|
806
|
+
<tr>
|
807
|
+
<td>
|
808
|
+
<pre class="lines">
|
809
|
+
|
810
|
+
|
811
|
+
238
|
812
|
+
239
|
813
|
+
240
|
814
|
+
241
|
815
|
+
242
|
816
|
+
243
|
817
|
+
244
|
818
|
+
245</pre>
|
819
|
+
</td>
|
820
|
+
<td>
|
821
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 238</span>
|
822
|
+
|
823
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_team_to_project'>add_team_to_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>team_id:</span><span class='comma'>,</span> <span class='label'>write:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
824
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
825
|
+
<span class='label'>team_id:</span> <span class='id identifier rubyid_team_id'>team_id</span><span class='comma'>,</span>
|
826
|
+
<span class='label'>write:</span> <span class='id identifier rubyid_write'>write</span>
|
827
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
828
|
+
|
829
|
+
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams</span><span class='tstring_end'>"</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_success?'>success?</span>
|
830
|
+
<span class='kw'>end</span></pre>
|
831
|
+
</td>
|
832
|
+
</tr>
|
833
|
+
</table>
|
834
|
+
</div>
|
835
|
+
|
836
|
+
<div class="method_details ">
|
837
|
+
<h3 class="signature " id="archive_project-instance_method">
|
838
|
+
|
839
|
+
#<strong>archive_project</strong>(id:, archive_strategy_id:, exclude_linked_files: false) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
840
|
+
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
</h3><div class="docstring">
|
846
|
+
<div class="discussion">
|
847
|
+
|
848
|
+
<p>Archives a project</p>
|
849
|
+
|
850
|
+
|
851
|
+
</div>
|
852
|
+
</div>
|
853
|
+
<div class="tags">
|
854
|
+
<p class="tag_title">Parameters:</p>
|
855
|
+
<ul class="param">
|
856
|
+
|
857
|
+
<li>
|
858
|
+
|
859
|
+
<span class='name'>id</span>
|
860
|
+
|
861
|
+
|
862
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
—
|
867
|
+
<div class='inline'>
|
868
|
+
<p>Id of the project to archive</p>
|
869
|
+
</div>
|
870
|
+
|
871
|
+
</li>
|
872
|
+
|
873
|
+
</ul>
|
874
|
+
|
875
|
+
<p class="tag_title">Returns:</p>
|
876
|
+
<ul class="return">
|
877
|
+
|
878
|
+
<li>
|
879
|
+
|
880
|
+
|
881
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
—
|
886
|
+
<div class='inline'>
|
887
|
+
<p>The operation status</p>
|
888
|
+
</div>
|
889
|
+
|
890
|
+
</li>
|
891
|
+
|
892
|
+
</ul>
|
893
|
+
|
894
|
+
</div><table class="source_code">
|
895
|
+
<tr>
|
896
|
+
<td>
|
897
|
+
<pre class="lines">
|
898
|
+
|
899
|
+
|
900
|
+
169
|
901
|
+
170
|
902
|
+
171
|
903
|
+
172
|
904
|
+
173
|
905
|
+
174
|
906
|
+
175
|
907
|
+
176
|
908
|
+
177
|
909
|
+
178</pre>
|
910
|
+
</td>
|
911
|
+
<td>
|
912
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 169</span>
|
913
|
+
|
914
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_archive_project'>archive_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>archive_strategy_id:</span><span class='comma'>,</span> <span class='label'>exclude_linked_files:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
915
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
916
|
+
<span class='label'>strategy:</span> <span class='id identifier rubyid_archive_strategy_id'>archive_strategy_id</span><span class='comma'>,</span>
|
917
|
+
<span class='label'>exclude_linked_files:</span> <span class='id identifier rubyid_exclude_linked_files'>exclude_linked_files</span>
|
918
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
919
|
+
|
920
|
+
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/archive</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>archivestrategystate</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_state'>state</span><span class='op'>|</span>
|
921
|
+
<span class='const'><span class='object_link'><a href="../ArchiveStrategyState.html" title="StrawberryAPI::ArchiveStrategyState (class)">ArchiveStrategyState</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ArchiveStrategyState.html#initialize-instance_method" title="StrawberryAPI::ArchiveStrategyState#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
|
922
|
+
<span class='kw'>end</span>
|
923
|
+
<span class='kw'>end</span></pre>
|
924
|
+
</td>
|
925
|
+
</tr>
|
926
|
+
</table>
|
927
|
+
</div>
|
928
|
+
|
929
|
+
<div class="method_details ">
|
930
|
+
<h3 class="signature " id="archived_projects-instance_method">
|
931
|
+
|
932
|
+
#<strong>archived_projects</strong> ⇒ <tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>
|
933
|
+
|
934
|
+
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
</h3><div class="docstring">
|
939
|
+
<div class="discussion">
|
940
|
+
|
941
|
+
<p>Fetches all archived projects</p>
|
942
|
+
|
943
|
+
|
944
|
+
</div>
|
945
|
+
</div>
|
946
|
+
<div class="tags">
|
947
|
+
|
948
|
+
<p class="tag_title">Returns:</p>
|
949
|
+
<ul class="return">
|
950
|
+
|
951
|
+
<li>
|
952
|
+
|
953
|
+
|
954
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>)</span>
|
955
|
+
|
956
|
+
|
957
|
+
|
958
|
+
—
|
959
|
+
<div class='inline'>
|
960
|
+
<p>A list of archived projects</p>
|
961
|
+
</div>
|
962
|
+
|
963
|
+
</li>
|
964
|
+
|
965
|
+
</ul>
|
966
|
+
|
967
|
+
</div><table class="source_code">
|
968
|
+
<tr>
|
969
|
+
<td>
|
970
|
+
<pre class="lines">
|
971
|
+
|
972
|
+
|
973
|
+
43
|
974
|
+
44
|
975
|
+
45
|
976
|
+
46
|
977
|
+
47</pre>
|
978
|
+
</td>
|
979
|
+
<td>
|
980
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 43</span>
|
981
|
+
|
982
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_archived_projects'>archived_projects</span>
|
983
|
+
<span class='id identifier rubyid_projects'>projects</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='op'>|</span>
|
984
|
+
<span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_archive_strategy_id'>archive_strategy_id</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_deleted'>deleted</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_is_library_project'>is_library_project</span>
|
985
|
+
<span class='kw'>end</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="close_project-instance_method">
|
994
|
+
|
995
|
+
#<strong>close_project</strong>(id:, edit:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
</h3><div class="docstring">
|
1002
|
+
<div class="discussion">
|
1003
|
+
|
1004
|
+
<p>Closes a project</p>
|
1005
|
+
|
1006
|
+
|
1007
|
+
</div>
|
1008
|
+
</div>
|
1009
|
+
<div class="tags">
|
1010
|
+
<p class="tag_title">Parameters:</p>
|
1011
|
+
<ul class="param">
|
1012
|
+
|
1013
|
+
<li>
|
1014
|
+
|
1015
|
+
<span class='name'>id</span>
|
1016
|
+
|
1017
|
+
|
1018
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
—
|
1023
|
+
<div class='inline'>
|
1024
|
+
<p>Id of the project to close</p>
|
1025
|
+
</div>
|
1026
|
+
|
1027
|
+
</li>
|
1028
|
+
|
1029
|
+
</ul>
|
1030
|
+
|
1031
|
+
<p class="tag_title">Returns:</p>
|
1032
|
+
<ul class="return">
|
1033
|
+
|
1034
|
+
<li>
|
1035
|
+
|
1036
|
+
|
1037
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
—
|
1042
|
+
<div class='inline'>
|
1043
|
+
<p>The operation status</p>
|
1044
|
+
</div>
|
1045
|
+
|
1046
|
+
</li>
|
1047
|
+
|
1048
|
+
</ul>
|
1049
|
+
|
1050
|
+
</div><table class="source_code">
|
1051
|
+
<tr>
|
1052
|
+
<td>
|
1053
|
+
<pre class="lines">
|
1054
|
+
|
1055
|
+
|
1056
|
+
114
|
1057
|
+
115
|
1058
|
+
116
|
1059
|
+
117</pre>
|
1060
|
+
</td>
|
1061
|
+
<td>
|
1062
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 114</span>
|
1063
|
+
|
1064
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_close_project'>close_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>edit:</span><span class='rparen'>)</span>
|
1065
|
+
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/close</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-FLAVOURSYS-EDIT</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_edit'>edit</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1066
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1067
|
+
<span class='kw'>end</span></pre>
|
1068
|
+
</td>
|
1069
|
+
</tr>
|
1070
|
+
</table>
|
1071
|
+
</div>
|
1072
|
+
|
1073
|
+
<div class="method_details ">
|
1074
|
+
<h3 class="signature " id="create_project-instance_method">
|
1075
|
+
|
1076
|
+
#<strong>create_project</strong>(name:, templatename:) ⇒ <tt><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span></tt>
|
1077
|
+
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
</h3><div class="docstring">
|
1083
|
+
<div class="discussion">
|
1084
|
+
|
1085
|
+
<p>Creates a project</p>
|
1086
|
+
|
1087
|
+
|
1088
|
+
</div>
|
1089
|
+
</div>
|
1090
|
+
<div class="tags">
|
1091
|
+
<p class="tag_title">Parameters:</p>
|
1092
|
+
<ul class="param">
|
1093
|
+
|
1094
|
+
<li>
|
1095
|
+
|
1096
|
+
<span class='name'>name</span>
|
1097
|
+
|
1098
|
+
|
1099
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1100
|
+
|
1101
|
+
|
1102
|
+
|
1103
|
+
—
|
1104
|
+
<div class='inline'>
|
1105
|
+
<p>Name of the project to create</p>
|
1106
|
+
</div>
|
1107
|
+
|
1108
|
+
</li>
|
1109
|
+
|
1110
|
+
<li>
|
1111
|
+
|
1112
|
+
<span class='name'>templatename</span>
|
1113
|
+
|
1114
|
+
|
1115
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
—
|
1120
|
+
<div class='inline'>
|
1121
|
+
<p>Name of the template to use</p>
|
1122
|
+
</div>
|
1123
|
+
|
1124
|
+
</li>
|
1125
|
+
|
1126
|
+
</ul>
|
1127
|
+
|
1128
|
+
<p class="tag_title">Returns:</p>
|
1129
|
+
<ul class="return">
|
1130
|
+
|
1131
|
+
<li>
|
1132
|
+
|
1133
|
+
|
1134
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span></tt>)</span>
|
1135
|
+
|
1136
|
+
|
1137
|
+
|
1138
|
+
—
|
1139
|
+
<div class='inline'>
|
1140
|
+
<p>The created project</p>
|
1141
|
+
</div>
|
1142
|
+
|
1143
|
+
</li>
|
1144
|
+
|
1145
|
+
</ul>
|
1146
|
+
|
1147
|
+
</div><table class="source_code">
|
1148
|
+
<tr>
|
1149
|
+
<td>
|
1150
|
+
<pre class="lines">
|
1151
|
+
|
1152
|
+
|
1153
|
+
67
|
1154
|
+
68
|
1155
|
+
69
|
1156
|
+
70
|
1157
|
+
71
|
1158
|
+
72
|
1159
|
+
73
|
1160
|
+
74
|
1161
|
+
75</pre>
|
1162
|
+
</td>
|
1163
|
+
<td>
|
1164
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 67</span>
|
1165
|
+
|
1166
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_project'>create_project</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>templatename:</span><span class='rparen'>)</span>
|
1167
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1168
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
1169
|
+
<span class='label'>templatename:</span> <span class='id identifier rubyid_templatename'>templatename</span>
|
1170
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
1171
|
+
|
1172
|
+
<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'>"</span><span class='tstring_content'>/projects</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>project</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1173
|
+
<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="../Project.html" title="StrawberryAPI::Project (class)">Project</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Project.html#initialize-instance_method" title="StrawberryAPI::Project#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1174
|
+
<span class='kw'>end</span></pre>
|
1175
|
+
</td>
|
1176
|
+
</tr>
|
1177
|
+
</table>
|
1178
|
+
</div>
|
1179
|
+
|
1180
|
+
<div class="method_details ">
|
1181
|
+
<h3 class="signature " id="destroy_project-instance_method">
|
1182
|
+
|
1183
|
+
#<strong>destroy_project</strong>(id:) ⇒ <tt>Boolean</tt>
|
1184
|
+
|
1185
|
+
|
1186
|
+
|
1187
|
+
|
1188
|
+
|
1189
|
+
</h3><div class="docstring">
|
1190
|
+
<div class="discussion">
|
1191
|
+
|
1192
|
+
<p>Deletes a project</p>
|
1193
|
+
|
1194
|
+
|
1195
|
+
</div>
|
1196
|
+
</div>
|
1197
|
+
<div class="tags">
|
1198
|
+
<p class="tag_title">Parameters:</p>
|
1199
|
+
<ul class="param">
|
1200
|
+
|
1201
|
+
<li>
|
1202
|
+
|
1203
|
+
<span class='name'>id</span>
|
1204
|
+
|
1205
|
+
|
1206
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1207
|
+
|
1208
|
+
|
1209
|
+
|
1210
|
+
—
|
1211
|
+
<div class='inline'>
|
1212
|
+
<p>Id of the project to delete</p>
|
1213
|
+
</div>
|
1214
|
+
|
1215
|
+
</li>
|
1216
|
+
|
1217
|
+
</ul>
|
1218
|
+
|
1219
|
+
<p class="tag_title">Returns:</p>
|
1220
|
+
<ul class="return">
|
1221
|
+
|
1222
|
+
<li>
|
1223
|
+
|
1224
|
+
|
1225
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1226
|
+
|
1227
|
+
|
1228
|
+
|
1229
|
+
—
|
1230
|
+
<div class='inline'>
|
1231
|
+
<p>Success</p>
|
1232
|
+
</div>
|
1233
|
+
|
1234
|
+
</li>
|
1235
|
+
|
1236
|
+
</ul>
|
1237
|
+
|
1238
|
+
</div><table class="source_code">
|
1239
|
+
<tr>
|
1240
|
+
<td>
|
1241
|
+
<pre class="lines">
|
1242
|
+
|
1243
|
+
|
1244
|
+
83
|
1245
|
+
84
|
1246
|
+
85</pre>
|
1247
|
+
</td>
|
1248
|
+
<td>
|
1249
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 83</span>
|
1250
|
+
|
1251
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy_project'>destroy_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1252
|
+
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
|
1253
|
+
<span class='kw'>end</span></pre>
|
1254
|
+
</td>
|
1255
|
+
</tr>
|
1256
|
+
</table>
|
1257
|
+
</div>
|
1258
|
+
|
1259
|
+
<div class="method_details ">
|
1260
|
+
<h3 class="signature " id="forceclose_project-instance_method">
|
1261
|
+
|
1262
|
+
#<strong>forceclose_project</strong>(id:, edit:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
1263
|
+
|
1264
|
+
|
1265
|
+
|
1266
|
+
|
1267
|
+
|
1268
|
+
</h3><div class="docstring">
|
1269
|
+
<div class="discussion">
|
1270
|
+
|
1271
|
+
<p>Forcecloses a project</p>
|
1272
|
+
|
1273
|
+
|
1274
|
+
</div>
|
1275
|
+
</div>
|
1276
|
+
<div class="tags">
|
1277
|
+
<p class="tag_title">Parameters:</p>
|
1278
|
+
<ul class="param">
|
1279
|
+
|
1280
|
+
<li>
|
1281
|
+
|
1282
|
+
<span class='name'>id</span>
|
1283
|
+
|
1284
|
+
|
1285
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1286
|
+
|
1287
|
+
|
1288
|
+
|
1289
|
+
—
|
1290
|
+
<div class='inline'>
|
1291
|
+
<p>Id of the project to forceclose</p>
|
1292
|
+
</div>
|
1293
|
+
|
1294
|
+
</li>
|
1295
|
+
|
1296
|
+
</ul>
|
1297
|
+
|
1298
|
+
<p class="tag_title">Returns:</p>
|
1299
|
+
<ul class="return">
|
1300
|
+
|
1301
|
+
<li>
|
1302
|
+
|
1303
|
+
|
1304
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
1305
|
+
|
1306
|
+
|
1307
|
+
|
1308
|
+
—
|
1309
|
+
<div class='inline'>
|
1310
|
+
<p>The operation status</p>
|
1311
|
+
</div>
|
1312
|
+
|
1313
|
+
</li>
|
1314
|
+
|
1315
|
+
</ul>
|
1316
|
+
|
1317
|
+
</div><table class="source_code">
|
1318
|
+
<tr>
|
1319
|
+
<td>
|
1320
|
+
<pre class="lines">
|
1321
|
+
|
1322
|
+
|
1323
|
+
125
|
1324
|
+
126
|
1325
|
+
127
|
1326
|
+
128</pre>
|
1327
|
+
</td>
|
1328
|
+
<td>
|
1329
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 125</span>
|
1330
|
+
|
1331
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_forceclose_project'>forceclose_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>edit:</span><span class='rparen'>)</span>
|
1332
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/forceclose</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-FLAVOURSYS-EDIT</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_edit'>edit</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1333
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1334
|
+
<span class='kw'>end</span></pre>
|
1335
|
+
</td>
|
1336
|
+
</tr>
|
1337
|
+
</table>
|
1338
|
+
</div>
|
1339
|
+
|
1340
|
+
<div class="method_details ">
|
1341
|
+
<h3 class="signature " id="library_projects-instance_method">
|
1342
|
+
|
1343
|
+
#<strong>library_projects</strong> ⇒ <tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>
|
1344
|
+
|
1345
|
+
|
1346
|
+
|
1347
|
+
|
1348
|
+
|
1349
|
+
</h3><div class="docstring">
|
1350
|
+
<div class="discussion">
|
1351
|
+
|
1352
|
+
<p>Fetches all library projects</p>
|
1353
|
+
|
1354
|
+
|
1355
|
+
</div>
|
1356
|
+
</div>
|
1357
|
+
<div class="tags">
|
1358
|
+
|
1359
|
+
<p class="tag_title">Returns:</p>
|
1360
|
+
<ul class="return">
|
1361
|
+
|
1362
|
+
<li>
|
1363
|
+
|
1364
|
+
|
1365
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>)</span>
|
1366
|
+
|
1367
|
+
|
1368
|
+
|
1369
|
+
—
|
1370
|
+
<div class='inline'>
|
1371
|
+
<p>A list of library projects</p>
|
1372
|
+
</div>
|
1373
|
+
|
1374
|
+
</li>
|
1375
|
+
|
1376
|
+
</ul>
|
1377
|
+
|
1378
|
+
</div><table class="source_code">
|
1379
|
+
<tr>
|
1380
|
+
<td>
|
1381
|
+
<pre class="lines">
|
1382
|
+
|
1383
|
+
|
1384
|
+
21
|
1385
|
+
22
|
1386
|
+
23
|
1387
|
+
24
|
1388
|
+
25</pre>
|
1389
|
+
</td>
|
1390
|
+
<td>
|
1391
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 21</span>
|
1392
|
+
|
1393
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_library_projects'>library_projects</span>
|
1394
|
+
<span class='id identifier rubyid_projects'>projects</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='op'>|</span>
|
1395
|
+
<span class='op'>!</span><span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_deleted'>deleted</span> <span class='op'>&&</span> <span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_is_library_project'>is_library_project</span>
|
1396
|
+
<span class='kw'>end</span>
|
1397
|
+
<span class='kw'>end</span></pre>
|
1398
|
+
</td>
|
1399
|
+
</tr>
|
1400
|
+
</table>
|
1401
|
+
</div>
|
1402
|
+
|
1403
|
+
<div class="method_details ">
|
1404
|
+
<h3 class="signature " id="mount_project-instance_method">
|
1405
|
+
|
1406
|
+
#<strong>mount_project</strong>(id:, edit:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
1407
|
+
|
1408
|
+
|
1409
|
+
|
1410
|
+
|
1411
|
+
|
1412
|
+
</h3><div class="docstring">
|
1413
|
+
<div class="discussion">
|
1414
|
+
|
1415
|
+
<p>Mounts a project</p>
|
1416
|
+
|
1417
|
+
|
1418
|
+
</div>
|
1419
|
+
</div>
|
1420
|
+
<div class="tags">
|
1421
|
+
<p class="tag_title">Parameters:</p>
|
1422
|
+
<ul class="param">
|
1423
|
+
|
1424
|
+
<li>
|
1425
|
+
|
1426
|
+
<span class='name'>id</span>
|
1427
|
+
|
1428
|
+
|
1429
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1430
|
+
|
1431
|
+
|
1432
|
+
|
1433
|
+
—
|
1434
|
+
<div class='inline'>
|
1435
|
+
<p>Id of the project to mount</p>
|
1436
|
+
</div>
|
1437
|
+
|
1438
|
+
</li>
|
1439
|
+
|
1440
|
+
</ul>
|
1441
|
+
|
1442
|
+
<p class="tag_title">Returns:</p>
|
1443
|
+
<ul class="return">
|
1444
|
+
|
1445
|
+
<li>
|
1446
|
+
|
1447
|
+
|
1448
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
1449
|
+
|
1450
|
+
|
1451
|
+
|
1452
|
+
—
|
1453
|
+
<div class='inline'>
|
1454
|
+
<p>The operation status</p>
|
1455
|
+
</div>
|
1456
|
+
|
1457
|
+
</li>
|
1458
|
+
|
1459
|
+
</ul>
|
1460
|
+
|
1461
|
+
</div><table class="source_code">
|
1462
|
+
<tr>
|
1463
|
+
<td>
|
1464
|
+
<pre class="lines">
|
1465
|
+
|
1466
|
+
|
1467
|
+
136
|
1468
|
+
137
|
1469
|
+
138
|
1470
|
+
139</pre>
|
1471
|
+
</td>
|
1472
|
+
<td>
|
1473
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 136</span>
|
1474
|
+
|
1475
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_mount_project'>mount_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>edit:</span><span class='rparen'>)</span>
|
1476
|
+
<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'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/mount</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-FLAVOURSYS-EDIT</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_edit'>edit</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1477
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1478
|
+
<span class='kw'>end</span></pre>
|
1479
|
+
</td>
|
1480
|
+
</tr>
|
1481
|
+
</table>
|
1482
|
+
</div>
|
1483
|
+
|
1484
|
+
<div class="method_details ">
|
1485
|
+
<h3 class="signature " id="online_projects-instance_method">
|
1486
|
+
|
1487
|
+
#<strong>online_projects</strong> ⇒ <tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>
|
1488
|
+
|
1489
|
+
|
1490
|
+
|
1491
|
+
|
1492
|
+
|
1493
|
+
</h3><div class="docstring">
|
1494
|
+
<div class="discussion">
|
1495
|
+
|
1496
|
+
<p>Fetches all online projects</p>
|
1497
|
+
|
1498
|
+
|
1499
|
+
</div>
|
1500
|
+
</div>
|
1501
|
+
<div class="tags">
|
1502
|
+
|
1503
|
+
<p class="tag_title">Returns:</p>
|
1504
|
+
<ul class="return">
|
1505
|
+
|
1506
|
+
<li>
|
1507
|
+
|
1508
|
+
|
1509
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>)</span>
|
1510
|
+
|
1511
|
+
|
1512
|
+
|
1513
|
+
—
|
1514
|
+
<div class='inline'>
|
1515
|
+
<p>A list of online projects</p>
|
1516
|
+
</div>
|
1517
|
+
|
1518
|
+
</li>
|
1519
|
+
|
1520
|
+
</ul>
|
1521
|
+
|
1522
|
+
</div><table class="source_code">
|
1523
|
+
<tr>
|
1524
|
+
<td>
|
1525
|
+
<pre class="lines">
|
1526
|
+
|
1527
|
+
|
1528
|
+
32
|
1529
|
+
33
|
1530
|
+
34
|
1531
|
+
35
|
1532
|
+
36</pre>
|
1533
|
+
</td>
|
1534
|
+
<td>
|
1535
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 32</span>
|
1536
|
+
|
1537
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_online_projects'>online_projects</span>
|
1538
|
+
<span class='id identifier rubyid_projects'>projects</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='op'>|</span>
|
1539
|
+
<span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_archive_strategy_id'>archive_strategy_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_deleted'>deleted</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_project'>project</span><span class='period'>.</span><span class='id identifier rubyid_is_library_project'>is_library_project</span>
|
1540
|
+
<span class='kw'>end</span>
|
1541
|
+
<span class='kw'>end</span></pre>
|
1542
|
+
</td>
|
1543
|
+
</tr>
|
1544
|
+
</table>
|
1545
|
+
</div>
|
1546
|
+
|
1547
|
+
<div class="method_details ">
|
1548
|
+
<h3 class="signature " id="open_project-instance_method">
|
1549
|
+
|
1550
|
+
#<strong>open_project</strong>(id:) ⇒ <tt>Boolean</tt>
|
1551
|
+
|
1552
|
+
|
1553
|
+
|
1554
|
+
|
1555
|
+
|
1556
|
+
</h3><div class="docstring">
|
1557
|
+
<div class="discussion">
|
1558
|
+
|
1559
|
+
<p>Opens a project</p>
|
1560
|
+
|
1561
|
+
|
1562
|
+
</div>
|
1563
|
+
</div>
|
1564
|
+
<div class="tags">
|
1565
|
+
<p class="tag_title">Parameters:</p>
|
1566
|
+
<ul class="param">
|
1567
|
+
|
1568
|
+
<li>
|
1569
|
+
|
1570
|
+
<span class='name'>id</span>
|
1571
|
+
|
1572
|
+
|
1573
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1574
|
+
|
1575
|
+
|
1576
|
+
|
1577
|
+
—
|
1578
|
+
<div class='inline'>
|
1579
|
+
<p>Id of the project to open</p>
|
1580
|
+
</div>
|
1581
|
+
|
1582
|
+
</li>
|
1583
|
+
|
1584
|
+
</ul>
|
1585
|
+
|
1586
|
+
<p class="tag_title">Returns:</p>
|
1587
|
+
<ul class="return">
|
1588
|
+
|
1589
|
+
<li>
|
1590
|
+
|
1591
|
+
|
1592
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1593
|
+
|
1594
|
+
|
1595
|
+
|
1596
|
+
—
|
1597
|
+
<div class='inline'>
|
1598
|
+
<p>Success</p>
|
1599
|
+
</div>
|
1600
|
+
|
1601
|
+
</li>
|
1602
|
+
|
1603
|
+
</ul>
|
1604
|
+
|
1605
|
+
</div><table class="source_code">
|
1606
|
+
<tr>
|
1607
|
+
<td>
|
1608
|
+
<pre class="lines">
|
1609
|
+
|
1610
|
+
|
1611
|
+
93
|
1612
|
+
94
|
1613
|
+
95</pre>
|
1614
|
+
</td>
|
1615
|
+
<td>
|
1616
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 93</span>
|
1617
|
+
|
1618
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_open_project'>open_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1619
|
+
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/open</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
|
1620
|
+
<span class='kw'>end</span></pre>
|
1621
|
+
</td>
|
1622
|
+
</tr>
|
1623
|
+
</table>
|
1624
|
+
</div>
|
1625
|
+
|
1626
|
+
<div class="method_details ">
|
1627
|
+
<h3 class="signature " id="project-instance_method">
|
1628
|
+
|
1629
|
+
#<strong>project</strong>(id:) ⇒ <tt><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span></tt>
|
1630
|
+
|
1631
|
+
|
1632
|
+
|
1633
|
+
|
1634
|
+
|
1635
|
+
</h3><div class="docstring">
|
1636
|
+
<div class="discussion">
|
1637
|
+
|
1638
|
+
<p>Fetches a project</p>
|
1639
|
+
|
1640
|
+
|
1641
|
+
</div>
|
1642
|
+
</div>
|
1643
|
+
<div class="tags">
|
1644
|
+
<p class="tag_title">Parameters:</p>
|
1645
|
+
<ul class="param">
|
1646
|
+
|
1647
|
+
<li>
|
1648
|
+
|
1649
|
+
<span class='name'>id</span>
|
1650
|
+
|
1651
|
+
|
1652
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1653
|
+
|
1654
|
+
|
1655
|
+
|
1656
|
+
—
|
1657
|
+
<div class='inline'>
|
1658
|
+
<p>Id of the project to retrieve</p>
|
1659
|
+
</div>
|
1660
|
+
|
1661
|
+
</li>
|
1662
|
+
|
1663
|
+
</ul>
|
1664
|
+
|
1665
|
+
<p class="tag_title">Returns:</p>
|
1666
|
+
<ul class="return">
|
1667
|
+
|
1668
|
+
<li>
|
1669
|
+
|
1670
|
+
|
1671
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span></tt>)</span>
|
1672
|
+
|
1673
|
+
|
1674
|
+
|
1675
|
+
—
|
1676
|
+
<div class='inline'>
|
1677
|
+
<p>The fetched project</p>
|
1678
|
+
</div>
|
1679
|
+
|
1680
|
+
</li>
|
1681
|
+
|
1682
|
+
</ul>
|
1683
|
+
|
1684
|
+
</div><table class="source_code">
|
1685
|
+
<tr>
|
1686
|
+
<td>
|
1687
|
+
<pre class="lines">
|
1688
|
+
|
1689
|
+
|
1690
|
+
55
|
1691
|
+
56
|
1692
|
+
57
|
1693
|
+
58</pre>
|
1694
|
+
</td>
|
1695
|
+
<td>
|
1696
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 55</span>
|
1697
|
+
|
1698
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project'>project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1699
|
+
<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'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>project</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1700
|
+
<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="../Project.html" title="StrawberryAPI::Project (class)">Project</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Project.html#initialize-instance_method" title="StrawberryAPI::Project#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1701
|
+
<span class='kw'>end</span></pre>
|
1702
|
+
</td>
|
1703
|
+
</tr>
|
1704
|
+
</table>
|
1705
|
+
</div>
|
1706
|
+
|
1707
|
+
<div class="method_details ">
|
1708
|
+
<h3 class="signature " id="project_assets-instance_method">
|
1709
|
+
|
1710
|
+
#<strong>project_assets</strong>(id:) ⇒ <tt>Array<<span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span>></tt>
|
1711
|
+
|
1712
|
+
|
1713
|
+
|
1714
|
+
|
1715
|
+
|
1716
|
+
</h3><div class="docstring">
|
1717
|
+
<div class="discussion">
|
1718
|
+
|
1719
|
+
<p>Fetches a project assets</p>
|
1720
|
+
|
1721
|
+
|
1722
|
+
</div>
|
1723
|
+
</div>
|
1724
|
+
<div class="tags">
|
1725
|
+
<p class="tag_title">Parameters:</p>
|
1726
|
+
<ul class="param">
|
1727
|
+
|
1728
|
+
<li>
|
1729
|
+
|
1730
|
+
<span class='name'>id</span>
|
1731
|
+
|
1732
|
+
|
1733
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1734
|
+
|
1735
|
+
|
1736
|
+
|
1737
|
+
—
|
1738
|
+
<div class='inline'>
|
1739
|
+
<p>Id of the project to retrieve which to retrieve assets from</p>
|
1740
|
+
</div>
|
1741
|
+
|
1742
|
+
</li>
|
1743
|
+
|
1744
|
+
</ul>
|
1745
|
+
|
1746
|
+
<p class="tag_title">Returns:</p>
|
1747
|
+
<ul class="return">
|
1748
|
+
|
1749
|
+
<li>
|
1750
|
+
|
1751
|
+
|
1752
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Asset.html" title="StrawberryAPI::Asset (class)">StrawberryAPI::Asset</a></span>></tt>)</span>
|
1753
|
+
|
1754
|
+
|
1755
|
+
|
1756
|
+
—
|
1757
|
+
<div class='inline'>
|
1758
|
+
<p>The fetched project assets</p>
|
1759
|
+
</div>
|
1760
|
+
|
1761
|
+
</li>
|
1762
|
+
|
1763
|
+
</ul>
|
1764
|
+
|
1765
|
+
</div><table class="source_code">
|
1766
|
+
<tr>
|
1767
|
+
<td>
|
1768
|
+
<pre class="lines">
|
1769
|
+
|
1770
|
+
|
1771
|
+
287
|
1772
|
+
288
|
1773
|
+
289
|
1774
|
+
290
|
1775
|
+
291
|
1776
|
+
292</pre>
|
1777
|
+
</td>
|
1778
|
+
<td>
|
1779
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 287</span>
|
1780
|
+
|
1781
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project_assets'>project_assets</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1782
|
+
<span class='id identifier rubyid_assets'>assets</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/assets</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>assets</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1783
|
+
<span class='id identifier rubyid_assets'>assets</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_asset'>asset</span><span class='op'>|</span>
|
1784
|
+
<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>
|
1785
|
+
<span class='kw'>end</span>
|
1786
|
+
<span class='kw'>end</span></pre>
|
1787
|
+
</td>
|
1788
|
+
</tr>
|
1789
|
+
</table>
|
1790
|
+
</div>
|
1791
|
+
|
1792
|
+
<div class="method_details ">
|
1793
|
+
<h3 class="signature " id="project_custom_metadata-instance_method">
|
1794
|
+
|
1795
|
+
#<strong>project_custom_metadata</strong>(id:) ⇒ <tt>Array<StrawberryAPI::CustomMetadata></tt>
|
1796
|
+
|
1797
|
+
|
1798
|
+
|
1799
|
+
|
1800
|
+
|
1801
|
+
</h3><div class="docstring">
|
1802
|
+
<div class="discussion">
|
1803
|
+
|
1804
|
+
<p>Fetches a project custom metadata</p>
|
1805
|
+
|
1806
|
+
|
1807
|
+
</div>
|
1808
|
+
</div>
|
1809
|
+
<div class="tags">
|
1810
|
+
<p class="tag_title">Parameters:</p>
|
1811
|
+
<ul class="param">
|
1812
|
+
|
1813
|
+
<li>
|
1814
|
+
|
1815
|
+
<span class='name'>id</span>
|
1816
|
+
|
1817
|
+
|
1818
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1819
|
+
|
1820
|
+
|
1821
|
+
|
1822
|
+
—
|
1823
|
+
<div class='inline'>
|
1824
|
+
<p>Id of the project to retrieve custom metadata from</p>
|
1825
|
+
</div>
|
1826
|
+
|
1827
|
+
</li>
|
1828
|
+
|
1829
|
+
</ul>
|
1830
|
+
|
1831
|
+
<p class="tag_title">Returns:</p>
|
1832
|
+
<ul class="return">
|
1833
|
+
|
1834
|
+
<li>
|
1835
|
+
|
1836
|
+
|
1837
|
+
<span class='type'>(<tt>Array<StrawberryAPI::CustomMetadata></tt>)</span>
|
1838
|
+
|
1839
|
+
|
1840
|
+
|
1841
|
+
—
|
1842
|
+
<div class='inline'>
|
1843
|
+
<p>The fetched project custom metadata</p>
|
1844
|
+
</div>
|
1845
|
+
|
1846
|
+
</li>
|
1847
|
+
|
1848
|
+
</ul>
|
1849
|
+
|
1850
|
+
</div><table class="source_code">
|
1851
|
+
<tr>
|
1852
|
+
<td>
|
1853
|
+
<pre class="lines">
|
1854
|
+
|
1855
|
+
|
1856
|
+
274
|
1857
|
+
275
|
1858
|
+
276
|
1859
|
+
277
|
1860
|
+
278
|
1861
|
+
279</pre>
|
1862
|
+
</td>
|
1863
|
+
<td>
|
1864
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 274</span>
|
1865
|
+
|
1866
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project_custom_metadata'>project_custom_metadata</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1867
|
+
<span class='id identifier rubyid_custom_metadata'>custom_metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</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'>"</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'>'</span><span class='tstring_content'>array</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1868
|
+
<span class='id identifier rubyid_custom_metadata'>custom_metadata</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_custom_metadata'>custom_metadata</span><span class='op'>|</span>
|
1869
|
+
<span class='const'><span class='object_link'><a href="CustomMetadata.html" title="StrawberryAPI::Client::CustomMetadata (module)">CustomMetadata</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../HttpClient.html#initialize-instance_method" title="StrawberryAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_custom_metadata'>custom_metadata</span><span class='rparen'>)</span>
|
1870
|
+
<span class='kw'>end</span>
|
1871
|
+
<span class='kw'>end</span></pre>
|
1872
|
+
</td>
|
1873
|
+
</tr>
|
1874
|
+
</table>
|
1875
|
+
</div>
|
1876
|
+
|
1877
|
+
<div class="method_details ">
|
1878
|
+
<h3 class="signature " id="project_effective_access_rights-instance_method">
|
1879
|
+
|
1880
|
+
#<strong>project_effective_access_rights</strong>(id:) ⇒ <tt>Array<<span class='object_link'><a href="../AccessRight.html" title="StrawberryAPI::AccessRight (class)">StrawberryAPI::AccessRight</a></span>></tt>
|
1881
|
+
|
1882
|
+
|
1883
|
+
|
1884
|
+
|
1885
|
+
|
1886
|
+
</h3><div class="docstring">
|
1887
|
+
<div class="discussion">
|
1888
|
+
|
1889
|
+
<p>Fetches all access rights of a project</p>
|
1890
|
+
|
1891
|
+
|
1892
|
+
</div>
|
1893
|
+
</div>
|
1894
|
+
<div class="tags">
|
1895
|
+
<p class="tag_title">Parameters:</p>
|
1896
|
+
<ul class="param">
|
1897
|
+
|
1898
|
+
<li>
|
1899
|
+
|
1900
|
+
<span class='name'>id</span>
|
1901
|
+
|
1902
|
+
|
1903
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1904
|
+
|
1905
|
+
|
1906
|
+
|
1907
|
+
—
|
1908
|
+
<div class='inline'>
|
1909
|
+
<p>Id of the project to retrieve access rights from</p>
|
1910
|
+
</div>
|
1911
|
+
|
1912
|
+
</li>
|
1913
|
+
|
1914
|
+
</ul>
|
1915
|
+
|
1916
|
+
<p class="tag_title">Returns:</p>
|
1917
|
+
<ul class="return">
|
1918
|
+
|
1919
|
+
<li>
|
1920
|
+
|
1921
|
+
|
1922
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../AccessRight.html" title="StrawberryAPI::AccessRight (class)">StrawberryAPI::AccessRight</a></span>></tt>)</span>
|
1923
|
+
|
1924
|
+
|
1925
|
+
|
1926
|
+
—
|
1927
|
+
<div class='inline'>
|
1928
|
+
<p>The fetched project access rights</p>
|
1929
|
+
</div>
|
1930
|
+
|
1931
|
+
</li>
|
1932
|
+
|
1933
|
+
</ul>
|
1934
|
+
|
1935
|
+
</div><table class="source_code">
|
1936
|
+
<tr>
|
1937
|
+
<td>
|
1938
|
+
<pre class="lines">
|
1939
|
+
|
1940
|
+
|
1941
|
+
223
|
1942
|
+
224
|
1943
|
+
225
|
1944
|
+
226
|
1945
|
+
227
|
1946
|
+
228</pre>
|
1947
|
+
</td>
|
1948
|
+
<td>
|
1949
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 223</span>
|
1950
|
+
|
1951
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project_effective_access_rights'>project_effective_access_rights</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
1952
|
+
<span class='id identifier rubyid_access_rights'>access_rights</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/effective_access_rights</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>hash</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1953
|
+
<span class='id identifier rubyid_access_rights'>access_rights</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_accessright'>accessright</span><span class='op'>|</span>
|
1954
|
+
<span class='const'><span class='object_link'><a href="../AccessRight.html" title="StrawberryAPI::AccessRight (class)">AccessRight</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../AccessRight.html#initialize-instance_method" title="StrawberryAPI::AccessRight#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_accessright'>accessright</span><span class='rparen'>)</span>
|
1955
|
+
<span class='kw'>end</span>
|
1956
|
+
<span class='kw'>end</span></pre>
|
1957
|
+
</td>
|
1958
|
+
</tr>
|
1959
|
+
</table>
|
1960
|
+
</div>
|
1961
|
+
|
1962
|
+
<div class="method_details ">
|
1963
|
+
<h3 class="signature " id="project_status_flags-instance_method">
|
1964
|
+
|
1965
|
+
#<strong>project_status_flags</strong>(id:) ⇒ <tt>Hash</tt>
|
1966
|
+
|
1967
|
+
|
1968
|
+
|
1969
|
+
|
1970
|
+
|
1971
|
+
</h3><div class="docstring">
|
1972
|
+
<div class="discussion">
|
1973
|
+
|
1974
|
+
<p>Fetches a project status flags</p>
|
1975
|
+
|
1976
|
+
|
1977
|
+
</div>
|
1978
|
+
</div>
|
1979
|
+
<div class="tags">
|
1980
|
+
<p class="tag_title">Parameters:</p>
|
1981
|
+
<ul class="param">
|
1982
|
+
|
1983
|
+
<li>
|
1984
|
+
|
1985
|
+
<span class='name'>id</span>
|
1986
|
+
|
1987
|
+
|
1988
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1989
|
+
|
1990
|
+
|
1991
|
+
|
1992
|
+
—
|
1993
|
+
<div class='inline'>
|
1994
|
+
<p>Id of the project to retrieve status flags from</p>
|
1995
|
+
</div>
|
1996
|
+
|
1997
|
+
</li>
|
1998
|
+
|
1999
|
+
</ul>
|
2000
|
+
|
2001
|
+
<p class="tag_title">Returns:</p>
|
2002
|
+
<ul class="return">
|
2003
|
+
|
2004
|
+
<li>
|
2005
|
+
|
2006
|
+
|
2007
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2008
|
+
|
2009
|
+
|
2010
|
+
|
2011
|
+
—
|
2012
|
+
<div class='inline'>
|
2013
|
+
<p>The fetched project status flags</p>
|
2014
|
+
</div>
|
2015
|
+
|
2016
|
+
</li>
|
2017
|
+
|
2018
|
+
</ul>
|
2019
|
+
|
2020
|
+
</div><table class="source_code">
|
2021
|
+
<tr>
|
2022
|
+
<td>
|
2023
|
+
<pre class="lines">
|
2024
|
+
|
2025
|
+
|
2026
|
+
264
|
2027
|
+
265
|
2028
|
+
266</pre>
|
2029
|
+
</td>
|
2030
|
+
<td>
|
2031
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 264</span>
|
2032
|
+
|
2033
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project_status_flags'>project_status_flags</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
2034
|
+
<span class='id identifier rubyid_status_flags'>status_flags</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/status_flags</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>array</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
2035
|
+
<span class='kw'>end</span></pre>
|
2036
|
+
</td>
|
2037
|
+
</tr>
|
2038
|
+
</table>
|
2039
|
+
</div>
|
2040
|
+
|
2041
|
+
<div class="method_details ">
|
2042
|
+
<h3 class="signature " id="project_teams-instance_method">
|
2043
|
+
|
2044
|
+
#<strong>project_teams</strong>(id:) ⇒ <tt>Array<<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>></tt>
|
2045
|
+
|
2046
|
+
|
2047
|
+
|
2048
|
+
|
2049
|
+
|
2050
|
+
</h3><div class="docstring">
|
2051
|
+
<div class="discussion">
|
2052
|
+
|
2053
|
+
<p>Fetches all teams assigned to a project</p>
|
2054
|
+
|
2055
|
+
|
2056
|
+
</div>
|
2057
|
+
</div>
|
2058
|
+
<div class="tags">
|
2059
|
+
<p class="tag_title">Parameters:</p>
|
2060
|
+
<ul class="param">
|
2061
|
+
|
2062
|
+
<li>
|
2063
|
+
|
2064
|
+
<span class='name'>id</span>
|
2065
|
+
|
2066
|
+
|
2067
|
+
<span class='type'>(<tt>Interger</tt>)</span>
|
2068
|
+
|
2069
|
+
|
2070
|
+
|
2071
|
+
—
|
2072
|
+
<div class='inline'>
|
2073
|
+
<p>If of the project to retrieve teams from</p>
|
2074
|
+
</div>
|
2075
|
+
|
2076
|
+
</li>
|
2077
|
+
|
2078
|
+
</ul>
|
2079
|
+
|
2080
|
+
<p class="tag_title">Returns:</p>
|
2081
|
+
<ul class="return">
|
2082
|
+
|
2083
|
+
<li>
|
2084
|
+
|
2085
|
+
|
2086
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Team.html" title="StrawberryAPI::Team (class)">StrawberryAPI::Team</a></span>></tt>)</span>
|
2087
|
+
|
2088
|
+
|
2089
|
+
|
2090
|
+
—
|
2091
|
+
<div class='inline'>
|
2092
|
+
<p>The fetched project teams</p>
|
2093
|
+
</div>
|
2094
|
+
|
2095
|
+
</li>
|
2096
|
+
|
2097
|
+
</ul>
|
2098
|
+
|
2099
|
+
</div><table class="source_code">
|
2100
|
+
<tr>
|
2101
|
+
<td>
|
2102
|
+
<pre class="lines">
|
2103
|
+
|
2104
|
+
|
2105
|
+
210
|
2106
|
+
211
|
2107
|
+
212
|
2108
|
+
213
|
2109
|
+
214
|
2110
|
+
215</pre>
|
2111
|
+
</td>
|
2112
|
+
<td>
|
2113
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 210</span>
|
2114
|
+
|
2115
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project_teams'>project_teams</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
2116
|
+
<span class='id identifier rubyid_teams'>teams</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>array</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
2117
|
+
<span class='id identifier rubyid_teams'>teams</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_team'>team</span><span class='op'>|</span>
|
2118
|
+
<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='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span>
|
2119
|
+
<span class='kw'>end</span>
|
2120
|
+
<span class='kw'>end</span></pre>
|
2121
|
+
</td>
|
2122
|
+
</tr>
|
2123
|
+
</table>
|
2124
|
+
</div>
|
2125
|
+
|
2126
|
+
<div class="method_details ">
|
2127
|
+
<h3 class="signature " id="projects-instance_method">
|
2128
|
+
|
2129
|
+
#<strong>projects</strong> ⇒ <tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>
|
2130
|
+
|
2131
|
+
|
2132
|
+
|
2133
|
+
|
2134
|
+
|
2135
|
+
</h3><div class="docstring">
|
2136
|
+
<div class="discussion">
|
2137
|
+
|
2138
|
+
<p>Fetches all projects</p>
|
2139
|
+
|
2140
|
+
|
2141
|
+
</div>
|
2142
|
+
</div>
|
2143
|
+
<div class="tags">
|
2144
|
+
|
2145
|
+
<p class="tag_title">Returns:</p>
|
2146
|
+
<ul class="return">
|
2147
|
+
|
2148
|
+
<li>
|
2149
|
+
|
2150
|
+
|
2151
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>)</span>
|
2152
|
+
|
2153
|
+
|
2154
|
+
|
2155
|
+
—
|
2156
|
+
<div class='inline'>
|
2157
|
+
<p>A list of projects</p>
|
2158
|
+
</div>
|
2159
|
+
|
2160
|
+
</li>
|
2161
|
+
|
2162
|
+
</ul>
|
2163
|
+
|
2164
|
+
</div><table class="source_code">
|
2165
|
+
<tr>
|
2166
|
+
<td>
|
2167
|
+
<pre class="lines">
|
2168
|
+
|
2169
|
+
|
2170
|
+
10
|
2171
|
+
11
|
2172
|
+
12
|
2173
|
+
13
|
2174
|
+
14</pre>
|
2175
|
+
</td>
|
2176
|
+
<td>
|
2177
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 10</span>
|
2178
|
+
|
2179
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_projects'>projects</span>
|
2180
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>projects</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='op'>|</span>
|
2181
|
+
<span class='const'><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">Project</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Project.html#initialize-instance_method" title="StrawberryAPI::Project#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_project'>project</span><span class='rparen'>)</span>
|
2182
|
+
<span class='kw'>end</span>
|
2183
|
+
<span class='kw'>end</span></pre>
|
2184
|
+
</td>
|
2185
|
+
</tr>
|
2186
|
+
</table>
|
2187
|
+
</div>
|
2188
|
+
|
2189
|
+
<div class="method_details ">
|
2190
|
+
<h3 class="signature " id="projects_report-instance_method">
|
2191
|
+
|
2192
|
+
#<strong>projects_report</strong> ⇒ <tt>Hash</tt>
|
2193
|
+
|
2194
|
+
|
2195
|
+
|
2196
|
+
|
2197
|
+
|
2198
|
+
</h3><div class="docstring">
|
2199
|
+
<div class="discussion">
|
2200
|
+
|
2201
|
+
<p>Fetches projects report</p>
|
2202
|
+
|
2203
|
+
|
2204
|
+
</div>
|
2205
|
+
</div>
|
2206
|
+
<div class="tags">
|
2207
|
+
|
2208
|
+
<p class="tag_title">Returns:</p>
|
2209
|
+
<ul class="return">
|
2210
|
+
|
2211
|
+
<li>
|
2212
|
+
|
2213
|
+
|
2214
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2215
|
+
|
2216
|
+
|
2217
|
+
|
2218
|
+
—
|
2219
|
+
<div class='inline'>
|
2220
|
+
<p>The fetched projects report</p>
|
2221
|
+
</div>
|
2222
|
+
|
2223
|
+
</li>
|
2224
|
+
|
2225
|
+
</ul>
|
2226
|
+
|
2227
|
+
</div><table class="source_code">
|
2228
|
+
<tr>
|
2229
|
+
<td>
|
2230
|
+
<pre class="lines">
|
2231
|
+
|
2232
|
+
|
2233
|
+
299
|
2234
|
+
300
|
2235
|
+
301</pre>
|
2236
|
+
</td>
|
2237
|
+
<td>
|
2238
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 299</span>
|
2239
|
+
|
2240
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_projects_report'>projects_report</span>
|
2241
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects_report</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span>
|
2242
|
+
<span class='kw'>end</span></pre>
|
2243
|
+
</td>
|
2244
|
+
</tr>
|
2245
|
+
</table>
|
2246
|
+
</div>
|
2247
|
+
|
2248
|
+
<div class="method_details ">
|
2249
|
+
<h3 class="signature " id="refresh_mounted_project-instance_method">
|
2250
|
+
|
2251
|
+
#<strong>refresh_mounted_project</strong>(id:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
2252
|
+
|
2253
|
+
|
2254
|
+
|
2255
|
+
|
2256
|
+
|
2257
|
+
</h3><div class="docstring">
|
2258
|
+
<div class="discussion">
|
2259
|
+
|
2260
|
+
<p>Refreshes a mounted project</p>
|
2261
|
+
|
2262
|
+
|
2263
|
+
</div>
|
2264
|
+
</div>
|
2265
|
+
<div class="tags">
|
2266
|
+
<p class="tag_title">Parameters:</p>
|
2267
|
+
<ul class="param">
|
2268
|
+
|
2269
|
+
<li>
|
2270
|
+
|
2271
|
+
<span class='name'>id</span>
|
2272
|
+
|
2273
|
+
|
2274
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2275
|
+
|
2276
|
+
|
2277
|
+
|
2278
|
+
—
|
2279
|
+
<div class='inline'>
|
2280
|
+
<p>Id of the mounted project to refresh</p>
|
2281
|
+
</div>
|
2282
|
+
|
2283
|
+
</li>
|
2284
|
+
|
2285
|
+
</ul>
|
2286
|
+
|
2287
|
+
<p class="tag_title">Returns:</p>
|
2288
|
+
<ul class="return">
|
2289
|
+
|
2290
|
+
<li>
|
2291
|
+
|
2292
|
+
|
2293
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
2294
|
+
|
2295
|
+
|
2296
|
+
|
2297
|
+
—
|
2298
|
+
<div class='inline'>
|
2299
|
+
<p>The operation status</p>
|
2300
|
+
</div>
|
2301
|
+
|
2302
|
+
</li>
|
2303
|
+
|
2304
|
+
</ul>
|
2305
|
+
|
2306
|
+
</div><table class="source_code">
|
2307
|
+
<tr>
|
2308
|
+
<td>
|
2309
|
+
<pre class="lines">
|
2310
|
+
|
2311
|
+
|
2312
|
+
158
|
2313
|
+
159
|
2314
|
+
160
|
2315
|
+
161</pre>
|
2316
|
+
</td>
|
2317
|
+
<td>
|
2318
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 158</span>
|
2319
|
+
|
2320
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_refresh_mounted_project'>refresh_mounted_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
2321
|
+
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/refreshmountedproject</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-FLAVOURSYS-EDIT</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_edit'>edit</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
2322
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2323
|
+
<span class='kw'>end</span></pre>
|
2324
|
+
</td>
|
2325
|
+
</tr>
|
2326
|
+
</table>
|
2327
|
+
</div>
|
2328
|
+
|
2329
|
+
<div class="method_details ">
|
2330
|
+
<h3 class="signature " id="remove_team_from_project-instance_method">
|
2331
|
+
|
2332
|
+
#<strong>remove_team_from_project</strong>(id:, team_id:) ⇒ <tt>Boolean</tt>
|
2333
|
+
|
2334
|
+
|
2335
|
+
|
2336
|
+
|
2337
|
+
|
2338
|
+
</h3><div class="docstring">
|
2339
|
+
<div class="discussion">
|
2340
|
+
|
2341
|
+
<p>Removes a team from a project</p>
|
2342
|
+
|
2343
|
+
|
2344
|
+
</div>
|
2345
|
+
</div>
|
2346
|
+
<div class="tags">
|
2347
|
+
<p class="tag_title">Parameters:</p>
|
2348
|
+
<ul class="param">
|
2349
|
+
|
2350
|
+
<li>
|
2351
|
+
|
2352
|
+
<span class='name'>id</span>
|
2353
|
+
|
2354
|
+
|
2355
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2356
|
+
|
2357
|
+
|
2358
|
+
|
2359
|
+
—
|
2360
|
+
<div class='inline'>
|
2361
|
+
<p>Id of the project from which the team should be deleted</p>
|
2362
|
+
</div>
|
2363
|
+
|
2364
|
+
</li>
|
2365
|
+
|
2366
|
+
<li>
|
2367
|
+
|
2368
|
+
<span class='name'>team_id</span>
|
2369
|
+
|
2370
|
+
|
2371
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2372
|
+
|
2373
|
+
|
2374
|
+
|
2375
|
+
—
|
2376
|
+
<div class='inline'>
|
2377
|
+
<p>Id of the team to remove from the project</p>
|
2378
|
+
</div>
|
2379
|
+
|
2380
|
+
</li>
|
2381
|
+
|
2382
|
+
</ul>
|
2383
|
+
|
2384
|
+
<p class="tag_title">Returns:</p>
|
2385
|
+
<ul class="return">
|
2386
|
+
|
2387
|
+
<li>
|
2388
|
+
|
2389
|
+
|
2390
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
2391
|
+
|
2392
|
+
|
2393
|
+
|
2394
|
+
—
|
2395
|
+
<div class='inline'>
|
2396
|
+
<p>Success</p>
|
2397
|
+
</div>
|
2398
|
+
|
2399
|
+
</li>
|
2400
|
+
|
2401
|
+
</ul>
|
2402
|
+
|
2403
|
+
</div><table class="source_code">
|
2404
|
+
<tr>
|
2405
|
+
<td>
|
2406
|
+
<pre class="lines">
|
2407
|
+
|
2408
|
+
|
2409
|
+
254
|
2410
|
+
255
|
2411
|
+
256</pre>
|
2412
|
+
</td>
|
2413
|
+
<td>
|
2414
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 254</span>
|
2415
|
+
|
2416
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_team_from_project'>remove_team_from_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>team_id:</span><span class='rparen'>)</span>
|
2417
|
+
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/teams/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_team_id'>team_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
|
2418
|
+
<span class='kw'>end</span></pre>
|
2419
|
+
</td>
|
2420
|
+
</tr>
|
2421
|
+
</table>
|
2422
|
+
</div>
|
2423
|
+
|
2424
|
+
<div class="method_details ">
|
2425
|
+
<h3 class="signature " id="search_project-instance_method">
|
2426
|
+
|
2427
|
+
#<strong>search_project</strong>(name:) ⇒ <tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>
|
2428
|
+
|
2429
|
+
|
2430
|
+
|
2431
|
+
|
2432
|
+
|
2433
|
+
</h3><div class="docstring">
|
2434
|
+
<div class="discussion">
|
2435
|
+
|
2436
|
+
<p>Searches for a substring in project names</p>
|
2437
|
+
|
2438
|
+
|
2439
|
+
</div>
|
2440
|
+
</div>
|
2441
|
+
<div class="tags">
|
2442
|
+
<p class="tag_title">Parameters:</p>
|
2443
|
+
<ul class="param">
|
2444
|
+
|
2445
|
+
<li>
|
2446
|
+
|
2447
|
+
<span class='name'>name</span>
|
2448
|
+
|
2449
|
+
|
2450
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2451
|
+
|
2452
|
+
|
2453
|
+
|
2454
|
+
—
|
2455
|
+
<div class='inline'>
|
2456
|
+
<p>Substring to look for</p>
|
2457
|
+
</div>
|
2458
|
+
|
2459
|
+
</li>
|
2460
|
+
|
2461
|
+
</ul>
|
2462
|
+
|
2463
|
+
<p class="tag_title">Returns:</p>
|
2464
|
+
<ul class="return">
|
2465
|
+
|
2466
|
+
<li>
|
2467
|
+
|
2468
|
+
|
2469
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">StrawberryAPI::Project</a></span>></tt>)</span>
|
2470
|
+
|
2471
|
+
|
2472
|
+
|
2473
|
+
—
|
2474
|
+
<div class='inline'>
|
2475
|
+
<p>A list of project matching the substring</p>
|
2476
|
+
</div>
|
2477
|
+
|
2478
|
+
</li>
|
2479
|
+
|
2480
|
+
</ul>
|
2481
|
+
|
2482
|
+
</div><table class="source_code">
|
2483
|
+
<tr>
|
2484
|
+
<td>
|
2485
|
+
<pre class="lines">
|
2486
|
+
|
2487
|
+
|
2488
|
+
198
|
2489
|
+
199
|
2490
|
+
200
|
2491
|
+
201
|
2492
|
+
202</pre>
|
2493
|
+
</td>
|
2494
|
+
<td>
|
2495
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 198</span>
|
2496
|
+
|
2497
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_project'>search_project</span><span class='lparen'>(</span><span class='label'>name:</span><span class='rparen'>)</span>
|
2498
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/search</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='lbrace'>{</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>projects</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='op'>|</span>
|
2499
|
+
<span class='const'><span class='object_link'><a href="../Project.html" title="StrawberryAPI::Project (class)">Project</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Project.html#initialize-instance_method" title="StrawberryAPI::Project#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_project'>project</span><span class='rparen'>)</span>
|
2500
|
+
<span class='kw'>end</span>
|
2501
|
+
<span class='kw'>end</span></pre>
|
2502
|
+
</td>
|
2503
|
+
</tr>
|
2504
|
+
</table>
|
2505
|
+
</div>
|
2506
|
+
|
2507
|
+
<div class="method_details ">
|
2508
|
+
<h3 class="signature " id="sync_project-instance_method">
|
2509
|
+
|
2510
|
+
#<strong>sync_project</strong>(id:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
2511
|
+
|
2512
|
+
|
2513
|
+
|
2514
|
+
|
2515
|
+
|
2516
|
+
</h3><div class="docstring">
|
2517
|
+
<div class="discussion">
|
2518
|
+
|
2519
|
+
<p>Syncs a project</p>
|
2520
|
+
|
2521
|
+
|
2522
|
+
</div>
|
2523
|
+
</div>
|
2524
|
+
<div class="tags">
|
2525
|
+
<p class="tag_title">Parameters:</p>
|
2526
|
+
<ul class="param">
|
2527
|
+
|
2528
|
+
<li>
|
2529
|
+
|
2530
|
+
<span class='name'>id</span>
|
2531
|
+
|
2532
|
+
|
2533
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2534
|
+
|
2535
|
+
|
2536
|
+
|
2537
|
+
—
|
2538
|
+
<div class='inline'>
|
2539
|
+
<p>Id of the project to sync</p>
|
2540
|
+
</div>
|
2541
|
+
|
2542
|
+
</li>
|
2543
|
+
|
2544
|
+
</ul>
|
2545
|
+
|
2546
|
+
<p class="tag_title">Returns:</p>
|
2547
|
+
<ul class="return">
|
2548
|
+
|
2549
|
+
<li>
|
2550
|
+
|
2551
|
+
|
2552
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
2553
|
+
|
2554
|
+
|
2555
|
+
|
2556
|
+
—
|
2557
|
+
<div class='inline'>
|
2558
|
+
<p>The operation status</p>
|
2559
|
+
</div>
|
2560
|
+
|
2561
|
+
</li>
|
2562
|
+
|
2563
|
+
</ul>
|
2564
|
+
|
2565
|
+
</div><table class="source_code">
|
2566
|
+
<tr>
|
2567
|
+
<td>
|
2568
|
+
<pre class="lines">
|
2569
|
+
|
2570
|
+
|
2571
|
+
103
|
2572
|
+
104
|
2573
|
+
105
|
2574
|
+
106</pre>
|
2575
|
+
</td>
|
2576
|
+
<td>
|
2577
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 103</span>
|
2578
|
+
|
2579
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sync_project'>sync_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
2580
|
+
<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'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/sync</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
2581
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2582
|
+
<span class='kw'>end</span></pre>
|
2583
|
+
</td>
|
2584
|
+
</tr>
|
2585
|
+
</table>
|
2586
|
+
</div>
|
2587
|
+
|
2588
|
+
<div class="method_details ">
|
2589
|
+
<h3 class="signature " id="umount_project-instance_method">
|
2590
|
+
|
2591
|
+
#<strong>umount_project</strong>(id:, edit:) ⇒ <tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>
|
2592
|
+
|
2593
|
+
|
2594
|
+
|
2595
|
+
|
2596
|
+
|
2597
|
+
</h3><div class="docstring">
|
2598
|
+
<div class="discussion">
|
2599
|
+
|
2600
|
+
<p>Unmounts a project</p>
|
2601
|
+
|
2602
|
+
|
2603
|
+
</div>
|
2604
|
+
</div>
|
2605
|
+
<div class="tags">
|
2606
|
+
<p class="tag_title">Parameters:</p>
|
2607
|
+
<ul class="param">
|
2608
|
+
|
2609
|
+
<li>
|
2610
|
+
|
2611
|
+
<span class='name'>id</span>
|
2612
|
+
|
2613
|
+
|
2614
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2615
|
+
|
2616
|
+
|
2617
|
+
|
2618
|
+
—
|
2619
|
+
<div class='inline'>
|
2620
|
+
<p>Id of the project to unmount</p>
|
2621
|
+
</div>
|
2622
|
+
|
2623
|
+
</li>
|
2624
|
+
|
2625
|
+
</ul>
|
2626
|
+
|
2627
|
+
<p class="tag_title">Returns:</p>
|
2628
|
+
<ul class="return">
|
2629
|
+
|
2630
|
+
<li>
|
2631
|
+
|
2632
|
+
|
2633
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">StrawberryAPI::ProjectFeedback</a></span></tt>)</span>
|
2634
|
+
|
2635
|
+
|
2636
|
+
|
2637
|
+
—
|
2638
|
+
<div class='inline'>
|
2639
|
+
<p>The operation status</p>
|
2640
|
+
</div>
|
2641
|
+
|
2642
|
+
</li>
|
2643
|
+
|
2644
|
+
</ul>
|
2645
|
+
|
2646
|
+
</div><table class="source_code">
|
2647
|
+
<tr>
|
2648
|
+
<td>
|
2649
|
+
<pre class="lines">
|
2650
|
+
|
2651
|
+
|
2652
|
+
147
|
2653
|
+
148
|
2654
|
+
149
|
2655
|
+
150</pre>
|
2656
|
+
</td>
|
2657
|
+
<td>
|
2658
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 147</span>
|
2659
|
+
|
2660
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_umount_project'>umount_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='comma'>,</span> <span class='label'>edit:</span><span class='rparen'>)</span>
|
2661
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/umount</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-FLAVOURSYS-EDIT</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_edit'>edit</span><span class='rbrace'>}</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'>'</span><span class='tstring_content'>job</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
2662
|
+
<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="../ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProjectFeedback.html#initialize-instance_method" title="StrawberryAPI::ProjectFeedback#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2663
|
+
<span class='kw'>end</span></pre>
|
2664
|
+
</td>
|
2665
|
+
</tr>
|
2666
|
+
</table>
|
2667
|
+
</div>
|
2668
|
+
|
2669
|
+
<div class="method_details ">
|
2670
|
+
<h3 class="signature " id="unarchive_project-instance_method">
|
2671
|
+
|
2672
|
+
#<strong>unarchive_project</strong>(id:) ⇒ <tt><span class='object_link'><a href="../ArchiveStrategyState.html" title="StrawberryAPI::ArchiveStrategyState (class)">StrawberryAPI::ArchiveStrategyState</a></span></tt>
|
2673
|
+
|
2674
|
+
|
2675
|
+
|
2676
|
+
|
2677
|
+
|
2678
|
+
</h3><div class="docstring">
|
2679
|
+
<div class="discussion">
|
2680
|
+
|
2681
|
+
<p>Unarchives a project</p>
|
2682
|
+
|
2683
|
+
|
2684
|
+
</div>
|
2685
|
+
</div>
|
2686
|
+
<div class="tags">
|
2687
|
+
<p class="tag_title">Parameters:</p>
|
2688
|
+
<ul class="param">
|
2689
|
+
|
2690
|
+
<li>
|
2691
|
+
|
2692
|
+
<span class='name'>id</span>
|
2693
|
+
|
2694
|
+
|
2695
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
2696
|
+
|
2697
|
+
|
2698
|
+
|
2699
|
+
—
|
2700
|
+
<div class='inline'>
|
2701
|
+
<p>Id of the project to unarchive</p>
|
2702
|
+
</div>
|
2703
|
+
|
2704
|
+
</li>
|
2705
|
+
|
2706
|
+
</ul>
|
2707
|
+
|
2708
|
+
<p class="tag_title">Returns:</p>
|
2709
|
+
<ul class="return">
|
2710
|
+
|
2711
|
+
<li>
|
2712
|
+
|
2713
|
+
|
2714
|
+
<span class='type'>(<tt><span class='object_link'><a href="../ArchiveStrategyState.html" title="StrawberryAPI::ArchiveStrategyState (class)">StrawberryAPI::ArchiveStrategyState</a></span></tt>)</span>
|
2715
|
+
|
2716
|
+
|
2717
|
+
|
2718
|
+
—
|
2719
|
+
<div class='inline'>
|
2720
|
+
<p>The operation status</p>
|
2721
|
+
</div>
|
2722
|
+
|
2723
|
+
</li>
|
2724
|
+
|
2725
|
+
</ul>
|
2726
|
+
|
2727
|
+
</div><table class="source_code">
|
2728
|
+
<tr>
|
2729
|
+
<td>
|
2730
|
+
<pre class="lines">
|
2731
|
+
|
2732
|
+
|
2733
|
+
186
|
2734
|
+
187
|
2735
|
+
188
|
2736
|
+
189
|
2737
|
+
190</pre>
|
2738
|
+
</td>
|
2739
|
+
<td>
|
2740
|
+
<pre class="code"><span class="info file"># File 'lib/strawberry_api/client/projects.rb', line 186</span>
|
2741
|
+
|
2742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_unarchive_project'>unarchive_project</span><span class='lparen'>(</span><span class='label'>id:</span><span class='rparen'>)</span>
|
2743
|
+
<span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/projects/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/unarchive</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>archivestrategystate</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_state'>state</span><span class='op'>|</span>
|
2744
|
+
<span class='const'><span class='object_link'><a href="../ArchiveStrategyState.html" title="StrawberryAPI::ArchiveStrategyState (class)">ArchiveStrategyState</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ArchiveStrategyState.html#initialize-instance_method" title="StrawberryAPI::ArchiveStrategyState#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
|
2745
|
+
<span class='kw'>end</span>
|
2746
|
+
<span class='kw'>end</span></pre>
|
2747
|
+
</td>
|
2748
|
+
</tr>
|
2749
|
+
</table>
|
2750
|
+
</div>
|
2751
|
+
|
2752
|
+
</div>
|
2753
|
+
|
2754
|
+
</div>
|
2755
|
+
|
2756
|
+
<div id="footer">
|
2757
|
+
Generated on Thu Aug 30 12:51:40 2018 by
|
2758
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2759
|
+
0.9.16 (ruby-2.5.0).
|
2760
|
+
</div>
|
2761
|
+
|
2762
|
+
</div>
|
2763
|
+
</body>
|
2764
|
+
</html>
|