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
64
 
# 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)
    @locale = params.dig(:locale)
    @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 



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

def accounting_role_code_def_id
  @accounting_role_code_def_id
end

#accounting_role_code_definition ⇒ CodeDefinitionModel 



200
201
202
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 200

def accounting_role_code_definition
  @accounting_role_code_definition
end

#address1 ⇒ String 



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

def address1
  @address1
end

#address2 ⇒ String 



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

def address2
  @address2
end

#address3 ⇒ String 



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

def address3
  @address3
end

#attachments ⇒ AttachmentModel 



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

def attachments
  @attachments
end

#b2_clast_logged_in ⇒ Date-time 



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

def b2_clast_logged_in
  @b2_clast_logged_in
end

#b2_cuser_id ⇒ Uuid 



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

def b2_cuser_id
  @b2_cuser_id
end

#city ⇒ String 



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

def city
  @city
end

#country ⇒ String 



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

def country
  @country
end

#created ⇒ Date-time 



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

def created
  @created
end

#created_user_id ⇒ Uuid 



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

def created_user_id
  @created_user_id
end

#custom_field_values ⇒ CustomFieldValueModel 



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

def custom_field_values
  @custom_field_values
end

#default_currency_code ⇒ String 



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

def default_currency_code
  @default_currency_code
end

#description ⇒ String 



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

def description
  @description
end

#email ⇒ Email 



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

def email
  @email
end

#fax_number ⇒ String 



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

def fax_number
  @fax_number
end

#group_key ⇒ Uuid 



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

def group_key
  @group_key
end

#image_url ⇒ String 



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

def image_url
  @image_url
end

#invite_sent ⇒ Date-time 



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

def invite_sent
  @invite_sent
end

#locale ⇒ String 



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

def locale
  @locale
end

#modified ⇒ Date-time 



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

def modified
  @modified
end

#modified_user_id ⇒ Uuid 



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

def modified_user_id
  @modified_user_id
end

#modified_user_name ⇒ String 



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

def modified_user_name
  @modified_user_name
end

#notes ⇒ NoteModel 



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

def notes
  @notes
end

#phone_number ⇒ String 



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

def phone_number
  @phone_number
end

#postal_code ⇒ String 



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

def postal_code
  @postal_code
end

#state_region ⇒ String 



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

def state_region
  @state_region
end

#status ⇒ String 



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

def status
  @status
end

#time_zone ⇒ String 



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

def time_zone
  @time_zone
end

#title ⇒ String 



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

def title
  @title
end

#user_id ⇒ Uuid 



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

def user_id
  @user_id
end

#user_name ⇒ String 



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

def user_name
  @user_name
end

#user_role ⇒ Uuid 



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

def user_role
  @user_role
end

Instance Method Details

#as_json(options = {}) ⇒ object 



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
236
237
238
239
240
241
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 204

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,
        'locale' => @locale,
        'notes' => @notes,
        'attachments' => @attachments,
        'customFieldValues' => @custom_field_values,
        'accountingRoleCodeDefinition' => @accounting_role_code_definition,
    }
end

#to_json(*options) ⇒ String 



245
246
247
 
# File 'lib/lockstep_sdk/models/user_account_model.rb', line 245

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