workos 0.9.2 → 0.11.0

data/docs/file.README.html

@@ -5,9 +5,9 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
   File: README
-  
+
     &mdash; Documentation by YARD 0.9.22
-  
+
 </title>
 
   <link rel="stylesheet" href="css/style.css" type="text/css" />
@@ -35,14 +35,14 @@
     <div id="main" tabindex="-1">
       <div id="header">
         <div id="menu">
-  
-    <a href="_index.html">Index</a> &raquo; 
+
+    <a href="_index.html">Index</a> &raquo;
     <span class="title">File: README</span>
-  
+
 </div>
 
         <div id="search">
-  
+
     <a class="full_list_link" id="class_list_link"
         href="class_list.html">
 
@@ -52,7 +52,7 @@
           <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
         </svg>
     </a>
-  
+
 </div>
         <div class="clear"></div>
       </div>
@@ -139,7 +139,7 @@
 
 <p>See our Ruby SSO example app for a <a href="https://github.com/workos-inc/ruby-sso-example">complete example</a>.</p>
 
-<pre class="code ruby"><code class="ruby">WorkOS::SSO.authorization_url(domain:, project_id:, redirect_uri:, state: {})
+<pre class="code ruby"><code class="ruby">WorkOS::SSO.authorization_url(domain:, client_id:, redirect_uri:, state: {})
 </code></pre>
 
 <blockquote>
@@ -150,27 +150,27 @@
 <ul><li>
 <p><code>domain</code> (string) — the authenticating user&#39;s company domain, without protocol (ex. <code>example.com</code>)</p>
 </li><li>
-<p><code>project_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Project ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
+<p><code>client_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Client ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
 </li><li>
 <p><code>state</code> (optional, hash) — an optional hash used to manage state across authorization transactions (ex. <code>{ next_page: &#39;/docs&#39;}</code>)</p>
 </li><li>
-<p><code>redirect_uri</code> (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. <code>workos.dev/callback</code>). This must match one of your configured callback URLs for the associated project on your WorkOS dashboard.</p>
+<p><code>redirect_uri</code> (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. <code>workos.dev/callback</code>). This must match one of your configured callback URLs for the associated environment on your WorkOS dashboard.</p>
 </li></ul>
 
 <p>This method will return an OAuth2 query string of the form:</p>
 
-<p><code>https://${domain}/sso/authorize?response_type=code&client_id=${projectID}&redirect_uri=${redirectURI}&state=${state}</code></p>
+<p><code>https://${domain}/sso/authorize?response_type=code&client_id=${clientID}&redirect_uri=${redirectURI}&state=${state}</code></p>
 
 <p>For example, when used in a <a href="http://sinatrarb.com/">Sinatra app</a>:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='const'>DOMAIN</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>example.com</span><span class='tstring_end'>&#39;</span></span>
-<span class='const'>PROJECT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{projectId}</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>CLIENT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{clientId}</span><span class='tstring_end'>&#39;</span></span>
 <span class='const'>REDIRECT_URI</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://localhost:4567/callback</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/auth</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
   <span class='id identifier rubyid_authorization_url'>authorization_url</span> <span class='op'>=</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/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_authorization_url'><span class='object_link'><a href="WorkOS/SSO.html#authorization_url-class_method" title="WorkOS::SSO.authorization_url (method)">authorization_url</a></span></span><span class='lparen'>(</span>
     <span class='label'>domain:</span> <span class='const'>DOMAIN</span><span class='comma'>,</span>
-    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+    <span class='label'>client_id:</span> <span class='const'>CLIENT_ID</span><span class='comma'>,</span>
     <span class='label'>redirect_uri:</span> <span class='const'>REDIRECT_URI</span><span class='comma'>,</span>
   <span class='rparen'>)</span>
 
@@ -180,11 +180,11 @@
 
 <p>The user would be redirected to:</p>
 
-<p><code>https://api.workos.com/sso/authorize?response_type=code&client_id={projectID}&redirect_uri=http://localhost:4567/callback</code></p>
+<p><code>https://api.workos.com/sso/authorize?response_type=code&client_id={clientID}&redirect_uri=http://localhost:4567/callback</code></p>
 
 <p>WorkOS takes over from here, sending the user to authenticate with their IDP, and on successful login, returns the user to your callback URL with a <code>code</code> parameter. You&#39;ll use <code>WorkOS::SSO.profile</code> to exchange the code for a <code>WorkOS::Profile</code>.</p>
 
-<pre class="code ruby"><code class="ruby">WorkOS::SSO.profile(code:, project_id:)&lt;/h4&gt;
+<pre class="code ruby"><code class="ruby">WorkOS::SSO.profile(code:, client_id:)&lt;/h4&gt;
 </code></pre>
 
 <blockquote>
@@ -195,7 +195,7 @@
 <ul><li>
 <p><code>code</code> (string) — an opaque string provided by the authorization server; will be exchanged for an Access Token when the user&#39;s profile is sent</p>
 </li><li>
-<p><code>project_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Project ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
+<p><code>client_id</code> (string) — your application&#39;s WorkOS <a href="https://dashboard.workos.com/sso/configuration">Client ID</a> (ex. <code>project_01JG3BCPTRTSTTWQR4VSHXGWCQ</code>)</p>
 </li></ul>
 
 <p>This method will return an instance of a <code>WorkOS::Profile</code> with the following attributes:</p>
@@ -213,13 +213,13 @@
 <p>Our Sintatra app can be extended to use this method:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='const'>DOMAIN</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>example.com</span><span class='tstring_end'>&#39;</span></span>
-<span class='const'>PROJECT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{projectId}</span><span class='tstring_end'>&#39;</span></span>
+<span class='const'>CLIENT_ID</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{clientId}</span><span class='tstring_end'>&#39;</span></span>
 <span class='const'>REDIRECT_URI</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://localhost:4567/callback</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/auth</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
   <span class='id identifier rubyid_authorization_url'>authorization_url</span> <span class='op'>=</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/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_authorization_url'><span class='object_link'><a href="WorkOS/SSO.html#authorization_url-class_method" title="WorkOS::SSO.authorization_url (method)">authorization_url</a></span></span><span class='lparen'>(</span>
     <span class='label'>domain:</span> <span class='const'>DOMAIN</span><span class='comma'>,</span>
-    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+    <span class='label'>client_id:</span> <span class='const'>CLIENT_ID</span><span class='comma'>,</span>
     <span class='label'>redirect_uri:</span> <span class='const'>REDIRECT_URI</span><span class='comma'>,</span>
   <span class='rparen'>)</span>
 
