class PlatformAPI::PasswordReset

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

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2309
def initialize(client)
  @client = client
end

Public Instance Methods

complete_reset_password(password_reset_reset_password_token, body = {}) click to toggle source

Complete password reset.

@param password_reset_reset_password_token: unique identifier of a password reset attempt @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2324
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 = {}) click to toggle source

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

@param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2316
def reset_password(body = {})
  @client.password_reset.reset_password(body)
end