Class: TripletexRubyClient::MobileAppLogin

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/mobile_app_login.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MobileAppLogin

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 59

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?(:'username')
    self.username = attributes[:'username']
  end

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

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

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

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

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

Instance Attribute Details

#app_secret ⇒ Object

App secret



22
23
24
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 22

def app_secret
  @app_secret
end

#employee_id ⇒ Object

Optional employee ID. Default employee is used when null



31
32
33
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 31

def employee_id
  @employee_id
end

#expiration_date ⇒ Object

Expiration date for the combined token



28
29
30
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 28

def expiration_date
  @expiration_date
end

#mfa_code ⇒ Object

Optional mfa auth code



25
26
27
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 25

def mfa_code
  @mfa_code
end

#password ⇒ Object

Users password



19
20
21
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 19

def password
  @password
end

#username ⇒ Object

Users username (email)



16
17
18
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 16

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 34

def self.attribute_map
  {
    :'username' => :'username',
    :'password' => :'password',
    :'app_secret' => :'appSecret',
    :'mfa_code' => :'mfaCode',
    :'expiration_date' => :'expirationDate',
    :'employee_id' => :'employeeId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 46

def self.swagger_types
  {
    :'username' => :'String',
    :'password' => :'String',
    :'app_secret' => :'String',
    :'mfa_code' => :'Integer',
    :'expiration_date' => :'String',
    :'employee_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      username == o.username &&
      password == o.password &&
      app_secret == o.app_secret &&
      mfa_code == o.mfa_code &&
      expiration_date == o.expiration_date &&
      employee_id == o.employee_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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 172

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 = TripletexRubyClient.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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 238

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 151

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


138
139
140
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 144

def hash
  [username, password, app_secret, mfa_code, expiration_date, employee_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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 92

def list_invalid_properties
  invalid_properties = Array.new
  if @username.nil?
    invalid_properties.push('invalid value for "username", username cannot be nil.')
  end

  if @password.nil?
    invalid_properties.push('invalid value for "password", password cannot be nil.')
  end

  if @app_secret.nil?
    invalid_properties.push('invalid value for "app_secret", app_secret cannot be nil.')
  end

  if @expiration_date.nil?
    invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
  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



218
219
220
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 218

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



224
225
226
227
228
229
230
231
232
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 224

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



212
213
214
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 212

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



115
116
117
118
119
120
121
 
# File 'lib/tripletex_ruby_client/models/mobile_app_login.rb', line 115

def valid?
  return false if @username.nil?
  return false if @password.nil?
  return false if @app_secret.nil?
  return false if @expiration_date.nil?
  true
end