workos 2.17.0 → 3.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/verify_email/valid.yml

@@ -0,0 +1,82 @@
+---
+http_interactions:
+  - request:
+      method: post
+      uri: https://api.workos.com/user_management/users/user_01H968BR1R84DSPYS9QR5PM6RZ/email_verification/confirm
+      body:
+        encoding: UTF-8
+        string: '{"code":"333495"}'
+      headers:
+        Content-Type:
+          - application/json
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - "*/*"
+        User-Agent:
+          - WorkOS; ruby/3.0.2; arm64-darwin21; v2.16.0
+        Authorization:
+          - Bearer <API_KEY>
+    response:
+      status:
+        code: 201
+        message: Created
+      headers:
+        Date:
+          - Thu, 31 Aug 2023 16:57:30 GMT
+        Content-Type:
+          - application/json; charset=utf-8
+        Content-Length:
+          - "375"
+        Connection:
+          - keep-alive
+        Cf-Ray:
+          - 7ff6d01c4853c71d-SEA
+        Cf-Cache-Status:
+          - DYNAMIC
+        Etag:
+          - W/"177-YBu4ZtIor9/cOTTWMVDcStQWgKw"
+        Strict-Transport-Security:
+          - max-age=15552000; includeSubDomains
+        Vary:
+          - Origin, Accept-Encoding
+        Via:
+          - 1.1 spaces-router (devel)
+        Access-Control-Allow-Credentials:
+          - "true"
+        Content-Security-Policy:
+          - "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self'
+            https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src
+            'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
+        Expect-Ct:
+          - max-age=0
+        Referrer-Policy:
+          - no-referrer
+        X-Content-Type-Options:
+          - nosniff
+        X-Dns-Prefetch-Control:
+          - "off"
+        X-Download-Options:
+          - noopen
+        X-Frame-Options:
+          - SAMEORIGIN
+        X-Permitted-Cross-Domain-Policies:
+          - none
+        X-Request-Id:
+          - 04bda556-68f2-4d4a-bf9a-4c062ef6a74c
+        X-Xss-Protection:
+          - "0"
+        Set-Cookie:
+          - __cf_bm=qyedAgoptBqJ5xN5lPHoIU9qwCUCQvbE3HD8c76nhUk-1693501050-0-AcNrMwoG1S+cyYFaLGGofemD2IQZEpdx4y1XWCEMFHec7s4VMppzx23C+RjWZW2swKRgz9N172Txwwh4bPatEvQ=;
+            path=/; expires=Thu, 31-Aug-23 17:27:30 GMT; domain=.workos.com; HttpOnly;
+            Secure; SameSite=None
+          - __cfruid=682f9a6af8fd91f62014876911781063f77faebe-1693501050; path=/; domain=.workos.com;
+            HttpOnly; Secure; SameSite=None
+        Server:
+          - cloudflare
+      body:
+        encoding: UTF-8
+        string: '{"user":{"object":"user","id":"user_01H968BR1R84DSPYS9QR5PM6RZ","email":"test@workos.com","email_verified":true,"first_name":"Adam","last_name":"Test","created_at":"2023-08-31T16:55:56.619Z","updated_at":"2023-08-31T16:57:30.574Z","user_type":"unmanaged","email_verified_at":"2023-08-31T16:57:30.628Z","google_oauth_profile_id":null,"microsoft_oauth_profile_id":null}}'
+      http_version:
+    recorded_at: Thu, 31 Aug 2023 16:57:30 GMT
+recorded_with: VCR 5.0.0

data/workos.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'tapioca'
   spec.add_development_dependency 'vcr', '~> 5.0.0'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'yard'
 
   spec.required_ruby_version = '>= 2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 3.0.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -136,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: API client for WorkOS
 email:
 - support@workos.com
@@ -172,44 +158,16 @@ files:
 - README.md
 - bin/build
 - bin/console
-- bin/docs
 - bin/publish
 - bin/tapioca
 - codecov.yml
 - devbox.json
 - devbox.lock
-- 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
-- docs/WorkOS/InvalidRequestError.html
-- docs/WorkOS/Profile.html
-- docs/WorkOS/RequestError.html
-- docs/WorkOS/SSO.html
-- docs/WorkOS/Types.html
-- docs/WorkOS/Types/ProfileStruct.html
-- docs/WorkOS/Types/Provider.html
-- docs/WorkOS/WorkOSError.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.README.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
 - lib/workos.rb
 - lib/workos/audit_log_export.rb
 - lib/workos/audit_logs.rb
-- lib/workos/audit_trail.rb
+- lib/workos/authentication_factor_and_challenge.rb
+- lib/workos/authentication_response.rb
 - lib/workos/challenge.rb
 - lib/workos/client.rb
 - lib/workos/configuration.rb
@@ -224,8 +182,10 @@ files:
 - lib/workos/events.rb
 - lib/workos/factor.rb
 - lib/workos/hash_provider.rb
