Class: PlatformAPI::PasswordReset

Inherits:

Object

• Object
• PlatformAPI::PasswordReset

Defined in:

lib/platform-api/client.rb

Overview

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

Instance Method Summary

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

  Complete password reset.

• #initialize(client) ⇒ PasswordReset constructor

  A new instance of PasswordReset.

• #reset_password(body = {}) ⇒ Object

  Reset account's password.

Constructor Details

#initialize(client) ⇒ PasswordReset

Returns a new instance of PasswordReset.

# File 'lib/platform-api/client.rb', line 2428

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

# File 'lib/platform-api/client.rb', line 2443

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

# File 'lib/platform-api/client.rb', line 2435

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