workos 4.6.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 332ad6b582c870d359c308f231c3a9aab661487177b5afb73f9eda7b8c42f3ba
-  data.tar.gz: e95ae8f206a0a365a96ecc849b7426c0fd5425b59ac3cb9fde6fae4db1bb3b87
+  metadata.gz: a59645d5489656e64892044220f777e2e1da74715f38e11f82c8bfad3ed905aa
+  data.tar.gz: baa9a0fa487c51d3c3adf1f11635fb17bbd22effefc774ca40d1a09e537dfcc8
 SHA512:
-  metadata.gz: b216f6e42eed12702ad449a0370aac224e7c946ea275b48170162a2eb43f4639ee2e7cdf5ef9a1be31edde3d120f3ae7f13d6531233d2974cf27c3af4c7a870a
-  data.tar.gz: e1597322a482e0c94fae260b11cc1225f831a80f5e916fbf8b52415df6972054b8eba8b973cb73336c6985396e518535197c9e3fccdc33cd17fd3871a5eff958
+  metadata.gz: ebb7b90352a85f433273cafd86e2ceecabd4d20451ce6e6c8122637beb509f55f82f19dc800f4028bdaf35f61a5a3d42dbe7d348db686dda129fff4fa0e034ce
+  data.tar.gz: 9a6039a67909bfce3a5f42ba854d88da052d5a70d6208f9d60cc3a5d7c20c3ea596f6fba3b1263c6a00e435f772c77a6176d16011f4f3151246dafbd49e142c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (4.6.0)
+    workos (4.8.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/workos/email_verification.rb

@@ -0,0 +1,37 @@
+# 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/invitation.rb

@@ -8,8 +8,9 @@ module WorkOS
     include HashProvider
 
     attr_accessor :id, :email, :state, :accepted_at, :revoked_at, :accept_invitation_url,
-                  :expires_at, :token, :organization_id, :created_at, :updated_at
+                  :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)
 
@@ -19,12 +20,14 @@ module WorkOS
       @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(*)
       {
@@ -34,6 +37,7 @@ module WorkOS
         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,

data/lib/workos/password_reset.rb

@@ -0,0 +1,37 @@
+# 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/user_management.rb

@@ -603,9 +603,11 @@ module WorkOS
       # @param [String] totp_issuer For totp factors. Typically your application
       #  or company name, this helps users distinguish between factors in authenticator apps.
       # @param [String] totp_user For totp factors. Used as the account name in authenticator apps.
+      # @param [String] totp_secret For totp factors.  The Base32 encdoded secret key for the
+      # factor. Generated if not provided. (Optional)
       #
       # @return WorkOS::AuthenticationFactorAndChallenge
-      def enroll_auth_factor(user_id:, type:, totp_issuer: nil, totp_user: nil)
+      def enroll_auth_factor(user_id:, type:, totp_issuer: nil, totp_user: nil, totp_secret: nil)
         validate_auth_factor_type(
           type: type,
         )
@@ -617,6 +619,7 @@ module WorkOS
               type: type,
               totp_issuer: totp_issuer,
               totp_user: totp_user,
+              totp_secret: totp_secret,
             },
             auth: true,
           ),
@@ -650,6 +653,22 @@ module WorkOS
         )
       end
 
+      # Gets an email verification object
+      #
+      # @param [String] id The unique ID of the EmailVerification object.
+      #
+      # @return WorkOS::EmailVerification
+      def get_email_verification(id:)
+        response = execute_request(
+          request: get_request(
+            path: "/user_management/email_verification/#{id}",
+            auth: true,
+          ),
+        )
+
+        WorkOS::EmailVerification.new(response.body)
+      end
+
       # Sends a verification email to the provided user.
       #
       # @param [String] user_id The unique ID of the User whose email address will be verified.
@@ -686,6 +705,41 @@ module WorkOS
         WorkOS::UserResponse.new(response.body)
       end
 
