workos 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13b44f46640b8e437a8202d958cc545ddbb95f04d9ab1ae2e56153531c5c0cef
-  data.tar.gz: 538208b90831666360053a2cbb7b732c43a64299523c5649858e16f4a2553cde
+  metadata.gz: e7d3d1ab0e4e31ce6558f2465677e784a4a084bc0eb7df11b70ddecf08c9afa1
+  data.tar.gz: 8d3d2869ca1836bcb88d4f91bd584295588bd429715dd338ef5bf7d7f50d86c6
 SHA512:
-  metadata.gz: 4699ed5040947a19c420caaca3f1bd3bf5443398ec2cdcfda1aed6e03ac05c874158e139cdce87f8dd44e26804b62fa0786700c8c156e3f1cf1457e7bf3174a3
-  data.tar.gz: 8c65f6603e50ccf76b0179c9bee721ca3aaae64ce749fe91b5daa3c9c0f57db74049944f1d0cf89b2755dfd38ddbbd4e8dfc3d3f7cdf3e99cb88077c54fac9f9
+  metadata.gz: f67a1ddc4ae967bb39745b29b349b75ae86f9841cb7d9f3406f7e77a035d77d09297df346783ab28a2b4789910263cedfcd9477ea3f9661e1d92198d74017aec
+  data.tar.gz: fc3e8043768d02ce2bb8ec2a5af7127beb68ef56bb4614192715e56cb3ce26f7296d3b09219ace183787773f8ba8491a563a778c3785cdc985cc4dcc9a7cce3a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.1.1)
+    workos (0.2.0)
       sorbet-runtime (~> 0.5)
 
 GEM

data/README.md

@@ -42,13 +42,13 @@ Alternatively, you may set the key yourself, such as in an initializer in your a
 WorkOS.key = '[your api key]'
 ```
 
-## The Audit Log Module
+## The Audit Trail Module
 
-The Audit Log Module provides methods for creating Audit Log events on
+The Audit Trail Module provides methods for creating Audit Trail events on
 WorkOS.
 
-See our [Audit Log
-Quickstart](https://dashboard.workos.com/docs/audit-log/quickstart) for
+See our [Audit Trail
+Overview](https://docs.workos.com/audit-trail/overview) for
 more information.
 
 ```ruby
@@ -67,7 +67,7 @@ payload = {
   }
 }
 
-WorkOS::AuditLog.create_event(event: payload)
+WorkOS::AuditTrail.create_event(event: payload)
 ```
 
 ### Idempotency
@@ -76,11 +76,11 @@ To perform an idempotent request, provide an additional idempotency_key
 parameter to the `create_event` options.
 
 ```ruby
