workos 6.1.0 → 7.0.0

data/lib/workos/directory_user.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: 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 < DeprecatedHashWrapper
-    include HashProvider
-
-    attr_accessor :id, :idp_id, :email, :emails, :first_name, :last_name, :job_title, :username, :state,
-                  :groups, :role, :roles, :custom_attributes, :raw_attributes, :directory_id, :organization_id,
-                  :created_at, :updated_at
-
-    # rubocop:disable Metrics/AbcSize
-    def initialize(json)
-      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]
-      @email = hash[:email]
-      # @deprecated Will be removed in a future major version.
-      # Enable the `emails` custom attribute in dashboard and pull from customAttributes instead.
-      # See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-      @emails = hash[:emails]
-      @first_name = hash[:first_name]
-      @last_name = hash[:last_name]
-      # @deprecated Will be removed in a future major version.
-      # Enable the `job_title` custom attribute in dashboard and pull from customAttributes instead.
-      # See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-      @job_title = hash[:job_title]
-      # @deprecated Will be removed in a future major version.
-      # Enable the `username` custom attribute in dashboard and pull from customAttributes instead.
-      # See https://workos.com/docs/directory-sync/attributes/custom-attributes/auto-mapped-attributes for details.
-      @username = hash[:username]
-      @state = hash[:state]
-      @groups = hash[:groups]
-      @role = hash[:role]
-      @roles = hash[:roles]
-      @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
-    # rubocop:enable Metrics/AbcSize
-
-    def to_json(*)
-      base_attributes.
-        merge(authorization_attributes)
-    end
-
-    private
-
-    def base_attributes
-      {
-        id: id,
-        directory_id: directory_id,
-        organization_id: organization_id,
-        idp_id: idp_id,
-        email: email,
-        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 authorization_attributes
-      {
-        role: role,
-        roles: roles,
-      }
-    end
-
-    public
-
-    # @deprecated Will be removed in a future major version. Use {#email} instead.
-    def primary_email
-      primary_email = (emails || []).find { |email| email[:primary] }
-      return primary_email[:value] if primary_email
-    end
-  end
-end

data/lib/workos/email_verification.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The EmailVerification class provides a lightweight wrapper around a WorkOS email
-  # verification resource. This class is not meant to be instantiated in a user space,
-  # and is instantiated internally but exposed.
-  class EmailVerification
-    include HashProvider
-
-    attr_accessor :id, :user_id, :email,
-                  :expires_at, :code, :created_at, :updated_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @user_id = hash[:user_id]
-      @email = hash[:email]
-      @code = hash[:code]
-      @expires_at = hash[:expires_at]
-      @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        user_id: user_id,
-        email: email,
-        code: code,
-        expires_at: expires_at,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/event.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The Event class provides a lightweight wrapper around
-  # a WorkOS Event resource. This class is not meant to be instantiated
-  # in user space, and is instantiated internally but exposed.
-  class Event
-    include HashProvider
-
-    attr_accessor :id, :event, :data, :created_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @event = hash[:event]
-      @created_at = hash[:created_at]
-      @data = hash[:data]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        event: event,
-        data: data,
-        created_at: created_at,
-      }
-    end
-  end
-end

