shotgrid_api_ruby 0.1.3.1 → 0.2.0.4
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/ISSUE_TEMPLATE/bug_report.md +38 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- data/.github/workflows/test_and_publish.yml +4 -1
- data/.github/workflows/test_only.yml +5 -1
- data/.gitignore +3 -2
- data/.overcommit.yml +9 -0
- data/.rubocop.yml +2 -0
- data/.ruby-version +1 -1
- data/CHANGELOG.md +31 -3
- data/CODE_OF_CONDUCT.md +128 -0
- data/Gemfile +18 -0
- data/Gemfile.lock +264 -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 +4 -11
- 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
- data/yarn.lock +3 -3
- metadata +157 -138
|
@@ -0,0 +1,646 @@
|
|
|
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::Schema
|
|
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::Schema";
|
|
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 (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> » <span class='title'><span class='object_link'><a href="../Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Schema</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::Schema
|
|
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::Schema</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/schema.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
112
|
+
<ul class="summary">
|
|
113
|
+
|
|
114
|
+
<li class="public ">
|
|
115
|
+
<span class="summary_signature">
|
|
116
|
+
|
|
117
|
+
<a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong> ⇒ Faraday::Connection </a>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</span>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<span class="note title readonly">readonly</span>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
137
|
+
|
|
138
|
+
</li>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ String, Symbol </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<span class="note title readonly">readonly</span>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
164
|
+
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</ul>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<h2>
|
|
175
|
+
Instance Method Summary
|
|
176
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
177
|
+
</h2>
|
|
178
|
+
|
|
179
|
+
<ul class="summary">
|
|
180
|
+
|
|
181
|
+
<li class="public ">
|
|
182
|
+
<span class="summary_signature">
|
|
183
|
+
|
|
184
|
+
<a href="#fields-instance_method" title="#fields (instance method)">#<strong>fields</strong> ⇒ OpenStruct </a>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<li class="public ">
|
|
204
|
+
<span class="summary_signature">
|
|
205
|
+
|
|
206
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(connection, type, base_url_prefix) ⇒ void </a>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</span>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<span class="note title constructor">constructor</span>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#read-instance_method" title="#read (instance method)">#<strong>read</strong> ⇒ OpenStruct </a>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
245
|
+
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</ul>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<div id="constructor_details" class="method_details_list">
|
|
254
|
+
<h2>Constructor Details</h2>
|
|
255
|
+
|
|
256
|
+
<div class="method_details first">
|
|
257
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
258
|
+
|
|
259
|
+
#<strong>initialize</strong>(connection, type, base_url_prefix) ⇒ <tt>void</tt>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</h3><div class="docstring">
|
|
266
|
+
<div class="discussion">
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
</div>
|
|
271
|
+
<div class="tags">
|
|
272
|
+
<p class="tag_title">Parameters:</p>
|
|
273
|
+
<ul class="param">
|
|
274
|
+
|
|
275
|
+
<li>
|
|
276
|
+
|
|
277
|
+
<span class='name'>connection</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
<li>
|
|
287
|
+
|
|
288
|
+
<span class='name'>type</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</li>
|
|
296
|
+
|
|
297
|
+
<li>
|
|
298
|
+
|
|
299
|
+
<span class='name'>base_url_prefix</span>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class='type'>(<tt>URI</tt>)</span>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
</ul>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</div><table class="source_code">
|
|
312
|
+
<tr>
|
|
313
|
+
<td>
|
|
314
|
+
<pre class="lines">
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
16
|
|
318
|
+
17
|
|
319
|
+
18
|
|
320
|
+
19
|
|
321
|
+
20</pre>
|
|
322
|
+
</td>
|
|
323
|
+
<td>
|
|
324
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/schema.rb', line 16</span>
|
|
325
|
+
|
|
326
|
+
<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='comma'>,</span> <span class='id identifier rubyid_base_url_prefix'>base_url_prefix</span><span class='rparen'>)</span>
|
|
327
|
+
<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>
|
|
328
|
+
<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='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
329
|
+
<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='id identifier rubyid_base_url_prefix'>base_url_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/schema/</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>
|
|
330
|
+
<span class='kw'>end</span></pre>
|
|
331
|
+
</td>
|
|
332
|
+
</tr>
|
|
333
|
+
</table>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
<div id="instance_attr_details" class="attr_details">
|
|
339
|
+
<h2>Instance Attribute Details</h2>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span id=""></span>
|
|
343
|
+
<div class="method_details first">
|
|
344
|
+
<h3 class="signature first" id="connection-instance_method">
|
|
345
|
+
|
|
346
|
+
#<strong>connection</strong> ⇒ <tt>Faraday::Connection</tt> <span class="extras">(readonly)</span>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</h3><div class="docstring">
|
|
353
|
+
<div class="discussion">
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
</div>
|
|
358
|
+
<div class="tags">
|
|
359
|
+
|
|
360
|
+
<p class="tag_title">Returns:</p>
|
|
361
|
+
<ul class="return">
|
|
362
|
+
|
|
363
|
+
<li>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</li>
|
|
371
|
+
|
|
372
|
+
</ul>
|
|
373
|
+
|
|
374
|
+
</div><table class="source_code">
|
|
375
|
+
<tr>
|
|
376
|
+
<td>
|
|
377
|
+
<pre class="lines">
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
24
|
|
381
|
+
25
|
|
382
|
+
26</pre>
|
|
383
|
+
</td>
|
|
384
|
+
<td>
|
|
385
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/schema.rb', line 24</span>
|
|
386
|
+
|
|
387
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
|
|
388
|
+
<span class='ivar'>@connection</span>
|
|
389
|
+
<span class='kw'>end</span></pre>
|
|
390
|
+
</td>
|
|
391
|
+
</tr>
|
|
392
|
+
</table>
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<span id=""></span>
|
|
397
|
+
<div class="method_details ">
|
|
398
|
+
<h3 class="signature " id="type-instance_method">
|
|
399
|
+
|
|
400
|
+
#<strong>type</strong> ⇒ <tt>String</tt>, <tt>Symbol</tt> <span class="extras">(readonly)</span>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</h3><div class="docstring">
|
|
407
|
+
<div class="discussion">
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
</div>
|
|
411
|
+
</div>
|
|
412
|
+
<div class="tags">
|
|
413
|
+
|
|
414
|
+
<p class="tag_title">Returns:</p>
|
|
415
|
+
<ul class="return">
|
|
416
|
+
|
|
417
|
+
<li>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</li>
|
|
425
|
+
|
|
426
|
+
</ul>
|
|
427
|
+
|
|
428
|
+
</div><table class="source_code">
|
|
429
|
+
<tr>
|
|
430
|
+
<td>
|
|
431
|
+
<pre class="lines">
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
22
|
|
435
|
+
23
|
|
436
|
+
24</pre>
|
|
437
|
+
</td>
|
|
438
|
+
<td>
|
|
439
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/schema.rb', line 22</span>
|
|
440
|
+
|
|
441
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
|
|
442
|
+
<span class='ivar'>@type</span>
|
|
443
|
+
<span class='kw'>end</span></pre>
|
|
444
|
+
</td>
|
|
445
|
+
</tr>
|
|
446
|
+
</table>
|
|
447
|
+
</div>
|
|
448
|
+
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<div id="instance_method_details" class="method_details_list">
|
|
453
|
+
<h2>Instance Method Details</h2>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<div class="method_details first">
|
|
457
|
+
<h3 class="signature first" id="fields-instance_method">
|
|
458
|
+
|
|
459
|
+
#<strong>fields</strong> ⇒ <tt>OpenStruct</tt>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
</h3><div class="docstring">
|
|
466
|
+
<div class="discussion">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div>
|
|
470
|
+
</div>
|
|
471
|
+
<div class="tags">
|
|
472
|
+
|
|
473
|
+
<p class="tag_title">Returns:</p>
|
|
474
|
+
<ul class="return">
|
|
475
|
+
|
|
476
|
+
<li>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
<span class='type'>(<tt>OpenStruct</tt>)</span>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
</li>
|
|
484
|
+
|
|
485
|
+
</ul>
|
|
486
|
+
|
|
487
|
+
</div><table class="source_code">
|
|
488
|
+
<tr>
|
|
489
|
+
<td>
|
|
490
|
+
<pre class="lines">
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
43
|
|
494
|
+
44
|
|
495
|
+
45
|
|
496
|
+
46
|
|
497
|
+
47
|
|
498
|
+
48
|
|
499
|
+
49
|
|
500
|
+
50
|
|
501
|
+
51
|
|
502
|
+
52
|
|
503
|
+
53
|
|
504
|
+
54
|
|
505
|
+
55
|
|
506
|
+
56
|
|
507
|
+
57
|
|
508
|
+
58
|
|
509
|
+
59
|
|
510
|
+
60
|
|
511
|
+
61
|
|
512
|
+
62
|
|
513
|
+
63
|
|
514
|
+
64
|
|
515
|
+
65
|
|
516
|
+
66
|
|
517
|
+
67
|
|
518
|
+
68
|
|
519
|
+
69
|
|
520
|
+
70
|
|
521
|
+
71</pre>
|
|
522
|
+
</td>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/schema.rb', line 43</span>
|
|
525
|
+
|
|
526
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_fields'>fields</span>
|
|
527
|
+
<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_content'>fields</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
528
|
+
<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>
|
|
529
|
+
|
|
530
|
+
<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>
|
|
531
|
+
<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>
|
|
532
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
533
|
+
<span class='label'>message:</span>
|
|
534
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while read schema fields for </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'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
535
|
+
<span class='rparen'>)</span>
|
|
536
|
+
<span class='kw'>end</span>
|
|
537
|
+
|
|
538
|
+
<span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
|
|
539
|
+
<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_transform_values'>transform_values</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
540
|
+
<span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
|
|
541
|
+
<span class='id identifier rubyid_value'>value</span>
|
|
542
|
+
<span class='period'>.</span><span class='id identifier rubyid_transform_values'>transform_values</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='op'>|</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
|
543
|
+
<span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span>
|
|
544
|
+
<span class='label'>properties:</span>
|
|
545
|
+
<span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
|
|
546
|
+
<span class='id identifier rubyid_value'>value</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>properties</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_transform_values'>transform_values</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_prop'>prop</span><span class='op'>|</span>
|
|
547
|
+
<span class='id identifier rubyid_prop'>prop</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
548
|
+
<span class='kw'>end</span><span class='comma'>,</span>
|
|
549
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
550
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
551
|
+
<span class='rparen'>)</span>
|
|
552
|
+
<span class='kw'>end</span><span class='comma'>,</span>
|
|
553
|
+
<span class='rparen'>)</span>
|
|
554
|
+
<span class='kw'>end</span></pre>
|
|
555
|
+
</td>
|
|
556
|
+
</tr>
|
|
557
|
+
</table>
|
|
558
|
+
</div>
|
|
559
|
+
|
|
560
|
+
<div class="method_details ">
|
|
561
|
+
<h3 class="signature " id="read-instance_method">
|
|
562
|
+
|
|
563
|
+
#<strong>read</strong> ⇒ <tt>OpenStruct</tt>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
</h3><div class="docstring">
|
|
570
|
+
<div class="discussion">
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
</div>
|
|
574
|
+
</div>
|
|
575
|
+
<div class="tags">
|
|
576
|
+
|
|
577
|
+
<p class="tag_title">Returns:</p>
|
|
578
|
+
<ul class="return">
|
|
579
|
+
|
|
580
|
+
<li>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
<span class='type'>(<tt>OpenStruct</tt>)</span>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
</li>
|
|
588
|
+
|
|
589
|
+
</ul>
|
|
590
|
+
|
|
591
|
+
</div><table class="source_code">
|
|
592
|
+
<tr>
|
|
593
|
+
<td>
|
|
594
|
+
<pre class="lines">
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
27
|
|
598
|
+
28
|
|
599
|
+
29
|
|
600
|
+
30
|
|
601
|
+
31
|
|
602
|
+
32
|
|
603
|
+
33
|
|
604
|
+
34
|
|
605
|
+
35
|
|
606
|
+
36
|
|
607
|
+
37
|
|
608
|
+
38
|
|
609
|
+
39
|
|
610
|
+
40</pre>
|
|
611
|
+
</td>
|
|
612
|
+
<td>
|
|
613
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/schema.rb', line 27</span>
|
|
614
|
+
|
|
615
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span>
|
|
616
|
+
<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='rparen'>)</span>
|
|
617
|
+
|
|
618
|
+
<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>
|
|
619
|
+
<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>
|
|
620
|
+
<span class='label'>response:</span> <span class='id identifier rubyid_resp'>resp</span><span class='comma'>,</span>
|
|
621
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Error while read schema for </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'>resp</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
622
|
+
<span class='rparen'>)</span>
|
|
623
|
+
<span class='kw'>end</span>
|
|
624
|
+
|
|
625
|
+
<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>
|
|
626
|
+
|
|
627
|
+
<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_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_transform_values'>transform_values</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
628
|
+
<span class='kw'>end</span></pre>
|
|
629
|
+
</td>
|
|
630
|
+
</tr>
|
|
631
|
+
</table>
|
|
632
|
+
</div>
|
|
633
|
+
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
</div>
|
|
637
|
+
|
|
638
|
+
<div id="footer">
|
|
639
|
+
Generated on Tue Oct 12 21:57:55 2021 by
|
|
640
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
641
|
+
0.9.26 (ruby-3.0.2).
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
</body>
|
|
646
|
+
</html>
|