Class: LockstepSdk::InviteModel
- Inherits:
-
Object
- Object
- LockstepSdk::InviteModel
- Defined in:
- lib/lockstep_sdk/models/invite_model.rb
Overview
Model from the User invite process
Instance Attribute Summary collapse
-
#email ⇒ String
The invited email address.
-
#error_message ⇒ String
The error message if the invite was not successful.
-
#invited_user ⇒ UserAccountModel
The invited user, may be null if the user could not be invited.
-
#success ⇒ Boolean
True if the invite was sent successfully.
Instance Method Summary collapse
-
#initialize(params = {}) ⇒ InviteModel
constructor
Initialize the InviteModel using the provided prototype.
Constructor Details
#initialize(params = {}) ⇒ InviteModel
Initialize the InviteModel using the provided prototype
24 25 26 27 28 29 |
# File 'lib/lockstep_sdk/models/invite_model.rb', line 24 def initialize(params = {}) @email = params.dig(:email) @success = params.dig(:success) @invited_user = params.dig(:invited_user) @error_message = params.dig(:error_message) end |
Instance Attribute Details
#email ⇒ String
Returns The invited email address.
32 33 34 |
# File 'lib/lockstep_sdk/models/invite_model.rb', line 32 def email @email end |
#error_message ⇒ String
Returns The error message if the invite was not successful.
38 39 40 |
# File 'lib/lockstep_sdk/models/invite_model.rb', line 38 def @error_message end |
#invited_user ⇒ UserAccountModel
Returns The invited user, may be null if the user could not be invited.
36 37 38 |
# File 'lib/lockstep_sdk/models/invite_model.rb', line 36 def invited_user @invited_user end |
#success ⇒ Boolean
Returns True if the invite was sent successfully.
34 35 36 |
# File 'lib/lockstep_sdk/models/invite_model.rb', line 34 def success @success end |