workos 0.9.2 → 0.11.0

data/lib/workos/directory_user.rb

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

data/lib/workos/passwordless.rb

@@ -36,7 +36,6 @@ module WorkOS
         ).returns(WorkOS::Types::PasswordlessSessionStruct)
       end
 
-      # rubocop:disable Metrics/MethodLength
       def create_session(options)
         response = execute_request(
           request: post_request(
@@ -55,7 +54,6 @@ module WorkOS
           link: hash['link'],
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Send a Passwordless Session via email.
       #

data/lib/workos/portal.rb

@@ -42,7 +42,7 @@ module WorkOS
       # Generate a link to grant access to an organization's Admin Portal
       #
       # @param [String] intent The access scope for the generated Admin Portal
-      #  link. Valid values are: ["sso"]
+      #  link. Valid values are: ["sso", "dsync"]
       # @param [String] organization The ID of the organization the Admin
       #  Portal link will be generated for.
       # @param [String] The URL that the end user will be redirected to upon
@@ -55,7 +55,6 @@ module WorkOS
           return_url: T.nilable(String),
         ).returns(String)
       end
-      # rubocop:disable Metrics/MethodLength
       def generate_link(intent:, organization:, return_url: nil)
         validate_intent(intent)
 
@@ -73,7 +72,6 @@ module WorkOS
 
         JSON.parse(response.body)['link']
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Retrieve a list of organizations that have connections configured
       # within your WorkOS dashboard.
@@ -91,7 +89,6 @@ module WorkOS
           options: T::Hash[Symbol, String],
         ).returns(WorkOS::Types::ListStruct)
       end
