workos 4.0.0 → 4.2.0

data/lib/workos/organization.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Organization class provides a lightweight wrapper around
@@ -7,20 +6,18 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   class Organization
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :domains, :name, :allow_profiles_outside_organization, :created_at, :updated_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @id = T.let(raw.id, String)
-      @name = T.let(raw.name, String)
-      @allow_profiles_outside_organization = T.let(raw.allow_profiles_outside_organization, T::Boolean)
-      @domains = T.let(raw.domains, Array)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @name = hash[:name]
+      @allow_profiles_outside_organization = hash[:allow_profiles_outside_organization]
+      @domains = hash[:domains]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
 
     def to_json(*)
@@ -33,25 +30,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig do
-      params(
-        json_string: String,
-      ).returns(WorkOS::Types::OrganizationStruct)
-    end
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::OrganizationStruct.new(
-        id: hash[:id],
-        name: hash[:name],
-        allow_profiles_outside_organization: hash[:allow_profiles_outside_organization],
-        domains: hash[:domains],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/organization_membership.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The OrganizationMembership class provides a lightweight wrapper around a WorkOS OrganizationMembership
@@ -7,20 +6,18 @@ module WorkOS
   # and is instantiated internally but exposed.
   class OrganizationMembership
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :user_id, :organization_id, :status, :created_at, :updated_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @id = T.let(raw.id, String)
-      @user_id = T.let(raw.user_id, String)
-      @organization_id = raw.organization_id
-      @status = T.let(raw.status, String)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @user_id = hash[:user_id]
+      @organization_id = hash[:organization_id]
+      @status = hash[:status]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
 
     def to_json(*)
@@ -33,21 +30,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::OrganizationMembershipStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::OrganizationMembershipStruct.new(
-        id: hash[:id],
-        user_id: hash[:user_id],
-        organization_id: hash[:organization_id],
-        status: hash[:status],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/organizations.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'net/http'
 
@@ -7,7 +6,6 @@ module WorkOS
   # The Organizations module provides resource methods for working with Organizations
   module Organizations
     class << self
-      extend T::Sig
       include Client
 
       # Retrieve a list of organizations that have connections configured
@@ -22,11 +20,6 @@ module WorkOS
       # @param [Integer] limit A pagination argument used to limit the number
       # @param [String] order The order in which to paginate records
       #  of listed Organizations that are returned.
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_organizations(options = {})
         options[:order] ||= 'desc'
         response = execute_request(
@@ -64,7 +57,6 @@ module WorkOS
       #            :domain=>"foo-corp.com"}]>
       #
       # @return [WorkOS::Organization]
-      sig { params(id: String).returns(WorkOS::Organization) }
       def get_organization(id:)
         request = get_request(
           auth: true,
@@ -84,14 +76,6 @@ module WorkOS
       # @param [Boolean, nil] allow_profiles_outside_organization Whether Connections
       #  within the Organization allow profiles that are outside of the Organization's configured User Email Domains.
       # @param [String] idempotency_key An idempotency key
-      sig do
-        params(
-          domains: T::Array[String],
-          name: String,
-          allow_profiles_outside_organization: T.nilable(T::Boolean),
-          idempotency_key: T.nilable(String),
-        ).returns(WorkOS::Organization)
-      end
       def create_organization(domains:, name:, allow_profiles_outside_organization: nil, idempotency_key: nil)
         request = post_request(
           auth: true,
@@ -118,14 +102,6 @@ module WorkOS
       # @param [String] name A unique, descriptive name for the organization
       # @param [Boolean, nil] allow_profiles_outside_organization Whether Connections
       #  within the Organization allow profiles that are outside of the Organization's configured User Email Domains.
-      sig do
-        params(
-          organization: String,
-          domains: T::Array[String],
-          name: String,
-          allow_profiles_outside_organization: T.nilable(T::Boolean),
-        ).returns(WorkOS::Organization)
-      end
       def update_organization(organization:, domains:, name:, allow_profiles_outside_organization: nil)
         request = put_request(
           auth: true,
@@ -152,7 +128,6 @@ module WorkOS
       #   => true
       #
       # @return [Bool] - returns `true` if successful
-      sig { params(id: String).returns(T::Boolean) }
       def delete_organization(id:)
         request = delete_request(
           auth: true,
@@ -166,7 +141,6 @@ module WorkOS
 
       private
 
-      sig { params(response: Net::HTTPResponse).void }
       def check_and_raise_organization_error(response:)
         begin
           body = JSON.parse(response.body)

data/lib/workos/passwordless.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'net/http'
 
@@ -11,7 +10,6 @@ module WorkOS
   # @see https://workos.com/docs/sso/configuring-magic-link
   module Passwordless
     class << self
-      extend T::Sig
       include Client
 
       # Create a Passwordless Session.
@@ -33,12 +31,6 @@ module WorkOS
       #  configured redirect URI on your WorkOS dashboard.
       #
       # @return Hash
-      sig do
-        params(
-          options: Hash,
-        ).returns(WorkOS::Types::PasswordlessSessionStruct)
-      end
-
       def create_session(options)
         response = execute_request(
           request: post_request(
@@ -64,12 +56,6 @@ module WorkOS
       #  Session to send an email for.
       #
       # @return Hash
-      sig do
-        params(
-          session_id: String,
-        ).returns(T::Hash[String, T::Boolean])
-      end
-
       def send_session(session_id)
         response = execute_request(
           request: post_request(

data/lib/workos/portal.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'net/http'
 
@@ -8,11 +7,9 @@ module WorkOS
   # Portal product
   module Portal
     class << self
-      extend T::Sig
       include Client
 
-      GENERATE_LINK_INTENTS = WorkOS::Types::Intent.values.map(&:serialize).
-                              freeze
+      GENERATE_LINK_INTENTS = WorkOS::Types::Intent::ALL
 
       # Generate a link to grant access to an organization's Admin Portal
       #
@@ -25,14 +22,6 @@ module WorkOS
       #  redirect link set in your WorkOS Dashboard will be used.
       # @param [String] The URL to which WorkOS will redirect users to upon
       #  successfully setting up Single Sign On or Directory Sync.
-      sig do
-        params(
-          intent: String,
-          organization: String,
-          return_url: T.nilable(String),
-          success_url: T.nilable(String),
-        ).returns(String)
-      end
       def generate_link(intent:, organization:, return_url: nil, success_url: nil)
         validate_intent(intent)
 
@@ -54,7 +43,6 @@ module WorkOS
 
       private
 
-      sig { params(intent: String).void }
       def validate_intent(intent)
         return if GENERATE_LINK_INTENTS.include?(intent)
 

data/lib/workos/profile.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Profile class provides a lighweight wrapper around
@@ -9,31 +8,25 @@ module WorkOS
   # is instantiated internally but exposed.
   class Profile
     include HashProvider
-    extend T::Sig
 
-    sig { returns(String) }
     attr_accessor :id, :email, :first_name, :last_name, :groups, :organization_id,
                   :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)
-
-      @id = T.let(raw.id, String)
-      @email = T.let(raw.email, String)
-      @first_name = raw.first_name
-      @last_name = raw.last_name
-      @groups = raw.groups
-      @organization_id = raw.organization_id
-      @connection_id = T.let(raw.connection_id, String)
-      @connection_type = T.let(raw.connection_type, String)
-      @idp_id = raw.idp_id
-      @raw_attributes = raw.raw_attributes
+      hash = JSON.parse(profile_json, symbolize_names: true)
+
+      @id = hash[:id]
+      @email = hash[:email]
+      @first_name = hash[:first_name]
+      @last_name = hash[:last_name]
+      @groups = hash[:groups]
+      @organization_id = hash[:organization_id]
+      @connection_id = hash[:connection_id]
+      @connection_type = hash[:connection_type]
+      @idp_id = hash[:idp_id]
+      @raw_attributes = hash[:raw_attributes]
     end
-    # rubocop:enable Metrics/AbcSize
 
-    sig { returns(String) }
     def full_name
       [first_name, last_name].compact.join(' ')
     end
@@ -52,25 +45,5 @@ module WorkOS
         raw_attributes: raw_attributes,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::ProfileStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::ProfileStruct.new(
-        id: hash[:id],
-        email: hash[:email],
-        first_name: hash[:first_name],
-        last_name: hash[:last_name],
-        groups: hash[:groups],
-        organization_id: hash[:organization_id],
-        connection_id: hash[:connection_id],
-        connection_type: hash[:connection_type],
-        idp_id: hash[:idp_id],
-        raw_attributes: hash[:raw_attributes],
-      )
-    end
   end
 end

data/lib/workos/profile_and_token.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The ProfileAndToken class represents a Profile and a corresponding
@@ -7,15 +6,13 @@ module WorkOS
   # is instantiated internally but exposed.
   class ProfileAndToken
     include HashProvider
-    extend T::Sig
 
     attr_accessor :access_token, :profile
 
-    sig { params(profile_and_token_json: String).void }
     def initialize(profile_and_token_json)
       json = JSON.parse(profile_and_token_json, symbolize_names: true)
 
-      @access_token = T.let(json[:access_token], String)
+      @access_token = json[:access_token]
       @profile = WorkOS::Profile.new(json[:profile].to_json)
     end
 

data/lib/workos/refresh_authentication_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WorkOS
+  # The RefreshAuthenticationResponse contains response data from a successful
+  # `UserManagement.authenticate_with_refresh_token` call
+  class RefreshAuthenticationResponse
+    include HashProvider
+
+    attr_accessor :access_token, :refresh_token
+
+    def initialize(authentication_response_json)
+      json = JSON.parse(authentication_response_json, symbolize_names: true)
+      @access_token = json[:access_token]
+      @refresh_token = json[:refresh_token]
+    end
+
+    def to_json(*)
+      {
+        access_token: access_token,
+        refresh_token: refresh_token,
+      }
+    end
+  end
+end

data/lib/workos/sso.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'net/http'
 require 'uri'
@@ -12,10 +11,9 @@ module WorkOS
   # @see https://docs.workos.com/sso/overview
   module SSO
     class << self
-      extend T::Sig
       include Client
 
-      PROVIDERS = WorkOS::Types::Provider.values.map(&:serialize).freeze
+      PROVIDERS = WorkOS::Types::Provider::ALL
 
       # Generate an Oauth2 authorization URL where your users will
       # authenticate using the configured SSO Identity Provider.
@@ -55,19 +53,6 @@ module WorkOS
       #
       # @return [String]
       # rubocop:disable Metrics/ParameterLists
-      sig do
-        params(
-          redirect_uri: String,
-          client_id: T.nilable(String),
-          domain: T.nilable(String),
-          domain_hint: T.nilable(String),
-          login_hint: T.nilable(String),
-          provider: T.nilable(String),
-          connection: T.nilable(String),
-          organization: T.nilable(String),
-          state: T.nilable(String),
-        ).returns(String)
-      end
       def authorization_url(
         redirect_uri:,
         client_id: nil,
@@ -108,11 +93,6 @@ module WorkOS
       end
       # rubocop:enable Metrics/ParameterLists
 
-      sig do
-        params(
-          access_token: String,
-        ).returns(WorkOS::Profile)
-      end
       def get_profile(access_token:)
         response = execute_request(
           request: get_request(
@@ -132,12 +112,6 @@ module WorkOS
       #  where you've configured your SSO connection
       #
       # @return [WorkOS::ProfileAndToken]
-      sig do
-        params(
-          code: String,
-          client_id: T.nilable(String),
-        ).returns(WorkOS::ProfileAndToken)
-      end
       def profile_and_token(code:, client_id: nil)
         body = {
           client_id: client_id,
@@ -169,11 +143,6 @@ module WorkOS
       #  before a provided Connection ID.
       #
       # @return [Hash]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_connections(options = {})
         options[:order] ||= 'desc'
         response = execute_request(
@@ -211,7 +180,6 @@ module WorkOS
       #            :domain=>"example.com"}]>
       #
       # @return [WorkOS::Connection]
-      sig { params(id: String).returns(WorkOS::Connection) }
       def get_connection(id:)
         request = get_request(
           auth: true,
@@ -232,7 +200,6 @@ module WorkOS
       #   => true
       #
       # @return [Bool] - returns `true` if successful
-      sig { params(id: String).returns(T::Boolean) }
       def delete_connection(id:)
         request = delete_request(
           auth: true,
@@ -246,14 +213,6 @@ module WorkOS
 
       private
 
-      sig do
-        params(
-          domain: T.nilable(String),
-          provider: T.nilable(String),
-          connection: T.nilable(String),
-          organization: T.nilable(String),
-        ).void
-      end
       def validate_authorization_url_arguments(
         domain:,
         provider:,
@@ -271,7 +230,6 @@ module WorkOS
           " `provider` must be in #{PROVIDERS}"
       end
 
-      sig { params(response: Net::HTTPResponse).void }
       def check_and_raise_profile_and_token_error(response:)
         begin
           body = JSON.parse(response.body)

data/lib/workos/types/intent.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WorkOS
+  module Types
+    # The Intent constants are declarations of a fixed set of values for
+    # intents while generating an Admin Portal link.
+    module Intent
+      AUDIT_LOGS = 'audit_logs'
+      DSYNC = 'dsync'
+      LOG_STREAMS = 'log_streams'
+      SSO = 'sso'
+
+      ALL = [AUDIT_LOGS, DSYNC, LOG_STREAMS, SSO].freeze
+    end
+  end
+end

data/lib/workos/types/list_struct.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
-# typed: strict
 
 module WorkOS
   module Types
-    # ListStruct acts as a typed interface to expose lists of data and related
+    # ListStruct acts as an interface to expose lists of data and related
     # metadata
-    class ListStruct < T::Struct
-      const :data, T::Array[T.untyped]
-      const :list_metadata, T::Hash[String, T.nilable(String)]
+    class ListStruct
+      attr_accessor :data, :list_metadata
+
+      def initialize(data:, list_metadata:)
+        @data = data
+        @list_metadata = list_metadata
+      end
     end
   end
 end

data/lib/workos/types/passwordless_session_struct.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
-# typed: strict
-
-require 'date'
 
 module WorkOS
   module Types
-    # This PasswordlessSessionStruct acts as a typed interface
+    # This PasswordlessSessionStruct acts as an interface
     # for the Passwordless class
-    class PasswordlessSessionStruct < T::Struct
-      const :id, String
-      const :email, String
-      const :expires_at, Date
-      const :link, String
+    class PasswordlessSessionStruct
+      attr_accessor :id, :email, :expires_at, :link
+
+      def initialize(id:, email:, expires_at:, link:)
+        @id = id
+        @email = email
+        @expires_at = expires_at
+        @link = link
+      end
     end
   end
 end

data/lib/workos/types/provider.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WorkOS
+  module Types
+    # The Provider constants are declarations of a
+    # fixed set of values for SSO Providers.
+    module Provider
+      GitHub = 'GitHubOAuth'
+      Google = 'GoogleOAuth'
+      Microsoft = 'MicrosoftOAuth'
+
+      ALL = [GitHub, Google, Microsoft].freeze
+    end
+  end
+end

data/lib/workos/types.rb

@@ -1,29 +1,11 @@
 # frozen_string_literal: true
-# typed: strong
 
 module WorkOS
-  # WorkOS believes strongly in typed languages,
-  # so we're using Sorbet throughout this Ruby gem.
+  # Types contains a few structs wrapping up common data structures.
   module Types
-    require_relative 'types/audit_log_export_struct'
-    require_relative 'types/challenge_struct'
-    require_relative 'types/connection_struct'
-    require_relative 'types/directory_group_struct'
-    require_relative 'types/directory_struct'
-    require_relative 'types/directory_user_struct'
-    require_relative 'types/event_struct'
-    require_relative 'types/factor_struct'
-    require_relative 'types/intent_enum'
-    require_relative 'types/invitation_struct'
-    require_relative 'types/list_struct'
-    require_relative 'types/magic_auth_challenge_struct'
-    require_relative 'types/organization_struct'
-    require_relative 'types/organization_membership_struct'
-    require_relative 'types/passwordless_session_struct'
-    require_relative 'types/profile_struct'
-    require_relative 'types/provider_enum'
-    require_relative 'types/user_struct'
-    require_relative 'types/verify_challenge_struct'
-    require_relative 'types/webhook_struct'
+    autoload :Provider, 'workos/types/provider'
+    autoload :Intent, 'workos/types/intent'
+    autoload :ListStruct, 'workos/types/list_struct'
+    autoload :PasswordlessSessionStruct, 'workos/types/passwordless_session_struct'
   end
 end