workos 4.0.0 → 4.2.0

data/lib/workos/directory.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Directory class provides a lightweight wrapper around
@@ -7,25 +6,21 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   class Directory
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :domain, :name, :type, :state, :organization_id, :created_at, :updated_at
 
-    # rubocop:disable Metrics/AbcSize
-    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 = raw.domain
-      @type = T.let(raw.type, String)
-      @state = T.let(raw.state, String)
-      @organization_id = raw.organization_id
-      @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]
+      @domain = hash[:domain]
+      @type = hash[:type]
+      @state = hash[:state]
+      @organization_id = hash[:organization_id]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
-    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
@@ -39,27 +34,5 @@ module WorkOS
         updated_at: updated_at,
       }
     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],
-        organization_id: hash[:organization_id],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/directory_group.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The DirectoryGroup class provides a lightweight wrapper around
@@ -7,28 +6,24 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   class DirectoryGroup < DeprecatedHashWrapper
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :directory_id, :idp_id, :name, :created_at, :updated_at,
                   :raw_attributes, :organization_id
 
-    # rubocop:disable Metrics/AbcSize
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
+      hash = JSON.parse(json, symbolize_names: true)
 
-      @id = T.let(raw.id, String)
-      @directory_id = T.let(raw.directory_id, String)
-      @organization_id = raw.organization_id
-      @idp_id = T.let(raw.idp_id, String)
-      @name = T.let(raw.name, String)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
-      @raw_attributes = raw.raw_attributes
+      @id = hash[:id]
+      @directory_id = hash[:directory_id]
+      @organization_id = hash[:organization_id]
+      @idp_id = hash[:idp_id]
+      @name = hash[:name]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @raw_attributes = hash[:raw_attributes]
 
       replace_without_warning(to_json)
     end
-    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
@@ -42,27 +37,5 @@ module WorkOS
         raw_attributes: raw_attributes,
       }
     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],
-        directory_id: hash[:directory_id],
-        organization_id: hash[:organization_id],
-        idp_id: hash[:idp_id],
-        name: hash[:name],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-        raw_attributes: hash[:raw_attributes],
-      )
-    end
   end
 end

data/lib/workos/directory_sync.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: strict
 
 require 'net/http'
 
@@ -11,7 +10,6 @@ module WorkOS
   # @see https://docs.workos.com/directory-sync/overview
   module DirectorySync
     class << self
-      extend T::Sig
       include Client
 
       # Retrieve directories.
