docs/WorkOS/Client.html in workos-0.1.0 vs docs/WorkOS/Client.html in workos-0.1.1
- old
+ new
@@ -96,17 +96,28 @@
<dd>lib/workos/client.rb</dd>
</dl>
</div>
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+
+<p>A Net::HTTP based API client for interacting with the WorkOS API</p>
+ </div>
+</div>
+<div class="tags">
+
+</div>
+
+
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
@@ -247,21 +258,21 @@
<tr>
<td>
<pre class="lines">
-11
12
13
14
15
16
17
-18</pre>
+18
+19</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 11</span>
+ <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='kw'>return</span> <span class='ivar'>@client</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../WorkOS.html#API_HOSTNAME-constant" title="WorkOS::API_HOSTNAME (constant)">API_HOSTNAME</a></span></span><span class='comma'>,</span> <span class='int'>443</span><span class='rparen'>)</span>
@@ -287,21 +298,21 @@
<tr>
<td>
<pre class="lines">
-21
22
23
24
25
26
27
-28</pre>
+28
+29</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 21</span>
+ <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_execute_request'>execute_request</span><span class='lparen'>(</span><span class='label'>request:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_http_status'>http_status</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
@@ -327,11 +338,10 @@
<tr>
<td>
<pre class="lines">
-53
54
55
56
57
58
@@ -356,14 +366,15 @@
77
78
79
80
81
-82</pre>
+82
+83</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 53</span>
+ <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_handle_error_response'>handle_error_response</span><span class='lparen'>(</span><span class='label'>response:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_http_status'>http_status</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
@@ -411,19 +422,19 @@
<tr>
<td>
<pre class="lines">
-31
32
33
34
35
-36</pre>
+36
+37</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 31</span>
+ <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_post_request'>post_request</span><span class='lparen'>(</span><span class='label'>path:</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span> <span class='kw'>if</span> <span class='id identifier rubyid_body'>body</span>
<span class='id identifier rubyid_request'>request</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent'>user_agent</span>
@@ -447,23 +458,23 @@
<tr>
<td>
<pre class="lines">
-39
40
41
42
43
44
45
46
47
-48</pre>
+48
+49</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 39</span>
+ <pre class="code"><span class="info file"># File 'lib/workos/client.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_agent'>user_agent</span>
<span class='id identifier rubyid_engine'>engine</span> <span class='op'>=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>RUBY_ENGINE</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='op'>::</span><span class='const'>RUBY_ENGINE</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Ruby</span><span class='tstring_end'>'</span></span>
<span class='lbracket'>[</span>
@@ -481,10 +492,10 @@
</div>
</div>
<div id="footer">
- Generated on Thu Jan 30 09:12:47 2020 by
+ Generated on Mon Mar 2 13:26:48 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.22 (ruby-2.6.5).
</div>
</div>
\ No newline at end of file