shotgrid_api_ruby 0.1.3 → 0.2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  3. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  4. data/.github/workflows/test_and_publish.yml +2 -0
  5. data/.github/workflows/test_only.yml +2 -0
  6. data/.gitignore +3 -0
  7. data/.overcommit.yml +9 -0
  8. data/.rubocop.yml +2 -0
  9. data/CHANGELOG.md +27 -1
  10. data/CODE_OF_CONDUCT.md +128 -0
  11. data/Gemfile +18 -0
  12. data/Guardfile +2 -2
  13. data/bin/generate_and_add_documentation +1 -0
  14. data/bin/generate_sorbet_coverage +3 -0
  15. data/bin/prettirun +1 -1
  16. data/bin/sorbet_check +1 -0
  17. data/bin/tapioca +29 -0
  18. data/docs/ShotgridApiRuby/Auth/Validator.html +319 -0
  19. data/docs/ShotgridApiRuby/Auth.html +1079 -0
  20. data/docs/ShotgridApiRuby/Client.html +933 -0
  21. data/docs/ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html +124 -0
  22. data/docs/ShotgridApiRuby/Entities/Params.html +1377 -0
  23. data/docs/ShotgridApiRuby/Entities/Schema.html +646 -0
  24. data/docs/ShotgridApiRuby/Entities/Summarize/Summary.html +401 -0
  25. data/docs/ShotgridApiRuby/Entities/Summarize.html +775 -0
  26. data/docs/ShotgridApiRuby/Entities.html +2461 -0
  27. data/docs/ShotgridApiRuby/Entity.html +935 -0
  28. data/docs/ShotgridApiRuby/Preferences.html +417 -0
  29. data/docs/ShotgridApiRuby/ServerInfo.html +415 -0
  30. data/docs/ShotgridApiRuby/ShotgridCallError.html +328 -0
  31. data/docs/ShotgridApiRuby/Types.html +136 -0
  32. data/docs/ShotgridApiRuby.html +307 -0
  33. data/docs/_index.html +253 -0
  34. data/docs/class_list.html +51 -0
  35. data/docs/css/common.css +1 -0
  36. data/docs/css/full_list.css +58 -0
  37. data/docs/css/style.css +497 -0
  38. data/docs/file.README.html +578 -0
  39. data/docs/file_list.html +56 -0
  40. data/docs/frames.html +17 -0
  41. data/docs/index.html +578 -0
  42. data/docs/js/app.js +314 -0
  43. data/docs/js/full_list.js +216 -0
  44. data/docs/js/jquery.js +4 -0
  45. data/docs/method_list.html +643 -0
  46. data/docs/top-level-namespace.html +110 -0
  47. data/lib/shotgrid_api_ruby/auth.rb +89 -33
  48. data/lib/shotgrid_api_ruby/client.rb +50 -7
  49. data/lib/shotgrid_api_ruby/entities/params.rb +304 -65
  50. data/lib/shotgrid_api_ruby/entities/schema.rb +18 -3
  51. data/lib/shotgrid_api_ruby/entities/summarize.rb +39 -7
  52. data/lib/shotgrid_api_ruby/entities.rb +118 -29
  53. data/lib/shotgrid_api_ruby/entity.rb +29 -12
  54. data/lib/shotgrid_api_ruby/preferences.rb +7 -1
  55. data/lib/shotgrid_api_ruby/server_info.rb +7 -1
  56. data/lib/shotgrid_api_ruby/shotgrid_call_error.rb +5 -1
  57. data/lib/shotgrid_api_ruby/types/auth_type.rb +23 -0
  58. data/lib/shotgrid_api_ruby/version.rb +2 -1
  59. data/lib/shotgrid_api_ruby.rb +20 -2
  60. data/shotgrid_api_ruby.gemspec +3 -11
  61. data/sorbet/config +6 -0
  62. data/sorbet/rbi/faraday.rbi +20 -0
  63. data/sorbet/rbi/gems/activesupport@6.1.4.1.rbi +3770 -0
  64. data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
  65. data/sorbet/rbi/gems/backport@1.2.0.rbi +8 -0
  66. data/sorbet/rbi/gems/benchmark@0.1.1.rbi +65 -0
  67. data/sorbet/rbi/gems/bundler-audit@0.8.0.rbi +8 -0
  68. data/sorbet/rbi/gems/byebug@11.1.3.rbi +1569 -0
  69. data/sorbet/rbi/gems/childprocess@4.1.0.rbi +8 -0
  70. data/sorbet/rbi/gems/coderay@1.1.3.rbi +1005 -0
  71. data/sorbet/rbi/gems/colorize@0.8.1.rbi +39 -0
  72. data/sorbet/rbi/gems/commander@4.6.0.rbi +8 -0
  73. data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2403 -0
  74. data/sorbet/rbi/gems/diff-lcs@1.4.4.rbi +8 -0
  75. data/sorbet/rbi/gems/docile@1.4.0.rbi +54 -0
  76. data/sorbet/rbi/gems/dotenv@2.7.6.rbi +88 -0
  77. data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +8 -0
  78. data/sorbet/rbi/gems/faker@2.19.0.rbi +2513 -0
  79. data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +101 -0
  80. data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +78 -0
  81. data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +77 -0
  82. data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +73 -0
  83. data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +82 -0
  84. data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +72 -0
  85. data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +74 -0
  86. data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +73 -0
  87. data/sorbet/rbi/gems/faraday@1.7.0.rbi +783 -0
  88. data/sorbet/rbi/gems/ffi@1.15.3.rbi +8 -0
  89. data/sorbet/rbi/gems/formatador@0.3.0.rbi +8 -0
  90. data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +8 -0
  91. data/sorbet/rbi/gems/guard-rspec@4.7.3.rbi +8 -0
  92. data/sorbet/rbi/gems/guard@2.18.0.rbi +8 -0
  93. data/sorbet/rbi/gems/haml@5.2.2.rbi +8 -0
  94. data/sorbet/rbi/gems/highline@2.0.3.rbi +8 -0
  95. data/sorbet/rbi/gems/i18n@1.8.10.rbi +584 -0
  96. data/sorbet/rbi/gems/iniparse@1.5.0.rbi +8 -0
  97. data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +8 -0
  98. data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +8 -0
  99. data/sorbet/rbi/gems/kramdown@2.3.1.rbi +8 -0
  100. data/sorbet/rbi/gems/listen@3.7.0.rbi +476 -0
  101. data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +8 -0
  102. data/sorbet/rbi/gems/method_source@1.0.0.rbi +72 -0
  103. data/sorbet/rbi/gems/minitest@5.14.4.rbi +344 -0
  104. data/sorbet/rbi/gems/multipart-post@2.1.1.rbi +69 -0
  105. data/sorbet/rbi/gems/nenv@0.3.0.rbi +8 -0
  106. data/sorbet/rbi/gems/nokogiri@1.12.3.rbi +8 -0
  107. data/sorbet/rbi/gems/notiffany@0.1.3.rbi +8 -0
  108. data/sorbet/rbi/gems/overcommit@0.58.0.rbi +8 -0
  109. data/sorbet/rbi/gems/parallel@1.20.1.rbi +8 -0
  110. data/sorbet/rbi/gems/parlour@6.0.1.rbi +1610 -0
  111. data/sorbet/rbi/gems/parser@3.0.2.0.rbi +1731 -0
  112. data/sorbet/rbi/gems/prettier@1.6.1.rbi +8 -0
  113. data/sorbet/rbi/gems/pry-byebug@3.9.0.rbi +461 -0
  114. data/sorbet/rbi/gems/pry@0.13.1.rbi +2553 -0
  115. data/sorbet/rbi/gems/racc@1.5.2.rbi +47 -0
  116. data/sorbet/rbi/gems/rainbow@3.0.0.rbi +153 -0
  117. data/sorbet/rbi/gems/rake@13.0.6.rbi +807 -0
  118. data/sorbet/rbi/gems/rb-fsevent@0.11.0.rbi +8 -0
  119. data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +8 -0
  120. data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +8 -0
  121. data/sorbet/rbi/gems/reverse_markdown@2.0.0.rbi +8 -0
  122. data/sorbet/rbi/gems/rexml@3.2.5.rbi +672 -0
  123. data/sorbet/rbi/gems/rspec-core@3.10.1.rbi +2500 -0
  124. data/sorbet/rbi/gems/rspec-expectations@3.10.1.rbi +1574 -0
  125. data/sorbet/rbi/gems/rspec-mocks@3.10.2.rbi +1462 -0
  126. data/sorbet/rbi/gems/rspec-support@3.10.2.rbi +510 -0
  127. data/sorbet/rbi/gems/rspec@3.10.0.rbi +39 -0
  128. data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +196 -0
  129. data/sorbet/rbi/gems/rubocop-ast@1.11.0.rbi +8 -0
  130. data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +8 -0
  131. data/sorbet/rbi/gems/rubocop-performance@1.11.5.rbi +8 -0
  132. data/sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi +8 -0
  133. data/sorbet/rbi/gems/rubocop@1.20.0.rbi +8 -0
  134. data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +8 -0
  135. data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +8 -0
  136. data/sorbet/rbi/gems/shellany@0.0.1.rbi +8 -0
  137. data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +89 -0
  138. data/sorbet/rbi/gems/simplecov@0.21.2.rbi +577 -0
  139. data/sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi +8 -0
  140. data/sorbet/rbi/gems/solargraph@0.43.0.rbi +8 -0
  141. data/sorbet/rbi/gems/spoom@1.1.2.rbi +1204 -0
  142. data/sorbet/rbi/gems/tapioca@0.4.25.rbi +1239 -0
  143. data/sorbet/rbi/gems/temple@0.8.2.rbi +8 -0
  144. data/sorbet/rbi/gems/thor@1.1.0.rbi +838 -0
  145. data/sorbet/rbi/gems/tilt@2.0.10.rbi +8 -0
  146. data/sorbet/rbi/gems/timecop@0.9.4.rbi +82 -0
  147. data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +857 -0
  148. data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +8 -0
  149. data/sorbet/rbi/gems/unparser@0.6.0.rbi +8 -0
  150. data/sorbet/rbi/gems/vcr@6.0.0.rbi +782 -0
  151. data/sorbet/rbi/gems/yard-sorbet@0.5.3.rbi +8 -0
  152. data/sorbet/rbi/gems/yard@0.9.26.rbi +8 -0
  153. data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +173 -0
  154. data/sorbet/tapioca/config +0 -0
  155. data/sorbet/tapioca/require.rb +5 -0
  156. metadata +148 -128