@@ -229,7 +229,7 @@
 <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/callback</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
   <span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</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/SSO.html" title="WorkOS::SSO (module)">SSO</a></span></span><span class='period'>.</span><span class='id identifier rubyid_profile'><span class='object_link'><a href="WorkOS/SSO.html#profile-class_method" title="WorkOS::SSO.profile (method)">profile</a></span></span><span class='lparen'>(</span>
     <span class='label'>code:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-    <span class='label'>project_id:</span> <span class='const'>PROJECT_ID</span><span class='comma'>,</span>
+    <span class='label'>client_id:</span> <span class='const'>CLIENT_ID</span><span class='comma'>,</span>
   <span class='rparen'>)</span>
 
   <span class='id identifier rubyid_session'>session</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
@@ -249,4 +249,4 @@
 
     </div>
   </body>
-</html>
+</html>

data/lib/workos.rb

@@ -32,11 +32,14 @@ module WorkOS
   autoload :AuditTrail, 'workos/audit_trail'
   autoload :Connection, 'workos/connection'
   autoload :DirectorySync, 'workos/directory_sync'
+  autoload :Directory, 'workos/directory'
+  autoload :DirectoryGroup, 'workos/directory_group'
   autoload :Organization, 'workos/organization'
   autoload :Passwordless, 'workos/passwordless'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
   autoload :SSO, 'workos/sso'
+  autoload :DirectoryUser, 'workos/directory_user'
 
   # Errors
   autoload :APIError, 'workos/errors'

data/lib/workos/client.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: true
+# typed: false
 
 module WorkOS
   # A Net::HTTP based API client for interacting with the WorkOS API
@@ -19,7 +19,7 @@ module WorkOS
 
     sig do
       params(
-        request: T.any(Net::HTTP::Get, Net::HTTP::Post),
+        request: T.any(Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Delete),
       ).returns(::T.untyped)
     end
     def execute_request(request:)
@@ -69,6 +69,27 @@ module WorkOS
       request
     end
 
+    sig do
+      params(
+        path: String,
+        auth: T.nilable(T::Boolean),
+        params: T.nilable(Hash),
+      ).returns(Net::HTTP::Delete)
+    end
+    def delete_request(path:, auth: false, params: {})
+      uri = URI(path)
+      uri.query = URI.encode_www_form(params) if params
+
+      request = Net::HTTP::Delete.new(
+        uri.to_s,
+        'Content-Type' => 'application/json',
+      )
+
+      request['Authorization'] = "Bearer #{WorkOS.key!}" if auth
+      request['User-Agent'] = user_agent
+      request
+    end
+
     sig { returns(String) }
     def user_agent
       engine = defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : 'Ruby'