-      # rubocop:disable Metrics/MethodLength
       def list_organizations(options = {})
         response = execute_request(
           request: get_request(
@@ -112,12 +109,10 @@ module WorkOS
           list_metadata: parsed_response['listMetadata'],
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 
       sig { params(response: Net::HTTPResponse).void }
-      # rubocop:disable Metrics/MethodLength
       def check_and_raise_organization_error(response:)
         begin
           body = JSON.parse(response.body)
@@ -135,7 +130,6 @@ module WorkOS
           request_id: request_id,
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       sig { params(intent: String).void }
       def validate_intent(intent)

data/lib/workos/profile.rb

@@ -13,7 +13,7 @@ module WorkOS
     sig { returns(String) }
     attr_accessor :id, :email, :first_name, :last_name, :connection_id,
                   :connection_type, :idp_id, :raw_attributes
-    # rubocop:disable Metrics/AbcSize
+
     sig { params(profile_json: String).void }
     def initialize(profile_json)
       raw = parse_json(profile_json)
@@ -27,7 +27,6 @@ module WorkOS
       @idp_id = raw.idp_id
       @raw_attributes = raw.raw_attributes
     end
-    # rubocop:enable Metrics/AbcSize
 
     sig { returns(String) }
     def full_name
@@ -49,7 +48,7 @@ module WorkOS
 
     private
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     sig { params(json_string: String).returns(WorkOS::Types::ProfileStruct) }
     def parse_json(json_string)
       hash = JSON.parse(json_string, symbolize_names: true)
@@ -65,6 +64,6 @@ module WorkOS
         raw_attributes: hash[:profile][:raw_attributes],
       )
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/sso.rb

@@ -6,7 +6,7 @@ require 'uri'
 
 module WorkOS
   # The SSO module provides convenience methods for working with the WorkOS
-  # SSO platform. You'll need a valid API key, a project ID, and to have
+  # SSO platform. You'll need a valid API key, a client ID, and to have
   # created an SSO connection on your WorkOS dashboard.
   #
   # @see https://docs.workos.com/sso/overview
@@ -26,8 +26,12 @@ module WorkOS
       #  required
       # @param [String] provider A provider name for an Identity Provider
       #  configured on your WorkOS dashboard. Only 'Google' is supported.
-      # @param [String] project_id The WorkOS project ID for the project
+      # @param [String] connection The ID for a Connection configured on
+      #  WorkOS.
+      # @param [String] client_id The WorkOS client ID for the environment
       #  where you've configured your SSO connection.
+      # @param [String] project_id The WorkOS project ID for the project.
+      # The project_id is deprecated in Dashboard2.
       # @param [String] redirect_uri The URI where users are directed
       #  after completing the authentication step. Must match a
       #  configured redirect URI on your WorkOS dashboard.
@@ -36,7 +40,7 @@ module WorkOS
       # @example
       #   WorkOS::SSO.authorization_url(
       #     domain: 'acme.com',
-      #     project_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ',
+      #     client_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ',
       #     redirect_uri: 'https://workos.com/callback',
       #     state: {
       #       next_page: '/docs'
@@ -51,40 +55,63 @@ module WorkOS
       # @return [String]
       sig do
         params(
-          project_id: String,
           redirect_uri: String,
+          project_id: T.nilable(String),
+          client_id: T.nilable(String),
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
           state: T.nilable(String),
         ).returns(String)
       end
+      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
       def authorization_url(
-        project_id:, redirect_uri:, domain: nil, provider: nil, state: ''
+        redirect_uri:,
+        project_id: nil,
+        client_id: nil,
+        domain: nil,
+        provider: nil,
+        connection: nil,
+        state: ''
       )
-        validate_domain_and_provider(provider: provider, domain: domain)
+        if project_id
+          warn '[DEPRECATION] `project_id` is deprecated.
+          Please use `client_id` instead.'
+          client_id = project_id
+        end
+
+        validate_authorization_url_arguments(
+          provider: provider,
+          domain: domain,
+          connection: connection,
+        )
 
         query = URI.encode_www_form({
-          client_id: project_id,
+          client_id: client_id,
           redirect_uri: redirect_uri,
           response_type: 'code',
           state: state,
           domain: domain,
           provider: provider,
+          connection: connection,
         }.compact)
 
         "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
       end
+      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
       # Fetch the profile details for the authenticated SSO user.
       #
       # @param [String] code The authorization code provided in the callback URL
-      # @param [String] project_id The WorkOS project ID for the project
+      # @param [String] client_id The WorkOS client ID for the environment
       #  where you've  configured your SSO connection
+      # @param [String] project_id The WorkOS project ID for the project.
+      # The project_id is deprecated in Dashboard2.
       #
       # @example
       #   WorkOS::SSO.profile(
       #     code: 'acme.com',
-      #     project_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ'
+      #     client_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ'
       #   )
       #   => #<WorkOS::Profile:0x00007fb6e4193d20
       #         @id="prof_01DRA1XNSJDZ19A31F183ECQW5",
@@ -97,10 +124,22 @@ module WorkOS
       #        >
       #
       # @return [WorkOS::Profile]
-      sig { params(code: String, project_id: String).returns(WorkOS::Profile) }
-      def profile(code:, project_id:)
+      sig do
+        params(
+          code: String,
+          project_id: T.nilable(String),
+          client_id: T.nilable(String),
+        ).returns(WorkOS::Profile)
+      end
+      def profile(code:, project_id: nil, client_id: nil)
+        if project_id
+          warn '[DEPRECATION] `project_id` is deprecated.
+          Please use `client_id` instead.'
+          client_id = project_id
+        end
+
         body = {
-          client_id: project_id,
+          client_id: client_id,
           client_secret: WorkOS.key!,
           grant_type: 'authorization_code',
           code: code,
@@ -168,17 +207,113 @@ module WorkOS
         WorkOS::Connection.new(response.body)
       end
 
+      # Retrieve connections.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] connection_type Authentication service
+      #  provider descriptor.
+      # @option options [String] domain The domain of the connection to be
+      #  retrieved.
+      # @option options [String] organization_id The id of the organization
+      #  of the connections to be retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Connection ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Connection ID.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOS::Types::ListStruct)
+      end
+      def list_connections(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/connections',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        connections = parsed_response['data'].map do |connection|
+          ::WorkOS::Connection.new(connection.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: connections,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+
+      # Get a Connection
+      #
+      # @param [String] id Connection unique identifier
+      #
+      # @example
+      #   WorkOS::SSO.get_connection(id: 'conn_02DRA1XNSJDZ19A31F183ECQW9')
+      #   => #<WorkOS::Connection:0x00007fb6e4193d20
+      #         @id="conn_02DRA1XNSJDZ19A31F183ECQW9",
+      #         @name="Foo Corp",
+      #         @connection_type="OktaSAML",
+      #         @domains=
+      #          [{:object=>"connection_domain",
+      #            :id=>"domain_01E6PK9N3XMD8RHWF7S66380AR",
+      #            :domain=>"example.com"}]>
+      #
+      # @return [WorkOS::Connection]
+      sig { params(id: String).returns(WorkOS::Connection) }
+      def get_connection(id:)
+        request = get_request(
+          auth: true,
+          path: "/connections/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        WorkOS::Connection.new(response.body)
+      end
+
+      # Delete a Connection
+      #
+      # @param [String] id Connection unique identifier
+      #
+      # @example
+      #   WorkOS::SSO.delete_connection(id: 'conn_02DRA1XNSJDZ19A31F183ECQW9')
+      #   => true
+      #
+      # @return [Bool] - returns `true` if successful
+      sig { params(id: String).returns(T::Boolean) }
+      def delete_connection(id:)
+        request = delete_request(
+          auth: true,
+          path: "/connections/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        response.is_a? Net::HTTPSuccess
+      end
+
       private
 
       sig do
         params(
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
         ).void
       end
-      def validate_domain_and_provider(domain:, provider:)
-        if [domain, provider].all?(&:nil?)
-          raise ArgumentError, 'Either domain or provider is required.'
+      def validate_authorization_url_arguments(
+        domain:,
+        provider:,
+        connection:
+      )
+        if [domain, provider, connection].all?(&:nil?)
+          raise ArgumentError, 'Either connection, domain, or ' \
+            'provider is required.'
         end
 
         return unless provider && !PROVIDERS.include?(provider)
@@ -187,7 +322,6 @@ module WorkOS
           " `provider` must be in #{PROVIDERS}"
       end
 
-      # rubocop:disable Metrics/MethodLength
       sig { params(response: Net::HTTPResponse).void }
       def check_and_raise_profile_error(response:)
         begin
@@ -206,7 +340,6 @@ module WorkOS
           request_id: request_id,
         )
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/workos/types.rb

@@ -6,11 +6,14 @@ module WorkOS
   # so we're using Sorbet throughout this Ruby gem.
   module Types
     require_relative 'types/connection_struct'
+    require_relative 'types/directory_struct'
+    require_relative 'types/directory_group_struct'
     require_relative 'types/intent_enum'
     require_relative 'types/list_struct'
     require_relative 'types/organization_struct'
     require_relative 'types/passwordless_session_struct'
     require_relative 'types/profile_struct'
     require_relative 'types/provider_enum'
+    require_relative 'types/directory_user_struct'
   end
 end

data/lib/workos/types/connection_struct.rb

@@ -10,6 +10,8 @@ module WorkOS
       const :name, String
       const :connection_type, String
       const :domains, T::Array[T.untyped]
+      const :organization_id, String
+      const :status, String
     end
   end
 end

data/lib/workos/types/directory_group_struct.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This DirectoryGroupStruct acts as a typed interface
+    # for the DirectoryGroup class
+    class DirectoryGroupStruct < T::Struct
+      const :id, String
+      const :name, String
+    end
+  end
+end