workos 10.4.0 → 10.6.0

data/lib/workos/user_management.rb

@@ -57,7 +57,7 @@ module WorkOS
     # @param code [String, nil] The authorization code received from the redirect.
     # @param code_verifier [String, nil] The PKCE code verifier used to derive the code challenge passed to the authorization URL.
     # @param invitation_token [String, nil] An invitation token to accept during authentication.
-    # @param ip_address [String, nil] The IP address of the user's request.
+    # @param ip_address [String, nil] The IP address of the user's request. Required when Radar is in Decision mode.
     # @param device_id [String, nil] A unique identifier for the device.
     # @param user_agent [String, nil] The user agent string from the user's browser.
     # @param signals_id [String, nil] An optional Radar signals ID to correlate client-side signals with this authentication attempt.
@@ -880,15 +880,18 @@ module WorkOS
 
     # Create a password reset token
     # @param email [String] The email address of the user requesting a password reset.
+    # @param locale [WorkOS::Types::CreatePasswordResetTokenLocale, nil] The locale to use when rendering the password reset email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::PasswordReset]
     def reset_password(
       email:,
+      locale: nil,
       request_options: {}
     )
       body = {
-        "email" => email
-      }
+        "email" => email,
+        "locale" => locale
+      }.compact
       response = @client.request(
         method: :post,
         path: "/user_management/password_reset",
@@ -1003,14 +1006,14 @@ module WorkOS
     end
 
     # Create a user
-    # @param email [String] The email address of the user.
+    # @param email [String] The email address of the user. WorkOS trims whitespace and converts the address to lowercase before storing it.
     # @param first_name [String, nil] The first name of the user.
     # @param last_name [String, nil] The last name of the user.
     # @param name [String, nil] The user's full name.
     # @param email_verified [Boolean, nil] Whether the user's email has been verified.
     # @param metadata [Hash{String => String}, nil] Object containing metadata key/value pairs associated with the user.
     # @param external_id [String, nil] The external ID of the user.
-    # @param ip_address [String, nil] The IP address of the user's request.
+    # @param ip_address [String, nil] The IP address of the user's request. Required when Radar is in Decision mode.
     # @param user_agent [String, nil] The user agent string from the user's request.
     # @param signals_id [String, nil] An optional Radar signals ID to correlate client-side signals with this request.
     # @param password [WorkOS::UserManagement::PasswordPlaintext, WorkOS::UserManagement::PasswordHashed, nil] Identifies the password.
@@ -1209,16 +1212,19 @@ module WorkOS
     # Send email change code
     # @param id [String] The unique ID of the user.
     # @param new_email [String] The new email address to change to.
+    # @param locale [WorkOS::Types::SendEmailChangeLocale, nil] The locale to use when rendering the email change email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::EmailChange]
     def send_email_change(
       id:,
       new_email:,
+      locale: nil,
       request_options: {}
     )
       body = {
-        "new_email" => new_email
-      }
+        "new_email" => new_email,
+        "locale" => locale
+      }.compact
       response = @client.request(
         method: :post,
         path: "/user_management/users/#{WorkOS::Util.encode_path(id)}/email_change/send",
@@ -1258,16 +1264,22 @@ module WorkOS
 
     # Send verification email
     # @param id [String] The ID of the user.
+    # @param locale [WorkOS::Types::SendVerificationEmailLocale, nil] The locale to use when rendering the verification email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::SendVerificationEmailResponse]
     def send_verification_email(
       id:,
+      locale: nil,
       request_options: {}
     )
+      body = {
+        "locale" => locale
+      }.compact
       response = @client.request(
         method: :post,
         path: "/user_management/users/#{WorkOS::Util.encode_path(id)}/email_verification/send",
         auth: true,
+        body: body,
         request_options: request_options
       )
       result = WorkOS::SendVerificationEmailResponse.new(response.body)
@@ -1398,7 +1410,7 @@ module WorkOS
     # @param role_slug [String, nil] The [role](https://workos.com/docs/authkit/roles) that the recipient will receive when they join the organization in the invitation.
     # @param expires_in_days [Integer, nil] How many days the invitations will be valid for. Must be between 1 and 30 days. Defaults to 7 days if not specified.
     # @param inviter_user_id [String, nil] The ID of the [user](https://workos.com/docs/reference/authkit/user) who invites the recipient. The invitation email will mention the name of this user.
-    # @param locale [WorkOS::Types::CreateUserInviteOptionsLocale, nil] The locale to use when rendering the invitation email. See [supported locales](https://workos.com/docs/authkit/hosted-ui/localization).
+    # @param locale [WorkOS::Types::CreateUserInviteOptionsLocale, nil] The locale to use when rendering the invitation email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::UserInvite]
     def send_invitation(
@@ -1489,7 +1501,7 @@ module WorkOS
 
     # Resend an invitation
     # @param id [String] The unique ID of the invitation.
-    # @param locale [WorkOS::Types::ResendUserInviteOptionsLocale, nil] The locale to use when rendering the invitation email. See [supported locales](https://workos.com/docs/authkit/hosted-ui/localization).
+    # @param locale [WorkOS::Types::ResendUserInviteOptionsLocale, nil] The locale to use when rendering the invitation email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::UserInvite]
     def resend_invitation(
@@ -1572,10 +1584,11 @@ module WorkOS
     # Create a Magic Auth code
     # @param email [String] The email address to send the magic code to.
     # @param invitation_token [String, nil] The invitation token to associate with this magic code.
-    # @param ip_address [String, nil] The IP address of the user's request.
+    # @param ip_address [String, nil] The IP address of the user's request. Required when Radar is in Decision mode.
     # @param user_agent [String, nil] The user agent string from the user's request.
     # @param radar_auth_attempt_id [String, nil] The ID of an existing Radar authentication attempt to associate with this request.
     # @param signals_id [String, nil] An optional Radar signals ID to correlate client-side signals with this request.
+    # @param locale [WorkOS::Types::CreateMagicCodeAndReturnLocale, nil] The locale to use when rendering the Magic Auth email. Defaults to the environment's default locale. See [supported locales](https://workos.com/docs/authkit/hosted-ui#localization).
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::MagicAuthSendMagicAuthCodeAndReturnResponse]
     def create_magic_auth(
@@ -1585,6 +1598,7 @@ module WorkOS
       user_agent: nil,
       radar_auth_attempt_id: nil,
       signals_id: nil,
+      locale: nil,
       request_options: {}
     )
       body = {
@@ -1593,7 +1607,8 @@ module WorkOS
         "ip_address" => ip_address,
         "user_agent" => user_agent,
         "radar_auth_attempt_id" => radar_auth_attempt_id,
-        "signals_id" => signals_id
+        "signals_id" => signals_id,
+        "locale" => locale
       }.compact
       response = @client.request(
         method: :post,

data/lib/workos/vault/vault_dek_rekeyed.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class VaultDekRekeyed < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::VaultDekRekeyedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/vault/vault_dek_rekeyed_data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class VaultDekRekeyedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      actor_id: :actor_id,
+      actor_source: :actor_source,
+      actor_name: :actor_name,
+      key_ids: :key_ids,
+      key_context: :key_context
+    }.freeze
+
+    attr_accessor \
+      :actor_id,
+      :actor_source,
+      :actor_name,
+      :key_ids,
+      :key_context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @actor_id = hash[:actor_id]
+      @actor_source = hash[:actor_source]
+      @actor_name = hash[:actor_name]
+      @key_ids = hash[:key_ids] || []
+      @key_context = hash[:key_context] || {}
+    end
+  end
+end

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 
 # @oagen-ignore-file
 module WorkOS
-  VERSION = "10.4.0"
+  VERSION = "10.6.0"
 end

data/rbi/workos/access_denied_oauth_error_body.rbi

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AccessDeniedOAuthErrorBody
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def error; end
+
+    sig { params(value: String).returns(String) }
+    def error=(value); end
+
+    sig { returns(String) }
+    def error_description; end
+
+    sig { params(value: String).returns(String) }
+    def error_description=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/account_selection_required_error_body.rbi

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AccountSelectionRequiredErrorBody
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def code; end
+
+    sig { params(value: String).returns(String) }
+    def code=(value); end
+
+    sig { returns(String) }
+    def message; end
+
+    sig { params(value: String).returns(String) }
+    def message=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/action_denied_error_body.rbi

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class ActionDeniedErrorBody
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def code; end
+
+    sig { params(value: String).returns(String) }
+    def code=(value); end
+
+    sig { returns(String) }
+    def message; end
+
+    sig { params(value: String).returns(String) }
+    def message=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/admin_portal.rbi

@@ -14,12 +14,22 @@ module WorkOS
         organization: String,
         return_url: T.nilable(String),
         success_url: T.nilable(String),
+        external_user_id: T.nilable(String),
         intent: T.nilable(String),
         it_contact_emails: T.nilable(T::Array[String]),
         request_options: T::Hash[Symbol, T.untyped]
       ).returns(WorkOS::PortalLinkResponse)
     end
-    def generate_link(organization:, return_url:, success_url:, intent:, it_contact_emails:, request_options:); end
+    def generate_link(organization:, return_url: nil, success_url: nil, external_user_id: nil, intent: nil, it_contact_emails: nil, request_options: {}); end
+
+    sig do
+      params(
+        organization: String,
+        external_user_id: String,
+        request_options: T::Hash[Symbol, T.untyped]
+      ).returns(NilClass)
+    end
+    def revoke_link(organization:, external_user_id:, request_options: {}); end
 
   end
 end

data/rbi/workos/agent_blueprint.rbi

@@ -45,6 +45,12 @@ module WorkOS
     sig { params(value: WorkOS::AgentBlueprintInvocableBy).returns(WorkOS::AgentBlueprintInvocableBy) }
     def invocable_by=(value); end
 
+    sig { returns(WorkOS::AgentBlueprintInvocableAs) }
+    def invocable_as; end
+
+    sig { params(value: WorkOS::AgentBlueprintInvocableAs).returns(WorkOS::AgentBlueprintInvocableAs) }
+    def invocable_as=(value); end
+
     sig { returns(WorkOS::AgentBlueprintSessionSetting) }
     def session_settings; end
 

data/rbi/workos/agent_blueprint_created_data.rbi

@@ -45,6 +45,12 @@ module WorkOS
     sig { params(value: WorkOS::AgentBlueprintCreatedDataInvocableBy).returns(WorkOS::AgentBlueprintCreatedDataInvocableBy) }
     def invocable_by=(value); end
 
+    sig { returns(WorkOS::AgentBlueprintCreatedDataInvocableAs) }
+    def invocable_as; end
+
+    sig { params(value: WorkOS::AgentBlueprintCreatedDataInvocableAs).returns(WorkOS::AgentBlueprintCreatedDataInvocableAs) }
+    def invocable_as=(value); end
+
     sig { returns(WorkOS::AgentBlueprintCreatedDataSessionSetting) }
     def session_settings; end
 

data/rbi/workos/agent_blueprint_created_data_invocable_as.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintCreatedDataInvocableAs
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T::Array[String]) }
+    def instance_types; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def instance_types=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_blueprint_invocable_as.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintInvocableAs
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T::Array[String]) }
+    def instance_types; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def instance_types=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_blueprint_updated_data.rbi

