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,933 @@
|
|
|
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::Client
|
|
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::Client";
|
|
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 (C)</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">Client</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::Client
|
|
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::Client</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/client.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Overview</h2><div class="docstring">
|
|
108
|
+
<div class="discussion">
|
|
109
|
+
|
|
110
|
+
<p>Main class for connection.</p>
|
|
111
|
+
|
|
112
|
+
<p>This should be only instanciated once to re-use tokens</p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
125
|
+
<ul class="summary">
|
|
126
|
+
|
|
127
|
+
<li class="public ">
|
|
128
|
+
<span class="summary_signature">
|
|
129
|
+
|
|
130
|
+
<a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong> ⇒ Faraday::Connection </a>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</span>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<span class="note title readonly">readonly</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
|
150
|
+
<p>Faraday connection.</p>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</ul>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<h2>
|
|
163
|
+
Instance Method Summary
|
|
164
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
165
|
+
</h2>
|
|
166
|
+
|
|
167
|
+
<ul class="summary">
|
|
168
|
+
|
|
169
|
+
<li class="public ">
|
|
170
|
+
<span class="summary_signature">
|
|
171
|
+
|
|
172
|
+
<a href="#entities-instance_method" title="#entities (instance method)">#<strong>entities</strong>(type) ⇒ Entities </a>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
</span>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'>
|
|
187
|
+
<p>Access entities related APIs.</p>
|
|
188
|
+
</div></span>
|
|
189
|
+
|
|
190
|
+
</li>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ void </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="note title constructor">constructor</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
213
|
+
|
|
214
|
+
</li>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<li class="public ">
|
|
218
|
+
<span class="summary_signature">
|
|
219
|
+
|
|
220
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">#<strong>method_missing</strong>(name, *args, &block) ⇒ Entities </a>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
235
|
+
|
|
236
|
+
</li>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<li class="public ">
|
|
240
|
+
<span class="summary_signature">
|
|
241
|
+
|
|
242
|
+
<a href="#preferences-instance_method" title="#preferences (instance method)">#<strong>preferences</strong> ⇒ Preferences </a>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<span class="summary_desc"><div class='inline'>
|
|
257
|
+
<p>Access preferences APIs.</p>
|
|
258
|
+
</div></span>
|
|
259
|
+
|
|
260
|
+
</li>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<li class="public ">
|
|
264
|
+
<span class="summary_signature">
|
|
265
|
+
|
|
266
|
+
<a href="#respond_to_missing%3F-instance_method" title="#respond_to_missing? (instance method)">#<strong>respond_to_missing?</strong>(_name, _include_private = false) ⇒ true </a>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</span>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
281
|
+
|
|
282
|
+
</li>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<li class="public ">
|
|
286
|
+
<span class="summary_signature">
|
|
287
|
+
|
|
288
|
+
<a href="#server_info-instance_method" title="#server_info (instance method)">#<strong>server_info</strong> ⇒ ServerInfo </a>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class="summary_desc"><div class='inline'>
|
|
303
|
+
<p>Access server_info APIs.</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</ul>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<div id="constructor_details" class="method_details_list">
|
|
314
|
+
<h2>Constructor Details</h2>
|
|
315
|
+
|
|
316
|
+
<div class="method_details first">
|
|
317
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
318
|
+
|
|
319
|
+
#<strong>initialize</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ <tt>void</tt>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</h3><div class="docstring">
|
|
326
|
+
<div class="discussion">
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
</div>
|
|
331
|
+
<div class="tags">
|
|
332
|
+
<p class="tag_title">Parameters:</p>
|
|
333
|
+
<ul class="param">
|
|
334
|
+
|
|
335
|
+
<li>
|
|
336
|
+
|
|
337
|
+
<span class='name'>auth</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<span class='type'>(<tt><span class='object_link'><a href="Types.html#AuthType-constant" title="ShotgridApiRuby::Types::AuthType (constant)">Types::AuthType</a></span></tt>)</span>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</li>
|
|
345
|
+
|
|
346
|
+
<li>
|
|
347
|
+
|
|
348
|
+
<span class='name'>site_url</span>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</li>
|
|
358
|
+
|
|
359
|
+
<li>
|
|
360
|
+
|
|
361
|
+
<span class='name'>shotgun_site</span>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</li>
|
|
371
|
+
|
|
372
|
+
<li>
|
|
373
|
+
|
|
374
|
+
<span class='name'>shotgrid_site</span>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</li>
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
</div><table class="source_code">
|
|
389
|
+
<tr>
|
|
390
|
+
<td>
|
|
391
|
+
<pre class="lines">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
19
|
|
395
|
+
20
|
|
396
|
+
21
|
|
397
|
+
22
|
|
398
|
+
23
|
|
399
|
+
24
|
|
400
|
+
25
|
|
401
|
+
26
|
|
402
|
+
27
|
|
403
|
+
28
|
|
404
|
+
29
|
|
405
|
+
30
|
|
406
|
+
31
|
|
407
|
+
32
|
|
408
|
+
33
|
|
409
|
+
34
|
|
410
|
+
35
|
|
411
|
+
36
|
|
412
|
+
37
|
|
413
|
+
38
|
|
414
|
+
39
|
|
415
|
+
40
|
|
416
|
+
41
|
|
417
|
+
42
|
|
418
|
+
43
|
|
419
|
+
44
|
|
420
|
+
45
|
|
421
|
+
46
|
|
422
|
+
47
|
|
423
|
+
48
|
|
424
|
+
49
|
|
425
|
+
50</pre>
|
|
426
|
+
</td>
|
|
427
|
+
<td>
|
|
428
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 19</span>
|
|
429
|
+
|
|
430
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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>
|
|
431
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>No site given</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_site_url'>site_url</span> <span class='op'>||</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span> <span class='op'>||</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span>
|
|
432
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='const'><span class='object_link'><a href="Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Auth/Validator.html" title="ShotgridApiRuby::Auth::Validator (module)">Validator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_valid?'><span class='object_link'><a href="Auth/Validator.html#valid%3F-class_method" title="ShotgridApiRuby::Auth::Validator.valid? (method)">valid?</a></span></span><span class='lparen'>(</span>
|
|
433
|
+
<span class='label'>client_id:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:client_id</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
434
|
+
<span class='label'>client_secret:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:client_secret</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
435
|
+
<span class='label'>username:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
436
|
+
<span class='label'>password:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
437
|
+
<span class='label'>session_token:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:session_token</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
438
|
+
<span class='label'>refresh_token:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:refresh_token</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
439
|
+
<span class='rparen'>)</span>
|
|
440
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>auth param not valid</span><span class='tstring_end'>'</span></span>
|
|
441
|
+
<span class='kw'>end</span>
|
|
442
|
+
|
|
443
|
+
<span class='id identifier rubyid_site_url'>site_url</span> <span class='op'>||=</span>
|
|
444
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span>
|
|
445
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_shotgun_site'>shotgun_site</span><span class='embexpr_end'>}</span><span class='tstring_content'>.shotgunstudio.com/api/v1</span><span class='tstring_end'>"</span></span>
|
|
446
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span>
|
|
447
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span><span class='embexpr_end'>}</span><span class='tstring_content'>.shotgrid.autodesk.com/api/v1</span><span class='tstring_end'>"</span></span>
|
|
448
|
+
<span class='kw'>end</span>
|
|
449
|
+
|
|
450
|
+
<span class='ivar'>@connection</span> <span class='op'>=</span>
|
|
451
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span>
|
|
452
|
+
<span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_faraday'>faraday</span><span class='op'>|</span>
|
|
453
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span><span class='comma'>,</span> <span class='label'>auth:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='rparen'>)</span>
|
|
454
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span>
|
|
455
|
+
<span class='kw'>end</span><span class='comma'>,</span>
|
|
456
|
+
<span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Connection</span><span class='comma'>,</span>
|
|
457
|
+
<span class='rparen'>)</span>
|
|
458
|
+
<span class='ivar'>@preferences</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="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
459
|
+
<span class='ivar'>@server_info</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="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
460
|
+
<span class='ivar'>@entity_caller</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.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
461
|
+
<span class='kw'>end</span></pre>
|
|
462
|
+
</td>
|
|
463
|
+
</tr>
|
|
464
|
+
</table>
|
|
465
|
+
</div>
|
|
466
|
+
|
|
467
|
+
</div>
|
|
468
|
+
<div id="method_missing_details" class="method_details_list">
|
|
469
|
+
<h2>Dynamic Method Handling</h2>
|
|
470
|
+
<p class="notice this">
|
|
471
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
472
|
+
|
|
473
|
+
</p>
|
|
474
|
+
|
|
475
|
+
<div class="method_details first">
|
|
476
|
+
<h3 class="signature first" id="method_missing-instance_method">
|
|
477
|
+
|
|
478
|
+
#<strong>method_missing</strong>(name, *args, &block) ⇒ <tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
</h3><div class="docstring">
|
|
485
|
+
<div class="discussion">
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
</div>
|
|
490
|
+
<div class="tags">
|
|
491
|
+
<p class="tag_title">Parameters:</p>
|
|
492
|
+
<ul class="param">
|
|
493
|
+
|
|
494
|
+
<li>
|
|
495
|
+
|
|
496
|
+
<span class='name'>name</span>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</li>
|
|
504
|
+
|
|
505
|
+
<li>
|
|
506
|
+
|
|
507
|
+
<span class='name'>args</span>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<span class='type'>(<tt>Array<T.untyped></tt>)</span>
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
</li>
|
|
515
|
+
|
|
516
|
+
<li>
|
|
517
|
+
|
|
518
|
+
<span class='name'>block</span>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<span class='type'>(<tt>Proc</tt>, <tt>nil</tt>)</span>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
</li>
|
|
526
|
+
|
|
527
|
+
</ul>
|
|
528
|
+
|
|
529
|
+
<p class="tag_title">Returns:</p>
|
|
530
|
+
<ul class="return">
|
|
531
|
+
|
|
532
|
+
<li>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>)</span>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
</li>
|
|
540
|
+
|
|
541
|
+
</ul>
|
|
542
|
+
|
|
543
|
+
</div><table class="source_code">
|
|
544
|
+
<tr>
|
|
545
|
+
<td>
|
|
546
|
+
<pre class="lines">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
89
|
|
550
|
+
90
|
|
551
|
+
91
|
|
552
|
+
92
|
|
553
|
+
93
|
|
554
|
+
94
|
|
555
|
+
95
|
|
556
|
+
96
|
|
557
|
+
97
|
|
558
|
+
98
|
|
559
|
+
99
|
|
560
|
+
100
|
|
561
|
+
101
|
|
562
|
+
102
|
|
563
|
+
103
|
|
564
|
+
104
|
|
565
|
+
105
|
|
566
|
+
106
|
|
567
|
+
107</pre>
|
|
568
|
+
</td>
|
|
569
|
+
<td>
|
|
570
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 89</span>
|
|
571
|
+
|
|
572
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
573
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
574
|
+
<span class='id identifier rubyid_fname'>fname</span> <span class='op'>=</span> <span class='id identifier rubyid_formated_name'>formated_name</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
575
|
+
<span class='kw'>self</span>
|
|
576
|
+
<span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
|
|
577
|
+
<span class='period'>.</span><span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
|
578
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_entities_client'>entities_client</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fname'>fname</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
579
|
+
<span class='id identifier rubyid_entities_client'>entities_client</span>
|
|
580
|
+
<span class='kw'>else</span>
|
|
581
|
+
<span class='id identifier rubyid_entities_client'>entities_client</span> <span class='op'>=</span> <span class='id identifier rubyid_entities_aux'>entities_aux</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span>
|
|
582
|
+
<span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fname'>fname</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_entities_client'>entities_client</span><span class='rparen'>)</span>
|
|
583
|
+
<span class='kw'>end</span>
|
|
584
|
+
<span class='kw'>end</span>
|
|
585
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_fname'>fname</span> <span class='rbrace'>}</span>
|
|
586
|
+
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span>
|
|
587
|
+
<span class='kw'>else</span>
|
|
588
|
+
<span class='kw'>super</span>
|
|
589
|
+
<span class='kw'>end</span>
|
|
590
|
+
<span class='kw'>end</span></pre>
|
|
591
|
+
</td>
|
|
592
|
+
</tr>
|
|
593
|
+
</table>
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
</div>
|
|
597
|
+
|
|
598
|
+
<div id="instance_attr_details" class="attr_details">
|
|
599
|
+
<h2>Instance Attribute Details</h2>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<span id=""></span>
|
|
603
|
+
<div class="method_details first">
|
|
604
|
+
<h3 class="signature first" id="connection-instance_method">
|
|
605
|
+
|
|
606
|
+
#<strong>connection</strong> ⇒ <tt>Faraday::Connection</tt> <span class="extras">(readonly)</span>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</h3><div class="docstring">
|
|
613
|
+
<div class="discussion">
|
|
614
|
+
|
|
615
|
+
<p>Faraday connection</p>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
</div>
|
|
619
|
+
</div>
|
|
620
|
+
<div class="tags">
|
|
621
|
+
|
|
622
|
+
<p class="tag_title">Returns:</p>
|
|
623
|
+
<ul class="return">
|
|
624
|
+
|
|
625
|
+
<li>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</li>
|
|
633
|
+
|
|
634
|
+
</ul>
|
|
635
|
+
|
|
636
|
+
</div><table class="source_code">
|
|
637
|
+
<tr>
|
|
638
|
+
<td>
|
|
639
|
+
<pre class="lines">
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
54
|
|
643
|
+
55
|
|
644
|
+
56</pre>
|
|
645
|
+
</td>
|
|
646
|
+
<td>
|
|
647
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 54</span>
|
|
648
|
+
|
|
649
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
|
|
650
|
+
<span class='ivar'>@connection</span>
|
|
651
|
+
<span class='kw'>end</span></pre>
|
|
652
|
+
</td>
|
|
653
|
+
</tr>
|
|
654
|
+
</table>
|
|
655
|
+
</div>
|
|
656
|
+
|
|
657
|
+
</div>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
<div id="instance_method_details" class="method_details_list">
|
|
661
|
+
<h2>Instance Method Details</h2>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
<div class="method_details first">
|
|
665
|
+
<h3 class="signature first" id="entities-instance_method">
|
|
666
|
+
|
|
667
|
+
#<strong>entities</strong>(type) ⇒ <tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</h3><div class="docstring">
|
|
674
|
+
<div class="discussion">
|
|
675
|
+
|
|
676
|
+
<p>Access entities related APIs</p>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</div>
|
|
680
|
+
</div>
|
|
681
|
+
<div class="tags">
|
|
682
|
+
<p class="tag_title">Parameters:</p>
|
|
683
|
+
<ul class="param">
|
|
684
|
+
|
|
685
|
+
<li>
|
|
686
|
+
|
|
687
|
+
<span class='name'>type</span>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<span class='type'>(<tt>Symbol</tt>, <tt>String</tt>)</span>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
</ul>
|
|
697
|
+
|
|
698
|
+
<p class="tag_title">Returns:</p>
|
|
699
|
+
<ul class="return">
|
|
700
|
+
|
|
701
|
+
<li>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>)</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
</li>
|
|
709
|
+
|
|
710
|
+
</ul>
|
|
711
|
+
|
|
712
|
+
</div><table class="source_code">
|
|
713
|
+
<tr>
|
|
714
|
+
<td>
|
|
715
|
+
<pre class="lines">
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
70
|
|
719
|
+
71
|
|
720
|
+
72</pre>
|
|
721
|
+
</td>
|
|
722
|
+
<td>
|
|
723
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 70</span>
|
|
724
|
+
|
|
725
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_entities'>entities</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
726
|
+
<span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
727
|
+
<span class='kw'>end</span></pre>
|
|
728
|
+
</td>
|
|
729
|
+
</tr>
|
|
730
|
+
</table>
|
|
731
|
+
</div>
|
|
732
|
+
|
|
733
|
+
<div class="method_details ">
|
|
734
|
+
<h3 class="signature " id="preferences-instance_method">
|
|
735
|
+
|
|
736
|
+
#<strong>preferences</strong> ⇒ <tt><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></tt>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
</h3><div class="docstring">
|
|
743
|
+
<div class="discussion">
|
|
744
|
+
|
|
745
|
+
<p>Access preferences APIs</p>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
</div>
|
|
749
|
+
</div>
|
|
750
|
+
<div class="tags">
|
|
751
|
+
|
|
752
|
+
<p class="tag_title">Returns:</p>
|
|
753
|
+
<ul class="return">
|
|
754
|
+
|
|
755
|
+
<li>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
<span class='type'>(<tt><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></tt>)</span>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
</li>
|
|
763
|
+
|
|
764
|
+
</ul>
|
|
765
|
+
|
|
766
|
+
</div><table class="source_code">
|
|
767
|
+
<tr>
|
|
768
|
+
<td>
|
|
769
|
+
<pre class="lines">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
58
|
|
773
|
+
59
|
|
774
|
+
60</pre>
|
|
775
|
+
</td>
|
|
776
|
+
<td>
|
|
777
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 58</span>
|
|
778
|
+
|
|
779
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_preferences'>preferences</span>
|
|
780
|
+
<span class='ivar'>@preferences</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</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><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
|
|
781
|
+
<span class='kw'>end</span></pre>
|
|
782
|
+
</td>
|
|
783
|
+
</tr>
|
|
784
|
+
</table>
|
|
785
|
+
</div>
|
|
786
|
+
|
|
787
|
+
<div class="method_details ">
|
|
788
|
+
<h3 class="signature " id="respond_to_missing?-instance_method">
|
|
789
|
+
|
|
790
|
+
#<strong>respond_to_missing?</strong>(_name, _include_private = false) ⇒ <tt>true</tt>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
</h3><div class="docstring">
|
|
797
|
+
<div class="discussion">
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
</div>
|
|
801
|
+
</div>
|
|
802
|
+
<div class="tags">
|
|
803
|
+
<p class="tag_title">Parameters:</p>
|
|
804
|
+
<ul class="param">
|
|
805
|
+
|
|
806
|
+
<li>
|
|
807
|
+
|
|
808
|
+
<span class='name'>_name</span>
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
<span class='type'>(<tt>T.untyped</tt>)</span>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
</li>
|
|
816
|
+
|
|
817
|
+
<li>
|
|
818
|
+
|
|
819
|
+
<span class='name'>_include_private</span>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<span class='type'>(<tt>T.untyped</tt>)</span>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
</li>
|
|
829
|
+
|
|
830
|
+
</ul>
|
|
831
|
+
|
|
832
|
+
<p class="tag_title">Returns:</p>
|
|
833
|
+
<ul class="return">
|
|
834
|
+
|
|
835
|
+
<li>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
<span class='type'>(<tt>true</tt>)</span>
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</li>
|
|
843
|
+
|
|
844
|
+
</ul>
|
|
845
|
+
|
|
846
|
+
</div><table class="source_code">
|
|
847
|
+
<tr>
|
|
848
|
+
<td>
|
|
849
|
+
<pre class="lines">
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
77
|
|
853
|
+
78
|
|
854
|
+
79</pre>
|
|
855
|
+
</td>
|
|
856
|
+
<td>
|
|
857
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 77</span>
|
|
858
|
+
|
|
859
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='id identifier rubyid__name'>_name</span><span class='comma'>,</span> <span class='id identifier rubyid__include_private'>_include_private</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
860
|
+
<span class='kw'>true</span>
|
|
861
|
+
<span class='kw'>end</span></pre>
|
|
862
|
+
</td>
|
|
863
|
+
</tr>
|
|
864
|
+
</table>
|
|
865
|
+
</div>
|
|
866
|
+
|
|
867
|
+
<div class="method_details ">
|
|
868
|
+
<h3 class="signature " id="server_info-instance_method">
|
|
869
|
+
|
|
870
|
+
#<strong>server_info</strong> ⇒ <tt><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></tt>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
</h3><div class="docstring">
|
|
877
|
+
<div class="discussion">
|
|
878
|
+
|
|
879
|
+
<p>Access server_info APIs</p>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
</div>
|
|
883
|
+
</div>
|
|
884
|
+
<div class="tags">
|
|
885
|
+
|
|
886
|
+
<p class="tag_title">Returns:</p>
|
|
887
|
+
<ul class="return">
|
|
888
|
+
|
|
889
|
+
<li>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
<span class='type'>(<tt><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></tt>)</span>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
</li>
|
|
897
|
+
|
|
898
|
+
</ul>
|
|
899
|
+
|
|
900
|
+
</div><table class="source_code">
|
|
901
|
+
<tr>
|
|
902
|
+
<td>
|
|
903
|
+
<pre class="lines">
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
64
|
|
907
|
+
65
|
|
908
|
+
66</pre>
|
|
909
|
+
</td>
|
|
910
|
+
<td>
|
|
911
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 64</span>
|
|
912
|
+
|
|
913
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_server_info'>server_info</span>
|
|
914
|
+
<span class='ivar'>@server_info</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</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><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
|
|
915
|
+
<span class='kw'>end</span></pre>
|
|
916
|
+
</td>
|
|
917
|
+
</tr>
|
|
918
|
+
</table>
|
|
919
|
+
</div>
|
|
920
|
+
|
|
921
|
+
</div>
|
|
922
|
+
|
|
923
|
+
</div>
|
|
924
|
+
|
|
925
|
+
<div id="footer">
|
|
926
|
+
Generated on Tue Oct 12 21:57:54 2021 by
|
|
927
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
928
|
+
0.9.26 (ruby-3.0.2).
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
</div>
|
|
932
|
+
</body>
|
|
933
|
+
</html>
|