Class: LockstepSdk::UserRoleModel

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

Overview

Represents a role for a user

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ UserRoleModel

Initialize the UserRoleModel using the provided prototype



27
28
29
30
31
32
33
34
35
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 27

def initialize(params = {})
    @user_role_id = params.dig(:user_role_id)
    @group_key = params.dig(:group_key)
    @user_role_name = params.dig(:user_role_name)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#created ⇒ Date-time

Returns The date that the user role was created.

Returns:

  • (Date-time) —

    The date that the user role was created



51
52
53
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 51

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created the user role.

Returns:

  • (Uuid) —

    The ID of the user who created the user role



55
56
57
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 55

def created_user_id
  @created_user_id
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



43
44
45
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 43

def group_key
  @group_key
end

#modified ⇒ Date-time

Returns The date the user role was last modified.

Returns:

  • (Date-time) —

    The date the user role was last modified



59
60
61
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 59

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified the user role.

Returns:

  • (Uuid) —

    The ID of the user who last modified the user role



63
64
65
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 63

def modified_user_id
  @modified_user_id
end

#user_role_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



39
40
41
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 39

def user_role_id
  @user_role_id
end

#user_role_name ⇒ String

Returns The name of the user role.

Returns:

  • (String) —

    The name of the user role



47
48
49
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 47

def user_role_name
  @user_role_name
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



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 67

def as_json(options={})
    {
        'userRoleId' => @user_role_id,
        'groupKey' => @group_key,
        'userRoleName' => @user_role_name,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



81
82
83
 
# File 'lib/lockstep_sdk/models/user_role_model.rb', line 81

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