@@ -45,6 +45,12 @@ module WorkOS
     sig { params(value: WorkOS::AgentBlueprintUpdatedDataInvocableBy).returns(WorkOS::AgentBlueprintUpdatedDataInvocableBy) }
     def invocable_by=(value); end
 
+    sig { returns(WorkOS::AgentBlueprintUpdatedDataInvocableAs) }
+    def invocable_as; end
+
+    sig { params(value: WorkOS::AgentBlueprintUpdatedDataInvocableAs).returns(WorkOS::AgentBlueprintUpdatedDataInvocableAs) }
+    def invocable_as=(value); end
+
     sig { returns(WorkOS::AgentBlueprintUpdatedDataSessionSetting) }
     def session_settings; end
 

data/rbi/workos/agent_blueprint_updated_data_invocable_as.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintUpdatedDataInvocableAs
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T::Array[String]) }
+    def instance_types; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def instance_types=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_blueprints_create_request.rbi

@@ -33,6 +33,12 @@ module WorkOS
     sig { params(value: T.nilable(WorkOS::AgentBlueprintsCreateRequestInvocableBy)).returns(T.nilable(WorkOS::AgentBlueprintsCreateRequestInvocableBy)) }
     def invocable_by=(value); end
 
+    sig { returns(T.nilable(WorkOS::AgentBlueprintsCreateRequestInvocableAs)) }
+    def invocable_as; end
+
+    sig { params(value: T.nilable(WorkOS::AgentBlueprintsCreateRequestInvocableAs)).returns(T.nilable(WorkOS::AgentBlueprintsCreateRequestInvocableAs)) }
+    def invocable_as=(value); end
+
     sig { returns(T.nilable(WorkOS::AgentBlueprintsCreateRequestSessionSetting)) }
     def session_settings; end
 

