Class: LockstepSdk::UserAccountModel

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

Overview

A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ UserAccountModel

Initialize the UserAccountModel using the provided prototype



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 28

def initialize(params = {})
    @user_id = params.dig(:user_id)
    @group_key = params.dig(:group_key)
    @user_name = params.dig(:user_name)
    @email = params.dig(:email)
    @status = params.dig(:status)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
    @modified_user_name = params.dig(:modified_user_name)
    @b2_cuser_id = params.dig(:b2_cuser_id)
    @user_role = params.dig(:user_role)
    @invite_sent = params.dig(:invite_sent)
    @phone_number = params.dig(:phone_number)
    @fax_number = params.dig(:fax_number)
    @title = params.dig(:title)
    @accounting_role_code_def_id = params.dig(:accounting_role_code_def_id)
    @address1 = params.dig(:address1)
    @address2 = params.dig(:address2)
    @address3 = params.dig(:address3)
    @city = params.dig(:city)
    @state_region = params.dig(:state_region)
    @postal_code = params.dig(:postal_code)
    @country = params.dig(:country)
    @image_url = params.dig(:image_url)
    @description = params.dig(:description)
    @b2_clast_logged_in = params.dig(:b2_clast_logged_in)
    @default_currency_code = params.dig(:default_currency_code)
    @notes = params.dig(:notes)
    @attachments = params.dig(:attachments)
    @custom_field_values = params.dig(:custom_field_values)
    @accounting_role_code_definition = params.dig(:accounting_role_code_definition)
end

Instance Attribute Details

#accounting_role_code_def_idUuid

Returns FK to the CodeDefinition table; CodeType = 'AccountingRole'.

Returns:

  • (Uuid)

    FK to the CodeDefinition table; CodeType = 'AccountingRole'



96
97
98
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 96

def accounting_role_code_def_id
  @accounting_role_code_def_id
end

#accounting_role_code_definitionCodeDefinitionModel

Returns Accounting role definition for this User. To retrieve this collection, specify `AccountingRole` in the “Include” parameter for your query.

Returns:

  • (CodeDefinitionModel)

    Accounting role definition for this User. To retrieve this collection, specify `AccountingRole` in the “Include” parameter for your query.



126
127
128
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 126

def accounting_role_code_definition
  @accounting_role_code_definition
end

#address1String

Returns Address Line 1 for this User.

Returns:

  • (String)

    Address Line 1 for this User



98
99
100
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 98

def address1
  @address1
end

#address2String

Returns Address Line 2 for this User.

Returns:

  • (String)

    Address Line 2 for this User



100
101
102
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 100

def address2
  @address2
end

#address3String

Returns Address Line 3 for this User.

Returns:

  • (String)

    Address Line 3 for this User



102
103
104
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 102

def address3
  @address3
end

#attachmentsAttachmentModel

Returns All attachments attached to this User. To retrieve this collection, specify `Attachments` in the “Include” parameter for your query.

Returns:

  • (AttachmentModel)

    All attachments attached to this User. To retrieve this collection, specify `Attachments` in the “Include” parameter for your query.



122
123
124
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 122

def attachments
  @attachments
end

#b2_clast_logged_inDate-time

Returns Last date time user logged into Azure B2C.

Returns:

  • (Date-time)

    Last date time user logged into Azure B2C.



116
117
118
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 116

def b2_clast_logged_in
  @b2_clast_logged_in
end

#b2_cuser_idUuid

Returns The ID of the user in Azure B2C.

Returns:

  • (Uuid)

    The ID of the user in Azure B2C



84
85
86
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 84

def b2_cuser_id
  @b2_cuser_id
end

#cityString

Returns City for this User.

Returns:

  • (String)

    City for this User



104
105
106
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 104

def city
  @city
end

#countryString

Returns Country for this User This will be validated by the /api/v1/countries data set.

Returns:

  • (String)

    Country for this User This will be validated by the /api/v1/countries data set



110
111
112
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 110

def country
  @country
end

#createdDate-time