data/docs/ShotgridApiRuby/Entity.html ADDED
@@ -0,0 +1,935 @@
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::Entity
8
+
9
+ &mdash; 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::Entity";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (E)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span>
41
+ &raquo;
42
+ <span class="title">Entity</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::Entity
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">T::Struct</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">T::Struct</li>
78
+
79
+ <li class="next">ShotgridApiRuby::Entity</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/entity.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>Represent each entity returned by Shotgrid</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="#attributes-instance_method" title="#attributes (instance method)">#<strong>attributes</strong> &#x21d2; OpenStruct </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>Returns the value of attribute `attributes`.</p>
151
+ </div></span>
152
+
153
+ </li>
154
+
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Integer </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+
167
+
168
+ <span class="note title readonly">readonly</span>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+ <span class="summary_desc"><div class='inline'>
179
+ <p>Returns the value of attribute `id`.</p>
180
+ </div></span>
181
+
182
+ </li>
183
+
184
+
185
+ <li class="public ">
186
+ <span class="summary_signature">
187
+
188
+ <a href="#links-instance_method" title="#links (instance method)">#<strong>links</strong> &#x21d2; Hash{String =&gt; String} </a>
189
+
190
+
191
+
192
+ </span>
193
+
194
+
195
+
196
+
197
+ <span class="note title readonly">readonly</span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+ <span class="summary_desc"><div class='inline'>
208
+ <p>Returns the value of attribute `links`.</p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#relationships-instance_method" title="#relationships (instance method)">#<strong>relationships</strong> &#x21d2; Hash{T.untyped =&gt; T.untyped} </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+ <span class="note title readonly">readonly</span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <span class="summary_desc"><div class='inline'>
237
+ <p>Returns the value of attribute `relationships`.</p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; String </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+ <span class="note title readonly">readonly</span>
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <span class="summary_desc"><div class='inline'>
266
+ <p>.new(:type, :attributes, :relationships, :id, :links) do.</p>
267
+ </div></span>
268
+
269
+ </li>
270
+
271
+
272
+ </ul>
273
+
274
+
275
+
276
+
277
+
278
+ <h2>
279
+ Instance Method Summary
280
+ <small><a href="#" class="summary_toggle">collapse</a></small>
281
+ </h2>
282
+
283
+ <ul class="summary">
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(type:, attributes:, relationships:, id:, links:) &#x21d2; void </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+ <span class="note title constructor">constructor</span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'></div></span>
305
+
306
+ </li>
307
+
308
+
309
+ <li class="public ">
310
+ <span class="summary_signature">
311
+
312
+ <a href="#method_missing-instance_method" title="#method_missing (instance method)">#<strong>method_missing</strong>(name, *args, &amp;block) &#x21d2; T.untyped </a>
313
+
314
+
315
+
316
+ </span>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <span class="summary_desc"><div class='inline'></div></span>
327
+
328
+ </li>
329
+
330
+
331
+ <li class="public ">
332
+ <span class="summary_signature">
333
+
334
+ <a href="#respond_to_missing%3F-instance_method" title="#respond_to_missing? (instance method)">#<strong>respond_to_missing?</strong>(name, _private_methods = false) &#x21d2; Boolean </a>
335
+
336
+
337
+
338
+ </span>
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+ <span class="summary_desc"><div class='inline'></div></span>
349
+
350
+ </li>
351
+
352
+
353
+ </ul>
354
+
355
+
356
+
357
+
358
+ <div id="constructor_details" class="method_details_list">
359
+ <h2>Constructor Details</h2>
360
+
361
+ <div class="method_details first">
362
+ <h3 class="signature first" id="initialize-instance_method">
363
+
364
+ #<strong>initialize</strong>(type:, attributes:, relationships:, id:, links:) &#x21d2; <tt>void</tt>
365
+
366
+
367
+
368
+
369
+
370
+ </h3><div class="docstring">
371
+ <div class="discussion">
372
+
373
+
374
+ </div>
375
+ </div>
376
+ <div class="tags">
377
+ <p class="tag_title">Parameters:</p>
378
+ <ul class="param">
379
+
380
+ <li>
381
+
382
+ <span class='name'>type</span>
383
+
384
+
385
+ <span class='type'>(<tt>String</tt>)</span>
386
+
387
+
388
+
389
+ &mdash;
390
+ <div class='inline'>
391
+ <p>.new(:type, :attributes, :relationships, :id, :links) do</p>
392
+ </div>
393
+
394
+ </li>
395
+
396
+ <li>
397
+
398
+ <span class='name'>attributes</span>
399
+
400
+
401
+ <span class='type'>(<tt>OpenStruct</tt>)</span>
402
+
403
+
404
+
405
+ </li>
406
+
407
+ <li>
408
+
409
+ <span class='name'>relationships</span>
410
+
411
+
412
+ <span class='type'>(<tt>Hash{T.untyped =&gt; T.untyped}</tt>)</span>
413
+
414
+
415
+
416
+ </li>
417
+
418
+ <li>
419
+
420
+ <span class='name'>id</span>
421
+
422
+
423
+ <span class='type'>(<tt>Integer</tt>)</span>
424
+
425
+
426
+
427
+ </li>
428
+
429
+ <li>
430
+
431
+ <span class='name'>links</span>
432
+
433
+
434
+ <span class='type'>(<tt>Hash{String =&gt; String}</tt>)</span>
435
+
436
+
437
+
438
+ </li>
439
+
440
+ </ul>
441
+
442
+
443
+ </div><table class="source_code">
444
+ <tr>
445
+ <td>
446
+ <pre class="lines">
447
+
448
+
449
+ </pre>
450
+ </td>
451
+ <td>
452
+ <pre class="code"><span class="info file"># File ''</span>
453
+
454
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:type</span><span class='comma'>,</span> <span class='const'>String</span>
455
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:attributes</span><span class='comma'>,</span> <span class='const'>OpenStruct</span>
456
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:relationships</span><span class='comma'>,</span> <span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='rbracket'>]</span>
457
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='const'>Integer</span>
458
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:links</span><span class='comma'>,</span> <span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span></pre>
459
+ </td>
460
+ </tr>
461
+ </table>
462
+ </div>
463
+
464
+ </div>
465
+ <div id="method_missing_details" class="method_details_list">
466
+ <h2>Dynamic Method Handling</h2>
467
+ <p class="notice this">
468
+ This class handles dynamic methods through the <tt>method_missing</tt> method
469
+
470
+ </p>
471
+
472
+ <div class="method_details first">
473
+ <h3 class="signature first" id="method_missing-instance_method">
474
+
475
+ #<strong>method_missing</strong>(name, *args, &amp;block) &#x21d2; <tt>T.untyped</tt>
476
+
477
+
478
+
479
+
480
+
481
+ </h3><div class="docstring">
482
+ <div class="discussion">
483
+
484
+
485
+ </div>
486
+ </div>
487
+ <div class="tags">
488
+ <p class="tag_title">Parameters:</p>
489
+ <ul class="param">
490
+
491
+ <li>
492
+
493
+ <span class='name'>name</span>
494
+
495
+
496
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
497
+
498
+
499
+
500
+ </li>
501
+
502
+ <li>
503
+
504
+ <span class='name'>args</span>
505
+
506
+
507
+ <span class='type'>(<tt>T.untyped</tt>)</span>
508
+
509
+
510
+
511
+ </li>
512
+
513
+ <li>
514
+
515
+ <span class='name'>block</span>
516
+
517
+
518
+ <span class='type'>(<tt>T.untyped</tt>)</span>
519
+
520
+
521
+
522
+ </li>
523
+
524
+ </ul>
525
+
526
+ <p class="tag_title">Returns:</p>
527
+ <ul class="return">
528
+
529
+ <li>
530
+
531
+
532
+ <span class='type'>(<tt>T.untyped</tt>)</span>
533
+
534
+
535
+
536
+ </li>
537
+
538
+ </ul>
539
+
540
+ </div><table class="source_code">
541
+ <tr>
542
+ <td>
543
+ <pre class="lines">
544
+
545
+
546
+ 20
547
+ 21
548
+ 22
549
+ 23
550
+ 24
551
+ 25
552
+ 26
553
+ 27</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entity.rb', line 20</span>
557
+
558
+ <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'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
559
+ <span class='kw'>if</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
560
+ <span class='id identifier rubyid_define_singleton_method'>define_singleton_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
561
+ <span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
562
+ <span class='kw'>else</span>
563
+ <span class='kw'>super</span>
564
+ <span class='kw'>end</span>
565
+ <span class='kw'>end</span></pre>
566
+ </td>
567
+ </tr>
568
+ </table>
569
+ </div>
570
+
571
+ </div>
572
+
573
+ <div id="instance_attr_details" class="attr_details">
574
+ <h2>Instance Attribute Details</h2>
575
+
576
+
577
+ <span id=""></span>
578
+ <div class="method_details first">
579
+ <h3 class="signature first" id="attributes-instance_method">
580
+
581
+ #<strong>attributes</strong> &#x21d2; <tt>OpenStruct</tt> <span class="extras">(readonly)</span>
582
+
583
+
584
+
585
+
586
+
587
+ </h3><div class="docstring">
588
+ <div class="discussion">
589
+
590
+ <p>Returns the value of attribute `attributes`.</p>
591
+
592
+
593
+ </div>
594
+ </div>
595
+ <div class="tags">
596
+
597
+ <p class="tag_title">Returns:</p>
598
+ <ul class="return">
599
+
600
+ <li>
601
+
602
+
603
+ <span class='type'>(<tt>OpenStruct</tt>)</span>
604
+
605
+
606
+
607
+ </li>
608
+
609
+ </ul>
610
+
611
+ </div><table class="source_code">
612
+ <tr>
613
+ <td>
614
+ <pre class="lines">
615
+
616
+
617
+ </pre>
618
+ </td>
619
+ <td>
620
+ <pre class="code"><span class="info file"># File ''</span>
621
+
622
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:attributes</span><span class='comma'>,</span> <span class='const'>OpenStruct</span></pre>
623
+ </td>
624
+ </tr>
625
+ </table>
626
+ </div>
627
+
628
+
629
+ <span id=""></span>
630
+ <div class="method_details ">
631
+ <h3 class="signature " id="id-instance_method">
632
+
633
+ #<strong>id</strong> &#x21d2; <tt>Integer</tt> <span class="extras">(readonly)</span>
634
+
635
+
636
+
637
+
638
+
639
+ </h3><div class="docstring">
640
+ <div class="discussion">
641
+
642
+ <p>Returns the value of attribute `id`.</p>
643
+
644
+
645
+ </div>
646
+ </div>
647
+ <div class="tags">
648
+
649
+ <p class="tag_title">Returns:</p>
650
+ <ul class="return">
651
+
652
+ <li>
653
+
654
+
655
+ <span class='type'>(<tt>Integer</tt>)</span>
656
+
657
+
658
+
659
+ </li>
660
+
661
+ </ul>
662
+
663
+ </div><table class="source_code">
664
+ <tr>
665
+ <td>
666
+ <pre class="lines">
667
+
668
+
669
+ </pre>
670
+ </td>
671
+ <td>
672
+ <pre class="code"><span class="info file"># File ''</span>
673
+
674
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='const'>Integer</span></pre>
675
+ </td>
676
+ </tr>
677
+ </table>
678
+ </div>
679
+
680
+
681
+ <span id=""></span>
682
+ <div class="method_details ">
683
+ <h3 class="signature " id="links-instance_method">
684
+
685
+ #<strong>links</strong> &#x21d2; <tt>Hash{String =&gt; String}</tt> <span class="extras">(readonly)</span>
686
+
687
+
688
+
689
+
690
+
691
+ </h3><div class="docstring">
692
+ <div class="discussion">
693
+
694
+ <p>Returns the value of attribute `links`.</p>
695
+
696
+
697
+ </div>
698
+ </div>
699
+ <div class="tags">
700
+
701
+ <p class="tag_title">Returns:</p>
702
+ <ul class="return">
703
+
704
+ <li>
705
+
706
+
707
+ <span class='type'>(<tt>Hash{String =&gt; String}</tt>)</span>
708
+
709
+
710
+
711
+ </li>
712
+
713
+ </ul>
714
+
715
+ </div><table class="source_code">
716
+ <tr>
717
+ <td>
718
+ <pre class="lines">
719
+
720
+
721
+ </pre>
722
+ </td>
723
+ <td>
724
+ <pre class="code"><span class="info file"># File ''</span>
725
+
726
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:links</span><span class='comma'>,</span> <span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span></pre>
727
+ </td>
728
+ </tr>
729
+ </table>
730
+ </div>
731
+
732
+
733
+ <span id=""></span>
734
+ <div class="method_details ">
735
+ <h3 class="signature " id="relationships-instance_method">
736
+
737
+ #<strong>relationships</strong> &#x21d2; <tt>Hash{T.untyped =&gt; T.untyped}</tt> <span class="extras">(readonly)</span>
738
+
739
+
740
+
741
+
742
+
743
+ </h3><div class="docstring">
744
+ <div class="discussion">
745
+
746
+ <p>Returns the value of attribute `relationships`.</p>
747
+
748
+
749
+ </div>
750
+ </div>
751
+ <div class="tags">
752
+
753
+ <p class="tag_title">Returns:</p>
754
+ <ul class="return">
755
+
756
+ <li>
757
+
758
+
759
+ <span class='type'>(<tt>Hash{T.untyped =&gt; T.untyped}</tt>)</span>
760
+
761
+
762
+
763
+ </li>
764
+
765
+ </ul>
766
+
767
+ </div><table class="source_code">
768
+ <tr>
769
+ <td>
770
+ <pre class="lines">
771
+
772
+
773
+ </pre>
774
+ </td>
775
+ <td>
776
+ <pre class="code"><span class="info file"># File ''</span>
777
+
778
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:relationships</span><span class='comma'>,</span> <span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='rbracket'>]</span></pre>
779
+ </td>
780
+ </tr>
781
+ </table>
782
+ </div>
783
+
784
+
785
+ <span id=""></span>
786
+ <div class="method_details ">
787
+ <h3 class="signature " id="type-instance_method">
788
+
789
+ #<strong>type</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
790
+
791
+
792
+
793
+
794
+
795
+ </h3><div class="docstring">
796
+ <div class="discussion">
797
+
798
+ <p>.new(:type, :attributes, :relationships, :id, :links) do</p>
799
+
800
+
801
+ </div>
802
+ </div>
803
+ <div class="tags">
804
+
805
+ <p class="tag_title">Returns:</p>
806
+ <ul class="return">
807
+
808
+ <li>
809
+
810
+
811
+ <span class='type'>(<tt>String</tt>)</span>
812
+
813
+
814
+
815
+ </li>
816
+
817
+ </ul>
818
+
819
+ </div><table class="source_code">
820
+ <tr>
821
+ <td>
822
+ <pre class="lines">
823
+
824
+
825
+ </pre>
826
+ </td>
827
+ <td>
828
+ <pre class="code"><span class="info file"># File ''</span>
829
+
830
+ <span class='id identifier rubyid_const'>const</span> <span class='symbol'>:type</span><span class='comma'>,</span> <span class='const'>String</span></pre>
831
+ </td>
832
+ </tr>
833
+ </table>
834
+ </div>
835
+
836
+ </div>
837
+
838
+
839
+ <div id="instance_method_details" class="method_details_list">
840
+ <h2>Instance Method Details</h2>
841
+
842
+
843
+ <div class="method_details first">
844
+ <h3 class="signature first" id="respond_to_missing?-instance_method">
845
+
846
+ #<strong>respond_to_missing?</strong>(name, _private_methods = false) &#x21d2; <tt>Boolean</tt>
847
+
848
+
849
+
850
+
851
+
852
+ </h3><div class="docstring">
853
+ <div class="discussion">
854
+
855
+
856
+ </div>
857
+ </div>
858
+ <div class="tags">
859
+ <p class="tag_title">Parameters:</p>
860
+ <ul class="param">
861
+
862
+ <li>
863
+
864
+ <span class='name'>name</span>
865
+
866
+
867
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
868
+
869
+
870
+
871
+ </li>
872
+
873
+ <li>
874
+
875
+ <span class='name'>_private_methods</span>
876
+
877
+
878
+ <span class='type'>(<tt>T.untyped</tt>)</span>
879
+
880
+
881
+ <em class="default">(defaults to: <tt>false</tt>)</em>
882
+
883
+
884
+ </li>
885
+
886
+ </ul>
887
+
888
+ <p class="tag_title">Returns:</p>
889
+ <ul class="return">
890
+
891
+ <li>
892
+
893
+
894
+ <span class='type'>(<tt>Boolean</tt>)</span>
895
+
896
+
897
+
898
+ </li>
899
+
900
+ </ul>
901
+
902
+ </div><table class="source_code">
903
+ <tr>
904
+ <td>
905
+ <pre class="lines">
906
+
907
+
908
+ 33
909
+ 34
910
+ 35</pre>
911
+ </td>
912
+ <td>
913
+ <pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entity.rb', line 33</span>
914
+
915
+ <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__private_methods'>_private_methods</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
916
+ <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='kw'>super</span>
917
+ <span class='kw'>end</span></pre>
918
+ </td>
919
+ </tr>
920
+ </table>
921
+ </div>
922
+
923
+ </div>
924
+
925
+ </div>
926
+
927
+ <div id="footer">
928
+ Generated on Tue Oct 12 21:57:54 2021 by
929
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
930
+ 0.9.26 (ruby-3.0.2).
931
+ </div>
932
+
933
+ </div>
934
+ </body>
935
+ </html>