data/rbi/workos/agent_blueprints_create_request_invocable_as.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintsCreateRequestInvocableAs
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def instance_types; end
+
+    sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+    def instance_types=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_blueprints_update_request.rbi

@@ -33,6 +33,12 @@ module WorkOS
     sig { params(value: T.nilable(WorkOS::AgentBlueprintsUpdateRequestInvocableBy)).returns(T.nilable(WorkOS::AgentBlueprintsUpdateRequestInvocableBy)) }
     def invocable_by=(value); end
 
+    sig { returns(T.nilable(WorkOS::AgentBlueprintsUpdateRequestInvocableAs)) }
+    def invocable_as; end
+
+    sig { params(value: T.nilable(WorkOS::AgentBlueprintsUpdateRequestInvocableAs)).returns(T.nilable(WorkOS::AgentBlueprintsUpdateRequestInvocableAs)) }
+    def invocable_as=(value); end
+
     sig { returns(T.nilable(WorkOS::AgentBlueprintsUpdateRequestSessionSetting)) }
     def session_settings; end
 

data/rbi/workos/agent_blueprints_update_request_invocable_as.rbi

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintsUpdateRequestInvocableAs
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def instance_types; end
+
+    sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+    def instance_types=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_registration.rbi

@@ -33,6 +33,12 @@ module WorkOS
     sig { params(value: String).returns(String) }
     def status=(value); end
 
+    sig { returns(T.nilable(String)) }
+    def revoked_at; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def revoked_at=(value); end
+
     sig { returns(String) }
     def kind; end