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,1079 @@
|
|
|
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::Auth
|
|
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::Auth";
|
|
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 (A)</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">Auth</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::Auth
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Faraday::Middleware</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Faraday::Middleware</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">ShotgridApiRuby::Auth</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<dl>
|
|
91
|
+
<dt>Extended by:</dt>
|
|
92
|
+
<dd>T::Sig</dd>
|
|
93
|
+
</dl>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<dl>
|
|
103
|
+
<dt>Defined in:</dt>
|
|
104
|
+
<dd>lib/shotgrid_api_ruby/auth.rb</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Overview</h2><div class="docstring">
|
|
110
|
+
<div class="discussion">
|
|
111
|
+
|
|
112
|
+
<p>Faraday middleware responsible for authentication with the shotgrid site</p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div><h2>Defined Under Namespace</h2>
|
|
121
|
+
<p class="children">
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Auth/Validator.html" title="ShotgridApiRuby::Auth::Validator (module)">Validator</a></span>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</p>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
135
|
+
<ul class="summary">
|
|
136
|
+
|
|
137
|
+
<li class="public ">
|
|
138
|
+
<span class="summary_signature">
|
|
139
|
+
|
|
140
|
+
<a href="#client_id-instance_method" title="#client_id (instance method)">#<strong>client_id</strong> ⇒ String<sup>?</sup> </a>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="note title readonly">readonly</span>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
160
|
+
|
|
161
|
+
</li>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<li class="public ">
|
|
165
|
+
<span class="summary_signature">
|
|
166
|
+
|
|
167
|
+
<a href="#client_secret-instance_method" title="#client_secret (instance method)">#<strong>client_secret</strong> ⇒ String<sup>?</sup> </a>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</span>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="note title readonly">readonly</span>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
187
|
+
|
|
188
|
+
</li>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<li class="public ">
|
|
192
|
+
<span class="summary_signature">
|
|
193
|
+
|
|
194
|
+
<a href="#password-instance_method" title="#password (instance method)">#<strong>password</strong> ⇒ String<sup>?</sup> </a>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</span>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="note title readonly">readonly</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#refresh_token-instance_method" title="#refresh_token (instance method)">#<strong>refresh_token</strong> ⇒ String<sup>?</sup> </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="note title readonly">readonly</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
241
|
+
|
|
242
|
+
</li>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<li class="public ">
|
|
246
|
+
<span class="summary_signature">
|
|
247
|
+
|
|
248
|
+
<a href="#session_token-instance_method" title="#session_token (instance method)">#<strong>session_token</strong> ⇒ String<sup>?</sup> </a>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</span>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="note title readonly">readonly</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
268
|
+
|
|
269
|
+
</li>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<li class="public ">
|
|
273
|
+
<span class="summary_signature">
|
|
274
|
+
|
|
275
|
+
<a href="#site_url-instance_method" title="#site_url (instance method)">#<strong>site_url</strong> ⇒ String </a>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class="note title readonly">readonly</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<li class="public ">
|
|
300
|
+
<span class="summary_signature">
|
|
301
|
+
|
|
302
|
+
<a href="#username-instance_method" title="#username (instance method)">#<strong>username</strong> ⇒ String<sup>?</sup> </a>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<span class="note title readonly">readonly</span>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
</ul>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<h2>
|
|
333
|
+
Instance Method Summary
|
|
334
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
335
|
+
</h2>
|
|
336
|
+
|
|
337
|
+
<ul class="summary">
|
|
338
|
+
|
|
339
|
+
<li class="public ">
|
|
340
|
+
<span class="summary_signature">
|
|
341
|
+
|
|
342
|
+
<a href="#auth_type-instance_method" title="#auth_type (instance method)">#<strong>auth_type</strong> ⇒ String </a>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
</span>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
357
|
+
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<li class="public ">
|
|
362
|
+
<span class="summary_signature">
|
|
363
|
+
|
|
364
|
+
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(request_env) ⇒ Faraday::Response </a>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</span>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
379
|
+
|
|
380
|
+
</li>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
<li class="public ">
|
|
384
|
+
<span class="summary_signature">
|
|
385
|
+
|
|
386
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(app = nil, options = { auth: nil, site_url: nil }) ⇒ void </a>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</span>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
<span class="note title constructor">constructor</span>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
403
|
+
|
|
404
|
+
</li>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</ul>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<div id="constructor_details" class="method_details_list">
|
|
413
|
+
<h2>Constructor Details</h2>
|
|
414
|
+
|
|
415
|
+
<div class="method_details first">
|
|
416
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
417
|
+
|
|
418
|
+
#<strong>initialize</strong>(app = nil, options = { auth: nil, site_url: nil }) ⇒ <tt>void</tt>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</h3><div class="docstring">
|
|
425
|
+
<div class="discussion">
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
</div>
|
|
429
|
+
</div>
|
|
430
|
+
<div class="tags">
|
|
431
|
+
<p class="tag_title">Parameters:</p>
|
|
432
|
+
<ul class="param">
|
|
433
|
+
|
|
434
|
+
<li>
|
|
435
|
+
|
|
436
|
+
<span class='name'>app</span>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<span class='type'>(<tt>T.untyped</tt>)</span>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
</li>
|
|
446
|
+
|
|
447
|
+
<li>
|
|
448
|
+
|
|
449
|
+
<span class='name'>options</span>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
<em class="default">(defaults to: <tt>{ auth: nil, site_url: nil }</tt>)</em>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</li>
|
|
459
|
+
|
|
460
|
+
</ul>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
</div><table class="source_code">
|
|
464
|
+
<tr>
|
|
465
|
+
<td>
|
|
466
|
+
<pre class="lines">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
50
|
|
470
|
+
51
|
|
471
|
+
52
|
|
472
|
+
53
|
|
473
|
+
54
|
|
474
|
+
55
|
|
475
|
+
56
|
|
476
|
+
57
|
|
477
|
+
58
|
|
478
|
+
59
|
|
479
|
+
60
|
|
480
|
+
61
|
|
481
|
+
62
|
|
482
|
+
63
|
|
483
|
+
64
|
|
484
|
+
65
|
|
485
|
+
66
|
|
486
|
+
67
|
|
487
|
+
68
|
|
488
|
+
69
|
|
489
|
+
70
|
|
490
|
+
71
|
|
491
|
+
72
|
|
492
|
+
73
|
|
493
|
+
74
|
|
494
|
+
75
|
|
495
|
+
76</pre>
|
|
496
|
+
</td>
|
|
497
|
+
<td>
|
|
498
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 50</span>
|
|
499
|
+
|
|
500
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>auth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='kw'>nil</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
501
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>missing auth</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span>
|
|
502
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>missing site_url</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site_url</span><span class='rbracket'>]</span>
|
|
503
|
+
<span class='kw'>unless</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><span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_transform_keys'>transform_keys</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
504
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Auth not valid</span><span class='tstring_end'>'</span></span>
|
|
505
|
+
<span class='kw'>end</span>
|
|
506
|
+
|
|
507
|
+
<span class='ivar'>@site_url</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site_url</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
|
|
508
|
+
<span class='ivar'>@client_id</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:client_id</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
509
|
+
<span class='ivar'>@client_secret</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:client_secret</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
510
|
+
<span class='ivar'>@username</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
511
|
+
<span class='ivar'>@password</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
512
|
+
<span class='ivar'>@session_token</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:session_token</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
513
|
+
<span class='ivar'>@refresh_token</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:auth</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:refresh_token</span><span class='rbracket'>]</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
514
|
+
<span class='ivar'>@app</span> <span class='op'>=</span>
|
|
515
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span>
|
|
516
|
+
<span class='kw'>nil</span><span class='comma'>,</span>
|
|
517
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</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'>Faraday</span><span class='op'>::</span><span class='const'>Middleware</span><span class='comma'>,</span> <span class='const'>VCR</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Faraday</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
518
|
+
<span class='rparen'>)</span>
|
|
519
|
+
<span class='ivar'>@auth_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='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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
520
|
+
<span class='ivar'>@auth_params</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
521
|
+
<span class='ivar'>@auth_url</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
522
|
+
<span class='ivar'>@access_token</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'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
523
|
+
<span class='ivar'>@token_expiry</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'>Time</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
524
|
+
|
|
525
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
|
|
526
|
+
<span class='kw'>end</span></pre>
|
|
527
|
+
</td>
|
|
528
|
+
</tr>
|
|
529
|
+
</table>
|
|
530
|
+
</div>
|
|
531
|
+
|
|
532
|
+
</div>
|
|
533
|
+
|
|
534
|
+
<div id="instance_attr_details" class="attr_details">
|
|
535
|
+
<h2>Instance Attribute Details</h2>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<span id=""></span>
|
|
539
|
+
<div class="method_details first">
|
|
540
|
+
<h3 class="signature first" id="client_id-instance_method">
|
|
541
|
+
|
|
542
|
+
#<strong>client_id</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
</h3><div class="docstring">
|
|
549
|
+
<div class="discussion">
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</div>
|
|
553
|
+
</div>
|
|
554
|
+
<div class="tags">
|
|
555
|
+
|
|
556
|
+
<p class="tag_title">Returns:</p>
|
|
557
|
+
<ul class="return">
|
|
558
|
+
|
|
559
|
+
<li>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</li>
|
|
567
|
+
|
|
568
|
+
</ul>
|
|
569
|
+
|
|
570
|
+
</div><table class="source_code">
|
|
571
|
+
<tr>
|
|
572
|
+
<td>
|
|
573
|
+
<pre class="lines">
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
79
|
|
577
|
+
80
|
|
578
|
+
81</pre>
|
|
579
|
+
</td>
|
|
580
|
+
<td>
|
|
581
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 79</span>
|
|
582
|
+
|
|
583
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client_id'>client_id</span>
|
|
584
|
+
<span class='ivar'>@client_id</span>
|
|
585
|
+
<span class='kw'>end</span></pre>
|
|
586
|
+
</td>
|
|
587
|
+
</tr>
|
|
588
|
+
</table>
|
|
589
|
+
</div>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<span id=""></span>
|
|
593
|
+
<div class="method_details ">
|
|
594
|
+
<h3 class="signature " id="client_secret-instance_method">
|
|
595
|
+
|
|
596
|
+
#<strong>client_secret</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</h3><div class="docstring">
|
|
603
|
+
<div class="discussion">
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</div>
|
|
607
|
+
</div>
|
|
608
|
+
<div class="tags">
|
|
609
|
+
|
|
610
|
+
<p class="tag_title">Returns:</p>
|
|
611
|
+
<ul class="return">
|
|
612
|
+
|
|
613
|
+
<li>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
</li>
|
|
621
|
+
|
|
622
|
+
</ul>
|
|
623
|
+
|
|
624
|
+
</div><table class="source_code">
|
|
625
|
+
<tr>
|
|
626
|
+
<td>
|
|
627
|
+
<pre class="lines">
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
82
|
|
631
|
+
83
|
|
632
|
+
84</pre>
|
|
633
|
+
</td>
|
|
634
|
+
<td>
|
|
635
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 82</span>
|
|
636
|
+
|
|
637
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client_secret'>client_secret</span>
|
|
638
|
+
<span class='ivar'>@client_secret</span>
|
|
639
|
+
<span class='kw'>end</span></pre>
|
|
640
|
+
</td>
|
|
641
|
+
</tr>
|
|
642
|
+
</table>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
<span id=""></span>
|
|
647
|
+
<div class="method_details ">
|
|
648
|
+
<h3 class="signature " id="password-instance_method">
|
|
649
|
+
|
|
650
|
+
#<strong>password</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</h3><div class="docstring">
|
|
657
|
+
<div class="discussion">
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
</div>
|
|
661
|
+
</div>
|
|
662
|
+
<div class="tags">
|
|
663
|
+
|
|
664
|
+
<p class="tag_title">Returns:</p>
|
|
665
|
+
<ul class="return">
|
|
666
|
+
|
|
667
|
+
<li>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
</ul>
|
|
677
|
+
|
|
678
|
+
</div><table class="source_code">
|
|
679
|
+
<tr>
|
|
680
|
+
<td>
|
|
681
|
+
<pre class="lines">
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
91
|
|
685
|
+
92
|
|
686
|
+
93</pre>
|
|
687
|
+
</td>
|
|
688
|
+
<td>
|
|
689
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 91</span>
|
|
690
|
+
|
|
691
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span>
|
|
692
|
+
<span class='ivar'>@password</span>
|
|
693
|
+
<span class='kw'>end</span></pre>
|
|
694
|
+
</td>
|
|
695
|
+
</tr>
|
|
696
|
+
</table>
|
|
697
|
+
</div>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
<span id=""></span>
|
|
701
|
+
<div class="method_details ">
|
|
702
|
+
<h3 class="signature " id="refresh_token-instance_method">
|
|
703
|
+
|
|
704
|
+
#<strong>refresh_token</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
</h3><div class="docstring">
|
|
711
|
+
<div class="discussion">
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
</div>
|
|
715
|
+
</div>
|
|
716
|
+
<div class="tags">
|
|
717
|
+
|
|
718
|
+
<p class="tag_title">Returns:</p>
|
|
719
|
+
<ul class="return">
|
|
720
|
+
|
|
721
|
+
<li>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</li>
|
|
729
|
+
|
|
730
|
+
</ul>
|
|
731
|
+
|
|
732
|
+
</div><table class="source_code">
|
|
733
|
+
<tr>
|
|
734
|
+
<td>
|
|
735
|
+
<pre class="lines">
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
97
|
|
739
|
+
98
|
|
740
|
+
99</pre>
|
|
741
|
+
</td>
|
|
742
|
+
<td>
|
|
743
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 97</span>
|
|
744
|
+
|
|
745
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
|
|
746
|
+
<span class='ivar'>@refresh_token</span>
|
|
747
|
+
<span class='kw'>end</span></pre>
|
|
748
|
+
</td>
|
|
749
|
+
</tr>
|
|
750
|
+
</table>
|
|
751
|
+
</div>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<span id=""></span>
|
|
755
|
+
<div class="method_details ">
|
|
756
|
+
<h3 class="signature " id="session_token-instance_method">
|
|
757
|
+
|
|
758
|
+
#<strong>session_token</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
</h3><div class="docstring">
|
|
765
|
+
<div class="discussion">
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
</div>
|
|
769
|
+
</div>
|
|
770
|
+
<div class="tags">
|
|
771
|
+
|
|
772
|
+
<p class="tag_title">Returns:</p>
|
|
773
|
+
<ul class="return">
|
|
774
|
+
|
|
775
|
+
<li>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</li>
|
|
783
|
+
|
|
784
|
+
</ul>
|
|
785
|
+
|
|
786
|
+
</div><table class="source_code">
|
|
787
|
+
<tr>
|
|
788
|
+
<td>
|
|
789
|
+
<pre class="lines">
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
94
|
|
793
|
+
95
|
|
794
|
+
96</pre>
|
|
795
|
+
</td>
|
|
796
|
+
<td>
|
|
797
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 94</span>
|
|
798
|
+
|
|
799
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_session_token'>session_token</span>
|
|
800
|
+
<span class='ivar'>@session_token</span>
|
|
801
|
+
<span class='kw'>end</span></pre>
|
|
802
|
+
</td>
|
|
803
|
+
</tr>
|
|
804
|
+
</table>
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
<span id=""></span>
|
|
809
|
+
<div class="method_details ">
|
|
810
|
+
<h3 class="signature " id="site_url-instance_method">
|
|
811
|
+
|
|
812
|
+
#<strong>site_url</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</h3><div class="docstring">
|
|
819
|
+
<div class="discussion">
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
</div>
|
|
823
|
+
</div>
|
|
824
|
+
<div class="tags">
|
|
825
|
+
|
|
826
|
+
<p class="tag_title">Returns:</p>
|
|
827
|
+
<ul class="return">
|
|
828
|
+
|
|
829
|
+
<li>
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
</li>
|
|
837
|
+
|
|
838
|
+
</ul>
|
|
839
|
+
|
|
840
|
+
</div><table class="source_code">
|
|
841
|
+
<tr>
|
|
842
|
+
<td>
|
|
843
|
+
<pre class="lines">
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
85
|
|
847
|
+
86
|
|
848
|
+
87</pre>
|
|
849
|
+
</td>
|
|
850
|
+
<td>
|
|
851
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 85</span>
|
|
852
|
+
|
|
853
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_site_url'>site_url</span>
|
|
854
|
+
<span class='ivar'>@site_url</span>
|
|
855
|
+
<span class='kw'>end</span></pre>
|
|
856
|
+
</td>
|
|
857
|
+
</tr>
|
|
858
|
+
</table>
|
|
859
|
+
</div>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<span id=""></span>
|
|
863
|
+
<div class="method_details ">
|
|
864
|
+
<h3 class="signature " id="username-instance_method">
|
|
865
|
+
|
|
866
|
+
#<strong>username</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
</h3><div class="docstring">
|
|
873
|
+
<div class="discussion">
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
</div>
|
|
877
|
+
</div>
|
|
878
|
+
<div class="tags">
|
|
879
|
+
|
|
880
|
+
<p class="tag_title">Returns:</p>
|
|
881
|
+
<ul class="return">
|
|
882
|
+
|
|
883
|
+
<li>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</li>
|
|
891
|
+
|
|
892
|
+
</ul>
|
|
893
|
+
|
|
894
|
+
</div><table class="source_code">
|
|
895
|
+
<tr>
|
|
896
|
+
<td>
|
|
897
|
+
<pre class="lines">
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
88
|
|
901
|
+
89
|
|
902
|
+
90</pre>
|
|
903
|
+
</td>
|
|
904
|
+
<td>
|
|
905
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 88</span>
|
|
906
|
+
|
|
907
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span>
|
|
908
|
+
<span class='ivar'>@username</span>
|
|
909
|
+
<span class='kw'>end</span></pre>
|
|
910
|
+
</td>
|
|
911
|
+
</tr>
|
|
912
|
+
</table>
|
|
913
|
+
</div>
|
|
914
|
+
|
|
915
|
+
</div>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
<div id="instance_method_details" class="method_details_list">
|
|
919
|
+
<h2>Instance Method Details</h2>
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<div class="method_details first">
|
|
923
|
+
<h3 class="signature first" id="auth_type-instance_method">
|
|
924
|
+
|
|
925
|
+
#<strong>auth_type</strong> ⇒ <tt>String</tt>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
</h3><div class="docstring">
|
|
932
|
+
<div class="discussion">
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
</div>
|
|
936
|
+
</div>
|
|
937
|
+
<div class="tags">
|
|
938
|
+
|
|
939
|
+
<p class="tag_title">Returns:</p>
|
|
940
|
+
<ul class="return">
|
|
941
|
+
|
|
942
|
+
<li>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
</li>
|
|
950
|
+
|
|
951
|
+
</ul>
|
|
952
|
+
|
|
953
|
+
</div><table class="source_code">
|
|
954
|
+
<tr>
|
|
955
|
+
<td>
|
|
956
|
+
<pre class="lines">
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
100
|
|
960
|
+
101
|
|
961
|
+
102
|
|
962
|
+
103
|
|
963
|
+
104
|
|
964
|
+
105
|
|
965
|
+
106
|
|
966
|
+
107
|
|
967
|
+
108
|
|
968
|
+
109
|
|
969
|
+
110
|
|
970
|
+
111
|
|
971
|
+
112
|
|
972
|
+
113</pre>
|
|
973
|
+
</td>
|
|
974
|
+
<td>
|
|
975
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 100</span>
|
|
976
|
+
|
|
977
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_auth_type'>auth_type</span>
|
|
978
|
+
<span class='ivar'>@auth_type</span> <span class='op'>||=</span>
|
|
979
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
|
|
980
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>refresh_token</span><span class='tstring_end'>'</span></span>
|
|
981
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_client_id'>client_id</span>
|
|
982
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>client_credentials</span><span class='tstring_end'>'</span></span>
|
|
983
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_username'>username</span>
|
|
984
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>password</span><span class='tstring_end'>'</span></span>
|
|
985
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_session_token'>session_token</span>
|
|
986
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>session_token</span><span class='tstring_end'>'</span></span>
|
|
987
|
+
<span class='kw'>else</span>
|
|
988
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
989
|
+
<span class='kw'>end</span>
|
|
990
|
+
<span class='kw'>end</span></pre>
|
|
991
|
+
</td>
|
|
992
|
+
</tr>
|
|
993
|
+
</table>
|
|
994
|
+
</div>
|
|
995
|
+
|
|
996
|
+
<div class="method_details ">
|
|
997
|
+
<h3 class="signature " id="call-instance_method">
|
|
998
|
+
|
|
999
|
+
#<strong>call</strong>(request_env) ⇒ <tt>Faraday::Response</tt>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
</h3><div class="docstring">
|
|
1006
|
+
<div class="discussion">
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
</div>
|
|
1010
|
+
</div>
|
|
1011
|
+
<div class="tags">
|
|
1012
|
+
<p class="tag_title">Parameters:</p>
|
|
1013
|
+
<ul class="param">
|
|
1014
|
+
|
|
1015
|
+
<li>
|
|
1016
|
+
|
|
1017
|
+
<span class='name'>request_env</span>
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
<span class='type'>(<tt>Faraday::Env</tt>)</span>
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
</li>
|
|
1025
|
+
|
|
1026
|
+
</ul>
|
|
1027
|
+
|
|
1028
|
+
<p class="tag_title">Returns:</p>
|
|
1029
|
+
<ul class="return">
|
|
1030
|
+
|
|
1031
|
+
<li>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
<span class='type'>(<tt>Faraday::Response</tt>)</span>
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
</li>
|
|
1039
|
+
|
|
1040
|
+
</ul>
|
|
1041
|
+
|
|
1042
|
+
</div><table class="source_code">
|
|
1043
|
+
<tr>
|
|
1044
|
+
<td>
|
|
1045
|
+
<pre class="lines">
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
116
|
|
1049
|
+
117
|
|
1050
|
+
118
|
|
1051
|
+
119
|
|
1052
|
+
120</pre>
|
|
1053
|
+
</td>
|
|
1054
|
+
<td>
|
|
1055
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 116</span>
|
|
1056
|
+
|
|
1057
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_request_env'>request_env</span><span class='rparen'>)</span>
|
|
1058
|
+
<span class='id identifier rubyid_request_env'>request_env</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_std_headers'>std_headers</span><span class='rparen'>)</span>
|
|
1059
|
+
|
|
1060
|
+
<span class='ivar'>@app</span><span class='op'>&.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_request_env'>request_env</span><span class='rparen'>)</span>
|
|
1061
|
+
<span class='kw'>end</span></pre>
|
|
1062
|
+
</td>
|
|
1063
|
+
</tr>
|
|
1064
|
+
</table>
|
|
1065
|
+
</div>
|
|
1066
|
+
|
|
1067
|
+
</div>
|
|
1068
|
+
|
|
1069
|
+
</div>
|
|
1070
|
+
|
|
1071
|
+
<div id="footer">
|
|
1072
|
+
Generated on Tue Oct 12 21:57:54 2021 by
|
|
1073
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1074
|
+
0.9.26 (ruby-3.0.2).
|
|
1075
|
+
</div>
|
|
1076
|
+
|
|
1077
|
+
</div>
|
|
1078
|
+
</body>
|
|
1079
|
+
</html>
|