Class: UltracartClient::User

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/ultracart_api/models/user.rb', line 101

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'api_ip_address_masks')
    if (value = attributes[:'api_ip_address_masks']).is_a?(Array)
      self.api_ip_address_masks = value
    end
  end

  if attributes.has_key?(:'change_ftp_password_to')
    self.change_ftp_password_to = attributes[:'change_ftp_password_to']
  end

  if attributes.has_key?(:'change_password_to')
    self.change_password_to = attributes[:'change_password_to']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'full_name')
    self.full_name = attributes[:'full_name']
  end

  if attributes.has_key?(:'groups')
    if (value = attributes[:'groups']).is_a?(Array)
      self.groups = value
    end
  end

  if attributes.has_key?(:'linked_accounts')
    if (value = attributes[:'linked_accounts']).is_a?(Array)
      self.linked_accounts = value
    end
  end

  if attributes.has_key?(:'login')
    self. = attributes[:'login']
  end

  if attributes.has_key?(:'login_histories')
    if (value = attributes[:'login_histories']).is_a?(Array)
      self. = value
    end
  end

  if attributes.has_key?(:'notifications')
    if (value = attributes[:'notifications']).is_a?(Array)
      self.notifications = value
    end
  end

  if attributes.has_key?(:'otp_serial_number')
    self.otp_serial_number = attributes[:'otp_serial_number']
  end

  if attributes.has_key?(:'permissions')
    if (value = attributes[:'permissions']).is_a?(Array)
      self.permissions = value
    end
  end

  if attributes.has_key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.has_key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end
end

Instance Attribute Details

#api_ip_address_masks ⇒ Object

A list of IP addresses whitelisted for any user with API Access permission. Without this list, each ip address must be authenticated by a user, which can be a pain for some servers.



18
19
20
 
# File 'lib/ultracart_api/models/user.rb', line 18

def api_ip_address_masks
  @api_ip_address_masks
end

#change_ftp_password_to ⇒ Object

Supply a new FTP password using this field. Password are stored using one-way encryption, so they are never available anywhere in the system. The FTP password cannot be the same as the normal password.



21
22
23
 
# File 'lib/ultracart_api/models/user.rb', line 21

def change_ftp_password_to
  @change_ftp_password_to
end

#change_password_to ⇒ Object

Supply a new password using this field. Password are stored using one-way encryption, so they are never available anywhere in the system.



24
25
26
 
# File 'lib/ultracart_api/models/user.rb', line 24

def change_password_to
  @change_password_to
end

#email ⇒ Object

Email address of user



27
28
29
 
# File 'lib/ultracart_api/models/user.rb', line 27

def email
  @email
end

#full_name ⇒ Object

Full name of user. This is used solely for human assistance and so the UltraCart staff knows who they are calling when there is a problem.



30
31
32
 
# File 'lib/ultracart_api/models/user.rb', line 30

def full_name
  @full_name
end

#groups ⇒ Object

A list of groups for this merchant and whether or not this user is a member of those groups.



33
34
35
 
# File 'lib/ultracart_api/models/user.rb', line 33

def groups
  @groups
end

#linked_accounts ⇒ Object

A list of linked accounts and whether or not this user is mirrored to any of those accounts.



36
37
38
 
# File 'lib/ultracart_api/models/user.rb', line 36

def linked_accounts
  @linked_accounts
end

#login ⇒ Object

User name of user. Must be unique across a merchant account.



39
40
41
 
# File 'lib/ultracart_api/models/user.rb', line 39

def 
  @login
end

#login_histories ⇒ Object

A list of user logins over the past 90 days



42
43
44
 
# File 'lib/ultracart_api/models/user.rb', line 42

def 
  @login_histories
end

#notifications ⇒ Object

A list of notifications the user receives.



45
46
47
 
# File 'lib/ultracart_api/models/user.rb', line 45

def notifications
  @notifications
end

#otp_serial_number ⇒ Object

OTP Serial Number such as Google Authenticator or Crypto Card.



48
49
50
 
# File 'lib/ultracart_api/models/user.rb', line 48

def otp_serial_number
  @otp_serial_number
end

#permissions ⇒ Object

A list of permissions the user enjoys for accessing the backend of UltraCart.



51
52
53
 
# File 'lib/ultracart_api/models/user.rb', line 51

def permissions
  @permissions
end

#phone ⇒ Object

Phone number of user. Please supply a valid phone number. When something breaks on your account, we need to be able to reach you.



54
55
56
 
# File 'lib/ultracart_api/models/user.rb', line 54

def phone
  @phone
end

#user_id ⇒ Object

User id is a unique identifier for this user



57
58
59
 
# File 'lib/ultracart_api/models/user.rb', line 57

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ultracart_api/models/user.rb', line 60

def self.attribute_map
  {
    :'api_ip_address_masks' => :'api_ip_address_masks',
    :'change_ftp_password_to' => :'change_ftp_password_to',
    :'change_password_to' => :'change_password_to',
    :'email' => :'email',
    :'full_name' => :'full_name',
    :'groups' => :'groups',
    :'linked_accounts' => :'linked_accounts',
    :'login' => :'login',
    :'login_histories' => :'login_histories',
    :'notifications' => :'notifications',
    :'otp_serial_number' => :'otp_serial_number',
    :'permissions' => :'permissions',
    :'phone' => :'phone',
    :'user_id' => :'user_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ultracart_api/models/user.rb', line 80

def self.swagger_types
  {
    :'api_ip_address_masks' => :'Array<String>',
    :'change_ftp_password_to' => :'String',
    :'change_password_to' => :'String',
    :'email' => :'String',
    :'full_name' => :'String',
    :'groups' => :'Array<UserGroupMembership>',
    :'linked_accounts' => :'Array<LinkedAccount>',
    :'login' => :'String',
    :'login_histories' => :'Array<UserLogin>',
    :'notifications' => :'Array<Notification>',
    :'otp_serial_number' => :'String',
    :'permissions' => :'Array<Permission>',
    :'phone' => :'String',
    :'user_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/ultracart_api/models/user.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_ip_address_masks == o.api_ip_address_masks &&
      change_ftp_password_to == o.change_ftp_password_to &&
      change_password_to == o.change_password_to &&
      email == o.email &&
      full_name == o.full_name &&
      groups == o.groups &&
      linked_accounts == o.linked_accounts &&
       == o. &&
       == o. &&
      notifications == o.notifications &&
      otp_serial_number == o.otp_serial_number &&
      permissions == o.permissions &&
      phone == o.phone &&
      user_id == o.user_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/ultracart_api/models/user.rb', line 261

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/ultracart_api/models/user.rb', line 327

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ultracart_api/models/user.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/ultracart_api/models/user.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/ultracart_api/models/user.rb', line 233

def hash
  [api_ip_address_masks, change_ftp_password_to, change_password_to, email, full_name, groups, linked_accounts, , , notifications, otp_serial_number, permissions, phone, user_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



178
179
180
181
182
183
184
185
 
# File 'lib/ultracart_api/models/user.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  if !@email.nil? && @email.to_s.length > 150
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 150.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
 
# File 'lib/ultracart_api/models/user.rb', line 307

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
 
# File 'lib/ultracart_api/models/user.rb', line 313

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



301
302
303
 
# File 'lib/ultracart_api/models/user.rb', line 301

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
 
# File 'lib/ultracart_api/models/user.rb', line 189

def valid?
  return false if !@email.nil? && @email.to_s.length > 150
  true
end