workosv2 2.15.0

data/lib/workosv2/directory.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOSV2
+  # The Directory class provides a lightweight wrapper around
+  # a WorkOSV2 Directory resource. This class is not meant to be instantiated
+  # 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)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+        domain: domain,
+        type: type,
+        state: state,
+        organization_id: organization_id,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOSV2::Types::DirectoryStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOSV2::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/workosv2/directory_group.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOSV2
+  # The DirectoryGroup class provides a lightweight wrapper around
+  # a WorkOSV2 DirectoryGroup resource. This class is not meant to be instantiated
+  # 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)
+
+      @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
+
+      replace_without_warning(to_json)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def to_json(*)
+      {
+        id: id,
+        directory_id: directory_id,
+        organization_id: organization_id,
+        idp_id: idp_id,
+        name: name,
+        created_at: created_at,
+        updated_at: updated_at,
+        raw_attributes: raw_attributes,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOSV2::Types::DirectoryGroupStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOSV2::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/workosv2/directory_sync.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'net/http'
+
+module WorkOSV2
+  # The Directory Sync module provides convenience methods for working with the
+  # WorkOSV2 Directory Sync platform. You'll need a valid API key and to have
+  # created a Directory Sync connection on your WorkOSV2 dashboard.
+  #
+  # @see https://docs.workos.com/directory-sync/overview
+  module DirectorySync
+    class << self
+      extend T::Sig
+      include Client
+
+      # Retrieve directories.
+      #
+      # @param [Hash] options An options hash
+      # @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] order The order in which to paginate records
+      # @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.
+      # @option options [String] organization_id The ID for an Organization configured on WorkOSV2.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOSV2::Types::ListStruct)
+      end
+      def list_directories(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directories',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        directories = parsed_response['data'].map do |directory|
+          ::WorkOSV2::Directory.new(directory.to_json)
+        end
+
+        WorkOSV2::Types::ListStruct.new(
+          data: directories,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+
+      # Retrieve directory.
+      #
+      # @param [String] id Directory unique identifier
+      #
+      # @example
+      #   WorkOSV2::SSO.get_directory(id: 'directory_01FK17DWRHH7APAFXT5B52PV0W')
+      #   => #<WorkOSV2::Directory:0x00007fb6e4193d20
+      #         @id="directory_01FK17DWRHH7APAFXT5B52PV0W",
+      #         @name="Foo Corp",
+      #         @domain="foo-corp.com",
+      #         @type="okta scim v2.0",
+      #         @state="linked",
+      #         @organization_id="org_01F6Q6TFP7RD2PF6J03ANNWDKV",
+      #         @created_at="2021-10-27T15:55:47.856Z",
+      #         @updated_at="2021-10-27T16:03:43.990Z"
+      #
+      # @return [WorkOSV2::Directory]
+      sig { params(id: String).returns(WorkOSV2::Directory) }
+      def get_directory(id:)
+        request = get_request(
+          auth: true,
+          path: "/directories/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        WorkOSV2::Directory.new(response.body)
+      end
+
+      # Retrieve directory groups.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] directory The ID of the directory whose
+      #  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] order The order in which to paginate records
+      # @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 [WorkOSV2::DirectoryGroup]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOSV2::Types::ListStruct)
+      end
+      def list_groups(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directory_groups',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        groups = parsed_response['data'].map do |group|
+          ::WorkOSV2::DirectoryGroup.new(group.to_json)
+        end
+
+        WorkOSV2::Types::ListStruct.new(
+          data: groups,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+
+      # Retrieve directory users.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] directory The ID of the directory whose
+      #  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] order The order in which to paginate records
+      # @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 [WorkOSV2::DirectoryUser]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOSV2::Types::ListStruct)
+      end
+      def list_users(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directory_users',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        users = parsed_response['data'].map do |user|
+          ::WorkOSV2::DirectoryUser.new(user.to_json)
+        end
+
+        WorkOSV2::Types::ListStruct.new(
+          data: users,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+
+      # Retrieve the directory group with the given ID.
+      #
+      # @param [String] id The ID of the directory group.
+      #
+      # @return WorkOSV2::DirectoryGroup
+      sig { params(id: String).returns(WorkOSV2::DirectoryGroup) }
+      def get_group(id)
+        response = execute_request(
+          request: get_request(
+            path: "/directory_groups/#{id}",
+            auth: true,
+          ),
+        )
+
+        ::WorkOSV2::DirectoryGroup.new(response.body)
+      end
+
+      # Retrieve the directory user with the given ID.
+      #
+      # @param [String] id The ID of the directory user.
+      #
+      # @return WorkOSV2::DirectoryUser
+      sig { params(id: String).returns(WorkOSV2::DirectoryUser) }
+      def get_user(id)
+        response = execute_request(
+          request: get_request(
+            path: "/directory_users/#{id}",
+            auth: true,
+          ),
+        )
+
+        ::WorkOSV2::DirectoryUser.new(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

data/lib/workosv2/directory_user.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOSV2
+  # The DirectoryUser class provides a lightweight wrapper around
+  # a WorkOSV2 DirectoryUser resource. This class is not meant to be instantiated
+  # 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)
+
+      replace_without_warning(to_json)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def to_json(*)
+      {
+        id: id,
+        directory_id: directory_id,
+        organization_id: organization_id,
+        idp_id: idp_id,
+        emails: emails,
+        first_name: first_name,
+        last_name: last_name,
+        job_title: job_title,
+        username: username,
+        state: state,
+        groups: groups,
+        custom_attributes: custom_attributes,
+        raw_attributes: raw_attributes,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    def primary_email
+      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(WorkOSV2::Types::DirectoryUserStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOSV2::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/workosv2/errors.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+# typed: true
+
+
+module WorkOSV2
+  # Parent class for WorkOSV2 related errors
+  class WorkOSV2Error < 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,
+      error_description: nil,
+      http_status: nil,
+      request_id: nil,
+      code: nil,
+      errors: nil
+    )
+      @message = message
+      @error = error
+      @error_description = error_description
+      @http_status = http_status
+      @request_id = request_id
+      @code = code
+      @errors = errors
+    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}"
+      if @error && @error_description
+        error_string = "error: #{@error}, error_description: #{@error_description}"
+        "#{status_string}#{error_string}#{id_string}"
+      elsif @error
+        "#{status_string}#{@error}#{id_string}"
+      else
+        "#{status_string}#{@message}#{id_string}"
+      end
+    end
+  end
+
+  # 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't know how to handle it.
+  class APIError < WorkOSV2Error; end
+
+  # AuthenticationError is raised when invalid credentials are used to connect
+  # to WorkOSV2's servers.
+  class AuthenticationError < WorkOSV2Error; end
+
+  # InvalidRequestError is raised when a request is initiated with invalid
+  # parameters.
+  class InvalidRequestError < WorkOSV2Error; end
+
+  # SignatureVerificationError is raised when the signature verification for a
+  # webhook fails
+  class SignatureVerificationError < WorkOSV2Error; end
+
+  # TimeoutError is raised when the HTTP request to the API times out
+  class TimeoutError < WorkOSV2Error; end
+end

data/lib/workosv2/event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOSV2
+  # The Event class provides a lightweight wrapper around
+  # a WorkOSV2 Event resource. This class is not meant to be instantiated
+  # 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)
+
+      @id = T.let(raw.id, String)
+      @event = T.let(raw.event, String)
+      @created_at = T.let(raw.created_at, String)
+      @data = raw.data
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        event: event,
+        data: data,
+        created_at: created_at,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOSV2::Types::EventStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOSV2::Types::EventStruct.new(
+        id: hash[:id],
+        event: hash[:event],
+        data: hash[:data],
+        created_at: hash[:created_at],
+      )
+    end
+  end
+end

data/lib/workosv2/events.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'net/http'
+
+module WorkOSV2
+  # The Events module provides convenience methods for working with the
+  # WorkOSV2 Events platform. You'll need a valid API key and be in the
+  # Events beta to be able to access the API
+  #
+  module Events
+    class << self
+      extend T::Sig
+      include Client
+
+      # Retrieve events.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] event The type of event
+      #  retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] after Pagination cursor to receive records
+      #  after a provided Event ID.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOSV2::Types::ListStruct)
+      end
+      def list_events(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/events',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        events = parsed_response['data'].map do |event|
+          ::WorkOSV2::Event.new(event.to_json)
+        end
+
+        WorkOSV2::Types::ListStruct.new(
+          data: events,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+    end
+  end
+end

data/lib/workosv2/factor.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# typed: false
+
+module WorkOSV2
+  # The Factor class provides a lightweight wrapper around
+  # a WorkOSV2 DirectoryUser resource. This class is not meant to be instantiated
+  # 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
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        object: object,
+        type: type,
+        totp: totp,
+        sms: sms,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOSV2::Types::FactorStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOSV2::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/workosv2/hash_provider.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOSV2
+  # Module to include an explicit method for converting a model into a Hash containing
+  # its attributes. Default implementation will simply call to_json. Individual classes
+  # may override.
+  module HashProvider
+    include Kernel
+
+    def to_json(*)
+      raise 'Must be implemented by including class.'
+    end
+
+    def to_h
+      to_json
+    end
+  end
+end