shotgrid_api_ruby 0.1.3.3 → 0.2.0.5
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/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 +65 -1
- data/Gemfile +18 -0
- data/Gemfile.lock +263 -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 +301 -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 +6 -13
- 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 +156 -140
|
@@ -0,0 +1,1377 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: ShotgridApiRuby::Entities::Params
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ShotgridApiRuby::Entities::Params";
|
|
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 (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> » <span class='title'><span class='object_link'><a href="../Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Params</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: ShotgridApiRuby::Entities::Params
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ShotgridApiRuby::Entities::Params</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>Forwardable, T::Sig</dd>
|
|
91
|
+
</dl>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/shotgrid_api_ruby/entities/params.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Defined Under Namespace</h2>
|
|
108
|
+
<p class="children">
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Params/TooComplexFiltersError.html" title="ShotgridApiRuby::Entities::Params::TooComplexFiltersError (class)">TooComplexFiltersError</a></span>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</p>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>
|
|
120
|
+
Constant Summary
|
|
121
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
122
|
+
</h2>
|
|
123
|
+
|
|
124
|
+
<dl class="constants">
|
|
125
|
+
|
|
126
|
+
<dt id="SortType-constant" class="">SortType =
|
|
127
|
+
|
|
128
|
+
</dt>
|
|
129
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='kw'>do</span>
|
|
130
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span>
|
|
131
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
132
|
+
<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_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
133
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
134
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
135
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
136
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
137
|
+
<span class='rparen'>)</span>
|
|
138
|
+
<span class='kw'>end</span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="PageType-constant" class="">PageType =
|
|
141
|
+
|
|
142
|
+
</dt>
|
|
143
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='lbrace'>{</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'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span></pre></dd>
|
|
144
|
+
|
|
145
|
+
<dt id="PageSizeType-constant" class="">PageSizeType =
|
|
146
|
+
|
|
147
|
+
</dt>
|
|
148
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='lbrace'>{</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'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span></pre></dd>
|
|
149
|
+
|
|
150
|
+
<dt id="FieldsType-constant" class="">FieldsType =
|
|
151
|
+
|
|
152
|
+
</dt>
|
|
153
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='kw'>do</span>
|
|
154
|
+
<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'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
155
|
+
<span class='kw'>end</span></pre></dd>
|
|
156
|
+
|
|
157
|
+
<dt id="LogicalOperatorType-constant" class="">LogicalOperatorType =
|
|
158
|
+
|
|
159
|
+
</dt>
|
|
160
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='lbrace'>{</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span> <span class='rbrace'>}</span></pre></dd>
|
|
161
|
+
|
|
162
|
+
<dt id="FiltersFiledType-constant" class="">FiltersFiledType =
|
|
163
|
+
|
|
164
|
+
</dt>
|
|
165
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='kw'>do</span>
|
|
166
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span>
|
|
167
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
168
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
169
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
170
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
171
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
172
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
173
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
174
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
175
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
176
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
177
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
178
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
179
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
180
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
181
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
182
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
183
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
184
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
185
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span>
|
|
186
|
+
<span class='rparen'>)</span>
|
|
187
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
188
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span>
|
|
189
|
+
<span class='rparen'>)</span>
|
|
190
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
191
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
192
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
193
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
194
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
195
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
196
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
197
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
198
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
199
|
+
<span class='rparen'>)</span>
|
|
200
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
201
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
202
|
+
<span class='rparen'>)</span>
|
|
203
|
+
<span class='kw'>end</span></pre></dd>
|
|
204
|
+
|
|
205
|
+
<dt id="GroupingFieldType-constant" class="">GroupingFieldType =
|
|
206
|
+
|
|
207
|
+
</dt>
|
|
208
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='kw'>do</span>
|
|
209
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span>
|
|
210
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
211
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
212
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
213
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
214
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
215
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
216
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
217
|
+
<span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
218
|
+
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
219
|
+
<span class='lbrace'>{</span> <span class='label'>direction:</span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
220
|
+
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>direction</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
221
|
+
<span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>direction:</span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
222
|
+
<span class='lbrace'>{</span> <span class='symbol'>:type</span> <span class='op'>=></span> <span class='const'>String</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>direction</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
223
|
+
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span><span class='comma'>,</span> <span class='symbol'>:direction</span> <span class='op'>=></span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
224
|
+
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>direction</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>String</span> <span class='rbrace'>}</span><span class='comma'>,</span>
|
|
225
|
+
<span class='rparen'>)</span>
|
|
226
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
227
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
228
|
+
<span class='rparen'>)</span>
|
|
229
|
+
<span class='kw'>end</span></pre></dd>
|
|
230
|
+
|
|
231
|
+
<dt id="SummaryFiledsType-constant" class="">SummaryFiledsType =
|
|
232
|
+
|
|
233
|
+
</dt>
|
|
234
|
+
<dd><pre class="code"><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_type_alias'>type_alias</span> <span class='kw'>do</span>
|
|
235
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span>
|
|
236
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
237
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span>
|
|
238
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
239
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
240
|
+
<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_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
|
241
|
+
<span class='rbracket'>]</span>
|
|
242
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
243
|
+
<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_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
244
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
245
|
+
<span class='rparen'>)</span>
|
|
246
|
+
<span class='kw'>end</span></pre></dd>
|
|
247
|
+
|
|
248
|
+
</dl>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<h2>
|
|
259
|
+
Class Method Summary
|
|
260
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
261
|
+
</h2>
|
|
262
|
+
|
|
263
|
+
<ul class="summary">
|
|
264
|
+
|
|
265
|
+
<li class="public ">
|
|
266
|
+
<span class="summary_signature">
|
|
267
|
+
|
|
268
|
+
<a href="#filters_are_simple%3F-class_method" title="filters_are_simple? (class method)">.<strong>filters_are_simple?</strong>(filters) ⇒ Boolean </a>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</ul>
|
|
288
|
+
|
|
289
|
+
<h2>
|
|
290
|
+
Instance Method Summary
|
|
291
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
292
|
+
</h2>
|
|
293
|
+
|
|
294
|
+
<ul class="summary">
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#add_fields-instance_method" title="#add_fields (instance method)">#<strong>add_fields</strong>(fields) ⇒ String </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
314
|
+
|
|
315
|
+
</li>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<li class="public ">
|
|
319
|
+
<span class="summary_signature">
|
|
320
|
+
|
|
321
|
+
<a href="#add_filter-instance_method" title="#add_filter (instance method)">#<strong>add_filter</strong>(filters, logical_operator = 'and') ⇒ Hash{String => String}, ... </a>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</span>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
336
|
+
|
|
337
|
+
</li>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<li class="public ">
|
|
341
|
+
<span class="summary_signature">
|
|
342
|
+
|
|
343
|
+
<a href="#add_grouping-instance_method" title="#add_grouping (instance method)">#<strong>add_grouping</strong>(grouping) ⇒ T.untyped </a>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
</span>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
358
|
+
|
|
359
|
+
</li>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<li class="public ">
|
|
363
|
+
<span class="summary_signature">
|
|
364
|
+
|
|
365
|
+
<a href="#add_options-instance_method" title="#add_options (instance method)">#<strong>add_options</strong>(return_only, include_archived_projects) ⇒ Hash<sup>?</sup> </a>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
380
|
+
|
|
381
|
+
</li>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<li class="public ">
|
|
385
|
+
<span class="summary_signature">
|
|
386
|
+
|
|
387
|
+
<a href="#add_page-instance_method" title="#add_page (instance method)">#<strong>add_page</strong>(page, page_size) ⇒ Hash{T.untyped => T.untyped}<sup>?</sup> </a>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
</span>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#add_sort-instance_method" title="#add_sort (instance method)">#<strong>add_sort</strong>(sort) ⇒ String<sup>?</sup> </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
424
|
+
|
|
425
|
+
</li>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<li class="public ">
|
|
429
|
+
<span class="summary_signature">
|
|
430
|
+
|
|
431
|
+
<a href="#add_summary_fields-instance_method" title="#add_summary_fields (instance method)">#<strong>add_summary_fields</strong>(summary_fields) ⇒ Array<Hash{T.untyped => T.untyped}><sup>?</sup> </a>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
</span>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
446
|
+
|
|
447
|
+
</li>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<li class="public ">
|
|
451
|
+
<span class="summary_signature">
|
|
452
|
+
|
|
453
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ void </a>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</span>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span class="note title constructor">constructor</span>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
470
|
+
|
|
471
|
+
</li>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
</ul>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
<div id="constructor_details" class="method_details_list">
|
|
480
|
+
<h2>Constructor Details</h2>
|
|
481
|
+
|
|
482
|
+
<div class="method_details first">
|
|
483
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
484
|
+
|
|
485
|
+
#<strong>initialize</strong> ⇒ <tt>void</tt>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</h3><div class="docstring">
|
|
492
|
+
<div class="discussion">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</div>
|
|
496
|
+
</div>
|
|
497
|
+
<div class="tags">
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</div><table class="source_code">
|
|
501
|
+
<tr>
|
|
502
|
+
<td>
|
|
503
|
+
<pre class="lines">
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
14
|
|
507
|
+
15
|
|
508
|
+
16</pre>
|
|
509
|
+
</td>
|
|
510
|
+
<td>
|
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 14</span>
|
|
512
|
+
|
|
513
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
514
|
+
<span class='ivar'>@parsed_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='lbrace'>{</span><span class='rbrace'>}</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_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
515
|
+
<span class='kw'>end</span></pre>
|
|
516
|
+
</td>
|
|
517
|
+
</tr>
|
|
518
|
+
</table>
|
|
519
|
+
</div>
|
|
520
|
+
|
|
521
|
+
</div>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<div id="class_method_details" class="method_details_list">
|
|
525
|
+
<h2>Class Method Details</h2>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<div class="method_details first">
|
|
529
|
+
<h3 class="signature first" id="filters_are_simple?-class_method">
|
|
530
|
+
|
|
531
|
+
.<strong>filters_are_simple?</strong>(filters) ⇒ <tt>Boolean</tt>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</h3><div class="docstring">
|
|
538
|
+
<div class="discussion">
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
</div>
|
|
543
|
+
<div class="tags">
|
|
544
|
+
<p class="tag_title">Parameters:</p>
|
|
545
|
+
<ul class="param">
|
|
546
|
+
|
|
547
|
+
<li>
|
|
548
|
+
|
|
549
|
+
<span class='name'>filters</span>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
<span class='type'>(<tt><span class='object_link'><a href="#FiltersFiledType-constant" title="ShotgridApiRuby::Entities::Params::FiltersFiledType (constant)">FiltersFiledType</a></span></tt>)</span>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
</li>
|
|
557
|
+
|
|
558
|
+
</ul>
|
|
559
|
+
|
|
560
|
+
<p class="tag_title">Returns:</p>
|
|
561
|
+
<ul class="return">
|
|
562
|
+
|
|
563
|
+
<li>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
</li>
|
|
571
|
+
|
|
572
|
+
</ul>
|
|
573
|
+
|
|
574
|
+
</div><table class="source_code">
|
|
575
|
+
<tr>
|
|
576
|
+
<td>
|
|
577
|
+
<pre class="lines">
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
299
|
|
581
|
+
300
|
|
582
|
+
301
|
|
583
|
+
302
|
|
584
|
+
303
|
|
585
|
+
304
|
|
586
|
+
305
|
|
587
|
+
306
|
|
588
|
+
307
|
|
589
|
+
308
|
|
590
|
+
309
|
|
591
|
+
310
|
|
592
|
+
311
|
|
593
|
+
312
|
|
594
|
+
313
|
|
595
|
+
314
|
|
596
|
+
315
|
|
597
|
+
316
|
|
598
|
+
317</pre>
|
|
599
|
+
</td>
|
|
600
|
+
<td>
|
|
601
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 299</span>
|
|
602
|
+
|
|
603
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_filters_are_simple?'>filters_are_simple?</span><span class='lparen'>(</span><span class='id identifier rubyid_filters'>filters</span><span class='rparen'>)</span>
|
|
604
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_filters'>filters</span>
|
|
605
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_filters'>filters</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
|
|
606
|
+
|
|
607
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='symbol'>:conditions</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>conditions</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
608
|
+
|
|
609
|
+
<span class='id identifier rubyid_filters'>filters</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_filter_val'>filter_val</span><span class='op'>|</span>
|
|
610
|
+
<span class='lparen'>(</span>
|
|
611
|
+
<span class='id identifier rubyid_filter_val'>filter_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_filter_val'>filter_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span>
|
|
612
|
+
<span class='id identifier rubyid_filter_val'>filter_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
|
|
613
|
+
<span class='rparen'>)</span> <span class='op'>||</span>
|
|
614
|
+
<span class='lparen'>(</span>
|
|
615
|
+
<span class='id identifier rubyid_filter_val'>filter_val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>&&</span>
|
|
616
|
+
<span class='id identifier rubyid_filter_val'>filter_val</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
|
|
617
|
+
<span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span>
|
|
618
|
+
<span class='kw'>end</span>
|
|
619
|
+
<span class='rparen'>)</span>
|
|
620
|
+
<span class='kw'>end</span>
|
|
621
|
+
<span class='kw'>end</span></pre>
|
|
622
|
+
</td>
|
|
623
|
+
</tr>
|
|
624
|
+
</table>
|
|
625
|
+
</div>
|
|
626
|
+
|
|
627
|
+
</div>
|
|
628
|
+
|
|
629
|
+
<div id="instance_method_details" class="method_details_list">
|
|
630
|
+
<h2>Instance Method Details</h2>
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<div class="method_details first">
|
|
634
|
+
<h3 class="signature first" id="add_fields-instance_method">
|
|
635
|
+
|
|
636
|
+
#<strong>add_fields</strong>(fields) ⇒ <tt>String</tt>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
</h3><div class="docstring">
|
|
643
|
+
<div class="discussion">
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
</div>
|
|
647
|
+
</div>
|
|
648
|
+
<div class="tags">
|
|
649
|
+
<p class="tag_title">Parameters:</p>
|
|
650
|
+
<ul class="param">
|
|
651
|
+
|
|
652
|
+
<li>
|
|
653
|
+
|
|
654
|
+
<span class='name'>fields</span>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<span class='type'>(<tt><span class='object_link'><a href="#FieldsType-constant" title="ShotgridApiRuby::Entities::Params::FieldsType (constant)">FieldsType</a></span></tt>)</span>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</li>
|
|
662
|
+
|
|
663
|
+
</ul>
|
|
664
|
+
|
|
665
|
+
<p class="tag_title">Returns:</p>
|
|
666
|
+
<ul class="return">
|
|
667
|
+
|
|
668
|
+
<li>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
</li>
|
|
676
|
+
|
|
677
|
+
</ul>
|
|
678
|
+
|
|
679
|
+
</div><table class="source_code">
|
|
680
|
+
<tr>
|
|
681
|
+
<td>
|
|
682
|
+
<pre class="lines">
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
69
|
|
686
|
+
70
|
|
687
|
+
71
|
|
688
|
+
72</pre>
|
|
689
|
+
</td>
|
|
690
|
+
<td>
|
|
691
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 69</span>
|
|
692
|
+
|
|
693
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_fields'>add_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='rparen'>)</span>
|
|
694
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
695
|
+
<span class='id identifier rubyid_fields'>fields</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='lbracket'>[</span><span class='id identifier rubyid_fields'>fields</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span>
|
|
696
|
+
<span class='kw'>end</span></pre>
|
|
697
|
+
</td>
|
|
698
|
+
</tr>
|
|
699
|
+
</table>
|
|
700
|
+
</div>
|
|
701
|
+
|
|
702
|
+
<div class="method_details ">
|
|
703
|
+
<h3 class="signature " id="add_filter-instance_method">
|
|
704
|
+
|
|
705
|
+
#<strong>add_filter</strong>(filters, logical_operator = 'and') ⇒ <tt>Hash{String => String}</tt>, ...
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</h3><div class="docstring">
|
|
712
|
+
<div class="discussion">
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
</div>
|
|
716
|
+
</div>
|
|
717
|
+
<div class="tags">
|
|
718
|
+
<p class="tag_title">Parameters:</p>
|
|
719
|
+
<ul class="param">
|
|
720
|
+
|
|
721
|
+
<li>
|
|
722
|
+
|
|
723
|
+
<span class='name'>filters</span>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
<span class='type'>(<tt><span class='object_link'><a href="#FiltersFiledType-constant" title="ShotgridApiRuby::Entities::Params::FiltersFiledType (constant)">FiltersFiledType</a></span></tt>)</span>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
</li>
|
|
731
|
+
|
|
732
|
+
<li>
|
|
733
|
+
|
|
734
|
+
<span class='name'>logical_operator</span>
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<span class='type'>(<tt><span class='object_link'><a href="#LogicalOperatorType-constant" title="ShotgridApiRuby::Entities::Params::LogicalOperatorType (constant)">LogicalOperatorType</a></span></tt>)</span>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<em class="default">(defaults to: <tt>'and'</tt>)</em>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</li>
|
|
744
|
+
|
|
745
|
+
</ul>
|
|
746
|
+
|
|
747
|
+
<p class="tag_title">Returns:</p>
|
|
748
|
+
<ul class="return">
|
|
749
|
+
|
|
750
|
+
<li>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
<span class='type'>(<tt>Hash{String => String}</tt>, <tt>Hash</tt>, <tt>nil</tt>)</span>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
</li>
|
|
758
|
+
|
|
759
|
+
</ul>
|
|
760
|
+
|
|
761
|
+
</div><table class="source_code">
|
|
762
|
+
<tr>
|
|
763
|
+
<td>
|
|
764
|
+
<pre class="lines">
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
153
|
|
768
|
+
154
|
|
769
|
+
155
|
|
770
|
+
156
|
|
771
|
+
157
|
|
772
|
+
158
|
|
773
|
+
159
|
|
774
|
+
160
|
|
775
|
+
161
|
|
776
|
+
162
|
|
777
|
+
163
|
|
778
|
+
164
|
|
779
|
+
165
|
|
780
|
+
166
|
|
781
|
+
167
|
|
782
|
+
168
|
|
783
|
+
169
|
|
784
|
+
170
|
|
785
|
+
171
|
|
786
|
+
172
|
|
787
|
+
173
|
|
788
|
+
174
|
|
789
|
+
175
|
|
790
|
+
176
|
|
791
|
+
177
|
|
792
|
+
178
|
|
793
|
+
179
|
|
794
|
+
180
|
|
795
|
+
181
|
|
796
|
+
182
|
|
797
|
+
183
|
|
798
|
+
184
|
|
799
|
+
185
|
|
800
|
+
186
|
|
801
|
+
187
|
|
802
|
+
188
|
|
803
|
+
189
|
|
804
|
+
190
|
|
805
|
+
191
|
|
806
|
+
192
|
|
807
|
+
193
|
|
808
|
+
194
|
|
809
|
+
195
|
|
810
|
+
196
|
|
811
|
+
197
|
|
812
|
+
198
|
|
813
|
+
199
|
|
814
|
+
200
|
|
815
|
+
201
|
|
816
|
+
202
|
|
817
|
+
203
|
|
818
|
+
204
|
|
819
|
+
205
|
|
820
|
+
206
|
|
821
|
+
207
|
|
822
|
+
208
|
|
823
|
+
209
|
|
824
|
+
210
|
|
825
|
+
211
|
|
826
|
+
212</pre>
|
|
827
|
+
</td>
|
|
828
|
+
<td>
|
|
829
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 153</span>
|
|
830
|
+
|
|
831
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_filter'>add_filter</span><span class='lparen'>(</span><span class='id identifier rubyid_filters'>filters</span><span class='comma'>,</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>and</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
832
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_filters'>filters</span>
|
|
833
|
+
|
|
834
|
+
<span class='comment'># cast are here because Sorbet is confused by the madness filters can be
|
|
835
|
+
</span> <span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:filter</span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
836
|
+
<span class='kw'>if</span> <span class='lparen'>(</span><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_filters_are_simple?'>filters_are_simple?</span><span class='lparen'>(</span><span class='id identifier rubyid_filters'>filters</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
837
|
+
<span class='id identifier rubyid_translate_simple_filters_to_sg'>translate_simple_filters_to_sg</span><span class='lparen'>(</span>
|
|
838
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_cast'>cast</span><span class='lparen'>(</span>
|
|
839
|
+
<span class='id identifier rubyid_filters'>filters</span><span class='comma'>,</span>
|
|
840
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
841
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
842
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
843
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
844
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
845
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
846
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
847
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
848
|
+
<span class='rparen'>)</span>
|
|
849
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
850
|
+
<span class='rparen'>)</span><span class='comma'>,</span>
|
|
851
|
+
<span class='rparen'>)</span>
|
|
852
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_filters'>filters</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
|
|
853
|
+
<span class='id identifier rubyid_filters'>filters</span> <span class='op'>=</span>
|
|
854
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_cast'>cast</span><span class='lparen'>(</span>
|
|
855
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_unsafe'>unsafe</span><span class='lparen'>(</span><span class='id identifier rubyid_filters'>filters</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
856
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
857
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
858
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
859
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
860
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
861
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
862
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
863
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
864
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Hash</span><span class='lbracket'>[</span>
|
|
865
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
866
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span>
|
|
867
|
+
<span class='const'>String</span><span class='comma'>,</span>
|
|
868
|
+
<span class='const'>Symbol</span><span class='comma'>,</span>
|
|
869
|
+
<span class='const'>Integer</span><span class='comma'>,</span>
|
|
870
|
+
<span class='const'>Float</span><span class='comma'>,</span>
|
|
871
|
+
<span class='const'>T</span><span class='op'>::</span><span class='const'>Array</span><span class='lbracket'>[</span><span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
872
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span>
|
|
873
|
+
<span class='rparen'>)</span>
|
|
874
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
875
|
+
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_untyped'>untyped</span><span class='comma'>,</span>
|
|
876
|
+
<span class='rparen'>)</span>
|
|
877
|
+
<span class='rbracket'>]</span><span class='comma'>,</span>
|
|
878
|
+
<span class='rparen'>)</span>
|
|
879
|
+
<span class='lbrace'>{</span>
|
|
880
|
+
<span class='label'>conditions:</span>
|
|
881
|
+
<span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='symbol'>:conditions</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>conditions</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>||</span>
|
|
882
|
+
<span class='id identifier rubyid_translate_complex_filters_to_sg'>translate_complex_filters_to_sg</span><span class='lparen'>(</span><span class='id identifier rubyid_filters'>filters</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
883
|
+
<span class='label'>logical_operator:</span>
|
|
884
|
+
<span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='symbol'>:logical_operator</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_filters'>filters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>logical_operator</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>||</span>
|
|
885
|
+
<span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
886
|
+
<span class='rbrace'>}</span>
|
|
887
|
+
<span class='kw'>else</span>
|
|
888
|
+
<span class='lbrace'>{</span> <span class='label'>conditions:</span> <span class='id identifier rubyid_filters'>filters</span><span class='comma'>,</span> <span class='label'>logical_operator:</span> <span class='id identifier rubyid_logical_operator'>logical_operator</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
889
|
+
<span class='kw'>end</span>
|
|
890
|
+
<span class='kw'>end</span></pre>
|
|
891
|
+
</td>
|
|
892
|
+
</tr>
|
|
893
|
+
</table>
|
|
894
|
+
</div>
|
|
895
|
+
|
|
896
|
+
<div class="method_details ">
|
|
897
|
+
<h3 class="signature " id="add_grouping-instance_method">
|
|
898
|
+
|
|
899
|
+
#<strong>add_grouping</strong>(grouping) ⇒ <tt>T.untyped</tt>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</h3><div class="docstring">
|
|
906
|
+
<div class="discussion">
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
</div>
|
|
910
|
+
</div>
|
|
911
|
+
<div class="tags">
|
|
912
|
+
<p class="tag_title">Parameters:</p>
|
|
913
|
+
<ul class="param">
|
|
914
|
+
|
|
915
|
+
<li>
|
|
916
|
+
|
|
917
|
+
<span class='name'>grouping</span>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
<span class='type'>(<tt><span class='object_link'><a href="#GroupingFieldType-constant" title="ShotgridApiRuby::Entities::Params::GroupingFieldType (constant)">GroupingFieldType</a></span></tt>)</span>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
</li>
|
|
925
|
+
|
|
926
|
+
</ul>
|
|
927
|
+
|
|
928
|
+
<p class="tag_title">Returns:</p>
|
|
929
|
+
<ul class="return">
|
|
930
|
+
|
|
931
|
+
<li>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<span class='type'>(<tt>T.untyped</tt>)</span>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
</li>
|
|
939
|
+
|
|
940
|
+
</ul>
|
|
941
|
+
|
|
942
|
+
</div><table class="source_code">
|
|
943
|
+
<tr>
|
|
944
|
+
<td>
|
|
945
|
+
<pre class="lines">
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
238
|
|
949
|
+
239
|
|
950
|
+
240
|
|
951
|
+
241
|
|
952
|
+
242
|
|
953
|
+
243
|
|
954
|
+
244
|
|
955
|
+
245
|
|
956
|
+
246
|
|
957
|
+
247
|
|
958
|
+
248
|
|
959
|
+
249
|
|
960
|
+
250
|
|
961
|
+
251
|
|
962
|
+
252
|
|
963
|
+
253
|
|
964
|
+
254
|
|
965
|
+
255
|
|
966
|
+
256
|
|
967
|
+
257
|
|
968
|
+
258
|
|
969
|
+
259
|
|
970
|
+
260
|
|
971
|
+
261
|
|
972
|
+
262
|
|
973
|
+
263
|
|
974
|
+
264</pre>
|
|
975
|
+
</td>
|
|
976
|
+
<td>
|
|
977
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 238</span>
|
|
978
|
+
|
|
979
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_grouping'>add_grouping</span><span class='lparen'>(</span><span class='id identifier rubyid_grouping'>grouping</span><span class='rparen'>)</span>
|
|
980
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_grouping'>grouping</span>
|
|
981
|
+
|
|
982
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_grouping'>grouping</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
|
|
983
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:grouping</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_grouping'>grouping</span>
|
|
984
|
+
<span class='kw'>return</span>
|
|
985
|
+
<span class='kw'>end</span>
|
|
986
|
+
|
|
987
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:grouping</span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
988
|
+
<span class='id identifier rubyid_grouping'>grouping</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
|
|
989
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
|
|
990
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'><<</span> <span class='lbrace'>{</span>
|
|
991
|
+
<span class='label'>field:</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
992
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>exact</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
993
|
+
<span class='label'>direction:</span>
|
|
994
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:direction</span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>direction</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>||</span>
|
|
995
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>asc</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
996
|
+
<span class='rbrace'>}</span>
|
|
997
|
+
<span class='kw'>else</span>
|
|
998
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'><<</span> <span class='lbrace'>{</span>
|
|
999
|
+
<span class='label'>field:</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
1000
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>exact</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
1001
|
+
<span class='label'>direction:</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
1002
|
+
<span class='rbrace'>}</span>
|
|
1003
|
+
<span class='kw'>end</span>
|
|
1004
|
+
<span class='kw'>end</span>
|
|
1005
|
+
<span class='kw'>end</span></pre>
|
|
1006
|
+
</td>
|
|
1007
|
+
</tr>
|
|
1008
|
+
</table>
|
|
1009
|
+
</div>
|
|
1010
|
+
|
|
1011
|
+
<div class="method_details ">
|
|
1012
|
+
<h3 class="signature " id="add_options-instance_method">
|
|
1013
|
+
|
|
1014
|
+
#<strong>add_options</strong>(return_only, include_archived_projects) ⇒ <tt>Hash</tt><sup>?</sup>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
</h3><div class="docstring">
|
|
1021
|
+
<div class="discussion">
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
</div>
|
|
1025
|
+
</div>
|
|
1026
|
+
<div class="tags">
|
|
1027
|
+
<p class="tag_title">Parameters:</p>
|
|
1028
|
+
<ul class="param">
|
|
1029
|
+
|
|
1030
|
+
<li>
|
|
1031
|
+
|
|
1032
|
+
<span class='name'>return_only</span>
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
</li>
|
|
1040
|
+
|
|
1041
|
+
<li>
|
|
1042
|
+
|
|
1043
|
+
<span class='name'>include_archived_projects</span>
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
<span class='type'>(<tt>Boolean</tt>, <tt>nil</tt>)</span>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
</li>
|
|
1051
|
+
|
|
1052
|
+
</ul>
|
|
1053
|
+
|
|
1054
|
+
<p class="tag_title">Returns:</p>
|
|
1055
|
+
<ul class="return">
|
|
1056
|
+
|
|
1057
|
+
<li>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
<span class='type'>(<tt>Hash</tt>, <tt>nil</tt>)</span>
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
</li>
|
|
1065
|
+
|
|
1066
|
+
</ul>
|
|
1067
|
+
|
|
1068
|
+
</div><table class="source_code">
|
|
1069
|
+
<tr>
|
|
1070
|
+
<td>
|
|
1071
|
+
<pre class="lines">
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
85
|
|
1075
|
+
86
|
|
1076
|
+
87
|
|
1077
|
+
88
|
|
1078
|
+
89
|
|
1079
|
+
90
|
|
1080
|
+
91
|
|
1081
|
+
92</pre>
|
|
1082
|
+
</td>
|
|
1083
|
+
<td>
|
|
1084
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 85</span>
|
|
1085
|
+
|
|
1086
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_options'>add_options</span><span class='lparen'>(</span><span class='id identifier rubyid_return_only'>return_only</span><span class='comma'>,</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='rparen'>)</span>
|
|
1087
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_return_only'>return_only</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1088
|
+
|
|
1089
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1090
|
+
<span class='label'>return_only:</span> <span class='id identifier rubyid_return_only'>return_only</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>retired</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>active</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
1091
|
+
<span class='label'>include_archived_projects:</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_include_archived_projects'>include_archived_projects</span><span class='comma'>,</span>
|
|
1092
|
+
<span class='rbrace'>}</span>
|
|
1093
|
+
<span class='kw'>end</span></pre>
|
|
1094
|
+
</td>
|
|
1095
|
+
</tr>
|
|
1096
|
+
</table>
|
|
1097
|
+
</div>
|
|
1098
|
+
|
|
1099
|
+
<div class="method_details ">
|
|
1100
|
+
<h3 class="signature " id="add_page-instance_method">
|
|
1101
|
+
|
|
1102
|
+
#<strong>add_page</strong>(page, page_size) ⇒ <tt>Hash{T.untyped => T.untyped}</tt><sup>?</sup>
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
</h3><div class="docstring">
|
|
1109
|
+
<div class="discussion">
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
</div>
|
|
1113
|
+
</div>
|
|
1114
|
+
<div class="tags">
|
|
1115
|
+
<p class="tag_title">Parameters:</p>
|
|
1116
|
+
<ul class="param">
|
|
1117
|
+
|
|
1118
|
+
<li>
|
|
1119
|
+
|
|
1120
|
+
<span class='name'>page</span>
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
<span class='type'>(<tt><span class='object_link'><a href="#PageType-constant" title="ShotgridApiRuby::Entities::Params::PageType (constant)">PageType</a></span></tt>)</span>
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
</li>
|
|
1128
|
+
|
|
1129
|
+
<li>
|
|
1130
|
+
|
|
1131
|
+
<span class='name'>page_size</span>
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
<span class='type'>(<tt><span class='object_link'><a href="#PageSizeType-constant" title="ShotgridApiRuby::Entities::Params::PageSizeType (constant)">PageSizeType</a></span></tt>)</span>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
</li>
|
|
1139
|
+
|
|
1140
|
+
</ul>
|
|
1141
|
+
|
|
1142
|
+
<p class="tag_title">Returns:</p>
|
|
1143
|
+
<ul class="return">
|
|
1144
|
+
|
|
1145
|
+
<li>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
<span class='type'>(<tt>Hash{T.untyped => T.untyped}</tt>, <tt>nil</tt>)</span>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
</li>
|
|
1153
|
+
|
|
1154
|
+
</ul>
|
|
1155
|
+
|
|
1156
|
+
</div><table class="source_code">
|
|
1157
|
+
<tr>
|
|
1158
|
+
<td>
|
|
1159
|
+
<pre class="lines">
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
54
|
|
1163
|
+
55
|
|
1164
|
+
56
|
|
1165
|
+
57
|
|
1166
|
+
58
|
|
1167
|
+
59
|
|
1168
|
+
60
|
|
1169
|
+
61
|
|
1170
|
+
62</pre>
|
|
1171
|
+
</td>
|
|
1172
|
+
<td>
|
|
1173
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 54</span>
|
|
1174
|
+
|
|
1175
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_page'>add_page</span><span class='lparen'>(</span><span class='id identifier rubyid_page'>page</span><span class='comma'>,</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='rparen'>)</span>
|
|
1176
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_page'>page</span> <span class='op'>||</span> <span class='id identifier rubyid_page_size'>page_size</span>
|
|
1177
|
+
|
|
1178
|
+
<span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_page'>page</span>
|
|
1179
|
+
<span class='id identifier rubyid_page_size'>page_size</span> <span class='op'>=</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_page_size'>page_size</span>
|
|
1180
|
+
|
|
1181
|
+
<span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_page'>page</span> <span class='op'>&&</span> <span class='id identifier rubyid_page'>page</span> <span class='op'><</span> <span class='int'>1</span>
|
|
1182
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:page</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>size:</span> <span class='id identifier rubyid_page_size'>page_size</span> <span class='op'>||</span> <span class='int'>20</span><span class='comma'>,</span> <span class='label'>number:</span> <span class='id identifier rubyid_page'>page</span> <span class='op'>||</span> <span class='int'>1</span> <span class='rbrace'>}</span>
|
|
1183
|
+
<span class='kw'>end</span></pre>
|
|
1184
|
+
</td>
|
|
1185
|
+
</tr>
|
|
1186
|
+
</table>
|
|
1187
|
+
</div>
|
|
1188
|
+
|
|
1189
|
+
<div class="method_details ">
|
|
1190
|
+
<h3 class="signature " id="add_sort-instance_method">
|
|
1191
|
+
|
|
1192
|
+
#<strong>add_sort</strong>(sort) ⇒ <tt>String</tt><sup>?</sup>
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
</h3><div class="docstring">
|
|
1199
|
+
<div class="discussion">
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
</div>
|
|
1203
|
+
</div>
|
|
1204
|
+
<div class="tags">
|
|
1205
|
+
<p class="tag_title">Parameters:</p>
|
|
1206
|
+
<ul class="param">
|
|
1207
|
+
|
|
1208
|
+
<li>
|
|
1209
|
+
|
|
1210
|
+
<span class='name'>sort</span>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
<span class='type'>(<tt><span class='object_link'><a href="#SortType-constant" title="ShotgridApiRuby::Entities::Params::SortType (constant)">SortType</a></span></tt>)</span>
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
</li>
|
|
1218
|
+
|
|
1219
|
+
</ul>
|
|
1220
|
+
|
|
1221
|
+
<p class="tag_title">Returns:</p>
|
|
1222
|
+
<ul class="return">
|
|
1223
|
+
|
|
1224
|
+
<li>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
</li>
|
|
1232
|
+
|
|
1233
|
+
</ul>
|
|
1234
|
+
|
|
1235
|
+
</div><table class="source_code">
|
|
1236
|
+
<tr>
|
|
1237
|
+
<td>
|
|
1238
|
+
<pre class="lines">
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
32
|
|
1242
|
+
33
|
|
1243
|
+
34
|
|
1244
|
+
35
|
|
1245
|
+
36
|
|
1246
|
+
37
|
|
1247
|
+
38
|
|
1248
|
+
39
|
|
1249
|
+
40
|
|
1250
|
+
41
|
|
1251
|
+
42
|
|
1252
|
+
43
|
|
1253
|
+
44
|
|
1254
|
+
45</pre>
|
|
1255
|
+
</td>
|
|
1256
|
+
<td>
|
|
1257
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 32</span>
|
|
1258
|
+
|
|
1259
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_sort'>add_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_sort'>sort</span><span class='rparen'>)</span>
|
|
1260
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_sort'>sort</span>
|
|
1261
|
+
|
|
1262
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:sort</span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
1263
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_sort'>sort</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
1264
|
+
<span class='id identifier rubyid_sort'>sort</span>
|
|
1265
|
+
<span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_direction'>direction</span><span class='op'>|</span>
|
|
1266
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_direction'>direction</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>desc</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
1267
|
+
<span class='kw'>end</span>
|
|
1268
|
+
<span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1269
|
+
<span class='kw'>else</span>
|
|
1270
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_sort'>sort</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1271
|
+
<span class='kw'>end</span>
|
|
1272
|
+
<span class='kw'>end</span></pre>
|
|
1273
|
+
</td>
|
|
1274
|
+
</tr>
|
|
1275
|
+
</table>
|
|
1276
|
+
</div>
|
|
1277
|
+
|
|
1278
|
+
<div class="method_details ">
|
|
1279
|
+
<h3 class="signature " id="add_summary_fields-instance_method">
|
|
1280
|
+
|
|
1281
|
+
#<strong>add_summary_fields</strong>(summary_fields) ⇒ <tt>Array<Hash{T.untyped => T.untyped}></tt><sup>?</sup>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
</h3><div class="docstring">
|
|
1288
|
+
<div class="discussion">
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
</div>
|
|
1292
|
+
</div>
|
|
1293
|
+
<div class="tags">
|
|
1294
|
+
<p class="tag_title">Parameters:</p>
|
|
1295
|
+
<ul class="param">
|
|
1296
|
+
|
|
1297
|
+
<li>
|
|
1298
|
+
|
|
1299
|
+
<span class='name'>summary_fields</span>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
<span class='type'>(<tt><span class='object_link'><a href="#SummaryFiledsType-constant" title="ShotgridApiRuby::Entities::Params::SummaryFiledsType (constant)">SummaryFiledsType</a></span></tt>)</span>
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
</li>
|
|
1307
|
+
|
|
1308
|
+
</ul>
|
|
1309
|
+
|
|
1310
|
+
<p class="tag_title">Returns:</p>
|
|
1311
|
+
<ul class="return">
|
|
1312
|
+
|
|
1313
|
+
<li>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
<span class='type'>(<tt>Array<Hash{T.untyped => T.untyped}></tt>, <tt>nil</tt>)</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
</li>
|
|
1321
|
+
|
|
1322
|
+
</ul>
|
|
1323
|
+
|
|
1324
|
+
</div><table class="source_code">
|
|
1325
|
+
<tr>
|
|
1326
|
+
<td>
|
|
1327
|
+
<pre class="lines">
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
284
|
|
1331
|
+
285
|
|
1332
|
+
286
|
|
1333
|
+
287
|
|
1334
|
+
288
|
|
1335
|
+
289
|
|
1336
|
+
290
|
|
1337
|
+
291
|
|
1338
|
+
292
|
|
1339
|
+
293
|
|
1340
|
+
294
|
|
1341
|
+
295
|
|
1342
|
+
296</pre>
|
|
1343
|
+
</td>
|
|
1344
|
+
<td>
|
|
1345
|
+
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/entities/params.rb', line 284</span>
|
|
1346
|
+
|
|
1347
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_summary_fields'>add_summary_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_summary_fields'>summary_fields</span><span class='rparen'>)</span>
|
|
1348
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_summary_fields'>summary_fields</span>
|
|
1349
|
+
|
|
1350
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_summary_fields'>summary_fields</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
|
|
1351
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:summary_fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_summary_fields'>summary_fields</span>
|
|
1352
|
+
<span class='kw'>return</span>
|
|
1353
|
+
<span class='kw'>end</span>
|
|
1354
|
+
|
|
1355
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_summary_fields'>summary_fields</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
|
|
1356
|
+
<span class='ivar'>@parsed_params</span><span class='lbracket'>[</span><span class='symbol'>:summary_fields</span><span class='rbracket'>]</span> <span class='op'>=</span>
|
|
1357
|
+
<span class='id identifier rubyid_summary_fields'>summary_fields</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='lbrace'>{</span> <span class='label'>field:</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
|
|
1358
|
+
<span class='kw'>end</span>
|
|
1359
|
+
<span class='kw'>end</span></pre>
|
|
1360
|
+
</td>
|
|
1361
|
+
</tr>
|
|
1362
|
+
</table>
|
|
1363
|
+
</div>
|
|
1364
|
+
|
|
1365
|
+
</div>
|
|
1366
|
+
|
|
1367
|
+
</div>
|
|
1368
|
+
|
|
1369
|
+
<div id="footer">
|
|
1370
|
+
Generated on Tue Apr 5 14:53:00 2022 by
|
|
1371
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1372
|
+
0.9.27 (ruby-3.0.3).
|
|
1373
|
+
</div>
|
|
1374
|
+
|
|
1375
|
+
</div>
|
|
1376
|
+
</body>
|
|
1377
|
+
</html>
|