Class: SyncteraRubySdk::PayerPayeeRelationship

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/payer_payee_relationship.rb

Overview

> 🚧 Alpha > The PAYER_PAYEE relationship is Alpha. We may make breaking changes to this schema. PAYER_PAYEE denotes the relationship between specified person or business as a payer or payee to a person or businesses. One from_person_id/from_business_id must be provided, and one of to_person_id/to_business_id must be provided.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayerPayeeRelationship

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_data ⇒ Object

Returns the value of attribute additional_data.



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 19

def additional_data
  @additional_data
end

#creation_time ⇒ Object

The date and time the resource was created.



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 22

def creation_time
  @creation_time
end

#from_business_id ⇒ Object

Unique ID for the subject business.



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 25

def from_business_id
  @from_business_id
end

#from_person_id ⇒ Object

Unique ID for the subject person.



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 28

def from_person_id
  @from_person_id
end

#id ⇒ Object

Relationship unique identifier.



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 31

def id
  @id
end

#last_updated_time ⇒ Object

The date and time the resource was last updated.



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 34

def last_updated_time
  @last_updated_time
end

#metadata ⇒ Object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 37

def metadata
  @metadata
end

#relationship_type ⇒ Object

Returns the value of attribute relationship_type.



39
40
41
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 39

def relationship_type
  @relationship_type
end

#tenant ⇒ Object

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.



42
43
44
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 42

def tenant
  @tenant
end

#to_business_id ⇒ Object

Unique ID for the related business.



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 45

def to_business_id
  @to_business_id
end

#to_person_id ⇒ Object

Unique ID for the related person.



48
49
50
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 48

def to_person_id
  @to_person_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 73

def self.attribute_map
  {
    :'additional_data' => :'additional_data',
    :'creation_time' => :'creation_time',
    :'from_business_id' => :'from_business_id',
    :'from_person_id' => :'from_person_id',
    :'id' => :'id',
    :'last_updated_time' => :'last_updated_time',
    :'metadata' => :'metadata',
    :'relationship_type' => :'relationship_type',
    :'tenant' => :'tenant',
    :'to_business_id' => :'to_business_id',
    :'to_person_id' => :'to_person_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



240
241
242
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 240

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



118
119
120
121
122
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 118

def self.openapi_all_of
  [
  :'PatchPayerPayeeRelationship'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 112

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 95

def self.openapi_types
  {
    :'additional_data' => :'PayerPayeeAdditionalData',
    :'creation_time' => :'Time',
    :'from_business_id' => :'String',
    :'from_person_id' => :'String',
    :'id' => :'String',
    :'last_updated_time' => :'Time',
    :'metadata' => :'Object',
    :'relationship_type' => :'RelationshipTypes',
    :'tenant' => :'String',
    :'to_business_id' => :'String',
    :'to_person_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_data == o.additional_data &&
      creation_time == o.creation_time &&
      from_business_id == o.from_business_id &&
      from_person_id == o.from_person_id &&
      id == o.id &&
      last_updated_time == o.last_updated_time &&
      metadata == o.metadata &&
      relationship_type == o.relationship_type &&
      tenant == o.tenant &&
      to_business_id == o.to_business_id &&
      to_person_id == o.to_person_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



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
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 271

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 342

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 247

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 233

def hash
  [additional_data, creation_time, from_business_id, from_person_id, id, last_updated_time, metadata, relationship_type, tenant, to_business_id, to_person_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



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 186

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

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



318
319
320
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 324

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



312
313
314
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 312

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



201
202
203
204
205
 
# File 'lib/synctera_ruby_sdk/models/payer_payee_relationship.rb', line 201

def valid?
  return false if @additional_data.nil?
  return false if @relationship_type.nil?
  true
end