@@ -29,11 +27,6 @@ module WorkOS
       # @option options [String] organization_id The ID for an Organization configured on WorkOS.
       #
       # @return [Hash]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_directories(options = {})
         options[:order] ||= 'desc'
         response = execute_request(
@@ -72,7 +65,6 @@ module WorkOS
       #         @updated_at="2021-10-27T16:03:43.990Z"
       #
       # @return [WorkOS::Directory]
-      sig { params(id: String).returns(WorkOS::Directory) }
       def get_directory(id:)
         request = get_request(
           auth: true,
@@ -99,11 +91,6 @@ module WorkOS
       #  before a provided Directory Group ID.
       #
       # @return [WorkOS::DirectoryGroup]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_groups(options = {})
         options[:order] ||= 'desc'
         response = execute_request(
@@ -140,11 +127,6 @@ module WorkOS
       #  before a provided Directory User ID.
       #
       # @return [WorkOS::DirectoryUser]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_users(options = {})
         options[:order] ||= 'desc'
         response = execute_request(
@@ -171,7 +153,6 @@ module WorkOS
       # @param [String] id The ID of the directory group.
       #
       # @return WorkOS::DirectoryGroup
-      sig { params(id: String).returns(WorkOS::DirectoryGroup) }
       def get_group(id)
         response = execute_request(
           request: get_request(
@@ -188,7 +169,6 @@ module WorkOS
       # @param [String] id The ID of the directory user.
       #
       # @return WorkOS::DirectoryUser
-      sig { params(id: String).returns(WorkOS::DirectoryUser) }
       def get_user(id)
         response = execute_request(
           request: get_request(
@@ -205,7 +185,6 @@ module WorkOS
       # @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,

data/lib/workos/directory_user.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The DirectoryUser class provides a lightweight wrapper around
@@ -7,32 +6,30 @@ module WorkOS
   # in DirectoryUser space, and is instantiated internally but exposed.
   class DirectoryUser < DeprecatedHashWrapper
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :idp_id, :emails, :first_name, :last_name, :job_title, :username, :state,
                   :groups, :custom_attributes, :raw_attributes, :directory_id, :organization_id,
                   :created_at, :updated_at
 
     # rubocop:disable Metrics/AbcSize
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @id = T.let(raw.id, String)
-      @directory_id = T.let(raw.directory_id, String)
-      @organization_id = raw.organization_id
-      @idp_id = T.let(raw.idp_id, String)
-      @emails = T.let(raw.emails, Array)
-      @first_name = raw.first_name
-      @last_name = raw.last_name
-      @job_title = raw.job_title
-      @username = raw.username
-      @state = raw.state
-      @groups = T.let(raw.groups, Array)
-      @custom_attributes = raw.custom_attributes
-      @raw_attributes = raw.raw_attributes
-      @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]
+      @directory_id = hash[:directory_id]
+      @organization_id = hash[:organization_id]
+      @idp_id = hash[:idp_id]
+      @emails = hash[:emails]
+      @first_name = hash[:first_name]
+      @last_name = hash[:last_name]
+      @job_title = hash[:job_title]
+      @username = hash[:username]
+      @state = hash[:state]
+      @groups = hash[:groups]
+      @custom_attributes = hash[:custom_attributes]
+      @raw_attributes = hash[:raw_attributes]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
 
       replace_without_warning(to_json)
     end
@@ -62,36 +59,5 @@ module WorkOS
       primary_email = (emails || []).find { |email| email[:primary] }
       return primary_email[:value] if primary_email
     end
-
-    private
-
-    # rubocop:disable Metrics/AbcSize
-    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],
-        directory_id: hash[:directory_id],
-        organization_id: hash[:organization_id],
-        idp_id: hash[:idp_id],
-        emails: hash[:emails],
-        first_name: hash[:first_name],
-        last_name: hash[:last_name],
-        job_title: hash[:job_title],
-        username: hash[:username],
-        state: hash[:state],
-        groups: hash[:groups],
-        custom_attributes: hash[:custom_attributes],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-        raw_attributes: hash[:raw_attributes],
-      )
-    end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/errors.rb

@@ -1,29 +1,14 @@
 # frozen_string_literal: true
-# typed: true
-
 
 module WorkOS
   # Parent class for WorkOS related errors
   class WorkOSError < StandardError
-    extend T::Sig
-
     attr_reader :http_status
     attr_reader :request_id
     attr_reader :code
     attr_reader :errors
 
     # rubocop:disable Metrics/ParameterLists
-    sig do
-      params(
-        message: T.nilable(String),
-        error: T.nilable(String),
-        error_description: T.nilable(String),
-        http_status: T.nilable(Integer),
-        request_id: T.nilable(String),
-        code: T.nilable(String),
-        errors: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]),
-      ).void
-    end
     def initialize(
       message: nil,
       error: nil,
@@ -43,7 +28,6 @@ module WorkOS
     end
     # rubocop:enable Metrics/ParameterLists
 
-    sig { returns(String) }
     def to_s
       status_string = @http_status.nil? ? '' : "Status #{@http_status}, "
       id_string = @request_id.nil? ? '' : " - request ID: #{@request_id}"

data/lib/workos/event.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Event class provides a lightweight wrapper around
@@ -7,18 +6,16 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   class Event
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :event, :data, :created_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
+      hash = JSON.parse(json, symbolize_names: true)
 
-      @id = T.let(raw.id, String)
-      @event = T.let(raw.event, String)
-      @created_at = T.let(raw.created_at, String)
-      @data = raw.data
+      @id = hash[:id]
+      @event = hash[:event]
+      @created_at = hash[:created_at]
+      @data = hash[:data]
     end
 
     def to_json(*)
@@ -29,23 +26,5 @@ module WorkOS
         created_at: created_at,
       }
     end
-
-    private
-
-    sig do
-      params(
-        json_string: String,
-      ).returns(WorkOS::Types::EventStruct)
-    end
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::EventStruct.new(
-        id: hash[:id],
-        event: hash[:event],
-        data: hash[:data],
-        created_at: hash[:created_at],
-      )
-    end
   end
 end

data/lib/workos/events.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: strict
 
 require 'net/http'
 
@@ -10,7 +9,6 @@ module WorkOS
   #
   module Events
     class << self
-      extend T::Sig
       include Client
 
       # Retrieve events.
@@ -23,11 +21,6 @@ module WorkOS
       #  after a provided Event ID.
       #
       # @return [Hash]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(WorkOS::Types::ListStruct)
-      end
       def list_events(options = {})
         response = execute_request(
           request: get_request(

data/lib/workos/factor.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 module WorkOS
   # The Factor class provides a lightweight wrapper around
@@ -7,19 +6,18 @@ module WorkOS
   # in DirectoryUser space, and is instantiated internally but exposed.
   class Factor
     include HashProvider
-    extend T::Sig
     attr_accessor :id, :object, :type, :sms, :totp, :updated_at, :created_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-      @id = T.let(raw.id, String)
-      @object = T.let(raw.object, String)
-      @type = T.let(raw.type, String)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
-      @totp = raw.totp
-      @sms = raw.sms
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @object = hash[:object]
+      @type = hash[:type]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @totp = hash[:totp]
+      @sms = hash[:sms]
     end
 
     def to_json(*)
@@ -33,22 +31,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::FactorStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::FactorStruct.new(
-        id: hash[:id],
-        object: hash[:object],
-        type: hash[:type],
-        totp: hash[:totp],
-        sms: hash[:sms],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/hash_provider.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # Module to include an explicit method for converting a model into a Hash containing

data/lib/workos/impersonator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WorkOS
+  # Contains information about a WorkOS Dashboard user impersonating
+  # a User Management user.
+  class Impersonator
+    include HashProvider
+
+    attr_accessor :email, :reason
+
+    def initialize(email:, reason:)
+      @email = email
+      @reason = reason
+    end
+
+    def to_json(*)
+      {
+        email: email,
+        reason: reason,
+      }
+    end
+  end
+end

data/lib/workos/invitation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Invitation class provides a lightweight wrapper around a WorkOS Invitation
@@ -7,28 +6,24 @@ module WorkOS
   # and is instantiated internally but exposed.
   class Invitation
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :email, :state, :accepted_at, :revoked_at,
                   :expires_at, :token, :organization_id, :created_at, :updated_at
 
-    # rubocop:disable Metrics/AbcSize
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @id = T.let(raw.id, String)
-      @email = T.let(raw.email, String)
-      @state = T.let(raw.state, String)
-      @token = T.let(raw.token, String)
-      @organization_id = T.let(raw.organization_id, T.nilable(String))
-      @accepted_at = T.let(raw.accepted_at, T.nilable(String))
-      @revoked_at = T.let(raw.revoked_at, T.nilable(String))
-      @expires_at = T.let(raw.expires_at, 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]
+      @email = hash[:email]
+      @state = hash[:state]
+      @token = hash[:token]
+      @organization_id = hash[:organization_id]
+      @accepted_at = hash[:accepted_at]
+      @revoked_at = hash[:revoked_at]
+      @expires_at = hash[:expires_at]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
-    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
@@ -44,25 +39,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::InvitationStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::InvitationStruct.new(
-        id: hash[:id],
-        email: hash[:email],
-        state: hash[:state],
-        token: hash[:token],
-        organization_id: hash[:organization_id],
-        accepted_at: hash[:accepted_at],
-        revoked_at: hash[:revoked_at],
-        expires_at: hash[:expires_at],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/mfa.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-# typed: true
-
 
 require 'net/http'
 require 'uri'
@@ -10,9 +8,7 @@ module WorkOS
   # MFA platform. You'll need a valid API key
   module MFA
     class << self
-      extend T::Sig
       include Client
-      sig { params(id: String).returns(T::Boolean) }
       def delete_factor(id:)
         response = execute_request(
           request: delete_request(
@@ -23,9 +19,6 @@ module WorkOS
         response.is_a? Net::HTTPSuccess
       end
 
-      sig do
-        params(id: String).returns(WorkOS::Factor)
-      end
       def get_factor(
         id:
       )
@@ -38,17 +31,8 @@ module WorkOS
         WorkOS::Factor.new(response.body)
       end
 
-      sig do
-        params(
-          type: String,
-          totp_issuer: T.nilable(String),
-          totp_user: T.nilable(String),
-          phone_number: T.nilable(String),
-        ).void
-      end
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
-
       def validate_args(
         type:,
         totp_issuer: nil,
@@ -68,14 +52,6 @@ module WorkOS
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
 
-      sig do
-        params(
-          type: String,
-          totp_issuer: T.nilable(String),
-          totp_user: T.nilable(String),
-          phone_number: T.nilable(String),
-        ).returns(WorkOS::Factor)
-      end
       def enroll_factor(
         type:,
         totp_issuer: nil,
@@ -101,12 +77,6 @@ module WorkOS
         WorkOS::Factor.new(response.body)
       end
 
-      sig do
-        params(
-          authentication_factor_id: T.nilable(String),
-          sms_template: T.nilable(String),
-        ).returns(WorkOS::Challenge)
-      end
       def challenge_factor(
         authentication_factor_id: nil,
         sms_template: nil
@@ -127,12 +97,6 @@ module WorkOS
         WorkOS::Challenge.new(response.body)
       end
 
-      sig do
-        params(
-          authentication_challenge_id: T.nilable(String),
-          code: T.nilable(String),
-        ).returns(WorkOS::VerifyChallenge)
-      end
       def verify_factor(
         authentication_challenge_id: nil,
         code: nil
@@ -145,12 +109,6 @@ module WorkOS
         )
       end
 
-      sig do
-        params(
-          authentication_challenge_id: T.nilable(String),
-          code: T.nilable(String),
-        ).returns(WorkOS::VerifyChallenge)
-      end
       def verify_challenge(
         authentication_challenge_id: nil,
         code: nil