@@ -81,7 +102,7 @@ module WorkOS
       ].join('; ')
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     sig { params(response: ::T.untyped).void }
     def handle_error_response(response:)
       http_status = response.code.to_i
@@ -118,7 +139,7 @@ module WorkOS
         )
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 

data/lib/workos/connection.rb

@@ -8,7 +8,8 @@ module WorkOS
   class Connection
     extend T::Sig
 
-    attr_accessor :id, :name, :connection_type, :domains
+    attr_accessor :id, :name, :connection_type, :domains, :organization_id,
+                  :status
 
     sig { params(json: String).void }
     def initialize(json)
@@ -18,6 +19,8 @@ module WorkOS
       @name = T.let(raw.name, String)
       @connection_type = T.let(raw.connection_type, String)
       @domains = T.let(raw.domains, Array)
+      @organization_id = T.let(raw.organization_id, String)
+      @status = T.let(raw.status, String)
     end
 
     def to_json(*)
@@ -26,6 +29,8 @@ module WorkOS
         name: name,
         connection_type: connection_type,
         domains: domains,
+        organization_id: organization_id,
+        status: status,
       }
     end
 
@@ -40,6 +45,8 @@ module WorkOS
         name: hash[:name],
         connection_type: hash[:connection_type],
         domains: hash[:domains],
+        organization_id: hash[:organization_id],
+        status: hash[:status],
       )
     end
   end

data/lib/workos/directory.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The Directory class provides a lightweight wrapper around
+  # a WorkOS Directory resource. This class is not meant to be instantiated
+  # in user space, and is instantiated internally but exposed.
+  class Directory
+    extend T::Sig
+
+    attr_accessor :id, :domain, :name, :type, :state
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @name = T.let(raw.name, String)
+      @domain = T.let(raw.domain, String)
+      @type = T.let(raw.type, String)
+      @state = T.let(raw.state, String)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+        domain: domain,
+        type: type,
+        state: state,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOS::Types::DirectoryStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::DirectoryStruct.new(
+        id: hash[:id],
+        name: hash[:name],
+        domain: hash[:domain],
+        type: hash[:type],
+        state: hash[:state],
+      )
+    end
+  end
+end

data/lib/workos/directory_group.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The DirectoryGroup class provides a lightweight wrapper around
+  # a WorkOS DirectoryGroup resource. This class is not meant to be instantiated
+  # in user space, and is instantiated internally but exposed.
+  class DirectoryGroup
+    extend T::Sig
+
+    attr_accessor :id, :name
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @name = T.let(raw.name, String)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOS::Types::DirectoryGroupStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::DirectoryGroupStruct.new(
+        id: hash[:id],
+        name: hash[:name],
+      )
+    end
+  end
+end

data/lib/workos/directory_sync.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: true
+# typed: strict
 
 require 'net/http'
 
@@ -21,12 +21,17 @@ module WorkOS
       # @option options [String] domain The domain of the directory to be
       #  retrieved.
       # @option options [String] search A search term for direcory names.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_directories(options = {})
         response = execute_request(
@@ -37,7 +42,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        directories = parsed_response['data'].map do |directory|
+          ::WorkOS::Directory.new(directory.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: directories,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve directory groups.
@@ -47,12 +60,17 @@ module WorkOS
       #  directory groups will be retrieved.
       # @option options [String] user The ID of the directory user whose
       #  directory groups will be retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory Group ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory Group ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_groups(options = {})
         response = execute_request(
@@ -63,7 +81,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        groups = parsed_response['data'].map do |group|
+          ::WorkOS::DirectoryGroup.new(group.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: groups,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve directory users.
@@ -73,12 +99,17 @@ module WorkOS
       #  directory users will be retrieved.
       # @option options [String] user The ID of the directory group whose
       #  directory users will be retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory User ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory User ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.untyped]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_users(options = {})
         response = execute_request(
@@ -89,7 +120,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        users = parsed_response['data'].map do |user|
+          ::WorkOS::DirectoryUser.new(user.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: users,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve the directory group with the given ID.
@@ -125,6 +164,23 @@ module WorkOS
 
         JSON.parse(response.body)
       end
+
+      # Delete the directory with the given ID.
+      #
+      # @param [String] id The ID of the directory.
+      #
+      # @return Boolean
+      sig { params(id: String).returns(T::Boolean) }
+      def delete_directory(id)
+        request = delete_request(
+          auth: true,
+          path: "/directories/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        response.is_a? Net::HTTPSuccess
+      end
     end
   end
 end