shotgrid_api_ruby 0.1.3.3 → 0.2.0.1
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 +4 -4
- data/.github/workflows/test_and_publish.yml +2 -0
- data/.github/workflows/test_only.yml +2 -0
- data/.gitignore +3 -0
- data/.overcommit.yml +9 -0
- data/.rubocop.yml +2 -0
- data/CHANGELOG.md +11 -1
- data/Gemfile +18 -0
- data/Guardfile +2 -2
- data/bin/generate_and_add_documentation +1 -0
- data/bin/generate_sorbet_coverage +3 -0
- data/bin/prettirun +1 -1
- data/bin/sorbet_check +1 -0
- data/bin/tapioca +29 -0
- data/docs/ShotgridApiRuby/Auth/Validator.html +319 -0
- data/docs/ShotgridApiRuby/Auth.html +1079 -0
- data/docs/ShotgridApiRuby/Client.html +933 -0
- data/docs/ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html +124 -0
- data/docs/ShotgridApiRuby/Entities/Params.html +1377 -0
- data/docs/ShotgridApiRuby/Entities/Schema.html +646 -0
- data/docs/ShotgridApiRuby/Entities/Summarize/Summary.html +401 -0
- data/docs/ShotgridApiRuby/Entities/Summarize.html +775 -0
- data/docs/ShotgridApiRuby/Entities.html +2461 -0
- data/docs/ShotgridApiRuby/Entity.html +935 -0
- data/docs/ShotgridApiRuby/Preferences.html +417 -0
- data/docs/ShotgridApiRuby/ServerInfo.html +415 -0
- data/docs/ShotgridApiRuby/ShotgridCallError.html +328 -0
- data/docs/ShotgridApiRuby/Types.html +136 -0
- data/docs/ShotgridApiRuby.html +307 -0
- data/docs/_index.html +253 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +578 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +578 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +643 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/shotgrid_api_ruby/auth.rb +89 -33
- data/lib/shotgrid_api_ruby/client.rb +50 -7
- data/lib/shotgrid_api_ruby/entities/params.rb +304 -65
- data/lib/shotgrid_api_ruby/entities/schema.rb +18 -3
- data/lib/shotgrid_api_ruby/entities/summarize.rb +39 -7
- data/lib/shotgrid_api_ruby/entities.rb +118 -29
- data/lib/shotgrid_api_ruby/entity.rb +29 -12
- data/lib/shotgrid_api_ruby/preferences.rb +7 -1
- data/lib/shotgrid_api_ruby/server_info.rb +7 -1
- data/lib/shotgrid_api_ruby/shotgrid_call_error.rb +5 -1
- data/lib/shotgrid_api_ruby/types/auth_type.rb +23 -0
- data/lib/shotgrid_api_ruby/version.rb +2 -1
- data/lib/shotgrid_api_ruby.rb +20 -2
- data/shotgrid_api_ruby.gemspec +2 -10
- data/sorbet/config +6 -0
- data/sorbet/rbi/faraday.rbi +20 -0
- data/sorbet/rbi/gems/activesupport@6.1.4.1.rbi +3770 -0
- data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
- data/sorbet/rbi/gems/backport@1.2.0.rbi +8 -0
- data/sorbet/rbi/gems/benchmark@0.1.1.rbi +65 -0
- data/sorbet/rbi/gems/bundler-audit@0.8.0.rbi +8 -0
- data/sorbet/rbi/gems/byebug@11.1.3.rbi +1569 -0
- data/sorbet/rbi/gems/childprocess@4.1.0.rbi +8 -0
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +1005 -0
- data/sorbet/rbi/gems/colorize@0.8.1.rbi +39 -0
- data/sorbet/rbi/gems/commander@4.6.0.rbi +8 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2403 -0
- data/sorbet/rbi/gems/diff-lcs@1.4.4.rbi +8 -0
- data/sorbet/rbi/gems/docile@1.4.0.rbi +54 -0
- data/sorbet/rbi/gems/dotenv@2.7.6.rbi +88 -0
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +8 -0
- data/sorbet/rbi/gems/faker@2.19.0.rbi +2513 -0
- data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +101 -0
- data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +78 -0
- data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +77 -0
- data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +73 -0
- data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +82 -0
- data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +72 -0
- data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +74 -0
- data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +73 -0
- data/sorbet/rbi/gems/faraday@1.7.0.rbi +783 -0
- data/sorbet/rbi/gems/ffi@1.15.3.rbi +8 -0
- data/sorbet/rbi/gems/formatador@0.3.0.rbi +8 -0
- data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +8 -0
- data/sorbet/rbi/gems/guard-rspec@4.7.3.rbi +8 -0
- data/sorbet/rbi/gems/guard@2.18.0.rbi +8 -0
- data/sorbet/rbi/gems/haml@5.2.2.rbi +8 -0
- data/sorbet/rbi/gems/highline@2.0.3.rbi +8 -0
- data/sorbet/rbi/gems/i18n@1.8.10.rbi +584 -0
- data/sorbet/rbi/gems/iniparse@1.5.0.rbi +8 -0
- data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +8 -0
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +8 -0
- data/sorbet/rbi/gems/kramdown@2.3.1.rbi +8 -0
- data/sorbet/rbi/gems/listen@3.7.0.rbi +476 -0
- data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +8 -0
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +72 -0
- data/sorbet/rbi/gems/minitest@5.14.4.rbi +344 -0
- data/sorbet/rbi/gems/multipart-post@2.1.1.rbi +69 -0
- data/sorbet/rbi/gems/nenv@0.3.0.rbi +8 -0
- data/sorbet/rbi/gems/nokogiri@1.12.3.rbi +8 -0
- data/sorbet/rbi/gems/notiffany@0.1.3.rbi +8 -0
- data/sorbet/rbi/gems/overcommit@0.58.0.rbi +8 -0
- data/sorbet/rbi/gems/parallel@1.20.1.rbi +8 -0
- data/sorbet/rbi/gems/parlour@6.0.1.rbi +1610 -0
- data/sorbet/rbi/gems/parser@3.0.2.0.rbi +1731 -0
- data/sorbet/rbi/gems/prettier@1.6.1.rbi +8 -0
- data/sorbet/rbi/gems/pry-byebug@3.9.0.rbi +461 -0
- data/sorbet/rbi/gems/pry@0.13.1.rbi +2553 -0
- data/sorbet/rbi/gems/racc@1.5.2.rbi +47 -0
- data/sorbet/rbi/gems/rainbow@3.0.0.rbi +153 -0
- data/sorbet/rbi/gems/rake@13.0.6.rbi +807 -0
- data/sorbet/rbi/gems/rb-fsevent@0.11.0.rbi +8 -0
- data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +8 -0
- data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +8 -0
- data/sorbet/rbi/gems/reverse_markdown@2.0.0.rbi +8 -0
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +672 -0
- data/sorbet/rbi/gems/rspec-core@3.10.1.rbi +2500 -0
- data/sorbet/rbi/gems/rspec-expectations@3.10.1.rbi +1574 -0
- data/sorbet/rbi/gems/rspec-mocks@3.10.2.rbi +1462 -0
- data/sorbet/rbi/gems/rspec-support@3.10.2.rbi +510 -0
- data/sorbet/rbi/gems/rspec@3.10.0.rbi +39 -0
- data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +196 -0
- data/sorbet/rbi/gems/rubocop-ast@1.11.0.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-performance@1.11.5.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi +8 -0
- data/sorbet/rbi/gems/rubocop@1.20.0.rbi +8 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +8 -0
- data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +8 -0
- data/sorbet/rbi/gems/shellany@0.0.1.rbi +8 -0
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +89 -0
- data/sorbet/rbi/gems/simplecov@0.21.2.rbi +577 -0
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi +8 -0
- data/sorbet/rbi/gems/solargraph@0.43.0.rbi +8 -0
- data/sorbet/rbi/gems/spoom@1.1.2.rbi +1204 -0
- data/sorbet/rbi/gems/tapioca@0.4.25.rbi +1239 -0
- data/sorbet/rbi/gems/temple@0.8.2.rbi +8 -0
- data/sorbet/rbi/gems/thor@1.1.0.rbi +838 -0
- data/sorbet/rbi/gems/tilt@2.0.10.rbi +8 -0
- data/sorbet/rbi/gems/timecop@0.9.4.rbi +82 -0
- data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +857 -0
- data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +8 -0
- data/sorbet/rbi/gems/unparser@0.6.0.rbi +8 -0
- data/sorbet/rbi/gems/vcr@6.0.0.rbi +782 -0
- data/sorbet/rbi/gems/yard-sorbet@0.5.3.rbi +8 -0
- data/sorbet/rbi/gems/yard@0.9.26.rbi +8 -0
- data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +173 -0
- data/sorbet/tapioca/config +0 -0
- data/sorbet/tapioca/require.rb +5 -0
- metadata +144 -127
|
@@ -0,0 +1,2461 @@
|
|
|
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
|
+
Class: ShotgridApiRuby::Entities
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ShotgridApiRuby::Entities";
|
|
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 (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Entities</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>Class: ShotgridApiRuby::Entities
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ShotgridApiRuby::Entities</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<dl>
|
|
89
|
+
<dt>Extended by:</dt>
|
|
90
|
+
<dd>T::Sig</dd>
|
|
91
|
+
</dl>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/shotgrid_api_ruby/entities.rb<span class="defines">,<br />
|
|
103
|
+
lib/shotgrid_api_ruby/entities/params.rb,<br /> lib/shotgrid_api_ruby/entities/schema.rb,<br /> lib/shotgrid_api_ruby/entities/summarize.rb</span>
|
|
104
|
+
</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Defined Under Namespace</h2>
|
|
110
|
+
<p class="children">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span>, <span class='object_link'><a href="Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span>, <span class='object_link'><a href="Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</p>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
124
|
+
<ul class="summary">
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong> ⇒ Faraday::Connection </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="note title readonly">readonly</span>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
149
|
+
|
|
150
|
+
</li>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<li class="public ">
|
|
154
|
+
<span class="summary_signature">
|
|
155
|
+
|
|
156
|
+
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ String </a>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
</span>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="note title readonly">readonly</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<h2>
|
|
187
|
+
Instance Method Summary
|
|
188
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
189
|
+
</h2>
|
|
190
|
+
|
|
191
|
+
<ul class="summary">
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#all-instance_method" title="#all (instance method)">#<strong>all</strong>(fields: nil, logical_operator: 'and', sort: nil, filter: nil, page: nil, page_size: nil, retired: nil, include_archived_projects: nil) ⇒ Array<Entity> </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<li class="public ">
|
|
216
|
+
<span class="summary_signature">
|
|
217
|
+
|
|
218
|
+
<a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong>(filter: nil, logical_operator: 'and') ⇒ T.untyped </a>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
233
|
+
|
|
234
|
+
</li>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<li class="public ">
|
|
238
|
+
<span class="summary_signature">
|
|
239
|
+
|
|
240
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(attributes) ⇒ ShotgridApiRuby::Entity </a>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
255
|
+
|
|
256
|
+
</li>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<li class="public ">
|
|
260
|
+
<span class="summary_signature">
|
|
261
|
+
|
|
262
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id) ⇒ true </a>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
</span>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
277
|
+
|
|
278
|
+
</li>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<li class="public ">
|
|
282
|
+
<span class="summary_signature">
|
|
283
|
+
|
|
284
|
+
<a href="#fields-instance_method" title="#fields (instance method)">#<strong>fields</strong> ⇒ OpenStruct </a>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#find-instance_method" title="#find (instance method)">#<strong>find</strong>(id, fields: nil, retired: nil, include_archived_projects: nil) ⇒ ShotgridApiRuby::Entity </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#first-instance_method" title="#first (instance method)">#<strong>first</strong>(fields: nil, sort: nil, filter: nil, retired: nil, include_archived_projects: nil, logical_operator: 'and') ⇒ Entity<sup>?</sup> </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
343
|
+
|
|
344
|
+
</li>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<li class="public ">
|
|
348
|
+
<span class="summary_signature">
|
|
349
|
+
|
|
350
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(connection, type) ⇒ void </a>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
</span>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<span class="note title constructor">constructor</span>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
367
|
+
|
|
368
|
+
</li>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<li class="public ">
|
|
372
|
+
<span class="summary_signature">
|
|
373
|
+
|
|
374
|
+
<a href="#revive-instance_method" title="#revive (instance method)">#<strong>revive</strong>(id) ⇒ true </a>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</span>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
389
|
+
|
|
390
|
+
</li>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
<li class="public ">
|
|
394
|
+
<span class="summary_signature">
|
|
395
|
+
|
|
396
|
+
<a href="#schema-instance_method" title="#schema (instance method)">#<strong>schema</strong> ⇒ OpenStruct </a>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</span>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
411
|
+
|
|
412
|
+
</li>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<li class="public ">
|
|
416
|
+
<span class="summary_signature">
|
|
417
|
+
|
|
418
|
+
<a href="#schema_client-instance_method" title="#schema_client (instance method)">#<strong>schema_client</strong> ⇒ Schema </a>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
</span>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
433
|
+
|
|
434
|
+
</li>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<li class="public ">
|
|
438
|
+
<span class="summary_signature">
|
|
439
|
+
|
|
440
|
+
<a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(fields: nil, logical_operator: 'and', sort: nil, filter: nil, page: nil, page_size: nil, retired: nil, include_archived_projects: nil) ⇒ Array<Entity> </a>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
</span>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
455
|
+
|
|
456
|
+
</li>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
<li class="public ">
|
|
460
|
+
<span class="summary_signature">
|
|
461
|
+
|
|
462
|
+
<a href="#summarize-instance_method" title="#summarize (instance method)">#<strong>summarize</strong>(filter: nil, grouping: nil, summary_fields: nil, logical_operator: 'and', include_archived_projects: nil) ⇒ Summarize::Summary </a>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</span>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
477
|
+
|
|
478
|
+
</li>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<li class="public ">
|
|
482
|
+
<span class="summary_signature">
|
|
483
|
+
|
|
484
|
+
<a href="#summary_client-instance_method" title="#summary_client (instance method)">#<strong>summary_client</strong> ⇒ Summarize </a>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</span>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
499
|
+
|
|
500
|
+
</li>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<li class="public ">
|
|
504
|
+
<span class="summary_signature">
|
|
505
|
+
|
|
506
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id, changes) ⇒ ShotgridApiRuby::Entity </a>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</span>
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
521
|
+
|
|
522
|
+
</li>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
</ul>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div id="constructor_details" class="method_details_list">
|
|
530
|
+
<h2>Constructor Details</h2>
|
|
531
|
+
|
|
532
|
+
<div class="method_details first">
|
|
533
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
534
|
+
|
|
535
|
+
#<strong>initialize</strong>(connection, type) ⇒ <tt>void</tt>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</h3><div class="docstring">
|
|
542
|
+
<div class="discussion">
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</div>
|
|
546
|
+
</div>
|
|
547
|
+
<div class="tags">
|
|
548
|
+
<p class="tag_title">Parameters:</p>
|
|
549
|
+
<ul class="param">
|
|
550
|
+
|
|
551
|
+
<li>
|
|
552
|
+
|
|
553
|
+
<span class='name'>connection</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</li>
|
|
561
|
+
|
|
562
|
+
<li>
|
|
563
|
+
|
|
564
|
+
<span class='name'>type</span>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
</li>
|
|
572
|
+
|
|
573
|
+
</ul>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
</div><table class="source_code">
|
|
577
|
+
<tr>
|
|
578
|
+
<td>
|
|
579
|
+
<pre class="lines">
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
11
|
|
583
|
+
12
|
|
584
|
+
13
|
|
585
|
+
14
|
|
586
|
+
15
|
|
587
|
+
16
|
|
588
|
+
17
|
|
589
|
+
18</pre>
|
|
590
|
+
</td>
|
|
591
|
+
<td>
|
|
592
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 11</span>
|
|
593
|
+
|
|
594
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
595
|
+
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='comma'>,</span> <span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Connection</span><span class='rparen'>)</span>
|
|
596
|
+
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
|
|
597
|
+
<span class='ivar'>@base_url_prefix</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_url_prefix'>url_prefix</span><span class='comma'>,</span> <span class='const'>URI</span><span class='rparen'>)</span>
|
|
598
|
+
<span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_url_prefix'>url_prefix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_url_prefix'>url_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/entity/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
599
|
+
<span class='ivar'>@schema_client</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
600
|
+
<span class='ivar'>@summary_client</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
601
|
+
<span class='kw'>end</span></pre>
|
|
602
|
+
</td>
|
|
603
|
+
</tr>
|
|
604
|
+
</table>
|
|
605
|
+
</div>
|
|
606
|
+
|
|
607
|
+
</div>
|
|
608
|
+
|
|
609
|
+
<div id="instance_attr_details" class="attr_details">
|
|
610
|
+
<h2>Instance Attribute Details</h2>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span id=""></span>
|
|
614
|
+
<div class="method_details first">
|
|
615
|
+
<h3 class="signature first" id="connection-instance_method">
|
|
616
|
+
|
|
617
|
+
#<strong>connection</strong> ⇒ <tt>Faraday::Connection</tt> <span class="extras">(readonly)</span>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</h3><div class="docstring">
|
|
624
|
+
<div class="discussion">
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
</div>
|
|
628
|
+
</div>
|
|
629
|
+
<div class="tags">
|
|
630
|
+
|
|
631
|
+
<p class="tag_title">Returns:</p>
|
|
632
|
+
<ul class="return">
|
|
633
|
+
|
|
634
|
+
<li>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
</li>
|
|
642
|
+
|
|
643
|
+
</ul>
|
|
644
|
+
|
|
645
|
+
</div><table class="source_code">
|
|
646
|
+
<tr>
|
|
647
|
+
<td>
|
|
648
|
+
<pre class="lines">
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
21
|
|
652
|
+
22
|
|
653
|
+
23</pre>
|
|
654
|
+
</td>
|
|
655
|
+
<td>
|
|
656
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 21</span>
|
|
657
|
+
|
|
658
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
|
|
659
|
+
<span class='ivar'>@connection</span>
|
|
660
|
+
<span class='kw'>end</span></pre>
|
|
661
|
+
</td>
|
|
662
|
+
</tr>
|
|
663
|
+
</table>
|
|
664
|
+
</div>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<span id=""></span>
|
|
668
|
+
<div class="method_details ">
|
|
669
|
+
<h3 class="signature " id="type-instance_method">
|
|
670
|
+
|
|
671
|
+
#<strong>type</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
</h3><div class="docstring">
|
|
678
|
+
<div class="discussion">
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
</div>
|
|
682
|
+
</div>
|
|
683
|
+
<div class="tags">
|
|
684
|
+
|
|
685
|
+
<p class="tag_title">Returns:</p>
|
|
686
|
+
<ul class="return">
|
|
687
|
+
|
|
688
|
+
<li>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</li>
|
|
696
|
+
|
|
697
|
+
</ul>
|
|
698
|
+
|
|
699
|
+
</div><table class="source_code">
|
|
700
|
+
<tr>
|
|
701
|
+
<td>
|
|
702
|
+
<pre class="lines">
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
24
|
|
706
|
+
25
|
|
707
|
+
26</pre>
|
|
708
|
+
</td>
|
|
709
|
+
<td>
|
|
710
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 24</span>
|
|
711
|
+
|
|
712
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
|
|
713
|
+
<span class='ivar'>@type</span>
|
|
714
|
+
<span class='kw'>end</span></pre>
|
|
715
|
+
</td>
|
|
716
|
+
</tr>
|
|
717
|
+
</table>
|
|
718
|
+
</div>
|
|
719
|
+
|
|
720
|
+
</div>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
<div id="instance_method_details" class="method_details_list">
|
|
724
|
+
<h2>Instance Method Details</h2>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
<div class="method_details first">
|
|
728
|
+
<h3 class="signature first" id="all-instance_method">
|
|
729
|
+
|
|
730
|
+
#<strong>all</strong>(fields: nil, logical_operator: 'and', sort: nil, filter: nil, page: nil, page_size: nil, retired: nil, include_archived_projects: nil) ⇒ <tt>Array<<span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>></tt>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</h3><div class="docstring">
|
|
737
|
+
<div class="discussion">
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
</div>
|
|
741
|
+
</div>
|
|
742
|
+
<div class="tags">
|
|
743
|
+
<p class="tag_title">Parameters:</p>
|
|
744
|
+
<ul class="param">
|
|
745
|
+
|
|
746
|
+
<li>
|
|
747
|
+
|
|
748
|
+
<span class='name'>fields</span>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FIELDS_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FIELDS_TYPE (constant)">Params::FIELDS_TYPE</a></span></tt>)</span>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
</li>
|
|
758
|
+
|
|
759
|
+
<li>
|
|
760
|
+
|
|
761
|
+
<span class='name'>logical_operator</span>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#LOGICAL_OPERATOR_TYPE-constant" title="ShotgridApiRuby::Entities::Params::LOGICAL_OPERATOR_TYPE (constant)">Params::LOGICAL_OPERATOR_TYPE</a></span></tt>)</span>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
</li>
|
|
771
|
+
|
|
772
|
+
<li>
|
|
773
|
+
|
|
774
|
+
<span class='name'>sort</span>
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#SORT_TYPE-constant" title="ShotgridApiRuby::Entities::Params::SORT_TYPE (constant)">Params::SORT_TYPE</a></span></tt>)</span>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</li>
|
|
784
|
+
|
|
785
|
+
<li>
|
|
786
|
+
|
|
787
|
+
<span class='name'>filter</span>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FILTERS_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FILTERS_FIELD_TYPE (constant)">Params::FILTERS_FIELD_TYPE</a></span></tt>)</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
</li>
|
|
797
|
+
|
|
798
|
+
<li>
|
|
799
|
+
|
|
800
|
+
<span class='name'>page</span>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#PAGE_TYPE-constant" title="ShotgridApiRuby::Entities::Params::PAGE_TYPE (constant)">Params::PAGE_TYPE</a></span></tt>)</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
</li>
|
|
810
|
+
|
|
811
|
+
<li>
|
|
812
|
+
|
|
813
|
+
<span class='name'>page_size</span>
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#PAGE_SIZE_TYPE-constant" title="ShotgridApiRuby::Entities::Params::PAGE_SIZE_TYPE (constant)">Params::PAGE_SIZE_TYPE</a></span></tt>)</span>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
</li>
|
|
823
|
+
|
|
824
|
+
<li>
|
|
825
|
+
|
|
826
|
+
<span class='name'>retired</span>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
</li>
|
|
836
|
+
|
|
837
|
+
<li>
|
|
838
|
+
|
|
839
|
+
<span class='name'>include_archived_projects</span>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</li>
|
|
849
|
+
|
|
850
|
+
</ul>
|
|
851
|
+
|
|
852
|
+
<p class="tag_title">Returns:</p>
|
|
853
|
+
<ul class="return">
|
|
854
|
+
|
|
855
|
+
<li>
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>></tt>)</span>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
</li>
|
|
863
|
+
|
|
864
|
+
</ul>
|
|
865
|
+
|
|
866
|
+
</div><table class="source_code">
|
|
867
|
+
<tr>
|
|
868
|
+
<td>
|
|
869
|
+
<pre class="lines">
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
205
|
|
873
|
+
206
|
|
874
|
+
207
|
|
875
|
+
208
|
|
876
|
+
209
|
|
877
|
+
210
|
|
878
|
+
211
|
|
879
|
+
212
|
|
880
|
+
213
|
|
881
|
+
214
|
|
882
|
+
215
|
|
883
|
+
216
|
|
884
|
+
217
|
|
885
|
+
218
|
|
886
|
+
219
|
|
887
|
+
220
|
|
888
|
+
221
|
|
889
|
+
222
|
|
890
|
+
223
|
|
891
|
+
224
|
|
892
|
+
225
|
|
893
|
+
226
|
|
894
|
+
227
|
|
895
|
+
228
|
|
896
|
+
229
|
|
897
|
+
230
|
|
898
|
+
231
|
|
899
|
+
232
|
|
900
|
+
233
|
|
901
|
+
234
|
|
902
|
+
235
|
|
903
|
+
236
|
|
904
|
+
237
|
|
905
|
+
238
|
|
906
|
+
239
|
|
907
|
+
240
|
|
908
|
+
241
|
|
909
|
+
242
|
|
910
|
+
243
|
|
911
|
+
244
|
|
912
|
+
245
|
|
913
|
+
246
|
|
914
|
+
247
|
|
915
|
+
248
|
|
916
|
+
249
|
|
917
|
+
250
|
|
918
|
+
251
|
|
919
|
+
252
|
|
920
|
+
253
|
|
921
|
+
254
|
|
922
|
+
255
|
|
923
|
+
256
|
|
924
|
+
257</pre>
|
|
925
|
+
</td>
|
|
926
|
+
<td>
|
|
927
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 205</span>
|
|
928
|
+
|
|
929
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span>
|
|
930
|
+
<span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
931
|
+
<span class='label'>logical_operator:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
932
|
+
<span class='label'>sort:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
933
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
934
|
+
<span class='label'>page:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
935
|
+
<span class='label'>page_size:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
936
|
+
<span class='label'>retired:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
937
|
+
<span class='label'>include_archived_projects:</span> <span class='kw'>nil</span>
|
|
938
|
+
<span class='rparen'>)</span>
|
|
939
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_filter'>filter</span> <span class='op'>&&</span> <span class='op'>!</span><span class='const'><span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span></span><span class='period'>.</span><span class='id identifier rubyid_filters_are_simple?'><span class='object_link'><a href="Entities/Params.html#filters_are_simple%3F-class_method" title="ShotgridApiRuby::Entities::Params.filters_are_simple? (method)">filters_are_simple?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_filter'>filter</span><span class='rparen'>)</span>
|
|
940
|
+
<span class='kw'>return</span><span class='lparen'>(</span>
|
|
941
|
+
<span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
|
|
942
|
+
<span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
|
|
943
|
+
<span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='comma'>,</span>
|
|
944
|
+
<span class='label'>sort:</span> <span class='id identifier rubyid_sort'>sort</span><span class='comma'>,</span>
|
|
945
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
946
|
+
<span class='label'>page:</span> <span class='id identifier rubyid_page'>page</span><span class='comma'>,</span>
|
|
947
|
+
<span class='label'>page_size:</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='comma'>,</span>
|
|
948
|
+
<span class='label'>retired:</span> <span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span>
|
|
949
|
+
<span class='label'>include_archived_projects:</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='comma'>,</span>
|
|
950
|
+
<span class='rparen'>)</span>
|
|
951
|
+
<span class='rparen'>)</span>
|
|
952
|
+
<span class='kw'>end</span>
|
|
953
|
+
|
|
954
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entities/Params.html#initialize-instance_method" title="ShotgridApiRuby::Entities::Params#initialize (method)">new</a></span></span>
|
|
955
|
+
|
|
956
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_fields'>add_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
|
|
957
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_sort'>add_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_sort'>sort</span><span class='rparen'>)</span>
|
|
958
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_filter'>add_filter</span><span class='lparen'>(</span><span class='id identifier rubyid_filter'>filter</span><span class='rparen'>)</span>
|
|
959
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_page'>add_page</span><span class='lparen'>(</span><span class='id identifier rubyid_page'>page</span><span class='comma'>,</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='rparen'>)</span>
|
|
960
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_options'>add_options</span><span class='lparen'>(</span><span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='rparen'>)</span>
|
|
961
|
+
|
|
962
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
963
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
964
|
+
|
|
965
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
966
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
967
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
968
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while getting </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
969
|
+
<span class='rparen'>)</span>
|
|
970
|
+
<span class='kw'>end</span>
|
|
971
|
+
|
|
972
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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_entity'>entity</span><span class='op'>|</span>
|
|
973
|
+
<span class='const'><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
974
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
975
|
+
<span class='label'>attributes:</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
976
|
+
<span class='label'>relationships:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>relationships</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
977
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
978
|
+
<span class='label'>links:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>links</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
979
|
+
<span class='rparen'>)</span>
|
|
980
|
+
<span class='kw'>end</span>
|
|
981
|
+
<span class='kw'>end</span></pre>
|
|
982
|
+
</td>
|
|
983
|
+
</tr>
|
|
984
|
+
</table>
|
|
985
|
+
</div>
|
|
986
|
+
|
|
987
|
+
<div class="method_details ">
|
|
988
|
+
<h3 class="signature " id="count-instance_method">
|
|
989
|
+
|
|
990
|
+
#<strong>count</strong>(filter: nil, logical_operator: 'and') ⇒ <tt>T.untyped</tt>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
</h3><div class="docstring">
|
|
997
|
+
<div class="discussion">
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
</div>
|
|
1001
|
+
</div>
|
|
1002
|
+
<div class="tags">
|
|
1003
|
+
<p class="tag_title">Parameters:</p>
|
|
1004
|
+
<ul class="param">
|
|
1005
|
+
|
|
1006
|
+
<li>
|
|
1007
|
+
|
|
1008
|
+
<span class='name'>filter</span>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FILTERS_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FILTERS_FIELD_TYPE (constant)">Params::FILTERS_FIELD_TYPE</a></span></tt>)</span>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
</li>
|
|
1018
|
+
|
|
1019
|
+
<li>
|
|
1020
|
+
|
|
1021
|
+
<span class='name'>logical_operator</span>
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#LOGICAL_OPERATOR_TYPE-constant" title="ShotgridApiRuby::Entities::Params::LOGICAL_OPERATOR_TYPE (constant)">Params::LOGICAL_OPERATOR_TYPE</a></span></tt>)</span>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
</li>
|
|
1031
|
+
|
|
1032
|
+
</ul>
|
|
1033
|
+
|
|
1034
|
+
<p class="tag_title">Returns:</p>
|
|
1035
|
+
<ul class="return">
|
|
1036
|
+
|
|
1037
|
+
<li>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
<span class='type'>(<tt>T.untyped</tt>)</span>
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
</li>
|
|
1045
|
+
|
|
1046
|
+
</ul>
|
|
1047
|
+
|
|
1048
|
+
</div><table class="source_code">
|
|
1049
|
+
<tr>
|
|
1050
|
+
<td>
|
|
1051
|
+
<pre class="lines">
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
365
|
|
1055
|
+
366
|
|
1056
|
+
367</pre>
|
|
1057
|
+
</td>
|
|
1058
|
+
<td>
|
|
1059
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 365</span>
|
|
1060
|
+
|
|
1061
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span><span class='lparen'>(</span><span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>logical_operator:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1062
|
+
<span class='id identifier rubyid_summary_client'>summary_client</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span><span class='lparen'>(</span><span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span> <span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='rparen'>)</span>
|
|
1063
|
+
<span class='kw'>end</span></pre>
|
|
1064
|
+
</td>
|
|
1065
|
+
</tr>
|
|
1066
|
+
</table>
|
|
1067
|
+
</div>
|
|
1068
|
+
|
|
1069
|
+
<div class="method_details ">
|
|
1070
|
+
<h3 class="signature " id="create-instance_method">
|
|
1071
|
+
|
|
1072
|
+
#<strong>create</strong>(attributes) ⇒ <tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</h3><div class="docstring">
|
|
1079
|
+
<div class="discussion">
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
</div>
|
|
1083
|
+
</div>
|
|
1084
|
+
<div class="tags">
|
|
1085
|
+
<p class="tag_title">Parameters:</p>
|
|
1086
|
+
<ul class="param">
|
|
1087
|
+
|
|
1088
|
+
<li>
|
|
1089
|
+
|
|
1090
|
+
<span class='name'>attributes</span>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<span class='type'>(<tt>Hash{String, Symbol => T.untyped}</tt>)</span>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
</li>
|
|
1098
|
+
|
|
1099
|
+
</ul>
|
|
1100
|
+
|
|
1101
|
+
<p class="tag_title">Returns:</p>
|
|
1102
|
+
<ul class="return">
|
|
1103
|
+
|
|
1104
|
+
<li>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>)</span>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
</li>
|
|
1112
|
+
|
|
1113
|
+
</ul>
|
|
1114
|
+
|
|
1115
|
+
</div><table class="source_code">
|
|
1116
|
+
<tr>
|
|
1117
|
+
<td>
|
|
1118
|
+
<pre class="lines">
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
95
|
|
1122
|
+
96
|
|
1123
|
+
97
|
|
1124
|
+
98
|
|
1125
|
+
99
|
|
1126
|
+
100
|
|
1127
|
+
101
|
|
1128
|
+
102
|
|
1129
|
+
103
|
|
1130
|
+
104
|
|
1131
|
+
105
|
|
1132
|
+
106
|
|
1133
|
+
107
|
|
1134
|
+
108
|
|
1135
|
+
109
|
|
1136
|
+
110
|
|
1137
|
+
111
|
|
1138
|
+
112
|
|
1139
|
+
113
|
|
1140
|
+
114
|
|
1141
|
+
115
|
|
1142
|
+
116
|
|
1143
|
+
117
|
|
1144
|
+
118
|
|
1145
|
+
119
|
|
1146
|
+
120
|
|
1147
|
+
121</pre>
|
|
1148
|
+
</td>
|
|
1149
|
+
<td>
|
|
1150
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 95</span>
|
|
1151
|
+
|
|
1152
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
|
1153
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span>
|
|
1154
|
+
<span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
|
|
1155
|
+
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
1156
|
+
<span class='kw'>end</span>
|
|
1157
|
+
|
|
1158
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1159
|
+
|
|
1160
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
1161
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1162
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
1163
|
+
<span class='label'>message:</span>
|
|
1164
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while creating </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'> with </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attributes'>attributes</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span>
|
|
1165
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
1166
|
+
<span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1167
|
+
<span class='rparen'>)</span>
|
|
1168
|
+
<span class='kw'>end</span>
|
|
1169
|
+
|
|
1170
|
+
<span class='id identifier rubyid_entity'>entity</span> <span class='op'>=</span> <span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
1171
|
+
<span class='const'><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1172
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1173
|
+
<span class='label'>attributes:</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1174
|
+
<span class='label'>relationships:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>relationships</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1175
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1176
|
+
<span class='label'>links:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>links</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1177
|
+
<span class='rparen'>)</span>
|
|
1178
|
+
<span class='kw'>end</span></pre>
|
|
1179
|
+
</td>
|
|
1180
|
+
</tr>
|
|
1181
|
+
</table>
|
|
1182
|
+
</div>
|
|
1183
|
+
|
|
1184
|
+
<div class="method_details ">
|
|
1185
|
+
<h3 class="signature " id="delete-instance_method">
|
|
1186
|
+
|
|
1187
|
+
#<strong>delete</strong>(id) ⇒ <tt>true</tt>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
</h3><div class="docstring">
|
|
1194
|
+
<div class="discussion">
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
</div>
|
|
1198
|
+
</div>
|
|
1199
|
+
<div class="tags">
|
|
1200
|
+
<p class="tag_title">Parameters:</p>
|
|
1201
|
+
<ul class="param">
|
|
1202
|
+
|
|
1203
|
+
<li>
|
|
1204
|
+
|
|
1205
|
+
<span class='name'>id</span>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
</li>
|
|
1213
|
+
|
|
1214
|
+
</ul>
|
|
1215
|
+
|
|
1216
|
+
<p class="tag_title">Returns:</p>
|
|
1217
|
+
<ul class="return">
|
|
1218
|
+
|
|
1219
|
+
<li>
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
<span class='type'>(<tt>true</tt>)</span>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
</li>
|
|
1227
|
+
|
|
1228
|
+
</ul>
|
|
1229
|
+
|
|
1230
|
+
</div><table class="source_code">
|
|
1231
|
+
<tr>
|
|
1232
|
+
<td>
|
|
1233
|
+
<pre class="lines">
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
158
|
|
1237
|
+
159
|
|
1238
|
+
160
|
|
1239
|
+
161
|
|
1240
|
+
162
|
|
1241
|
+
163
|
|
1242
|
+
164
|
|
1243
|
+
165
|
|
1244
|
+
166
|
|
1245
|
+
167
|
|
1246
|
+
168
|
|
1247
|
+
169
|
|
1248
|
+
170
|
|
1249
|
+
171
|
|
1250
|
+
172
|
|
1251
|
+
173
|
|
1252
|
+
174</pre>
|
|
1253
|
+
</td>
|
|
1254
|
+
<td>
|
|
1255
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 158</span>
|
|
1256
|
+
|
|
1257
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1258
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span>
|
|
1259
|
+
<span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
|
|
1260
|
+
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
1261
|
+
<span class='kw'>end</span>
|
|
1262
|
+
|
|
1263
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
1264
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1265
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1266
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
1267
|
+
<span class='label'>message:</span>
|
|
1268
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while deleting </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1269
|
+
<span class='rparen'>)</span>
|
|
1270
|
+
<span class='kw'>end</span>
|
|
1271
|
+
|
|
1272
|
+
<span class='kw'>true</span>
|
|
1273
|
+
<span class='kw'>end</span></pre>
|
|
1274
|
+
</td>
|
|
1275
|
+
</tr>
|
|
1276
|
+
</table>
|
|
1277
|
+
</div>
|
|
1278
|
+
|
|
1279
|
+
<div class="method_details ">
|
|
1280
|
+
<h3 class="signature " id="fields-instance_method">
|
|
1281
|
+
|
|
1282
|
+
#<strong>fields</strong> ⇒ <tt>OpenStruct</tt>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
</h3><div class="docstring">
|
|
1289
|
+
<div class="discussion">
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
</div>
|
|
1293
|
+
</div>
|
|
1294
|
+
<div class="tags">
|
|
1295
|
+
|
|
1296
|
+
<p class="tag_title">Returns:</p>
|
|
1297
|
+
<ul class="return">
|
|
1298
|
+
|
|
1299
|
+
<li>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
<span class='type'>(<tt>OpenStruct</tt>)</span>
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
</li>
|
|
1307
|
+
|
|
1308
|
+
</ul>
|
|
1309
|
+
|
|
1310
|
+
</div><table class="source_code">
|
|
1311
|
+
<tr>
|
|
1312
|
+
<td>
|
|
1313
|
+
<pre class="lines">
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
349
|
|
1317
|
+
350
|
|
1318
|
+
351</pre>
|
|
1319
|
+
</td>
|
|
1320
|
+
<td>
|
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 349</span>
|
|
1322
|
+
|
|
1323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_fields'>fields</span>
|
|
1324
|
+
<span class='id identifier rubyid_schema_client'>schema_client</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span>
|
|
1325
|
+
<span class='kw'>end</span></pre>
|
|
1326
|
+
</td>
|
|
1327
|
+
</tr>
|
|
1328
|
+
</table>
|
|
1329
|
+
</div>
|
|
1330
|
+
|
|
1331
|
+
<div class="method_details ">
|
|
1332
|
+
<h3 class="signature " id="find-instance_method">
|
|
1333
|
+
|
|
1334
|
+
#<strong>find</strong>(id, fields: nil, retired: nil, include_archived_projects: nil) ⇒ <tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
</h3><div class="docstring">
|
|
1341
|
+
<div class="discussion">
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
</div>
|
|
1345
|
+
</div>
|
|
1346
|
+
<div class="tags">
|
|
1347
|
+
<p class="tag_title">Parameters:</p>
|
|
1348
|
+
<ul class="param">
|
|
1349
|
+
|
|
1350
|
+
<li>
|
|
1351
|
+
|
|
1352
|
+
<span class='name'>id</span>
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
</li>
|
|
1360
|
+
|
|
1361
|
+
<li>
|
|
1362
|
+
|
|
1363
|
+
<span class='name'>fields</span>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FIELDS_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FIELDS_TYPE (constant)">Params::FIELDS_TYPE</a></span></tt>)</span>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
</li>
|
|
1373
|
+
|
|
1374
|
+
<li>
|
|
1375
|
+
|
|
1376
|
+
<span class='name'>retired</span>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
</li>
|
|
1386
|
+
|
|
1387
|
+
<li>
|
|
1388
|
+
|
|
1389
|
+
<span class='name'>include_archived_projects</span>
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
</li>
|
|
1399
|
+
|
|
1400
|
+
</ul>
|
|
1401
|
+
|
|
1402
|
+
<p class="tag_title">Returns:</p>
|
|
1403
|
+
<ul class="return">
|
|
1404
|
+
|
|
1405
|
+
<li>
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>)</span>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
</li>
|
|
1413
|
+
|
|
1414
|
+
</ul>
|
|
1415
|
+
|
|
1416
|
+
</div><table class="source_code">
|
|
1417
|
+
<tr>
|
|
1418
|
+
<td>
|
|
1419
|
+
<pre class="lines">
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
65
|
|
1423
|
+
66
|
|
1424
|
+
67
|
|
1425
|
+
68
|
|
1426
|
+
69
|
|
1427
|
+
70
|
|
1428
|
+
71
|
|
1429
|
+
72
|
|
1430
|
+
73
|
|
1431
|
+
74
|
|
1432
|
+
75
|
|
1433
|
+
76
|
|
1434
|
+
77
|
|
1435
|
+
78
|
|
1436
|
+
79
|
|
1437
|
+
80
|
|
1438
|
+
81
|
|
1439
|
+
82
|
|
1440
|
+
83
|
|
1441
|
+
84
|
|
1442
|
+
85
|
|
1443
|
+
86
|
|
1444
|
+
87
|
|
1445
|
+
88
|
|
1446
|
+
89</pre>
|
|
1447
|
+
</td>
|
|
1448
|
+
<td>
|
|
1449
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 65</span>
|
|
1450
|
+
|
|
1451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>retired:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>include_archived_projects:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1452
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entities/Params.html#initialize-instance_method" title="ShotgridApiRuby::Entities::Params#initialize (method)">new</a></span></span>
|
|
1453
|
+
|
|
1454
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_fields'>add_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
|
|
1455
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_options'>add_options</span><span class='lparen'>(</span><span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='rparen'>)</span>
|
|
1456
|
+
|
|
1457
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1458
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1459
|
+
|
|
1460
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
1461
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1462
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while getting </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1463
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
1464
|
+
<span class='rparen'>)</span>
|
|
1465
|
+
<span class='kw'>end</span>
|
|
1466
|
+
|
|
1467
|
+
<span class='id identifier rubyid_entity'>entity</span> <span class='op'>=</span> <span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
1468
|
+
<span class='const'><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1469
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1470
|
+
<span class='label'>attributes:</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1471
|
+
<span class='label'>relationships:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>relationships</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1472
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1473
|
+
<span class='label'>links:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>links</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1474
|
+
<span class='rparen'>)</span>
|
|
1475
|
+
<span class='kw'>end</span></pre>
|
|
1476
|
+
</td>
|
|
1477
|
+
</tr>
|
|
1478
|
+
</table>
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
<div class="method_details ">
|
|
1482
|
+
<h3 class="signature " id="first-instance_method">
|
|
1483
|
+
|
|
1484
|
+
#<strong>first</strong>(fields: nil, sort: nil, filter: nil, retired: nil, include_archived_projects: nil, logical_operator: 'and') ⇒ <tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></tt><sup>?</sup>
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
</h3><div class="docstring">
|
|
1491
|
+
<div class="discussion">
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
</div>
|
|
1495
|
+
</div>
|
|
1496
|
+
<div class="tags">
|
|
1497
|
+
<p class="tag_title">Parameters:</p>
|
|
1498
|
+
<ul class="param">
|
|
1499
|
+
|
|
1500
|
+
<li>
|
|
1501
|
+
|
|
1502
|
+
<span class='name'>fields</span>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FIELDS_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FIELDS_TYPE (constant)">Params::FIELDS_TYPE</a></span></tt>)</span>
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
</li>
|
|
1512
|
+
|
|
1513
|
+
<li>
|
|
1514
|
+
|
|
1515
|
+
<span class='name'>sort</span>
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#SORT_TYPE-constant" title="ShotgridApiRuby::Entities::Params::SORT_TYPE (constant)">Params::SORT_TYPE</a></span></tt>)</span>
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
</li>
|
|
1525
|
+
|
|
1526
|
+
<li>
|
|
1527
|
+
|
|
1528
|
+
<span class='name'>filter</span>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FILTERS_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FILTERS_FIELD_TYPE (constant)">Params::FILTERS_FIELD_TYPE</a></span></tt>)</span>
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
</li>
|
|
1538
|
+
|
|
1539
|
+
<li>
|
|
1540
|
+
|
|
1541
|
+
<span class='name'>retired</span>
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
</li>
|
|
1551
|
+
|
|
1552
|
+
<li>
|
|
1553
|
+
|
|
1554
|
+
<span class='name'>include_archived_projects</span>
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
</li>
|
|
1564
|
+
|
|
1565
|
+
<li>
|
|
1566
|
+
|
|
1567
|
+
<span class='name'>logical_operator</span>
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#LOGICAL_OPERATOR_TYPE-constant" title="ShotgridApiRuby::Entities::Params::LOGICAL_OPERATOR_TYPE (constant)">Params::LOGICAL_OPERATOR_TYPE</a></span></tt>)</span>
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
</li>
|
|
1577
|
+
|
|
1578
|
+
</ul>
|
|
1579
|
+
|
|
1580
|
+
<p class="tag_title">Returns:</p>
|
|
1581
|
+
<ul class="return">
|
|
1582
|
+
|
|
1583
|
+
<li>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></tt>, <tt>nil</tt>)</span>
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
</li>
|
|
1591
|
+
|
|
1592
|
+
</ul>
|
|
1593
|
+
|
|
1594
|
+
</div><table class="source_code">
|
|
1595
|
+
<tr>
|
|
1596
|
+
<td>
|
|
1597
|
+
<pre class="lines">
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
37
|
|
1601
|
+
38
|
|
1602
|
+
39
|
|
1603
|
+
40
|
|
1604
|
+
41
|
|
1605
|
+
42
|
|
1606
|
+
43
|
|
1607
|
+
44
|
|
1608
|
+
45
|
|
1609
|
+
46
|
|
1610
|
+
47
|
|
1611
|
+
48
|
|
1612
|
+
49
|
|
1613
|
+
50
|
|
1614
|
+
51
|
|
1615
|
+
52
|
|
1616
|
+
53
|
|
1617
|
+
54</pre>
|
|
1618
|
+
</td>
|
|
1619
|
+
<td>
|
|
1620
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 37</span>
|
|
1621
|
+
|
|
1622
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_first'>first</span><span class='lparen'>(</span>
|
|
1623
|
+
<span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1624
|
+
<span class='label'>sort:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1625
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1626
|
+
<span class='label'>retired:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1627
|
+
<span class='label'>include_archived_projects:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1628
|
+
<span class='label'>logical_operator:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span>
|
|
1629
|
+
<span class='rparen'>)</span>
|
|
1630
|
+
<span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span>
|
|
1631
|
+
<span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
|
|
1632
|
+
<span class='label'>sort:</span> <span class='id identifier rubyid_sort'>sort</span><span class='comma'>,</span>
|
|
1633
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1634
|
+
<span class='label'>retired:</span> <span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span>
|
|
1635
|
+
<span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='comma'>,</span>
|
|
1636
|
+
<span class='label'>include_archived_projects:</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='comma'>,</span>
|
|
1637
|
+
<span class='label'>page_size:</span> <span class='int'>1</span><span class='comma'>,</span>
|
|
1638
|
+
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
1639
|
+
<span class='kw'>end</span></pre>
|
|
1640
|
+
</td>
|
|
1641
|
+
</tr>
|
|
1642
|
+
</table>
|
|
1643
|
+
</div>
|
|
1644
|
+
|
|
1645
|
+
<div class="method_details ">
|
|
1646
|
+
<h3 class="signature " id="revive-instance_method">
|
|
1647
|
+
|
|
1648
|
+
#<strong>revive</strong>(id) ⇒ <tt>true</tt>
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
</h3><div class="docstring">
|
|
1655
|
+
<div class="discussion">
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
</div>
|
|
1659
|
+
</div>
|
|
1660
|
+
<div class="tags">
|
|
1661
|
+
<p class="tag_title">Parameters:</p>
|
|
1662
|
+
<ul class="param">
|
|
1663
|
+
|
|
1664
|
+
<li>
|
|
1665
|
+
|
|
1666
|
+
<span class='name'>id</span>
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
</li>
|
|
1674
|
+
|
|
1675
|
+
</ul>
|
|
1676
|
+
|
|
1677
|
+
<p class="tag_title">Returns:</p>
|
|
1678
|
+
<ul class="return">
|
|
1679
|
+
|
|
1680
|
+
<li>
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
<span class='type'>(<tt>true</tt>)</span>
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
</li>
|
|
1688
|
+
|
|
1689
|
+
</ul>
|
|
1690
|
+
|
|
1691
|
+
</div><table class="source_code">
|
|
1692
|
+
<tr>
|
|
1693
|
+
<td>
|
|
1694
|
+
<pre class="lines">
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
177
|
|
1698
|
+
178
|
|
1699
|
+
179
|
|
1700
|
+
180
|
|
1701
|
+
181
|
|
1702
|
+
182
|
|
1703
|
+
183
|
|
1704
|
+
184
|
|
1705
|
+
185
|
|
1706
|
+
186
|
|
1707
|
+
187
|
|
1708
|
+
188
|
|
1709
|
+
189
|
|
1710
|
+
190</pre>
|
|
1711
|
+
</td>
|
|
1712
|
+
<td>
|
|
1713
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 177</span>
|
|
1714
|
+
|
|
1715
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_revive'>revive</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1716
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>?revive=true</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1717
|
+
|
|
1718
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
1719
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1720
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1721
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
1722
|
+
<span class='label'>message:</span>
|
|
1723
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while reviving </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1724
|
+
<span class='rparen'>)</span>
|
|
1725
|
+
<span class='kw'>end</span>
|
|
1726
|
+
|
|
1727
|
+
<span class='kw'>true</span>
|
|
1728
|
+
<span class='kw'>end</span></pre>
|
|
1729
|
+
</td>
|
|
1730
|
+
</tr>
|
|
1731
|
+
</table>
|
|
1732
|
+
</div>
|
|
1733
|
+
|
|
1734
|
+
<div class="method_details ">
|
|
1735
|
+
<h3 class="signature " id="schema-instance_method">
|
|
1736
|
+
|
|
1737
|
+
#<strong>schema</strong> ⇒ <tt>OpenStruct</tt>
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
</h3><div class="docstring">
|
|
1744
|
+
<div class="discussion">
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
</div>
|
|
1748
|
+
</div>
|
|
1749
|
+
<div class="tags">
|
|
1750
|
+
|
|
1751
|
+
<p class="tag_title">Returns:</p>
|
|
1752
|
+
<ul class="return">
|
|
1753
|
+
|
|
1754
|
+
<li>
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
<span class='type'>(<tt>OpenStruct</tt>)</span>
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
</li>
|
|
1762
|
+
|
|
1763
|
+
</ul>
|
|
1764
|
+
|
|
1765
|
+
</div><table class="source_code">
|
|
1766
|
+
<tr>
|
|
1767
|
+
<td>
|
|
1768
|
+
<pre class="lines">
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
344
|
|
1772
|
+
345
|
|
1773
|
+
346</pre>
|
|
1774
|
+
</td>
|
|
1775
|
+
<td>
|
|
1776
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 344</span>
|
|
1777
|
+
|
|
1778
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_schema'>schema</span>
|
|
1779
|
+
<span class='id identifier rubyid_schema_client'>schema_client</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
|
|
1780
|
+
<span class='kw'>end</span></pre>
|
|
1781
|
+
</td>
|
|
1782
|
+
</tr>
|
|
1783
|
+
</table>
|
|
1784
|
+
</div>
|
|
1785
|
+
|
|
1786
|
+
<div class="method_details ">
|
|
1787
|
+
<h3 class="signature " id="schema_client-instance_method">
|
|
1788
|
+
|
|
1789
|
+
#<strong>schema_client</strong> ⇒ <tt><span class='object_link'><a href="Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span></tt>
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
</h3><div class="docstring">
|
|
1796
|
+
<div class="discussion">
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
</div>
|
|
1800
|
+
</div>
|
|
1801
|
+
<div class="tags">
|
|
1802
|
+
|
|
1803
|
+
<p class="tag_title">Returns:</p>
|
|
1804
|
+
<ul class="return">
|
|
1805
|
+
|
|
1806
|
+
<li>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span></tt>)</span>
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
</li>
|
|
1814
|
+
|
|
1815
|
+
</ul>
|
|
1816
|
+
|
|
1817
|
+
</div><table class="source_code">
|
|
1818
|
+
<tr>
|
|
1819
|
+
<td>
|
|
1820
|
+
<pre class="lines">
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
339
|
|
1824
|
+
340
|
|
1825
|
+
341</pre>
|
|
1826
|
+
</td>
|
|
1827
|
+
<td>
|
|
1828
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 339</span>
|
|
1829
|
+
|
|
1830
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_schema_client'>schema_client</span>
|
|
1831
|
+
<span class='ivar'>@schema_client</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entities/Schema.html#initialize-instance_method" title="ShotgridApiRuby::Entities::Schema#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='ivar'>@base_url_prefix</span><span class='rparen'>)</span>
|
|
1832
|
+
<span class='kw'>end</span></pre>
|
|
1833
|
+
</td>
|
|
1834
|
+
</tr>
|
|
1835
|
+
</table>
|
|
1836
|
+
</div>
|
|
1837
|
+
|
|
1838
|
+
<div class="method_details ">
|
|
1839
|
+
<h3 class="signature " id="search-instance_method">
|
|
1840
|
+
|
|
1841
|
+
#<strong>search</strong>(fields: nil, logical_operator: 'and', sort: nil, filter: nil, page: nil, page_size: nil, retired: nil, include_archived_projects: nil) ⇒ <tt>Array<<span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>></tt>
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
</h3><div class="docstring">
|
|
1848
|
+
<div class="discussion">
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
</div>
|
|
1852
|
+
</div>
|
|
1853
|
+
<div class="tags">
|
|
1854
|
+
<p class="tag_title">Parameters:</p>
|
|
1855
|
+
<ul class="param">
|
|
1856
|
+
|
|
1857
|
+
<li>
|
|
1858
|
+
|
|
1859
|
+
<span class='name'>fields</span>
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FIELDS_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FIELDS_TYPE (constant)">Params::FIELDS_TYPE</a></span></tt>)</span>
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
</li>
|
|
1869
|
+
|
|
1870
|
+
<li>
|
|
1871
|
+
|
|
1872
|
+
<span class='name'>logical_operator</span>
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#LOGICAL_OPERATOR_TYPE-constant" title="ShotgridApiRuby::Entities::Params::LOGICAL_OPERATOR_TYPE (constant)">Params::LOGICAL_OPERATOR_TYPE</a></span></tt>)</span>
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
</li>
|
|
1882
|
+
|
|
1883
|
+
<li>
|
|
1884
|
+
|
|
1885
|
+
<span class='name'>sort</span>
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#SORT_TYPE-constant" title="ShotgridApiRuby::Entities::Params::SORT_TYPE (constant)">Params::SORT_TYPE</a></span></tt>)</span>
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
</li>
|
|
1895
|
+
|
|
1896
|
+
<li>
|
|
1897
|
+
|
|
1898
|
+
<span class='name'>filter</span>
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FILTERS_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FILTERS_FIELD_TYPE (constant)">Params::FILTERS_FIELD_TYPE</a></span></tt>)</span>
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
</li>
|
|
1908
|
+
|
|
1909
|
+
<li>
|
|
1910
|
+
|
|
1911
|
+
<span class='name'>page</span>
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#PAGE_TYPE-constant" title="ShotgridApiRuby::Entities::Params::PAGE_TYPE (constant)">Params::PAGE_TYPE</a></span></tt>)</span>
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
</li>
|
|
1921
|
+
|
|
1922
|
+
<li>
|
|
1923
|
+
|
|
1924
|
+
<span class='name'>page_size</span>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#PAGE_SIZE_TYPE-constant" title="ShotgridApiRuby::Entities::Params::PAGE_SIZE_TYPE (constant)">Params::PAGE_SIZE_TYPE</a></span></tt>)</span>
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
</li>
|
|
1934
|
+
|
|
1935
|
+
<li>
|
|
1936
|
+
|
|
1937
|
+
<span class='name'>retired</span>
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
</li>
|
|
1947
|
+
|
|
1948
|
+
<li>
|
|
1949
|
+
|
|
1950
|
+
<span class='name'>include_archived_projects</span>
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
</li>
|
|
1960
|
+
|
|
1961
|
+
</ul>
|
|
1962
|
+
|
|
1963
|
+
<p class="tag_title">Returns:</p>
|
|
1964
|
+
<ul class="return">
|
|
1965
|
+
|
|
1966
|
+
<li>
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>></tt>)</span>
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
</li>
|
|
1974
|
+
|
|
1975
|
+
</ul>
|
|
1976
|
+
|
|
1977
|
+
</div><table class="source_code">
|
|
1978
|
+
<tr>
|
|
1979
|
+
<td>
|
|
1980
|
+
<pre class="lines">
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
272
|
|
1984
|
+
273
|
|
1985
|
+
274
|
|
1986
|
+
275
|
|
1987
|
+
276
|
|
1988
|
+
277
|
|
1989
|
+
278
|
|
1990
|
+
279
|
|
1991
|
+
280
|
|
1992
|
+
281
|
|
1993
|
+
282
|
|
1994
|
+
283
|
|
1995
|
+
284
|
|
1996
|
+
285
|
|
1997
|
+
286
|
|
1998
|
+
287
|
|
1999
|
+
288
|
|
2000
|
+
289
|
|
2001
|
+
290
|
|
2002
|
+
291
|
|
2003
|
+
292
|
|
2004
|
+
293
|
|
2005
|
+
294
|
|
2006
|
+
295
|
|
2007
|
+
296
|
|
2008
|
+
297
|
|
2009
|
+
298
|
|
2010
|
+
299
|
|
2011
|
+
300
|
|
2012
|
+
301
|
|
2013
|
+
302
|
|
2014
|
+
303
|
|
2015
|
+
304
|
|
2016
|
+
305
|
|
2017
|
+
306
|
|
2018
|
+
307
|
|
2019
|
+
308
|
|
2020
|
+
309
|
|
2021
|
+
310
|
|
2022
|
+
311
|
|
2023
|
+
312
|
|
2024
|
+
313
|
|
2025
|
+
314
|
|
2026
|
+
315
|
|
2027
|
+
316
|
|
2028
|
+
317
|
|
2029
|
+
318
|
|
2030
|
+
319
|
|
2031
|
+
320
|
|
2032
|
+
321
|
|
2033
|
+
322
|
|
2034
|
+
323
|
|
2035
|
+
324
|
|
2036
|
+
325
|
|
2037
|
+
326
|
|
2038
|
+
327
|
|
2039
|
+
328
|
|
2040
|
+
329
|
|
2041
|
+
330
|
|
2042
|
+
331
|
|
2043
|
+
332
|
|
2044
|
+
333
|
|
2045
|
+
334
|
|
2046
|
+
335
|
|
2047
|
+
336</pre>
|
|
2048
|
+
</td>
|
|
2049
|
+
<td>
|
|
2050
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 272</span>
|
|
2051
|
+
|
|
2052
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span>
|
|
2053
|
+
<span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2054
|
+
<span class='label'>logical_operator:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
2055
|
+
<span class='label'>sort:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2056
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2057
|
+
<span class='label'>page:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2058
|
+
<span class='label'>page_size:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2059
|
+
<span class='label'>retired:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2060
|
+
<span class='label'>include_archived_projects:</span> <span class='kw'>nil</span>
|
|
2061
|
+
<span class='rparen'>)</span>
|
|
2062
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_filter'>filter</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span></span><span class='period'>.</span><span class='id identifier rubyid_filters_are_simple?'><span class='object_link'><a href="Entities/Params.html#filters_are_simple%3F-class_method" title="ShotgridApiRuby::Entities::Params.filters_are_simple? (method)">filters_are_simple?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_filter'>filter</span><span class='rparen'>)</span>
|
|
2063
|
+
<span class='kw'>return</span><span class='lparen'>(</span>
|
|
2064
|
+
<span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span>
|
|
2065
|
+
<span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
|
|
2066
|
+
<span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='comma'>,</span>
|
|
2067
|
+
<span class='label'>sort:</span> <span class='id identifier rubyid_sort'>sort</span><span class='comma'>,</span>
|
|
2068
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
2069
|
+
<span class='label'>page:</span> <span class='id identifier rubyid_page'>page</span><span class='comma'>,</span>
|
|
2070
|
+
<span class='label'>page_size:</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='comma'>,</span>
|
|
2071
|
+
<span class='label'>retired:</span> <span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span>
|
|
2072
|
+
<span class='label'>include_archived_projects:</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='comma'>,</span>
|
|
2073
|
+
<span class='rparen'>)</span>
|
|
2074
|
+
<span class='rparen'>)</span>
|
|
2075
|
+
<span class='kw'>end</span>
|
|
2076
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entities/Params.html#initialize-instance_method" title="ShotgridApiRuby::Entities::Params#initialize (method)">new</a></span></span>
|
|
2077
|
+
|
|
2078
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_fields'>add_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
|
|
2079
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_sort'>add_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_sort'>sort</span><span class='rparen'>)</span>
|
|
2080
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_page'>add_page</span><span class='lparen'>(</span><span class='id identifier rubyid_page'>page</span><span class='comma'>,</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='rparen'>)</span>
|
|
2081
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_options'>add_options</span><span class='lparen'>(</span><span class='id identifier rubyid_retired'>retired</span><span class='comma'>,</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='rparen'>)</span>
|
|
2082
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_add_filter'>add_filter</span><span class='lparen'>(</span><span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='rparen'>)</span>
|
|
2083
|
+
|
|
2084
|
+
<span class='comment'># In search: The name is filters and not filter
|
|
2085
|
+
</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:filters</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:filter</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:filter</span><span class='rbracket'>]</span>
|
|
2086
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:filter</span><span class='rparen'>)</span>
|
|
2087
|
+
|
|
2088
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span>
|
|
2089
|
+
<span class='ivar'>@connection</span><span class='period'>.</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'>_search</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
|
|
2090
|
+
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
2091
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:filters</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
|
|
2092
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/vnd+shotgun.api3_array+json</span><span class='tstring_end'>'</span></span>
|
|
2093
|
+
<span class='kw'>else</span>
|
|
2094
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/vnd+shotgun.api3_hash+json</span><span class='tstring_end'>'</span></span>
|
|
2095
|
+
<span class='kw'>end</span>
|
|
2096
|
+
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
2097
|
+
<span class='kw'>end</span>
|
|
2098
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
2099
|
+
|
|
2100
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
2101
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
2102
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
2103
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while getting </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2104
|
+
<span class='rparen'>)</span>
|
|
2105
|
+
<span class='kw'>end</span>
|
|
2106
|
+
|
|
2107
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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_entity'>entity</span><span class='op'>|</span>
|
|
2108
|
+
<span class='const'><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
2109
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2110
|
+
<span class='label'>attributes:</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
2111
|
+
<span class='label'>relationships:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>relationships</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2112
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2113
|
+
<span class='label'>links:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>links</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2114
|
+
<span class='rparen'>)</span>
|
|
2115
|
+
<span class='kw'>end</span>
|
|
2116
|
+
<span class='kw'>end</span></pre>
|
|
2117
|
+
</td>
|
|
2118
|
+
</tr>
|
|
2119
|
+
</table>
|
|
2120
|
+
</div>
|
|
2121
|
+
|
|
2122
|
+
<div class="method_details ">
|
|
2123
|
+
<h3 class="signature " id="summarize-instance_method">
|
|
2124
|
+
|
|
2125
|
+
#<strong>summarize</strong>(filter: nil, grouping: nil, summary_fields: nil, logical_operator: 'and', include_archived_projects: nil) ⇒ <tt><span class='object_link'><a href="Entities/Summarize/Summary.html" title="ShotgridApiRuby::Entities::Summarize::Summary (class)">Summarize::Summary</a></span></tt>
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
</h3><div class="docstring">
|
|
2132
|
+
<div class="discussion">
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
</div>
|
|
2136
|
+
</div>
|
|
2137
|
+
<div class="tags">
|
|
2138
|
+
<p class="tag_title">Parameters:</p>
|
|
2139
|
+
<ul class="param">
|
|
2140
|
+
|
|
2141
|
+
<li>
|
|
2142
|
+
|
|
2143
|
+
<span class='name'>filter</span>
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#FILTERS_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::FILTERS_FIELD_TYPE (constant)">Params::FILTERS_FIELD_TYPE</a></span></tt>)</span>
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
</li>
|
|
2153
|
+
|
|
2154
|
+
<li>
|
|
2155
|
+
|
|
2156
|
+
<span class='name'>grouping</span>
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#GROUPING_FIELD_TYPE-constant" title="ShotgridApiRuby::Entities::Params::GROUPING_FIELD_TYPE (constant)">Params::GROUPING_FIELD_TYPE</a></span></tt>)</span>
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
</li>
|
|
2166
|
+
|
|
2167
|
+
<li>
|
|
2168
|
+
|
|
2169
|
+
<span class='name'>summary_fields</span>
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#SUMMARY_FILEDS_TYPE-constant" title="ShotgridApiRuby::Entities::Params::SUMMARY_FILEDS_TYPE (constant)">Params::SUMMARY_FILEDS_TYPE</a></span></tt>)</span>
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
</li>
|
|
2179
|
+
|
|
2180
|
+
<li>
|
|
2181
|
+
|
|
2182
|
+
<span class='name'>logical_operator</span>
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Params.html#LOGICAL_OPERATOR_TYPE-constant" title="ShotgridApiRuby::Entities::Params::LOGICAL_OPERATOR_TYPE (constant)">Params::LOGICAL_OPERATOR_TYPE</a></span></tt>)</span>
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
</li>
|
|
2192
|
+
|
|
2193
|
+
<li>
|
|
2194
|
+
|
|
2195
|
+
<span class='name'>include_archived_projects</span>
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
</li>
|
|
2205
|
+
|
|
2206
|
+
</ul>
|
|
2207
|
+
|
|
2208
|
+
<p class="tag_title">Returns:</p>
|
|
2209
|
+
<ul class="return">
|
|
2210
|
+
|
|
2211
|
+
<li>
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Summarize/Summary.html" title="ShotgridApiRuby::Entities::Summarize::Summary (class)">Summarize::Summary</a></span></tt>)</span>
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
</li>
|
|
2219
|
+
|
|
2220
|
+
</ul>
|
|
2221
|
+
|
|
2222
|
+
</div><table class="source_code">
|
|
2223
|
+
<tr>
|
|
2224
|
+
<td>
|
|
2225
|
+
<pre class="lines">
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
379
|
|
2229
|
+
380
|
|
2230
|
+
381
|
|
2231
|
+
382
|
|
2232
|
+
383
|
|
2233
|
+
384
|
|
2234
|
+
385
|
|
2235
|
+
386
|
|
2236
|
+
387
|
|
2237
|
+
388
|
|
2238
|
+
389
|
|
2239
|
+
390
|
|
2240
|
+
391
|
|
2241
|
+
392
|
|
2242
|
+
393</pre>
|
|
2243
|
+
</td>
|
|
2244
|
+
<td>
|
|
2245
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 379</span>
|
|
2246
|
+
|
|
2247
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_summarize'>summarize</span><span class='lparen'>(</span>
|
|
2248
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2249
|
+
<span class='label'>grouping:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2250
|
+
<span class='label'>summary_fields:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2251
|
+
<span class='label'>logical_operator:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
2252
|
+
<span class='label'>include_archived_projects:</span> <span class='kw'>nil</span>
|
|
2253
|
+
<span class='rparen'>)</span>
|
|
2254
|
+
<span class='id identifier rubyid_summary_client'>summary_client</span><span class='period'>.</span><span class='id identifier rubyid_summarize'>summarize</span><span class='lparen'>(</span>
|
|
2255
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
2256
|
+
<span class='label'>grouping:</span> <span class='id identifier rubyid_grouping'>grouping</span><span class='comma'>,</span>
|
|
2257
|
+
<span class='label'>summary_fields:</span> <span class='id identifier rubyid_summary_fields'>summary_fields</span><span class='comma'>,</span>
|
|
2258
|
+
<span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='comma'>,</span>
|
|
2259
|
+
<span class='label'>include_archived_projects:</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='comma'>,</span>
|
|
2260
|
+
<span class='rparen'>)</span>
|
|
2261
|
+
<span class='kw'>end</span></pre>
|
|
2262
|
+
</td>
|
|
2263
|
+
</tr>
|
|
2264
|
+
</table>
|
|
2265
|
+
</div>
|
|
2266
|
+
|
|
2267
|
+
<div class="method_details ">
|
|
2268
|
+
<h3 class="signature " id="summary_client-instance_method">
|
|
2269
|
+
|
|
2270
|
+
#<strong>summary_client</strong> ⇒ <tt><span class='object_link'><a href="Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span></tt>
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
|
|
2276
|
+
</h3><div class="docstring">
|
|
2277
|
+
<div class="discussion">
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
</div>
|
|
2281
|
+
</div>
|
|
2282
|
+
<div class="tags">
|
|
2283
|
+
|
|
2284
|
+
<p class="tag_title">Returns:</p>
|
|
2285
|
+
<ul class="return">
|
|
2286
|
+
|
|
2287
|
+
<li>
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span></tt>)</span>
|
|
2291
|
+
|
|
2292
|
+
|
|
2293
|
+
|
|
2294
|
+
</li>
|
|
2295
|
+
|
|
2296
|
+
</ul>
|
|
2297
|
+
|
|
2298
|
+
</div><table class="source_code">
|
|
2299
|
+
<tr>
|
|
2300
|
+
<td>
|
|
2301
|
+
<pre class="lines">
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
354
|
|
2305
|
+
355
|
|
2306
|
+
356</pre>
|
|
2307
|
+
</td>
|
|
2308
|
+
<td>
|
|
2309
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 354</span>
|
|
2310
|
+
|
|
2311
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_summary_client'>summary_client</span>
|
|
2312
|
+
<span class='ivar'>@summary_client</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entities/Summarize.html#initialize-instance_method" title="ShotgridApiRuby::Entities::Summarize#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='ivar'>@base_url_prefix</span><span class='rparen'>)</span>
|
|
2313
|
+
<span class='kw'>end</span></pre>
|
|
2314
|
+
</td>
|
|
2315
|
+
</tr>
|
|
2316
|
+
</table>
|
|
2317
|
+
</div>
|
|
2318
|
+
|
|
2319
|
+
<div class="method_details ">
|
|
2320
|
+
<h3 class="signature " id="update-instance_method">
|
|
2321
|
+
|
|
2322
|
+
#<strong>update</strong>(id, changes) ⇒ <tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
</h3><div class="docstring">
|
|
2329
|
+
<div class="discussion">
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
</div>
|
|
2333
|
+
</div>
|
|
2334
|
+
<div class="tags">
|
|
2335
|
+
<p class="tag_title">Parameters:</p>
|
|
2336
|
+
<ul class="param">
|
|
2337
|
+
|
|
2338
|
+
<li>
|
|
2339
|
+
|
|
2340
|
+
<span class='name'>id</span>
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
</li>
|
|
2348
|
+
|
|
2349
|
+
<li>
|
|
2350
|
+
|
|
2351
|
+
<span class='name'>changes</span>
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
<span class='type'>(<tt>Hash{String, Symbol => T.untyped}</tt>)</span>
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
</li>
|
|
2359
|
+
|
|
2360
|
+
</ul>
|
|
2361
|
+
|
|
2362
|
+
<p class="tag_title">Returns:</p>
|
|
2363
|
+
<ul class="return">
|
|
2364
|
+
|
|
2365
|
+
<li>
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">ShotgridApiRuby::Entity</a></span></tt>)</span>
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
</li>
|
|
2373
|
+
|
|
2374
|
+
</ul>
|
|
2375
|
+
|
|
2376
|
+
</div><table class="source_code">
|
|
2377
|
+
<tr>
|
|
2378
|
+
<td>
|
|
2379
|
+
<pre class="lines">
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
127
|
|
2383
|
+
128
|
|
2384
|
+
129
|
|
2385
|
+
130
|
|
2386
|
+
131
|
|
2387
|
+
132
|
|
2388
|
+
133
|
|
2389
|
+
134
|
|
2390
|
+
135
|
|
2391
|
+
136
|
|
2392
|
+
137
|
|
2393
|
+
138
|
|
2394
|
+
139
|
|
2395
|
+
140
|
|
2396
|
+
141
|
|
2397
|
+
142
|
|
2398
|
+
143
|
|
2399
|
+
144
|
|
2400
|
+
145
|
|
2401
|
+
146
|
|
2402
|
+
147
|
|
2403
|
+
148
|
|
2404
|
+
149
|
|
2405
|
+
150
|
|
2406
|
+
151
|
|
2407
|
+
152
|
|
2408
|
+
153
|
|
2409
|
+
154
|
|
2410
|
+
155</pre>
|
|
2411
|
+
</td>
|
|
2412
|
+
<td>
|
|
2413
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities.rb', line 127</span>
|
|
2414
|
+
|
|
2415
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_changes'>changes</span><span class='rparen'>)</span>
|
|
2416
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_changes'>changes</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
2417
|
+
|
|
2418
|
+
<span class='id identifier rubyid_resp'>resp</span> <span class='op'>=</span>
|
|
2419
|
+
<span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_changes'>changes</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
|
|
2420
|
+
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
2421
|
+
<span class='kw'>end</span>
|
|
2422
|
+
|
|
2423
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
2424
|
+
|
|
2425
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_resp'>resp</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>>=</span> <span class='int'>300</span>
|
|
2426
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
2427
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
2428
|
+
<span class='label'>message:</span>
|
|
2429
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while updating </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'> with </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_changes'>changes</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span>
|
|
2430
|
+
<span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
2431
|
+
<span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2432
|
+
<span class='rparen'>)</span>
|
|
2433
|
+
<span class='kw'>end</span>
|
|
2434
|
+
|
|
2435
|
+
<span class='id identifier rubyid_entity'>entity</span> <span class='op'>=</span> <span class='id identifier rubyid_resp_body'>resp_body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>data</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
2436
|
+
<span class='const'><span class='object_link'><a href="Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span>
|
|
2437
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2438
|
+
<span class='label'>attributes:</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attributes</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
2439
|
+
<span class='label'>relationships:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>relationships</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2440
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2441
|
+
<span class='label'>links:</span> <span class='id identifier rubyid_entity'>entity</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>links</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
2442
|
+
<span class='rparen'>)</span>
|
|
2443
|
+
<span class='kw'>end</span></pre>
|
|
2444
|
+
</td>
|
|
2445
|
+
</tr>
|
|
2446
|
+
</table>
|
|
2447
|
+
</div>
|
|
2448
|
+
|
|
2449
|
+
</div>
|
|
2450
|
+
|
|
2451
|
+
</div>
|
|
2452
|
+
|
|
2453
|
+
<div id="footer">
|
|
2454
|
+
Generated on Tue Oct 12 21:57:54 2021 by
|
|
2455
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2456
|
+
0.9.26 (ruby-3.0.2).
|
|
2457
|
+
</div>
|
|
2458
|
+
|
|
2459
|
+
</div>
|
|
2460
|
+
</body>
|
|
2461
|
+
</html>
|