+      # Gets a password reset object
+      #
+      # @param [String] id The unique ID of the PasswordReset object.
+      #
+      # @return WorkOS::PasswordReset
+      def get_password_reset(id:)
+        response = execute_request(
+          request: get_request(
+            path: "/user_management/password_reset/#{id}",
+            auth: true,
+          ),
+        )
+
+        WorkOS::PasswordReset.new(response.body)
+      end
+
+      # Creates a password reset token
+      #
+      # @param [String] email The email address of the user.
+      #
+      # @return WorkOS::PasswordReset
+      def create_password_reset(email:)
+        response = execute_request(
+          request: post_request(
+            path: '/user_management/password_reset',
+            body: {
+              email: email,
+            },
+            auth: true,
+          ),
+        )
+
+        WorkOS::PasswordReset.new(response.body)
+      end
+
       # Create a password reset challenge and emails a password reset link to a user.
       #
       # @param [String] email The email of the user that wishes to reset their password.
@@ -693,6 +747,9 @@ module WorkOS
       #
       # @return [Bool] - returns `true` if successful
       def send_password_reset_email(email:, password_reset_url:)
+        warn_deprecation '`send_password_reset_email` is deprecated.
+        Please use `create_password_reset` instead. This method will be removed in a future major version.'
+
         request = post_request(
           path: '/user_management/password_reset/send',
           body: {
@@ -865,6 +922,22 @@ module WorkOS
         WorkOS::Invitation.new(response.body)
       end
 
+      # Finds an Invitation by Token
+      #
+      # @param [String] token The token of the Invitation.
+      #
+      # @return WorkOS::Invitation
+      def find_invitation_by_token(token:)
+        response = execute_request(
+          request: get_request(
+            path: "/user_management/invitations/by_token/#{token}",
+            auth: true,
+          ),
+        )
+
+        WorkOS::Invitation.new(response.body)
+      end
+
       # Retrieve a list of invitations.
       #
       # @param [Hash] options

data/lib/workos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkOS
-  VERSION = '4.6.0'
+  VERSION = '4.8.0'
 end

data/lib/workos.rb

@@ -54,6 +54,7 @@ module WorkOS
   autoload :DirectoryGroup, 'workos/directory_group'
   autoload :DirectorySync, 'workos/directory_sync'
   autoload :DirectoryUser, 'workos/directory_user'
+  autoload :EmailVerification, 'workos/email_verification'
   autoload :Event, 'workos/event'
   autoload :Events, 'workos/events'
   autoload :Factor, 'workos/factor'
@@ -65,6 +66,7 @@ module WorkOS
   autoload :Organizations, 'workos/organizations'
   autoload :OrganizationMembership, 'workos/organization_membership'
   autoload :Passwordless, 'workos/passwordless'
+  autoload :PasswordReset, 'workos/password_reset'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
   autoload :ProfileAndToken, 'workos/profile_and_token'

data/spec/lib/workos/user_management_spec.rb

@@ -677,6 +677,7 @@ describe WorkOS::UserManagement do
           authentication_response = WorkOS::UserManagement.enroll_auth_factor(
             user_id: 'user_01H7TVSKS45SDHN5V9XPSM6H44',
             type: 'totp',
+            totp_secret: 'secret-test',
           )
 
           expect(authentication_response.authentication_factor.id).to eq('auth_factor_01H96FETXENNY99ARX0GRC804C')
@@ -736,6 +737,31 @@ describe WorkOS::UserManagement do
     end
   end
 
+  describe '.get_email_verification' do
+    context 'with a valid id' do
+      it 'returns an email_verification object' do
+        VCR.use_cassette 'user_management/get_email_verification/valid' do
+          email_verification = described_class.get_email_verification(
+            id: 'email_verification_01HYK9VKNJQ0MJDXEXQP0DA1VK',
+          )
+
+          expect(email_verification.id.instance_of?(String))
+          expect(email_verification.instance_of?(WorkOS::EmailVerification))
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('user_management/get_email_verification/invalid') do
+          expect do
+            WorkOS::UserManagement.get_email_verification(id: 'invalid')
+          end.to raise_error(WorkOS::APIError, /Email Verification not found/)
+        end
+      end
+    end
+  end
+
   describe '.send_verification_email' do
     context 'with valid parameters' do
       it 'sends an email to that user and the magic auth challenge' do
@@ -804,6 +830,46 @@ describe WorkOS::UserManagement do
     end
   end
 
+  describe '.get_password_reset' do
+    context 'with a valid id' do
+      it 'returns a password_reset object' do
+        VCR.use_cassette 'user_management/get_password_reset/valid' do
+          password_reset = described_class.get_password_reset(
+            id: 'password_reset_01HYKA8DTF8TW5YD30MF0ZXZKT',
+          )
+
+          expect(password_reset.id.instance_of?(String))
+          expect(password_reset.instance_of?(WorkOS::PasswordReset))
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('user_management/get_password_reset/invalid') do
+          expect do
+            WorkOS::UserManagement.get_password_reset(id: 'invalid')
+          end.to raise_error(WorkOS::APIError, /Password Reset not found/)
+        end
+      end
+    end
+  end
+
+  describe '.create_password_reset' do
+    context 'with valid payload' do
+      it 'creates a password_reset object' do
+        VCR.use_cassette 'user_management/create_password_reset/valid' do
+          password_reset = described_class.create_password_reset(
+            email: 'test@workos.com',
+          )
+
+          expect(password_reset.id).to eq('password_reset_01HYKA8DTF8TW5YD30MF0ZXZKT')
+          expect(password_reset.email).to eq('test@workos.com')
+        end
+      end
+    end
+  end
+
   describe '.send_password_reset_email' do
     context 'with a valid payload' do
       it 'sends a password reset email' do
@@ -1090,6 +1156,31 @@ describe WorkOS::UserManagement do
     end
   end
 
+  describe '.find_invitation_by_token' do
+    context 'with a valid id' do
+      it 'returns an invitation' do
+        VCR.use_cassette 'user_management/find_invitation_by_token/valid' do
+          invitation = described_class.find_invitation_by_token(
+            token: 'iUV3XbYajpJlbpw1Qt3ZKlaKx',
+          )
+
+          expect(invitation.id.instance_of?(String))
+          expect(invitation.instance_of?(WorkOS::Invitation))
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('user_management/find_invitation_by_token/invalid') do
+          expect do
+            WorkOS::UserManagement.find_invitation_by_token(token: 'invalid')
+          end.to raise_error(WorkOS::APIError, /Invitation not found/)
+        end
+      end
+    end
+  end
+
   describe '.list_invitations' do
     context 'with no options' do
       it 'returns invitations and metadata' do

data/spec/support/fixtures/vcr_cassettes/user_management/create_password_reset/valid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/user_management/password_reset
+    body:
+      encoding: UTF-8
+      string: '{"email":"blair@workos.com"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.6.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Thu, 23 May 2024 18:08:51 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '397'
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 8886fe5e1c317b24-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"18d-Z6VC8jkvZuXmNL0BcJcqkF7M0BQ"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - db59df36-fce8-4174-a031-bd259bca32f8
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=d6moUiiUczj82CNolGPFWxb99g4YP_C.ZlaH9W7xnF8-1716487731-1.0.1.1-pRG1tKVpL4EV8NrdL78THPAhMdBiKwY_tOlgnuanVHgNFvw6MeMv2wJG0Nkp4oLwXdW629gkH1OwSaLIv9EuYQ;
+        path=/; expires=Thu, 23-May-24 18:38:51 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=bd64ac4e2572b6fc609d5cc06577eed03bc1bbcb-1716487731; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: UTF-8
+      string: '{"object":"password_reset","id":"password_reset_01HYKA8DTF8TW5YD30MF0ZXZKT","user_id":"user_01HH5GTVSP6PEXV0SRB9ANFE9G","email":"test@workos.com","password_reset_token":"DmNQt1ZWOz7k5hulOoGDN0TZd","password_reset_url":"https://my-app.com/reset-password/?token=DmNQt1ZWOz7k5hulOoGDN0TZd","expires_at":"2024-05-23T18:23:51.024Z","created_at":"2024-05-23T18:08:51.024Z"}'
+    http_version:
+  recorded_at: Thu, 23 May 2024 18:08:50 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/invalid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/invitations/by_token/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.7.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Mon, 03 Jun 2024 20:16:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 88e25cab2e0c520c-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"5a-PPX6d4bMxLfMyXe/1aUqFNwW/Dc"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 7066479f-3c65-4eb0-a5ab-fa371e8747e5
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=V3RT_KMrnFyoIbj_1OgapyAtReNBXvdzeYmNZWQQt6Y-1717445797-1.0.1.1-XWQk50226uaRo4S1BTn3wou4.mFaLOC20eA_MhrSil._j0XoCx6I2Q0gmgtBp1j9.dHqkmf4ZwOw1j6RmBLSnQ;
+        path=/; expires=Mon, 03-Jun-24 20:46:37 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=cb54bc416259840c8c11ad58469ec2c5d9f88ff3-1717445797; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Invitation not found: ''invalid''.","code":"entity_not_found","entity_id":"invalid"}'
+    http_version:
+  recorded_at: Mon, 03 Jun 2024 20:16:37 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/valid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/invitations/by_token/iUV3XbYajpJlbpw1Qt3ZKlaKx
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.7.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 03 Jun 2024 20:16:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 88e25ca97a127b32-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"1e5-ZUKH6e1N8G9JBxE8/nulDIEawKk"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 1359e287-00bc-4081-a3d9-6bfcded70273
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=WToCUplL1o5i0KSz5l81mSZ5SqsRh0MGwXHPwM7C.Sg-1717445797-1.0.1.1-KXhOU0BqmCe7ZDWcpEJ7V3gLLZpioBrWPxtyB5m2sOmYxj3GWOfjhqRz5d1L0cTOpGoT9OfeqzGa5qfmD0ELZw;
+        path=/; expires=Mon, 03-Jun-24 20:46:37 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=cb54bc416259840c8c11ad58469ec2c5d9f88ff3-1717445797; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"invitation","id":"invitation_01HZFVRAJ7EV7935K7H8NX2MRH","email":"blairlunceford@gmail.com","state":"pending","accepted_at":null,"revoked_at":null,"expires_at":"2024-06-10T20:13:21.862Z","organization_id":null,"inviter_user_id":null,"token":"iUV3XbYajpJlbpw1Qt3ZKlaKx","accept_invitation_url":"https://manageable-child-63-staging.authkit.app/invite/?invitation_token=iUV3XbYajpJlbpw1Qt3ZKlaKx","created_at":"2024-06-03T20:13:21.820Z","updated_at":"2024-06-03T20:13:21.820Z"}'
+    http_version:
+  recorded_at: Mon, 03 Jun 2024 20:16:37 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/invalid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/email_verification/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.6.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Thu, 23 May 2024 18:04:34 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 8886f81a5d7e7b18-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"66-ESd/ROLsUvsCu/wiWkoaXfmv1gY"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 777e6230-9045-4858-9925-efb5c5783aa7
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=jfT91VpwVMXi901oaS57bdvcPNjXwzgT0NN.TADMkSA-1716487474-1.0.1.1-D3FZIQ5VQOMnMl3UudReuAR600DpJh8NzCxffFA.bRKl_H6zziPQu7Kk3_.wsy8_ESDjlcUQ3suhVmUb5Iwbhg;
+        path=/; expires=Thu, 23-May-24 18:34:34 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=387f8a46c39c44e43af2f39cd9fd8aea810da563-1716487474; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Email Verification not found: ''invalid''.","code":"entity_not_found","entity_id":"invalid"}'
+    http_version:
+  recorded_at: Thu, 23 May 2024 18:04:34 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/valid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/email_verification/email_verification_01HYK9VKNJQ0MJDXEXQP0DA1VK
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.6.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 May 2024 18:20:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 88870f32dcd07c2e-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"12b-ekjr8XAvfdiqyjIkVD8WtynlLBo"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 52bf7914-d672-454b-bd61-353e397fdad5
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=huBpGvZo0rq1TOrNY2F0wBwT69_y.Paz9joecCAWK2Y-1716488420-1.0.1.1-YY9yAQE6aOIbVg6Vf8Rxc8ScBPueEKTcUGUXIQmi_AYXfCtcQUa3MzjWeeC0.vmO0AetYPSX3FmmWUf26GH2Fw;
+        path=/; expires=Thu, 23-May-24 18:50:20 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=823df799452104e182687db9c4f57d862b59f78e-1716488420; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"email_verification","id":"email_verification_01HYK9VKNJQ0MJDXEXQP0DA1VK","user_id":"user_01HYK9VAAW34TPP0KSYXCX44SB","email":"blairlunceford@gmail.com","code":"561814","expires_at":"2024-05-23T18:11:51.024Z","created_at":"2024-05-23T18:01:50.997Z","updated_at":"2024-05-23T18:01:50.997Z"}'
+    http_version:
+  recorded_at: Thu, 23 May 2024 18:20:20 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/invalid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/password_reset/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.6.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Thu, 23 May 2024 18:04:34 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 8886f81cb89c7b00-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"62-MwEIS86+oNNsmjVX0JyWZTcjZ9s"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 5b33aeae-7a47-4893-8fef-f014e6692866
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=nkAinUzRPwshxLJMd18TIu20ff0fkGCILsc2NGkWLcs-1716487474-1.0.1.1-Ci9e5PwUuKRRSCrdjfPf3hLETEBr8qGDcVdllyCDW39my5OtwL58BZDu0vB0kuC_6vsPe4UrLSzfoz6XMyjmmw;
+        path=/; expires=Thu, 23-May-24 18:34:34 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=387f8a46c39c44e43af2f39cd9fd8aea810da563-1716487474; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Password Reset not found: ''invalid''.","code":"entity_not_found","entity_id":"invalid"}'
+    http_version:
+  recorded_at: Thu, 23 May 2024 18:04:34 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/valid.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/user_management/password_reset/password_reset_01HYKA8DTF8TW5YD30MF0ZXZKT
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v4.6.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 May 2024 18:10:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 8887008eb83c51eb-DEN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"18d-Z6VC8jkvZuXmNL0BcJcqkF7M0BQ"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - bd5403d4-e651-4b63-acde-50287326e0d7
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=YhPLb6u6gDZZcI3AVyfPTCitp9JKWpSMhZ236D6EPJI-1716487820-1.0.1.1-F0GOL.FAH1ROxtTJumLoe_YGWkO6uoozp7qv4oFniAc0aX20kqay7JvCfszxpxRsEbvj5mPTJcqVyvDm7qedeA;
+        path=/; expires=Thu, 23-May-24 18:40:20 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=cdbb09208777e3b5b5ee0ae80b61e07279d590c0-1716487820; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"password_reset","id":"password_reset_01HYKA8DTF8TW5YD30MF0ZXZKT","user_id":"user_01HH5GTVSP6PEXV0SRB9ANFE9G","email":"blair@workos.com","password_reset_token":"DmNQt1ZWOz7k5hulOoGDN0TZd","password_reset_url":"https://manageable-child-63-staging.authkit.app/reset-password/?token=DmNQt1ZWOz7k5hulOoGDN0TZd","expires_at":"2024-05-23T18:23:51.024Z","created_at":"2024-05-23T18:08:51.024Z"}'
+    http_version:
+  recorded_at: Thu, 23 May 2024 18:10:20 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.8.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - lib/workos/directory_group.rb
 - lib/workos/directory_sync.rb
 - lib/workos/directory_user.rb
