<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: ShotgridApiRuby::Client
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "ShotgridApiRuby::Client";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span>
»
<span class="title">Client</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: ShotgridApiRuby::Client
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ShotgridApiRuby::Client</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Extended by:</dt>
<dd>T::Sig</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/shotgrid_api_ruby/client.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Main class for connection.</p>
<p>This should be only instanciated once to re-use tokens</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong> ⇒ Faraday::Connection </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Faraday connection.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#entities-instance_method" title="#entities (instance method)">#<strong>entities</strong>(type) ⇒ Entities </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Access entities related APIs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ void </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#method_missing-instance_method" title="#method_missing (instance method)">#<strong>method_missing</strong>(name, *args, &block) ⇒ Entities </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preferences-instance_method" title="#preferences (instance method)">#<strong>preferences</strong> ⇒ Preferences </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Access preferences APIs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#respond_to_missing%3F-instance_method" title="#respond_to_missing? (instance method)">#<strong>respond_to_missing?</strong>(_name, _include_private = false) ⇒ true </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#server_info-instance_method" title="#server_info (instance method)">#<strong>server_info</strong> ⇒ ServerInfo </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Access server_info APIs.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>auth</span>
<span class='type'>(<tt><span class='object_link'><a href="Types.html#AuthType-constant" title="ShotgridApiRuby::Types::AuthType (constant)">Types::AuthType</a></span></tt>)</span>
</li>
<li>
<span class='name'>site_url</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>shotgun_site</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>shotgrid_site</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>auth:</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgun_site:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgrid_site:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>No site given</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_site_url'>site_url</span> <span class='op'>||</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span> <span class='op'>||</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='const'><span class='object_link'><a href="Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Auth/Validator.html" title="ShotgridApiRuby::Auth::Validator (module)">Validator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_valid?'><span class='object_link'><a href="Auth/Validator.html#valid%3F-class_method" title="ShotgridApiRuby::Auth::Validator.valid? (method)">valid?</a></span></span><span class='lparen'>(</span>
<span class='label'>client_id:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:client_id</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>client_secret:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:client_secret</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>username:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>password:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>session_token:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:session_token</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>refresh_token:</span> <span class='id identifier rubyid_auth'>auth</span><span class='lbracket'>[</span><span class='symbol'>:refresh_token</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>auth param not valid</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_site_url'>site_url</span> <span class='op'>||=</span>
<span class='kw'>if</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_shotgun_site'>shotgun_site</span><span class='embexpr_end'>}</span><span class='tstring_content'>.shotgunstudio.com/api/v1</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span><span class='embexpr_end'>}</span><span class='tstring_content'>.shotgrid.autodesk.com/api/v1</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='ivar'>@connection</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='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_faraday'>faraday</span><span class='op'>|</span>
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span><span class='comma'>,</span> <span class='label'>auth:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='rparen'>)</span>
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span>
<span class='kw'>end</span><span class='comma'>,</span>
<span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Connection</span><span class='comma'>,</span>
<span class='rparen'>)</span>
<span class='ivar'>@preferences</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@server_info</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@entity_caller</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="method_missing_details" class="method_details_list">
<h2>Dynamic Method Handling</h2>
<p class="notice this">
This class handles dynamic methods through the <tt>method_missing</tt> method
</p>
<div class="method_details first">
<h3 class="signature first" id="method_missing-instance_method">
#<strong>method_missing</strong>(name, *args, &block) ⇒ <tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
</li>
<li>
<span class='name'>args</span>
<span class='type'>(<tt>Array<T.untyped></tt>)</span>
</li>
<li>
<span class='name'>block</span>
<span class='type'>(<tt>Proc</tt>, <tt>nil</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_fname'>fname</span> <span class='op'>=</span> <span class='id identifier rubyid_formated_name'>formated_name</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<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_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='kw'>if</span> <span class='id identifier rubyid_entities_client'>entities_client</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fname'>fname</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_entities_client'>entities_client</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_entities_client'>entities_client</span> <span class='op'>=</span> <span class='id identifier rubyid_entities_aux'>entities_aux</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fname'>fname</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_entities_client'>entities_client</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</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_instance_eval'>instance_eval</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_fname'>fname</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_fname'>fname</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='kw'>super</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="connection-instance_method">
#<strong>connection</strong> ⇒ <tt>Faraday::Connection</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Faraday connection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
<span class='ivar'>@connection</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="entities-instance_method">
#<strong>entities</strong>(type) ⇒ <tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Access entities related APIs</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt>Symbol</tt>, <tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_entities'>entities</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="preferences-instance_method">
#<strong>preferences</strong> ⇒ <tt><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Access preferences APIs</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_preferences'>preferences</span>
<span class='ivar'>@preferences</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="respond_to_missing?-instance_method">
#<strong>respond_to_missing?</strong>(_name, _include_private = false) ⇒ <tt>true</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>_name</span>
<span class='type'>(<tt>T.untyped</tt>)</span>
</li>
<li>
<span class='name'>_include_private</span>
<span class='type'>(<tt>T.untyped</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='id identifier rubyid__name'>_name</span><span class='comma'>,</span> <span class='id identifier rubyid__include_private'>_include_private</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="server_info-instance_method">
#<strong>server_info</strong> ⇒ <tt><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Access server_info APIs</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/client.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_server_info'>server_info</span>
<span class='ivar'>@server_info</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ShotgridApiRuby.html#new-class_method" title="ShotgridApiRuby.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 29 05:51:49 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.2.0).
</div>
</div>
</body>
</html>