RubyGems - workos - Versions diffs - 2.17.0 → 3.1.0 - Mend

workos 2.17.0 → 3.1.0

Files changed (109) hide show

data/docs/WorkOS/AuditLog.html DELETED Viewed

@@ -1,235 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: WorkOS::AuditLog
-    &mdash; Documentation by YARD 0.9.22
-</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 = "WorkOS::AuditLog";
-  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 (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span>
-     &raquo;
-    <span class="title">AuditLog</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>Module: WorkOS::AuditLog
-</h1>
-<div class="box_info">
-  <dl>
-      <dt>Extended by:</dt>
-      <dd>T::Sig, <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span>, <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/workos/audit_log.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>The Audit Log module provides convenience methods for working with the WorkOS Audit Log platform. You&#39;ll need a valid API key.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://dashboard.workos.com/docs/audit-log/quickstart" target="_parent" title="https://dashboard.workos.com/docs/audit-log/quickstart">https://dashboard.workos.com/docs/audit-log/quickstart</a></li>
-  </ul>
-</div>
-  <h2>Instance Attribute Summary</h2>
-  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Base.html#key-instance_method" title="WorkOS::Base#key (method)">#key</a></span></p>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_event-class_method" title="create_event (class method)">.<strong>create_event</strong>(event:, idempotency_key: nil)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Client.html#client-instance_method" title="WorkOS::Client#client (method)">client</a></span>, <span class='object_link'><a href="Client.html#execute_request-instance_method" title="WorkOS::Client#execute_request (method)">execute_request</a></span>, <span class='object_link'><a href="Client.html#handle_error_response-instance_method" title="WorkOS::Client#handle_error_response (method)">handle_error_response</a></span>, <span class='object_link'><a href="Client.html#post_request-instance_method" title="WorkOS::Client#post_request (method)">post_request</a></span>, <span class='object_link'><a href="Client.html#user_agent-instance_method" title="WorkOS::Client#user_agent (method)">user_agent</a></span></p>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="create_event-class_method">
-    .<strong>create_event</strong>(event:, idempotency_key: nil)  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-51
-52
-53
-54
-55
-56
-57
-58
-59</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/audit_log.rb', line 51</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_event'>create_event</span><span class='lparen'>(</span><span class='label'>event:</span><span class='comma'>,</span> <span class='label'>idempotency_key:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_post_request'>post_request</span><span class='lparen'>(</span>
-    <span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/events</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-    <span class='label'>idempotency_key:</span> <span class='id identifier rubyid_idempotency_key'>idempotency_key</span><span class='comma'>,</span>
-    <span class='label'>body:</span> <span class='id identifier rubyid_event'>event</span><span class='comma'>,</span>
-  <span class='rparen'>)</span>
-  <span class='id identifier rubyid_execute_request'>execute_request</span><span class='lparen'>(</span><span class='label'>request:</span> <span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Mar 13 12:16:46 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>
-  </body>
-</html>

data/docs/WorkOS/AuditTrail.html DELETED Viewed

@@ -1,235 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: WorkOS::AuditTrail
-    &mdash; Documentation by YARD 0.9.22
-</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 = "WorkOS::AuditTrail";
-  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 (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span>
-     &raquo;
-    <span class="title">AuditTrail</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>Module: WorkOS::AuditTrail
-</h1>
-<div class="box_info">
-  <dl>
-      <dt>Extended by:</dt>
-      <dd>T::Sig, <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span>, <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/workos/audit_trail.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>The Audit Trail module provides convenience methods for working with the WorkOS Audit Trail platform. You&#39;ll need a valid API key.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.workos.com/audit-trail/overview" target="_parent" title="https://docs.workos.com/audit-trail/overview">https://docs.workos.com/audit-trail/overview</a></li>
-  </ul>
-</div>
-  <h2>Instance Attribute Summary</h2>
-  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Base.html#key-instance_method" title="WorkOS::Base#key (method)">#key</a></span></p>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_event-class_method" title="create_event (class method)">.<strong>create_event</strong>(event:, idempotency_key: nil)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Client.html#client-instance_method" title="WorkOS::Client#client (method)">client</a></span>, <span class='object_link'><a href="Client.html#execute_request-instance_method" title="WorkOS::Client#execute_request (method)">execute_request</a></span>, <span class='object_link'><a href="Client.html#handle_error_response-instance_method" title="WorkOS::Client#handle_error_response (method)">handle_error_response</a></span>, <span class='object_link'><a href="Client.html#post_request-instance_method" title="WorkOS::Client#post_request (method)">post_request</a></span>, <span class='object_link'><a href="Client.html#user_agent-instance_method" title="WorkOS::Client#user_agent (method)">user_agent</a></span></p>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="create_event-class_method">
-    .<strong>create_event</strong>(event:, idempotency_key: nil)  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-51
-52
-53
-54
-55
-56
-57
-58
-59</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workos/audit_trail.rb', line 51</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_event'>create_event</span><span class='lparen'>(</span><span class='label'>event:</span><span class='comma'>,</span> <span class='label'>idempotency_key:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_post_request'>post_request</span><span class='lparen'>(</span>
-    <span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/events</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-    <span class='label'>idempotency_key:</span> <span class='id identifier rubyid_idempotency_key'>idempotency_key</span><span class='comma'>,</span>
-    <span class='label'>body:</span> <span class='id identifier rubyid_event'>event</span><span class='comma'>,</span>
-  <span class='rparen'>)</span>
-  <span class='id identifier rubyid_execute_request'>execute_request</span><span class='lparen'>(</span><span class='label'>request:</span> <span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Tue Apr  7 22:21:08 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.7.1).
-</div>
-    </div>
-  </body>
-</html>

data/docs/WorkOS/AuthenticationError.html DELETED Viewed

@@ -1,160 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Exception: WorkOS::AuthenticationError
-    &mdash; Documentation by YARD 0.9.22
-</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 = "WorkOS::AuthenticationError";
-  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 (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span>
-     &raquo;
-    <span class="title">AuthenticationError</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>Exception: WorkOS::AuthenticationError
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName"><span class='object_link'><a href="WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span></span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">StandardError</li>
-            <li class="next"><span class='object_link'><a href="WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span></li>
-            <li class="next">WorkOS::AuthenticationError</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/workos/errors.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>AuthenticationError is raised when invalid credentials are used to connect to WorkOS&#39;s servers.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-  <h2>Instance Attribute Summary</h2>
-  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="WorkOSError.html#http_status-instance_method" title="WorkOS::WorkOSError#http_status (method)">#http_status</a></span>, <span class='object_link'><a href="WorkOSError.html#request_id-instance_method" title="WorkOS::WorkOSError#request_id (method)">#request_id</a></span></p>
-  <h2>Method Summary</h2>
-  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="WorkOSError.html#initialize-instance_method" title="WorkOS::WorkOSError#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="WorkOSError.html#to_s-instance_method" title="WorkOS::WorkOSError#to_s (method)">#to_s</a></span></p>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="WorkOSError.html#initialize-instance_method" title="WorkOS::WorkOSError#initialize (method)">WorkOS::WorkOSError</a></span></p>
-</div>
-</div>
-      <div id="footer">
-  Generated on Tue Apr  7 22:21:08 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.7.1).
-</div>
-    </div>
-  </body>
-</html>