shotgrid_api_ruby 0.1.3.3 → 0.2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- 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,307 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: ShotgridApiRuby
|
|
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";
|
|
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
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">ShotgridApiRuby</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: ShotgridApiRuby
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<dl>
|
|
73
|
+
<dt>Extended by:</dt>
|
|
74
|
+
<dd>T::Sig</dd>
|
|
75
|
+
</dl>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/shotgrid_api_ruby/auth.rb<span class="defines">,<br />
|
|
87
|
+
lib/shotgrid_api_ruby.rb,<br /> lib/shotgrid_api_ruby/client.rb,<br /> lib/shotgrid_api_ruby/entity.rb,<br /> lib/shotgrid_api_ruby/version.rb,<br /> lib/shotgrid_api_ruby/entities.rb,<br /> lib/shotgrid_api_ruby/preferences.rb,<br /> lib/shotgrid_api_ruby/server_info.rb,<br /> lib/shotgrid_api_ruby/entities/params.rb,<br /> lib/shotgrid_api_ruby/entities/schema.rb,<br /> lib/shotgrid_api_ruby/types/auth_type.rb,<br /> lib/shotgrid_api_ruby/entities/summarize.rb,<br /> lib/shotgrid_api_ruby/shotgrid_call_error.rb</span>
|
|
88
|
+
</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>typed: strict</p>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
<div class="tags">
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</div><h2>Defined Under Namespace</h2>
|
|
105
|
+
<p class="children">
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="ShotgridApiRuby/Types.html" title="ShotgridApiRuby::Types (module)">Types</a></span>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ShotgridApiRuby/Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span>, <span class='object_link'><a href="ShotgridApiRuby/ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span>, <span class='object_link'><a href="ShotgridApiRuby/ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h2>
|
|
119
|
+
Constant Summary
|
|
120
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
121
|
+
</h2>
|
|
122
|
+
|
|
123
|
+
<dl class="constants">
|
|
124
|
+
|
|
125
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
126
|
+
|
|
127
|
+
</dt>
|
|
128
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.2.0.1</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
129
|
+
|
|
130
|
+
</dl>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<h2>
|
|
141
|
+
Class Method Summary
|
|
142
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
143
|
+
</h2>
|
|
144
|
+
|
|
145
|
+
<ul class="summary">
|
|
146
|
+
|
|
147
|
+
<li class="public ">
|
|
148
|
+
<span class="summary_signature">
|
|
149
|
+
|
|
150
|
+
<a href="#new-class_method" title="new (class method)">.<strong>new</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ Client </a>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</span>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
165
|
+
|
|
166
|
+
</li>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</ul>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<div id="class_method_details" class="method_details_list">
|
|
176
|
+
<h2>Class Method Details</h2>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<div class="method_details first">
|
|
180
|
+
<h3 class="signature first" id="new-class_method">
|
|
181
|
+
|
|
182
|
+
.<strong>new</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ <tt><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></tt>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</h3><div class="docstring">
|
|
189
|
+
<div class="discussion">
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</div>
|
|
193
|
+
</div>
|
|
194
|
+
<div class="tags">
|
|
195
|
+
<p class="tag_title">Parameters:</p>
|
|
196
|
+
<ul class="param">
|
|
197
|
+
|
|
198
|
+
<li>
|
|
199
|
+
|
|
200
|
+
<span class='name'>auth</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class='type'>(<tt><span class='object_link'><a href="ShotgridApiRuby/Types.html#AuthType-constant" title="ShotgridApiRuby::Types::AuthType (constant)">ShotgridApiRuby::Types::AuthType</a></span></tt>)</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</li>
|
|
208
|
+
|
|
209
|
+
<li>
|
|
210
|
+
|
|
211
|
+
<span class='name'>site_url</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</li>
|
|
221
|
+
|
|
222
|
+
<li>
|
|
223
|
+
|
|
224
|
+
<span class='name'>shotgun_site</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
<li>
|
|
236
|
+
|
|
237
|
+
<span class='name'>shotgrid_site</span>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
</ul>
|
|
249
|
+
|
|
250
|
+
<p class="tag_title">Returns:</p>
|
|
251
|
+
<ul class="return">
|
|
252
|
+
|
|
253
|
+
<li>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<span class='type'>(<tt><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></tt>)</span>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</li>
|
|
261
|
+
|
|
262
|
+
</ul>
|
|
263
|
+
|
|
264
|
+
</div><table class="source_code">
|
|
265
|
+
<tr>
|
|
266
|
+
<td>
|
|
267
|
+
<pre class="lines">
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
27
|
|
271
|
+
28
|
|
272
|
+
29
|
|
273
|
+
30
|
|
274
|
+
31
|
|
275
|
+
32
|
|
276
|
+
33
|
|
277
|
+
34</pre>
|
|
278
|
+
</td>
|
|
279
|
+
<td>
|
|
280
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby.rb', line 27</span>
|
|
281
|
+
|
|
282
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>auth:</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgun_site:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgrid_site:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
283
|
+
<span class='const'><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
|
|
284
|
+
<span class='label'>auth:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span>
|
|
285
|
+
<span class='label'>site_url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='comma'>,</span>
|
|
286
|
+
<span class='label'>shotgun_site:</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span><span class='comma'>,</span>
|
|
287
|
+
<span class='label'>shotgrid_site:</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span><span class='comma'>,</span>
|
|
288
|
+
<span class='rparen'>)</span>
|
|
289
|
+
<span class='kw'>end</span></pre>
|
|
290
|
+
</td>
|
|
291
|
+
</tr>
|
|
292
|
+
</table>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
<div id="footer">
|
|
300
|
+
Generated on Tue Oct 12 21:57:54 2021 by
|
|
301
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
302
|
+
0.9.26 (ruby-3.0.2).
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
</div>
|
|
306
|
+
</body>
|
|
307
|
+
</html>
|
data/docs/_index.html
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
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
|
+
Documentation by YARD 0.9.26
|
|
8
|
+
|
|
9
|
+
</title>
|
|
10
|
+
|
|
11
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript">
|
|
16
|
+
pathId = null;
|
|
17
|
+
relpath = '';
|
|
18
|
+
</script>
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</head>
|
|
27
|
+
<body>
|
|
28
|
+
<div class="nav_wrap">
|
|
29
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
30
|
+
<div id="resizer"></div>
|
|
31
|
+
</div>
|
|
32
|
+
|
|
33
|
+
<div id="main" tabindex="-1">
|
|
34
|
+
<div id="header">
|
|
35
|
+
<div id="menu">
|
|
36
|
+
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search">
|
|
40
|
+
|
|
41
|
+
<a class="full_list_link" id="class_list_link"
|
|
42
|
+
href="class_list.html">
|
|
43
|
+
|
|
44
|
+
<svg width="24" height="24">
|
|
45
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
46
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
47
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
48
|
+
</svg>
|
|
49
|
+
</a>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
<div class="clear"></div>
|
|
53
|
+
</div>
|
|
54
|
+
|
|
55
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.26</h1>
|
|
56
|
+
<div id="listing">
|
|
57
|
+
<h1 class="alphaindex">Alphabetic Index</h1>
|
|
58
|
+
|
|
59
|
+
<h2>File Listing</h2>
|
|
60
|
+
<ul id="files" class="index_inline_list">
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</ul>
|
|
67
|
+
|
|
68
|
+
<div class="clear"></div>
|
|
69
|
+
<h2>Namespace Listing A-Z</h2>
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
<table>
|
|
75
|
+
<tr>
|
|
76
|
+
<td valign='top' width="33%">
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<ul id="alpha_A" class="alpha">
|
|
80
|
+
<li class="letter">A</li>
|
|
81
|
+
<ul>
|
|
82
|
+
|
|
83
|
+
<li>
|
|
84
|
+
<span class='object_link'><a href="ShotgridApiRuby/Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span>
|
|
85
|
+
|
|
86
|
+
<small>(ShotgridApiRuby)</small>
|
|
87
|
+
|
|
88
|
+
</li>
|
|
89
|
+
|
|
90
|
+
</ul>
|
|
91
|
+
</ul>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<ul id="alpha_C" class="alpha">
|
|
95
|
+
<li class="letter">C</li>
|
|
96
|
+
<ul>
|
|
97
|
+
|
|
98
|
+
<li>
|
|
99
|
+
<span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span>
|
|
100
|
+
|
|
101
|
+
<small>(ShotgridApiRuby)</small>
|
|
102
|
+
|
|
103
|
+
</li>
|
|
104
|
+
|
|
105
|
+
</ul>
|
|
106
|
+
</ul>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<ul id="alpha_E" class="alpha">
|
|
110
|
+
<li class="letter">E</li>
|
|
111
|
+
<ul>
|
|
112
|
+
|
|
113
|
+
<li>
|
|
114
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span>
|
|
115
|
+
|
|
116
|
+
<small>(ShotgridApiRuby)</small>
|
|
117
|
+
|
|
118
|
+
</li>
|
|
119
|
+
|
|
120
|
+
<li>
|
|
121
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>
|
|
122
|
+
|
|
123
|
+
<small>(ShotgridApiRuby)</small>
|
|
124
|
+
|
|
125
|
+
</li>
|
|
126
|
+
|
|
127
|
+
</ul>
|
|
128
|
+
</ul>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<ul id="alpha_P" class="alpha">
|
|
132
|
+
<li class="letter">P</li>
|
|
133
|
+
<ul>
|
|
134
|
+
|
|
135
|
+
<li>
|
|
136
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span>
|
|
137
|
+
|
|
138
|
+
<small>(ShotgridApiRuby::Entities)</small>
|
|
139
|
+
|
|
140
|
+
</li>
|
|
141
|
+
|
|
142
|
+
<li>
|
|
143
|
+
<span class='object_link'><a href="ShotgridApiRuby/Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span>
|
|
144
|
+
|
|
145
|
+
<small>(ShotgridApiRuby)</small>
|
|
146
|
+
|
|
147
|
+
</li>
|
|
148
|
+
|
|
149
|
+
</ul>
|
|
150
|
+
</ul>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<ul id="alpha_S" class="alpha">
|
|
154
|
+
<li class="letter">S</li>
|
|
155
|
+
<ul>
|
|
156
|
+
|
|
157
|
+
<li>
|
|
158
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span>
|
|
159
|
+
|
|
160
|
+
<small>(ShotgridApiRuby::Entities)</small>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
<li>
|
|
165
|
+
<span class='object_link'><a href="ShotgridApiRuby/ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span>
|
|
166
|
+
|
|
167
|
+
<small>(ShotgridApiRuby)</small>
|
|
168
|
+
|
|
169
|
+
</li>
|
|
170
|
+
|
|
171
|
+
<li>
|
|
172
|
+
<span class='object_link'><a href="ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span>
|
|
173
|
+
|
|
174
|
+
</li>
|
|
175
|
+
|
|
176
|
+
<li>
|
|
177
|
+
<span class='object_link'><a href="ShotgridApiRuby/ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span>
|
|
178
|
+
|
|
179
|
+
<small>(ShotgridApiRuby)</small>
|
|
180
|
+
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
<li>
|
|
184
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span>
|
|
185
|
+
|
|
186
|
+
<small>(ShotgridApiRuby::Entities)</small>
|
|
187
|
+
|
|
188
|
+
</li>
|
|
189
|
+
|
|
190
|
+
<li>
|
|
191
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities/Summarize/Summary.html" title="ShotgridApiRuby::Entities::Summarize::Summary (class)">Summary</a></span>
|
|
192
|
+
|
|
193
|
+
<small>(ShotgridApiRuby::Entities::Summarize)</small>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
</ul>
|
|
198
|
+
</ul>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<ul id="alpha_T" class="alpha">
|
|
202
|
+
<li class="letter">T</li>
|
|
203
|
+
<ul>
|
|
204
|
+
|
|
205
|
+
<li>
|
|
206
|
+
<span class='object_link'><a href="ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html" title="ShotgridApiRuby::Entities::Params::TooComplexFiltersError (class)">TooComplexFiltersError</a></span>
|
|
207
|
+
|
|
208
|
+
<small>(ShotgridApiRuby::Entities::Params)</small>
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
<li>
|
|
213
|
+
<span class='object_link'><a href="ShotgridApiRuby/Types.html" title="ShotgridApiRuby::Types (module)">Types</a></span>
|
|
214
|
+
|
|
215
|
+
<small>(ShotgridApiRuby)</small>
|
|
216
|
+
|
|
217
|
+
</li>
|
|
218
|
+
|
|
219
|
+
</ul>
|
|
220
|
+
</ul>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<ul id="alpha_V" class="alpha">
|
|
224
|
+
<li class="letter">V</li>
|
|
225
|
+
<ul>
|
|
226
|
+
|
|
227
|
+
<li>
|
|
228
|
+
<span class='object_link'><a href="ShotgridApiRuby/Auth/Validator.html" title="ShotgridApiRuby::Auth::Validator (module)">Validator</a></span>
|
|
229
|
+
|
|
230
|
+
<small>(ShotgridApiRuby::Auth)</small>
|
|
231
|
+
|
|
232
|
+
</li>
|
|
233
|
+
|
|
234
|
+
</ul>
|
|
235
|
+
</ul>
|
|
236
|
+
|
|
237
|
+
</td>
|
|
238
|
+
</tr>
|
|
239
|
+
</table>
|
|
240
|
+
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
</div>
|
|
244
|
+
|
|
245
|
+
<div id="footer">
|
|
246
|
+
Generated on Tue Oct 12 21:57:53 2021 by
|
|
247
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
248
|
+
0.9.26 (ruby-3.0.2).
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
</div>
|
|
252
|
+
</body>
|
|
253
|
+
</html>
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>Class List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<div id="content">
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">Class List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<ul id="full_list" class="class">
|
|
45
|
+
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
|
46
|
+
<li id='object_ShotgridApiRuby' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_ShotgridApiRuby::Auth' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="ShotgridApiRuby/Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span> < Middleware<small class='search_info'>ShotgridApiRuby</small></div><ul><li id='object_ShotgridApiRuby::Auth::Validator' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="ShotgridApiRuby/Auth/Validator.html" title="ShotgridApiRuby::Auth::Validator (module)">Validator</a></span><small class='search_info'>ShotgridApiRuby::Auth</small></div></li></ul></li><li id='object_ShotgridApiRuby::Client' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span> < Object<small class='search_info'>ShotgridApiRuby</small></div></li><li id='object_ShotgridApiRuby::Entities' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="ShotgridApiRuby/Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span> < Object<small class='search_info'>ShotgridApiRuby</small></div><ul><li id='object_ShotgridApiRuby::Entities::Params' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="ShotgridApiRuby/Entities/Params.html" title="ShotgridApiRuby::Entities::Params (class)">Params</a></span> < Object<small class='search_info'>ShotgridApiRuby::Entities</small></div><ul><li id='object_ShotgridApiRuby::Entities::Params::TooComplexFiltersError' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html" title="ShotgridApiRuby::Entities::Params::TooComplexFiltersError (class)">TooComplexFiltersError</a></span> < StandardError<small class='search_info'>ShotgridApiRuby::Entities::Params</small></div></li></ul></li><li id='object_ShotgridApiRuby::Entities::Schema' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="ShotgridApiRuby/Entities/Schema.html" title="ShotgridApiRuby::Entities::Schema (class)">Schema</a></span> < Object<small class='search_info'>ShotgridApiRuby::Entities</small></div></li><li id='object_ShotgridApiRuby::Entities::Summarize' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="ShotgridApiRuby/Entities/Summarize.html" title="ShotgridApiRuby::Entities::Summarize (class)">Summarize</a></span> < Object<small class='search_info'>ShotgridApiRuby::Entities</small></div><ul><li id='object_ShotgridApiRuby::Entities::Summarize::Summary' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="ShotgridApiRuby/Entities/Summarize/Summary.html" title="ShotgridApiRuby::Entities::Summarize::Summary (class)">Summary</a></span> < Struct<small class='search_info'>ShotgridApiRuby::Entities::Summarize</small></div></li></ul></li></ul></li><li id='object_ShotgridApiRuby::Entity' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span> < Struct<small class='search_info'>ShotgridApiRuby</small></div></li><li id='object_ShotgridApiRuby::Preferences' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span> < Object<small class='search_info'>ShotgridApiRuby</small></div></li><li id='object_ShotgridApiRuby::ServerInfo' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span> < Object<small class='search_info'>ShotgridApiRuby</small></div></li><li id='object_ShotgridApiRuby::ShotgridCallError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span> < StandardError<small class='search_info'>ShotgridApiRuby</small></div></li><li id='object_ShotgridApiRuby::Types' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="ShotgridApiRuby/Types.html" title="ShotgridApiRuby::Types (module)">Types</a></span><small class='search_info'>ShotgridApiRuby</small></div></li></ul></li>
|
|
47
|
+
|
|
48
|
+
</ul>
|
|
49
|
+
</div>
|
|
50
|
+
</body>
|
|
51
|
+
</html>
|
data/docs/css/common.css
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
/* Override this file with custom rules */
|