Class: XeroRuby::Accounting::User

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/user.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

READONLY =
"READONLY".freeze
INVOICEONLY =
"INVOICEONLY".freeze
STANDARD =
"STANDARD".freeze
FINANCIALADVISER =
"FINANCIALADVISER".freeze
MANAGEDCLIENT =
"MANAGEDCLIENT".freeze
CASHBOOKCLIENT =
"CASHBOOKCLIENT".freeze
UNKNOWN =
"UNKNOWN".freeze

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


97
98
99
100
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
# File 'lib/xero-ruby/models/accounting/user.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::User` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::User`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'updated_date_utc')
    self.updated_date_utc = attributes[:'updated_date_utc']
  end

  if attributes.key?(:'is_subscriber')
    self.is_subscriber = attributes[:'is_subscriber']
  end

  if attributes.key?(:'organisation_role')
    self.organisation_role = attributes[:'organisation_role']
  end
end

Instance Attribute Details

#email_addressObject

Email address of user


23
24
25
# File 'lib/xero-ruby/models/accounting/user.rb', line 23

def email_address
  @email_address
end

#first_nameObject

First name of user


26
27
28
# File 'lib/xero-ruby/models/accounting/user.rb', line 26

def first_name
  @first_name
end

#is_subscriberObject

Boolean to indicate if user is the subscriber


35
36
37
# File 'lib/xero-ruby/models/accounting/user.rb', line 35

def is_subscriber
  @is_subscriber
end

#last_nameObject

Last name of user


29
30
31
# File 'lib/xero-ruby/models/accounting/user.rb', line 29

def last_name
  @last_name
end

#organisation_roleObject

User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc)


38
39
40
# File 'lib/xero-ruby/models/accounting/user.rb', line 38

def organisation_role
  @organisation_role
end

#updated_date_utcObject

Timestamp of last change to user


32
33
34
# File 'lib/xero-ruby/models/accounting/user.rb', line 32

def updated_date_utc
  @updated_date_utc
end

#user_idObject

Xero identifier


20
21
22
# File 'lib/xero-ruby/models/accounting/user.rb', line 20

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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


70
71
72
73
74
75
76
77
78
79
80
# File 'lib/xero-ruby/models/accounting/user.rb', line 70

def self.attribute_map
  {
    :'user_id' => :'UserID',
    :'email_address' => :'EmailAddress',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'is_subscriber' => :'IsSubscriber',
    :'organisation_role' => :'OrganisationRole'
  }
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


193
194
195
# File 'lib/xero-ruby/models/accounting/user.rb', line 193

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


83
84
85
86
87
88
89
90
91
92
93
# File 'lib/xero-ruby/models/accounting/user.rb', line 83

def self.openapi_types
  {
    :'user_id' => :'String',
    :'email_address' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'is_subscriber' => :'Boolean',
    :'organisation_role' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


166
167
168
169
170
171
172
173
174
175
176
# File 'lib/xero-ruby/models/accounting/user.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      email_address == o.email_address &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      updated_date_utc == o.updated_date_utc &&
      is_subscriber == o.is_subscriber &&
      organisation_role == o.organisation_role
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


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/xero-ruby/models/accounting/user.rb', line 221

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/xero-ruby/models/accounting/user.rb', line 294

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/xero-ruby/models/accounting/user.rb', line 200

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

180
181
182
# File 'lib/xero-ruby/models/accounting/user.rb', line 180

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


186
187
188
# File 'lib/xero-ruby/models/accounting/user.rb', line 186

def hash
  [user_id, email_address, first_name, last_name, updated_date_utc, is_subscriber, organisation_role].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


141
142
143
144
# File 'lib/xero-ruby/models/accounting/user.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


310
311
312
313
314
315
316
317
318
319
# File 'lib/xero-ruby/models/accounting/user.rb', line 310

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


286
287
288
# File 'lib/xero-ruby/models/accounting/user.rb', line 286

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


268
269
270
# File 'lib/xero-ruby/models/accounting/user.rb', line 268

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


274
275
276
277
278
279
280
281
282
283
# File 'lib/xero-ruby/models/accounting/user.rb', line 274

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


262
263
264
# File 'lib/xero-ruby/models/accounting/user.rb', line 262

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


148
149
150
151
152
# File 'lib/xero-ruby/models/accounting/user.rb', line 148

def valid?
  organisation_role_validator = EnumAttributeValidator.new('String', ["READONLY", "INVOICEONLY", "STANDARD", "FINANCIALADVISER", "MANAGEDCLIENT", "CASHBOOKCLIENT", "UNKNOWN"])
  return false unless organisation_role_validator.valid?(@organisation_role)
  true
end