-WorkOS::AuditLog.create_event(event: payload, idempotency_key: 'key123456')
+WorkOS::AuditTrail.create_event(event: payload, idempotency_key: 'key123456')
 ```
 
 See our [API
-Reference](https://dashboard.workos.com/docs/api-reference#idempotency)
+Reference](https://docs.workos.com/api-reference#idempotency)
 for more information on idempotency keys.
 
 ## The SSO Module

data/docs/WorkOS.html

@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/workos.rb<span class="defines">,<br />
-  lib/workos/sso.rb,<br /> lib/workos/base.rb,<br /> lib/workos/types.rb,<br /> lib/workos/client.rb,<br /> lib/workos/errors.rb,<br /> lib/workos/profile.rb,<br /> lib/workos/version.rb,<br /> lib/workos/audit_log.rb,<br /> lib/workos/types/provider_enum.rb,<br /> lib/workos/types/profile_struct.rb</span>
+  lib/workos/sso.rb,<br /> lib/workos/base.rb,<br /> lib/workos/types.rb,<br /> lib/workos/client.rb,<br /> lib/workos/errors.rb,<br /> lib/workos/profile.rb,<br /> lib/workos/version.rb,<br /> lib/workos/audit_trail.rb,<br /> lib/workos/types/provider_enum.rb,<br /> lib/workos/types/profile_struct.rb</span>
 </dd>
   </dl>
   
@@ -100,7 +100,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span>, <span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span>, <span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span>, <span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span>, <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="WorkOS/AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span>, <span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span>, <span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span>, <span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span>, <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span>
     
   
     
@@ -125,7 +125,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
       
     </dl>
   
@@ -314,7 +314,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/APIError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/AuditLog.html

@@ -225,7 +225,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  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>

data/docs/WorkOS/AuditTrail.html

@@ -0,0 +1,235 @@
+<!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 Sun Mar 15 22:11:09 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/AuthenticationError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Base.html

@@ -81,7 +81,7 @@
   
   <dl>
     <dt>Included in:</dt>
-    <dd><span class='object_link'><a href="AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span>, <span class='object_link'><a href="SSO.html" title="WorkOS::SSO (module)">SSO</a></span></dd>
+    <dd><span class='object_link'><a href="AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span>, <span class='object_link'><a href="SSO.html" title="WorkOS::SSO (module)">SSO</a></span></dd>
   </dl>
   
 
@@ -277,7 +277,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Client.html

@@ -86,7 +86,7 @@
   
   <dl>
     <dt>Included in:</dt>
-    <dd><span class='object_link'><a href="AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span>, <span class='object_link'><a href="SSO.html" title="WorkOS::SSO (module)">SSO</a></span></dd>
+    <dd><span class='object_link'><a href="AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span>, <span class='object_link'><a href="SSO.html" title="WorkOS::SSO (module)">SSO</a></span></dd>
   </dl>
   
 
@@ -494,7 +494,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/InvalidRequestError.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Profile.html

@@ -778,7 +778,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/SSO.html

@@ -102,7 +102,7 @@
   <p class="tag_title">See Also:</p>
   <ul class="see">
     
-      <li><a href="https://dashboard.workos.com/docs/sso/what-is-sso" target="_parent" title="https://dashboard.workos.com/docs/sso/what-is-sso">https://dashboard.workos.com/docs/sso/what-is-sso</a></li>
+      <li><a href="https://docs.workos.com/sso/overview" target="_parent" title="https://docs.workos.com/sso/overview">https://docs.workos.com/sso/overview</a></li>
     
   </ul>
 
@@ -208,7 +208,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Promote a DraftConnection created via IdP Link Embed such that the Enterprise users can begin signing into your application.</p>
+<p>Promote a DraftConnection created via the WorkOS.js embed such that the Enterprise users can begin signing into your application.</p>
 </div></span>
   
 </li>
@@ -576,9 +576,9 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Promote a DraftConnection created via IdP Link Embed such that the Enterprise users can begin signing into your application.</p>
+<p>Promote a DraftConnection created via the WorkOS.js embed such that the Enterprise users can begin signing into your application.</p>
 
-<p>you by the IdP Link Embed</p>
+<p>you by the WorkOS.js embed</p>
 
 
   </div>
@@ -681,7 +681,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Types.html

@@ -118,7 +118,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Types/ProfileStruct.html

@@ -125,7 +125,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/Types/Provider.html

@@ -125,7 +125,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/WorkOS/WorkOSError.html

@@ -437,7 +437,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_WorkOS' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_WorkOS::APIError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/APIError.html" title="WorkOS::APIError (class)">APIError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuditLog' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuthenticationError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuthenticationError.html" title="WorkOS::AuthenticationError (class)">AuthenticationError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Base' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::InvalidRequestError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/InvalidRequestError.html" title="WorkOS::InvalidRequestError (class)">InvalidRequestError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Profile' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span> &lt; Object<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::SSO' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Types' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span><small class='search_info'>WorkOS</small></div><ul><li id='object_WorkOS::Types::ProfileStruct' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span> &lt; Struct<small class='search_info'>WorkOS::Types</small></div></li><li id='object_WorkOS::Types::Provider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span> &lt; Enum<small class='search_info'>WorkOS::Types</small></div></li></ul></li><li id='object_WorkOS::WorkOSError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span> &lt; StandardError<small class='search_info'>WorkOS</small></div></li></ul></li>
+<li id='object_WorkOS' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_WorkOS::APIError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/APIError.html" title="WorkOS::APIError (class)">APIError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuditTrail' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::AuthenticationError' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/AuthenticationError.html" title="WorkOS::AuthenticationError (class)">AuthenticationError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Base' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Base.html" title="WorkOS::Base (module)">Base</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Client.html" title="WorkOS::Client (module)">Client</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::InvalidRequestError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/InvalidRequestError.html" title="WorkOS::InvalidRequestError (class)">InvalidRequestError</a></span> &lt; WorkOSError<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Profile' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/Profile.html" title="WorkOS::Profile (class)">Profile</a></span> &lt; Object<small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::SSO' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/SSO.html" title="WorkOS::SSO (module)">SSO</a></span><small class='search_info'>WorkOS</small></div></li><li id='object_WorkOS::Types' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="WorkOS/Types.html" title="WorkOS::Types (module)">Types</a></span><small class='search_info'>WorkOS</small></div><ul><li id='object_WorkOS::Types::ProfileStruct' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/ProfileStruct.html" title="WorkOS::Types::ProfileStruct (class)">ProfileStruct</a></span> &lt; Struct<small class='search_info'>WorkOS::Types</small></div></li><li id='object_WorkOS::Types::Provider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="WorkOS/Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span> &lt; Enum<small class='search_info'>WorkOS::Types</small></div></li></ul></li><li id='object_WorkOS::WorkOSError' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="WorkOS/WorkOSError.html" title="WorkOS::WorkOSError (class)">WorkOSError</a></span> &lt; StandardError<small class='search_info'>WorkOS</small></div></li></ul></li>
 
       </ul>
     </div>

data/docs/file.README.html

@@ -98,11 +98,11 @@
 <span class='const'><span class='object_link'><a href="WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_key'><span class='object_link'><a href="WorkOS.html#key-class_method" title="WorkOS.key (method)">key</a></span></span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>[your api key]</span><span class='tstring_end'>&#39;</span></span>
 </code></pre>
 
-<h2 id="label-The+Audit+Log+Module">The Audit Log Module</h2>
+<h2 id="label-The+Audit+Trail+Module">The Audit Trail Module</h2>
 
-<p>The Audit Log Module provides methods for creating Audit Log events on WorkOS.</p>
+<p>The Audit Trail Module provides methods for creating Audit Trail events on WorkOS.</p>
 
-<p>See our <a href="https://dashboard.workos.com/docs/audit-log/quickstart">Audit Log Quickstart</a> for more information.</p>
+<p>See our <a href="https://docs.workos.com/audit-trail/overview">Audit Trail Overview</a> for more information.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
   <span class='label'>group:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Foo Corp</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
@@ -119,17 +119,17 @@
   <span class='rbrace'>}</span>
 <span class='rbrace'>}</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/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</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/AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditTrail.html#create_event-class_method" title="WorkOS::AuditTrail.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
 </code></pre>
 
 <h3 id="label-Idempotency">Idempotency</h3>
 
 <p>To perform an idempotent request, provide an additional idempotency_key parameter to the <code>create_event</code> options.</p>
 
-<pre class="code ruby"><code class="ruby"><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/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>idempotency_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>key123456</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><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/AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_event'><span class='object_link'><a href="WorkOS/AuditTrail.html#create_event-class_method" title="WorkOS::AuditTrail.create_event (method)">create_event</a></span></span><span class='lparen'>(</span><span class='label'>event:</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>idempotency_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>key123456</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 </code></pre>
 
-<p>See our <a href="https://dashboard.workos.com/docs/api-reference#idempotency">API Reference</a> for more information on idempotency keys.</p>
+<p>See our <a href="https://docs.workos.com/api-reference#idempotency">API Reference</a> for more information on idempotency keys.</p>
 
 <h2 id="label-The+SSO+Module">The SSO Module</h2>
 
@@ -242,7 +242,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/docs/index.html

@@ -88,7 +88,7 @@
               </li>
             
               <li>
-                <span class='object_link'><a href="WorkOS/AuditLog.html" title="WorkOS::AuditLog (module)">AuditLog</a></span>
+                <span class='object_link'><a href="WorkOS/AuditTrail.html" title="WorkOS::AuditTrail (module)">AuditTrail</a></span>
                 
                   <small>(WorkOS)</small>
                 
@@ -240,7 +240,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:47 2020 by
+  Generated on Sun Mar 15 22:11:08 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>

data/docs/method_list.html

@@ -70,8 +70,8 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="WorkOS/AuditLog.html#create_event-class_method" title="WorkOS::AuditLog.create_event (method)">create_event</a></span>
-      <small>WorkOS::AuditLog</small>
+      <span class='object_link'><a href="WorkOS/AuditTrail.html#create_event-class_method" title="WorkOS::AuditTrail.create_event (method)">create_event</a></span>
+      <small>WorkOS::AuditTrail</small>
     </div>
   </li>
   

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Mar  2 13:26:48 2020 by
+  Generated on Sun Mar 15 22:11:09 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>

data/lib/workos.rb

@@ -28,7 +28,7 @@ module WorkOS
   autoload :Types, 'workos/types'
   autoload :Base, 'workos/base'
   autoload :Client, 'workos/client'
-  autoload :AuditLog, 'workos/audit_log'
+  autoload :AuditTrail, 'workos/audit_trail'
   autoload :Profile, 'workos/profile'
   autoload :SSO, 'workos/sso'
 

data/lib/workos/{audit_log.rb → audit_trail.rb}

@@ -5,17 +5,17 @@ require 'net/http'
 require 'uri'
 
 module WorkOS
-  # The Audit Log module provides convenience methods for working with the
-  # WorkOS Audit Log platform. You'll need a valid API key.
+  # The Audit Trail module provides convenience methods for working with the
+  # WorkOS Audit Trail platform. You'll need a valid API key.
   #
-  # @see https://dashboard.workos.com/docs/audit-log/quickstart
-  module AuditLog
+  # @see https://docs.workos.com/audit-trail/overview
+  module AuditTrail
     class << self
       extend T::Sig
       include Base
       include Client
 
-      # Create an Audit Log event.
+      # Create an Audit Trail event.
       #
       # @param [Hash] event An event hash
       # @option event [String] group A single organization containing related

data/lib/workos/sso.rb

@@ -9,7 +9,7 @@ module WorkOS
   # SSO platform. You'll need a valid API key, a project ID, and to have
   # created an SSO connection on your WorkOS dashboard.
   #
-  # @see https://dashboard.workos.com/docs/sso/what-is-sso
+  # @see https://docs.workos.com/sso/overview
   module SSO
     class << self
       extend T::Sig
@@ -125,11 +125,11 @@ module WorkOS
         ).returns(T::Boolean)
       end
 
-      # Promote a DraftConnection created via IdP Link Embed such that the
+      # Promote a DraftConnection created via the WorkOS.js embed such that the
       # Enterprise users can begin signing into your application.
       #
       # @param [String] token The draft connection token that's been provided to
-      # you by the IdP Link Embed
+      # you by the WorkOS.js embed
       #
       # @example
       #   WorkOS::SSO.promote_draft_connection(

data/lib/workos/version.rb

@@ -3,5 +3,5 @@
 
 
 module WorkOS
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/lib/workos/{audit_log_spec.rb → audit_trail_spec.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # typed: false
 
-describe WorkOS::AuditLog do
+describe WorkOS::AuditTrail do
   before(:all) do
     WorkOS.key = 'key'
   end
@@ -32,7 +32,7 @@ describe WorkOS::AuditLog do
       context 'with idempotency key' do
         context 'when idempotency key is used once' do
           it 'creates an event' do
-            VCR.use_cassette('audit_log/create_event_custom_idempotency_key') do
+            VCR.use_cassette('audit_trail/create_event_custom_idempotency_key') do
               response = described_class.create_event(
                 event: valid_event,
                 idempotency_key: 'key',
@@ -48,7 +48,7 @@ describe WorkOS::AuditLog do
         context 'when idempotency key is used more than once' do
           context 'with duplicate event payloads' do
             it 'creates an event' do
-              VCR.use_cassette('audit_log/create_events_duplicate_idempotency_key_and_payload') do
+              VCR.use_cassette('audit_trail/create_events_duplicate_idempotency_key_and_payload') do
                 response1 = described_class.create_event(
                   event: valid_event,
                   idempotency_key: 'foo',
@@ -71,7 +71,7 @@ describe WorkOS::AuditLog do
 
           context 'with different event payloads' do
             it 'raises an error' do
-              VCR.use_cassette('audit_log/create_events_duplicate_idempotency_key_different_payload') do
+              VCR.use_cassette('audit_trail/create_events_duplicate_idempotency_key_different_payload') do
                 described_class.create_event(
                   event: valid_event,
                   idempotency_key: 'bar',
@@ -97,7 +97,7 @@ describe WorkOS::AuditLog do
 
       context 'with no idempotency key' do
         it 'creates an event' do
-          VCR.use_cassette('audit_log/create_event') do
+          VCR.use_cassette('audit_trail/create_event') do
             response = described_class.create_event(event: valid_event)
 
             expect(response.code).to eq '201'
@@ -126,7 +126,7 @@ describe WorkOS::AuditLog do
       end
 
       it 'raises an error' do
-        VCR.use_cassette('audit_log/create_event_invalid') do
+        VCR.use_cassette('audit_trail/create_event_invalid') do
           expect do
             described_class.create_event(event: invalid_event)
           end.to raise_error(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - WorkOS
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -185,6 +185,7 @@ files:
 - docs/WorkOS.html
 - docs/WorkOS/APIError.html
 - docs/WorkOS/AuditLog.html
+- docs/WorkOS/AuditTrail.html
 - docs/WorkOS/AuthenticationError.html
 - docs/WorkOS/Base.html
 - docs/WorkOS/Client.html
@@ -210,7 +211,7 @@ files:
 - docs/method_list.html
 - docs/top-level-namespace.html
 - lib/workos.rb
-- lib/workos/audit_log.rb
+- lib/workos/audit_trail.rb
 - lib/workos/base.rb
 - lib/workos/client.rb
 - lib/workos/errors.rb
@@ -229,15 +230,15 @@ files:
 - sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi
 - sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi
 - sorbet/rbi/todo.rbi
-- spec/lib/workos/audit_log_spec.rb
+- spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
 - spec/lib/workos/sso_spec.rb
 - spec/spec_helper.rb
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event_custom_idempotency_key.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event_invalid.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_and_payload.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event_custom_idempotency_key.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
 - spec/support/profile.txt
 - workos.gemspec
@@ -260,19 +261,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API client for WorkOS
 test_files:
-- spec/lib/workos/audit_log_spec.rb
+- spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
 - spec/lib/workos/sso_spec.rb
 - spec/spec_helper.rb
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event_custom_idempotency_key.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_event_invalid.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_and_payload.yml
-- spec/support/fixtures/vcr_cassettes/audit_log/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event_custom_idempotency_key.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
 - spec/support/profile.txt