Class: PlatformAPI::PasswordReset

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A password reset represents a in-process password reset attempt.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PasswordReset

Returns a new instance of PasswordReset.


2025
2026
2027
# File 'lib/platform-api/client.rb', line 2025

def initialize(client)
  @client = client
end

Instance Method Details

#complete_reset_password(password_reset_reset_password_token, body = {}) ⇒ Object

Complete password reset.

Parameters:

  • password_reset_reset_password_token:

    unique identifier of a password reset attempt

  • body:

    the object to pass as the request payload


2040
2041
2042
# File 'lib/platform-api/client.rb', line 2040

def complete_reset_password(password_reset_reset_password_token, body = {})
  @client.password_reset.complete_reset_password(password_reset_reset_password_token, body)
end

#reset_password(body = {}) ⇒ Object

Reset account's password. This will send a reset password link to the user's email address.

Parameters:

  • body:

    the object to pass as the request payload


2032
2033
2034
# File 'lib/platform-api/client.rb', line 2032

def reset_password(body = {})
  @client.password_reset.reset_password(body)
end