Class: MxPlatformRuby::MemberResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/models/member_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MemberResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
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
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 183

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::MemberResponse` 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 `MxPlatformRuby::MemberResponse`. 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?(:'aggregated_at')
    self.aggregated_at = attributes[:'aggregated_at']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregated_at ⇒ Object

Returns the value of attribute aggregated_at.



18
19
20
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 18

def aggregated_at
  @aggregated_at
end

#background_aggregation_is_disabled ⇒ Object

Returns the value of attribute background_aggregation_is_disabled.



20
21
22
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 20

def background_aggregation_is_disabled
  @background_aggregation_is_disabled
end

#connection_status ⇒ Object

Returns the value of attribute connection_status.



22
23
24
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 22

def connection_status
  @connection_status
end

#connection_status_message ⇒ Object

Returns the value of attribute connection_status_message.



24
25
26
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 24

def connection_status_message
  @connection_status_message
end

#error ⇒ Object

Returns the value of attribute error.



26
27
28
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 26

def error
  @error
end

#guid ⇒ Object

Returns the value of attribute guid.



28
29
30
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 28

def guid
  @guid
end

#id ⇒ Object

Returns the value of attribute id.



30
31
32
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 30

def id
  @id
end

#institution_code ⇒ Object

Returns the value of attribute institution_code.



32
33
34
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 32

def institution_code
  @institution_code
end

#institution_guid ⇒ Object

Returns the value of attribute institution_guid.



34
35
36
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 34

def institution_guid
  @institution_guid
end

#is_being_aggregated ⇒ Object

Returns the value of attribute is_being_aggregated.



36
37
38
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 36

def is_being_aggregated
  @is_being_aggregated
end

#is_managed_by_user ⇒ Object

Returns the value of attribute is_managed_by_user.



38
39
40
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 38

def is_managed_by_user
  @is_managed_by_user
end

#is_manual ⇒ Object

Returns the value of attribute is_manual.



40
41
42
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 40

def is_manual
  @is_manual
end

#is_oauth ⇒ Object

Returns the value of attribute is_oauth.



42
43
44
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 42

def is_oauth
  @is_oauth
end

#metadata ⇒ Object

Returns the value of attribute metadata.



44
45
46
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 44

def metadata
  @metadata
end

#most_recent_job_detail_code ⇒ Object

Returns the value of attribute most_recent_job_detail_code.



46
47
48
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 46

def most_recent_job_detail_code
  @most_recent_job_detail_code
end

#most_recent_job_detail_text ⇒ Object

Returns the value of attribute most_recent_job_detail_text.



48
49
50
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 48

def most_recent_job_detail_text
  @most_recent_job_detail_text
end

#most_recent_job_guid ⇒ Object

Returns the value of attribute most_recent_job_guid.



50
51
52
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 50

def most_recent_job_guid
  @most_recent_job_guid
end

#name ⇒ Object

Returns the value of attribute name.



52
53
54
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 52

def name
  @name
end

#needs_updated_credentials ⇒ Object

Returns the value of attribute needs_updated_credentials.



54
55
56
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 54

def needs_updated_credentials
  @needs_updated_credentials
end

#oauth_window_uri ⇒ Object

Returns the value of attribute oauth_window_uri.



56
57
58
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 56

def oauth_window_uri
  @oauth_window_uri
end

#successfully_aggregated_at ⇒ Object

Returns the value of attribute successfully_aggregated_at.



58
59
60
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 58

def successfully_aggregated_at
  @successfully_aggregated_at
end

#use_cases ⇒ Object

The use case associated with the member. Valid values are ‘PFM` and/or `MONEY_MOVEMENT`. Only set this if you’ve met with MX and have opted in to using this field.



61
62
63
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 61

def use_cases
  @use_cases
end

#user_guid ⇒ Object

Returns the value of attribute user_guid.



63
64
65
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 63

def user_guid
  @user_guid
end

#user_id ⇒ Object

Returns the value of attribute user_id.



65
66
67
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 65

def user_id
  @user_id
end

Class Method Details

._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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 380

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MxPlatformRuby.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



120
121
122
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 120

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 90

