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



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
62
63
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 29

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)
    @time_zone = params.dig(:time_zone)
    @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_id ⇒ Uuid 



131
132
133
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 131

def accounting_role_code_def_id
  @accounting_role_code_def_id
end

#accounting_role_code_definition ⇒ CodeDefinitionModel 



195
196
197
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 195

def accounting_role_code_definition
  @accounting_role_code_definition
end

#address1 ⇒ String 



135
136
137
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 135

def address1
  @address1
end

#address2 ⇒ String 



139
140
141
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 139

def address2
  @address2
end

#address3 ⇒ String 



143
144
145
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 143

def address3
  @address3
end

#attachments ⇒ AttachmentModel 



187
188
189
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 187

def attachments
  @attachments
end

#b2_clast_logged_in ⇒ Date-time 



175
176
177
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 175

def b2_clast_logged_in
  @b2_clast_logged_in
end

#b2_cuser_id ⇒ Uuid 



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

def b2_cuser_id
  @b2_cuser_id
end

#city ⇒ String 



147
148
149
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 147

def city
  @city
end

#country ⇒ String 



159
160
161
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 159

def country
  @country
end

#created ⇒ Date-time 



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

def created
  @created
end

#created_user_id ⇒ Uuid 



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

def created_user_id
  @created_user_id
end

#custom_field_values ⇒ CustomFieldValueModel 



191
192
193
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 191

def custom_field_values
  @custom_field_values
end

#default_currency_code ⇒ String 



179
180
181
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 179

def default_currency_code
  @default_currency_code
end

#description ⇒ String 



171
172
173
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 171

def description
  @description
end

#email ⇒ Email 



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

def email
  @email
end

#fax_number ⇒ String 



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

def fax_number
  @fax_number
end

#group_key ⇒ Uuid 



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

def group_key
  @group_key
end

#image_url ⇒ String 



167
168
169
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 167

def image_url
  @image_url
end

#invite_sent ⇒ Date-time 



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

def invite_sent
  @invite_sent
end

#modified ⇒ Date-time 



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

def modified
  @modified
end

#modified_user_id ⇒ Uuid 



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

def modified_user_id
  @modified_user_id
end

#modified_user_name ⇒ String 



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

def modified_user_name
  @modified_user_name
end

#notes ⇒ NoteModel 



183
184
185
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 183

def notes
  @notes
end

#phone_number ⇒ String 



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

def phone_number
  @phone_number
end

#postal_code ⇒ String 



155
156
157
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 155

def postal_code
  @postal_code
end

#state_region ⇒ String 



151
152
153
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 151

def state_region
  @state_region
end

#status ⇒ String 



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

def status
  @status
end

#time_zone ⇒ String 



163
164
165
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 163

def time_zone
  @time_zone
end

#title ⇒ String 



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

def title
  @title
end

#user_id ⇒ Uuid 



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

def user_id
  @user_id
end

#user_name ⇒ String 



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

def user_name
  @user_name
end

#user_role ⇒ Uuid 



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

def user_role
  @user_role
end

Instance Method Details

#as_json(options = {}) ⇒ object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 199

def as_json(options={})
    {
        'userId' => @user_id,
        'groupKey' => @group_key,
        'userName' => @user_name,
        'email' => @email,
        'status' => @status,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'modifiedUserName' => @modified_user_name,
        'b2CUserId' => @b2_cuser_id,
        'userRole' => @user_role,
        'inviteSent' => @invite_sent,
        'phoneNumber' => @phone_number,
        'faxNumber' => @fax_number,
        'title' => @title,
        'accountingRoleCodeDefId' => @accounting_role_code_def_id,
        'address1' => @address1,
        'address2' => @address2,
        'address3' => @address3,
        'city' => @city,
        'stateRegion' => @state_region,
        'postalCode' => @postal_code,
        'country' => @country,
        'timeZone' => @time_zone,
        'imageURL' => @image_url,
        'description' => @description,
        'b2CLastLoggedIn' => @b2_clast_logged_in,
        'defaultCurrencyCode' => @default_currency_code,
        'notes' => @notes,
        'attachments' => @attachments,
        'customFieldValues' => @custom_field_values,
        'accountingRoleCodeDefinition' => @accounting_role_code_definition,
    }
end

#to_json(*options) ⇒ String 



239
240
241
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 239

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