+- lib/workos/invitation.rb
 - lib/workos/mfa.rb
 - lib/workos/organization.rb
+- lib/workos/organization_membership.rb
 - lib/workos/organizations.rb
 - lib/workos/passwordless.rb
 - lib/workos/portal.rb
@@ -242,13 +202,21 @@ files:
 - lib/workos/types/event_struct.rb
 - lib/workos/types/factor_struct.rb
 - lib/workos/types/intent_enum.rb
+- lib/workos/types/invitation_struct.rb
 - lib/workos/types/list_struct.rb
+- lib/workos/types/magic_auth_challenge_struct.rb
+- lib/workos/types/organization_membership_struct.rb
 - lib/workos/types/organization_struct.rb
 - lib/workos/types/passwordless_session_struct.rb
 - lib/workos/types/profile_struct.rb
 - lib/workos/types/provider_enum.rb
+- lib/workos/types/user_struct.rb
 - lib/workos/types/verify_challenge_struct.rb
 - lib/workos/types/webhook_struct.rb
+- lib/workos/user.rb
+- lib/workos/user_and_token.rb
+- lib/workos/user_management.rb
+- lib/workos/user_response.rb
 - lib/workos/verify_challenge.rb
 - lib/workos/version.rb
 - lib/workos/webhook.rb
@@ -296,7 +264,6 @@ files:
 - sorbet/tapioca/config.yml
 - sorbet/tapioca/require.rb
 - spec/lib/workos/audit_logs_spec.rb
-- spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/configuration_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
 - spec/lib/workos/directory_user_spec.rb
@@ -306,6 +273,7 @@ files:
 - spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
+- spec/lib/workos/user_management_spec.rb
 - spec/lib/workos/webhooks_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/vcr_cassettes/audit_logs/create_event.yml
@@ -394,6 +362,63 @@ files:
 - spec/support/fixtures/vcr_cassettes/sso/list_connections/with_no_options.yml
 - spec/support/fixtures/vcr_cassettes/sso/list_connections/with_organization_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/profile.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_code/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_code/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_email_verification/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_email_verification/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_magic_auth/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_magic_auth/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_organization_selection/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_organization_selection/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_totp/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_totp/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/confirm_password_reset/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/confirm_password_reset/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_user_invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_user_valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_organization_membership/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_user/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_user/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_organization_membership.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_user.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_after.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_before.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_limit.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_organization_id.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_organization_memberships/no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_organization_memberships/with_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_users/no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_users/with_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/reset_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/reset_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/revoke_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/revoke_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_magic_auth_code/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_password_reset_email/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_password_reset_email/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/invalid_code.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/invalid_magic_auth_challenge.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/valid.yml
 - spec/support/profile.txt
 - spec/support/shared_examples/client_spec.rb
 - spec/support/webhook_payload.txt
@@ -418,13 +443,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: API client for WorkOS
 test_files:
 - spec/lib/workos/audit_logs_spec.rb
-- spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/configuration_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
 - spec/lib/workos/directory_user_spec.rb
@@ -434,6 +458,7 @@ test_files:
 - spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
+- spec/lib/workos/user_management_spec.rb
 - spec/lib/workos/webhooks_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/vcr_cassettes/audit_logs/create_event.yml
@@ -522,6 +547,63 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/sso/list_connections/with_no_options.yml
 - spec/support/fixtures/vcr_cassettes/sso/list_connections/with_organization_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/profile.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_code/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_code/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_email_verification/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_email_verification/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_magic_auth/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_magic_auth/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_organization_selection/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_organization_selection/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_totp/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/authenticate_with_totp/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/confirm_password_reset/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/confirm_password_reset/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_user_invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_user_valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_organization_membership/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_user/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/delete_user/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_organization_membership.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_user.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_after.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_before.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_limit.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_invitations/with_organization_id.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_organization_memberships/no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_organization_memberships/with_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_users/no_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/list_users/with_options.yml
+- spec/support/fixtures/vcr_cassettes/user_management/reset_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/reset_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/revoke_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/revoke_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_invitation/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_invitation/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_magic_auth_code/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_password_reset_email/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_password_reset_email/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user_password/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user_password/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/invalid_code.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/invalid_magic_auth_challenge.yml
+- spec/support/fixtures/vcr_cassettes/user_management/verify_email/valid.yml
 - spec/support/profile.txt
 - spec/support/shared_examples/client_spec.rb
 - spec/support/webhook_payload.txt

data/bin/docs

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-bundle exec yard -o docs
-rm docs/index.html
-mv docs/_index.html docs/index.html

data/docs/WorkOS/APIError.html

@@ -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::APIError
-  
-    &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::APIError";
-  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">APIError</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::APIError
-  
-  
-  
-</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::APIError</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>APIError is a generic error that may be raised in cases where none of the other named errors cover the problem. It could also be raised in the case that a new error has been introduced in the API, but this version of the Ruby SDK doesn&#39;t know how to handle it.</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>