Class: Zype::Consumers

Inherits:
BaseModel show all
Defined in:
lib/zype/models/consumers.rb

Overview

Read more at docs.zype.com/v1.0/reference#consumers

Since:

  • 0.15.0

Constant Summary

Constants inherited from BaseModel

BaseModel::ACCEPTED_KEYS

Instance Attribute Summary

Attributes inherited from BaseModel

#client, #path

Instance Method Summary collapse

Methods inherited from BaseModel

#all, #auth=, #create, #delete, #find, #initialize, #update

Constructor Details

This class inherits a constructor from Zype::BaseModel

Instance Method Details

#forgot_password(email:) ⇒ Hash

Initiate consumer forgot password flow. Consumer will receive forgot password email.

Parameters:

  • email (String) —

    email of the consumer

Returns:

  • (Hash) —

    the consumer returned from the API

Since:

  • 0.15.0



11
12
13
 
# File 'lib/zype/models/consumers.rb', line 11

def forgot_password(email:)
  client.execute(method: :put, path: "/#{path}/forgot_password", params: { email: email })
end