def self.attribute_map
  {
    :'aggregated_at' => :'aggregated_at',
    :'background_aggregation_is_disabled' => :'background_aggregation_is_disabled',
    :'connection_status' => :'connection_status',
    :'connection_status_message' => :'connection_status_message',
    :'error' => :'error',
    :'guid' => :'guid',
    :'id' => :'id',
    :'institution_code' => :'institution_code',
    :'institution_guid' => :'institution_guid',
    :'is_being_aggregated' => :'is_being_aggregated',
    :'is_managed_by_user' => :'is_managed_by_user',
    :'is_manual' => :'is_manual',
    :'is_oauth' => :'is_oauth',
    :'metadata' => :'metadata',
    :'most_recent_job_detail_code' => :'most_recent_job_detail_code',
    :'most_recent_job_detail_text' => :'most_recent_job_detail_text',
    :'most_recent_job_guid' => :'most_recent_job_guid',
    :'name' => :'name',
    :'needs_updated_credentials' => :'needs_updated_credentials',
    :'oauth_window_uri' => :'oauth_window_uri',
    :'successfully_aggregated_at' => :'successfully_aggregated_at',
    :'use_cases' => :'use_cases',
    :'user_guid' => :'user_guid',
    :'user_id' => :'user_id'
  }
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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 356

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 155

def self.openapi_nullable
  Set.new([
    :'aggregated_at',
    :'connection_status',
    :'connection_status_message',
    :'error',
    :'guid',
    :'id',
    :'institution_code',
    :'is_being_aggregated',
    :'is_managed_by_user',
    :'is_manual',
    :'is_oauth',
    :'metadata',
    :'most_recent_job_detail_code',
    :'most_recent_job_detail_text',
    :'most_recent_job_guid',
    :'name',
    :'needs_updated_credentials',
    :'oauth_window_uri',
    :'successfully_aggregated_at',
    :'user_guid',
    :'user_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 125

def self.openapi_types
  {
    :'aggregated_at' => :'String',
    :'background_aggregation_is_disabled' => :'Boolean',
    :'connection_status' => :'String',
    :'connection_status_message' => :'String',
    :'error' => :'String',
    :'guid' => :'String',
    :'id' => :'String',
    :'institution_code' => :'String',
    :'institution_guid' => :'String',
    :'is_being_aggregated' => :'Boolean',
    :'is_managed_by_user' => :'Boolean',
    :'is_manual' => :'Boolean',
    :'is_oauth' => :'Boolean',
    :'metadata' => :'String',
    :'most_recent_job_detail_code' => :'Integer',
    :'most_recent_job_detail_text' => :'Boolean',
    :'most_recent_job_guid' => :'Boolean',
    :'name' => :'String',
    :'needs_updated_credentials' => :'Boolean',
    :'oauth_window_uri' => :'String',
    :'successfully_aggregated_at' => :'String',
    :'use_cases' => :'Array<String>',
    :'user_guid' => :'String',
    :'user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aggregated_at == o.aggregated_at &&
      background_aggregation_is_disabled == o.background_aggregation_is_disabled &&
      connection_status == o.connection_status &&
      connection_status_message == o.connection_status_message &&
      error == o.error &&
      guid == o.guid &&
      id == o.id &&
      institution_code == o.institution_code &&
      institution_guid == o.institution_guid &&
      is_being_aggregated == o.is_being_aggregated &&
      is_managed_by_user == o.is_managed_by_user &&
      is_manual == o.is_manual &&
      is_oauth == o.is_oauth &&
      metadata == o.metadata &&
      most_recent_job_detail_code == o.most_recent_job_detail_code &&
      most_recent_job_detail_text == o.most_recent_job_detail_text &&
      most_recent_job_guid == o.most_recent_job_guid &&
      name == o.name &&
      needs_updated_credentials == o.needs_updated_credentials &&
      oauth_window_uri == o.oauth_window_uri &&
      successfully_aggregated_at == o.successfully_aggregated_at &&
      use_cases == o.use_cases &&
      user_guid == o.user_guid &&
      user_id == o.user_id
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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 451

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


343
344
345
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 343

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



349
350
351
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 349

def hash
  [aggregated_at, background_aggregation_is_disabled, connection_status, connection_status_message, error, guid, id, institution_code, institution_guid, is_being_aggregated, is_managed_by_user, is_manual, is_oauth, metadata, most_recent_job_detail_code, most_recent_job_detail_text, most_recent_job_guid, name, needs_updated_credentials, oauth_window_uri, successfully_aggregated_at, use_cases, user_guid, 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



297
298
299
300
301
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 297

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



427
428
429
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 427

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 433

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



421
422
423
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 421

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



305
306
307
308
 
# File 'lib/mx-platform-ruby/models/member_response.rb', line 305

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end