+- lib/workos/email_verification.rb
 - lib/workos/errors.rb
 - lib/workos/event.rb
 - lib/workos/events.rb
@@ -130,6 +131,7 @@ files:
 - lib/workos/organization.rb
 - lib/workos/organization_membership.rb
 - lib/workos/organizations.rb
+- lib/workos/password_reset.rb
 - lib/workos/passwordless.rb
 - lib/workos/portal.rb
 - lib/workos/profile.rb
@@ -272,6 +274,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/user_management/create_magic_auth/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_password_reset/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_user_invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_user_valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/deactivate_organization_membership.yml
@@ -281,11 +284,17 @@ files:
 - spec/support/fixtures/vcr_cassettes/user_management/delete_user/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_invitation/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_invitation/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_magic_auth/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_magic_auth/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_organization_membership.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_user.yml
 - spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/valid.yml
@@ -472,6 +481,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/user_management/create_magic_auth/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/create_password_reset/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_user_invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/create_user_valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/deactivate_organization_membership.yml
@@ -481,11 +491,17 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/user_management/delete_user/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/enroll_auth_factor/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/find_invitation_by_token/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_email_verification/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_invitation/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_invitation/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_magic_auth/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_magic_auth/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_organization_membership.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/invalid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/get_password_reset/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/get_user.yml
 - spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/list_auth_factors/valid.yml