data/lib/workos/factor.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The Factor 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 Factor
-    include HashProvider
-    attr_accessor :id, :object, :type, :sms, :totp, :updated_at, :created_at
-
-    def initialize(json)
-      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(*)
-      {
-        id: id,
-        object: object,
-        type: type,
-        totp: totp,
-        sms: sms,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/feature_flag.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The FeatureFlag class provides a lightweight wrapper around
-  # a WorkOS Feature Flag resource. This class is not meant to be instantiated
-  # in user space, and is instantiated internally but exposed.
-  class FeatureFlag
-    include HashProvider
-
-    attr_accessor :id, :name, :slug, :description, :created_at, :updated_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @name = hash[:name]
-      @slug = hash[:slug]
-      @description = hash[:description]
-      @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        name: name,
-        slug: slug,
-        description: description,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/impersonator.rb

@@ -1,23 +0,0 @@
-# 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,49 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The Invitation class provides a lightweight wrapper around a WorkOS Invitation
-  # resource. This class is not meant to be instantiated in a user space,
-  # and is instantiated internally but exposed.
-  class Invitation
-    include HashProvider
-
-    attr_accessor :id, :email, :state, :accepted_at, :revoked_at, :accept_invitation_url,
-                  :expires_at, :token, :organization_id, :inviter_user_id, :created_at, :updated_at
-
-    # rubocop:disable Metrics/AbcSize
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @email = hash[:email]
-      @state = hash[:state]
-      @token = hash[:token]
-      @accept_invitation_url = hash[:accept_invitation_url]
-      @organization_id = hash[:organization_id]
-      @inviter_user_id = hash[:inviter_user_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(*)
-      {
-        id: id,
-        email: email,
-        state: state,
-        token: token,
-        accept_invitation_url: accept_invitation_url,
-        organization_id: organization_id,
-        inviter_user_id: inviter_user_id,
-        accepted_at: accepted_at,
-        revoked_at: revoked_at,
-        expires_at: expires_at,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/magic_auth.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The MagicAuth class provides a lightweight wrapper around a WorkOS MagicAuth
-  # resource. This class is not meant to be instantiated in a user space,
-  # and is instantiated internally but exposed.
-  class MagicAuth
-    include HashProvider
-
-    attr_accessor :id, :user_id, :email,
-                  :expires_at, :code, :created_at, :updated_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @user_id = hash[:user_id]
-      @email = hash[:email]
-      @code = hash[:code]
-      @expires_at = hash[:expires_at]
-      @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        user_id: user_id,
-        email: email,
-        code: code,
-        expires_at: expires_at,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/mfa.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'uri'
-
-module WorkOS
-  # The MFA module provides convenience methods for working with the WorkOS
-  # MFA platform. You'll need a valid API key
-  module MFA
-    class << self
-      include Client, Deprecation
-
-      def delete_factor(id:)
-        response = execute_request(
-          request: delete_request(
-            path: "/auth/factors/#{id}",
-            auth: true,
-          ),
-        )
-        response.is_a? Net::HTTPSuccess
-      end
-
-      def get_factor(
-        id:
-      )
-        response = execute_request(
-          request: get_request(
-            path: "/auth/factors/#{id}",
-            auth: true,
-          ),
-        )
-        WorkOS::Factor.new(response.body)
-      end
-
-      # rubocop:disable Metrics/PerceivedComplexity
-      def validate_args(
-        type:,
-        totp_issuer: nil,
-        totp_user: nil,
-        phone_number: nil
-      )
-        if type != 'sms' && type != 'totp' && type != 'generic_otp'
-          raise ArgumentError, "Type argument must be either 'sms' or 'totp'"
-        end
-        if (type == 'totp' && totp_issuer.nil?) || (type == 'totp' && totp_user.nil?)
-          raise ArgumentError, 'Incomplete arguments. Need to specify both totp_issuer and totp_user when type is totp'
-        end
-        return unless type == 'sms' && phone_number.nil?
-
-        raise ArgumentError, 'Incomplete arguments. Need to specify phone_number when type is sms'
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
-
-      def enroll_factor(
-        type:,
-        totp_issuer: nil,
-        totp_user: nil,
-        phone_number: nil
-      )
-        validate_args(
-          type: type,
-          totp_issuer: totp_issuer,
-          totp_user: totp_user,
-          phone_number: phone_number,
-        )
-        response = execute_request(request: post_request(
-          auth: true,
-          body: {
-            type: type,
-            totp_issuer: totp_issuer,
-            totp_user: totp_user,
-            phone_number: phone_number,
-          },
-          path: '/auth/factors/enroll',
-        ))
-        WorkOS::Factor.new(response.body)
-      end
-
-      def challenge_factor(
-        authentication_factor_id: nil,
-        sms_template: nil
-      )
-        if authentication_factor_id.nil?
-          raise ArgumentError, "Incomplete arguments: 'authentication_factor_id' is a required argument"
-        end
-
-        request = post_request(
-          auth: true,
-          body: {
-            sms_template: sms_template,
-          },
-          path: "/auth/factors/#{authentication_factor_id}/challenge",
-        )
-
-        response = execute_request(request: request)
-        WorkOS::Challenge.new(response.body)
-      end
-
-      def verify_factor(
-        authentication_challenge_id: nil,
-        code: nil
-      )
-        warn_deprecation '`verify_factor` is deprecated. Please use `verify_challenge` instead.'
-
-        verify_challenge(
-          authentication_challenge_id: authentication_challenge_id,
-          code: code,
-        )
-      end
-
-      def verify_challenge(
-        authentication_challenge_id: nil,
-        code: nil
-      )
-
-        if authentication_challenge_id.nil? || code.nil?
-          raise ArgumentError, "Incomplete arguments: 'authentication_challenge_id' and 'code' are required arguments"
-        end
-
-        options = {
-          "code": code,
-        }
-
-        response = execute_request(
-          request: post_request(
-            path: "/auth/challenges/#{authentication_challenge_id}/verify",
-            auth: true,
-            body: options,
-          ),
-        )
-        WorkOS::VerifyChallenge.new(response.body)
-      end
-    end
-  end
-end

data/lib/workos/oauth_tokens.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The OAuthTokens class represents the third party provider OAuth tokens returned in the authentication response.
-  # This class is not meant to be instantiated in user space, and is instantiated internally but exposed.
-  class OAuthTokens
-    include HashProvider
-
-    attr_accessor :access_token, :refresh_token, :scopes, :expires_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @access_token = hash[:access_token]
-      @refresh_token = hash[:refresh_token]
-      @scopes = hash[:scopes]
-      @expires_at = hash[:expires_at]
-    end
-
-    def to_json(*)
-      {
-        access_token: access_token,
-        refresh_token: refresh_token,
-        scopes: scopes,
-        expires_at: expires_at,
-      }
-    end
-  end
-end

data/lib/workos/organization.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The Organization class provides a lightweight wrapper around
-  # a WorkOS Organization resource. This class is not meant to be instantiated
-  # in user space, and is instantiated internally but exposed.
-  class Organization
-    include HashProvider
-
-    attr_accessor(
-      :id,
-      :domains,
-      :stripe_customer_id,
-      :name,
-      :external_id,
-      :allow_profiles_outside_organization,
-      :created_at,
-      :updated_at,
-    )
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @name = hash[:name]
-      @external_id = hash[:external_id]
-      @allow_profiles_outside_organization = hash[:allow_profiles_outside_organization]
-      @domains = hash[:domains]
-      @stripe_customer_id = hash[:stripe_customer_id]
-      @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        name: name,
-        external_id: external_id,
-        allow_profiles_outside_organization: allow_profiles_outside_organization,
-        domains: domains,
-        stripe_customer_id: stripe_customer_id,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/organization_membership.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The OrganizationMembership class provides a lightweight wrapper around a WorkOS OrganizationMembership
-  # resource. This class is not meant to be instantiated in a user space,
-  # and is instantiated internally but exposed.
-  class OrganizationMembership
-    include HashProvider
-
-    attr_accessor :id, :user_id, :organization_id, :status, :role, :roles, :custom_attributes, :created_at, :updated_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @user_id = hash[:user_id]
-      @organization_id = hash[:organization_id]
-      @status = hash[:status]
-      @role = hash[:role]
-      @roles = hash[:roles]
-      @custom_attributes = hash[:custom_attributes]
-      @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        user_id: user_id,
-        organization_id: organization_id,
-        status: status,
-        role: role,
-        roles: roles,
-        custom_attributes: custom_attributes,
-        created_at: created_at,
-        updated_at: updated_at,
-      }
-    end
-  end
-end

data/lib/workos/password_reset.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module WorkOS
-  # The PasswordReset class provides a lightweight wrapper around a WorkOS password
-  # reset resource. This class is not meant to be instantiated in a user space,
-  # and is instantiated internally but exposed.
-  class PasswordReset
-    include HashProvider
-
-    attr_accessor :id, :user_id, :email, :password_reset_token,
-                  :password_reset_url, :expires_at, :created_at
-
-    def initialize(json)
-      hash = JSON.parse(json, symbolize_names: true)
-
-      @id = hash[:id]
-      @user_id = hash[:user_id]
-      @email = hash[:email]
-      @password_reset_token = hash[:password_reset_token]
-      @password_reset_url = hash[:password_reset_url]
-      @expires_at = hash[:expires_at]
-      @created_at = hash[:created_at]
-    end
-
-    def to_json(*)
-      {
-        id: id,
-        user_id: user_id,
-        email: email,
-        password_reset_token: password_reset_token,
-        password_reset_url: password_reset_url,
-        expires_at: expires_at,
-        created_at: created_at,
-      }
-    end
-  end
-end

data/lib/workos/portal.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-
-module WorkOS
-  # The Portal module provides resource methods for working with the Admin
-  # Portal product
-  module Portal
-    class << self
-      include Client
-
-      GENERATE_LINK_INTENTS = WorkOS::Types::Intent::ALL
-
-      # 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: ["audit_logs", "dsync", "log_streams", "sso",]
-      # @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
-      #  exiting the generated Admin Portal. If none is provided, the default
-      #  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.
-      def generate_link(intent:, organization:, return_url: nil, success_url: nil)
-        validate_intent(intent)
-
-        request = post_request(
-          auth: true,
-          body: {
-            intent: intent,
-            organization: organization,
-            return_url: return_url,
-            success_url: success_url,
-          },
-          path: '/portal/generate_link',
-        )
-
-        response = execute_request(request: request)
-
-        JSON.parse(response.body)['link']
-      end
-
-      private
-
-      def validate_intent(intent)
-        return if GENERATE_LINK_INTENTS.include?(intent)
-
-        raise ArgumentError, "#{intent} is not a valid value." \
-        " `intent` must be in #{GENERATE_LINK_INTENTS}"
-      end
-    end
-  end
-end