Class: LockstepSdk::InviteDataModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/invite_data_model.rb

Overview

Model containing information about a user for the invite/onboarding process.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ InviteDataModel

Initialize the InviteDataModel using the provided prototype



26
27
28
29
# File 'lib/lockstep_sdk/models/invite_data_model.rb', line 26

def initialize(params = {})
    @email = params.dig(:email)
    @user_status = params.dig(:user_status)
end

Instance Attribute Details

#emailString

Returns The email address of the invited user.

Returns:

  • (String)

    The email address of the invited user.



32
33
34
# File 'lib/lockstep_sdk/models/invite_data_model.rb', line 32

def email
  @email
end

#user_statusString

Returns The status of the user.

Returns:

  • (String)

    The status of the user.



34
35
36
# File 'lib/lockstep_sdk/models/invite_data_model.rb', line 34

def user_status
  @user_status
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object)

    This object as a JSON key-value structure



37
38
39
40
41
42
# File 'lib/lockstep_sdk/models/invite_data_model.rb', line 37

def as_json(options={})
    {
        'email' => @email,
        'userStatus' => @user_status,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String)

    This object converted to a JSON string



45
46
47
# File 'lib/lockstep_sdk/models/invite_data_model.rb', line 45

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end