Returns The date that the user account was created.

Returns:

  • (Date-time)

    The date that the user account was created



74
75
76
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 74

def created
  @created
end

#created_user_idUuid

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

Returns:

  • (Uuid)

    The ID of the user who created the user account



76
77
78
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 76

def created_user_id
  @created_user_id
end

#custom_field_valuesCustomFieldValueModel

Returns All values attached to this User. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.

Returns:

  • (CustomFieldValueModel)

    All values attached to this User. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.



124
125
126
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 124

def custom_field_values
  @custom_field_values
end

#default_currency_codeString

Returns The default currency code used by this user entity. This value can be overridden for invoices in a different currency code. For a list of defined currency codes, see [Query Currencies](developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/currencies data set.

Returns:



118
119
120
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 118

def default_currency_code
  @default_currency_code
end

#descriptionString

Returns Description for this User.

Returns:

  • (String)

    Description for this User.



114
115
116
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 114

def description
  @description
end

#emailEmail

Returns The email of the user.

Returns:

  • (Email)

    The email of the user



70
71
72
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 70

def email
  @email
end

#fax_numberString

Returns The fax number of the user.

Returns:

  • (String)

    The fax number of the user.



92
93
94
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 92

def fax_number
  @fax_number
end

#group_keyUuid

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).



66
67
68
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 66

def group_key
  @group_key
end

#image_urlString

Returns Image URL for this User.

Returns:

  • (String)

    Image URL for this User



112
113
114
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 112

def image_url
  @image_url
end

#invite_sentDate-time

Returns The date timestamp when the invite was sent to the user.

Returns:

  • (Date-time)

    The date timestamp when the invite was sent to the user.



88
89
90
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 88

def invite_sent
  @invite_sent
end

#modifiedDate-time

Returns The date the user account was last modified.

Returns:

  • (Date-time)

    The date the user account was last modified



78
79
80
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 78

def modified
  @modified
end

#modified_user_idUuid

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

Returns:

  • (Uuid)

    The ID of the user who last modified the user account



80
81
82
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 80

def modified_user_id
  @modified_user_id
end

#modified_user_nameString

Returns The name of the user who last modified the user account.

Returns:

  • (String)

    The name of the user who last modified the user account



82
83
84
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 82

def modified_user_name
  @modified_user_name
end

#notesNoteModel

Returns All notes attached to this User. To retrieve this collection, specify `Notes` in the “Include” parameter for your query.

Returns:

  • (NoteModel)

    All notes attached to this User. To retrieve this collection, specify `Notes` in the “Include” parameter for your query.



120
121
122
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 120

def notes
  @notes
end

#phone_numberString

Returns The phone number of the user.

Returns:

  • (String)

    The phone number of the user.



90
91
92
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 90

def phone_number
  @phone_number
end

#postal_codeString

Returns Postal Code this User.

Returns:

  • (String)

    Postal Code this User



108
109
110
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 108

def postal_code
  @postal_code
end

#state_regionString

Returns Region (“state” in the US) for this User.

Returns:

  • (String)

    Region (“state” in the US) for this User



106
107
108
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 106

def state_region
  @state_region
end

#statusString

Returns The status of the user's account.

Returns:

  • (String)

    The status of the user's account



72
73
74
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 72

def status
  @status
end

#titleString

Returns The title of the user; free text field.

Returns:

  • (String)

    The title of the user; free text field



94
95
96
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 94

def title
  @title
end

#user_idUuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. This record provides a link to the user's Azure AD B2C OID.

Returns:

  • (Uuid)

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. This record provides a link to the user's Azure AD B2C OID.



64
65
66
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 64

def user_id
  @user_id
end

#user_nameString

Returns The full name of the user.

Returns:

  • (String)

    The full name of the user



68
69
70
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 68

def user_name
  @user_name
end

#user_roleUuid

Returns The id of the Permission Level for the user.

Returns:

  • (Uuid)

    The id of the Permission Level for the user.



86
87
88
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 86

def user_role
  @user_role
end