Class: TreezorClient::Body

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/models/body.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
# File 'lib/treezor_client/models/body.rb', line 91

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'usableForSct')
    self.usable_for_sct = attributes[:'usableForSct']
  else
    self.usable_for_sct = false
  end

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

Instance Attribute Details

#addressObject

Beneficiary address, linked to bank account.


30
31
32
# File 'lib/treezor_client/models/body.rb', line 30

def address
  @address
end

#bicObject

Beneficiary Bank Identifier Code. Mandatory if usableForSct is true.


36
37
38
# File 'lib/treezor_client/models/body.rb', line 36

def bic
  @bic
end

#fieldsObject

List of the object's properties you want to pick up.


51
52
53
# File 'lib/treezor_client/models/body.rb', line 51

def fields
  @fields
end

#ibanObject

Beneficiary International Bank Account Number. Mandatory if usableForSct is true.


33
34
35
# File 'lib/treezor_client/models/body.rb', line 33

def iban
  @iban
end

#nameObject

Beneficiary name, linked to bank account.


27
28
29
# File 'lib/treezor_client/models/body.rb', line 27

def name
  @name
end

#nick_nameObject

Name choosen by end user to easily recognize the beneficiary.


24
25
26
# File 'lib/treezor_client/models/body.rb', line 24

def nick_name
  @nick_name
end

#sdd_b2b_whitelistObject

Each unique mandate reference, with its frequency type, must be explicitely allowed when doing B2B Direct Debit. Furthermore, a mandate not used during more than 36 months will be automatically rejected even if in the white list. If provided, sepaCreditorIdentifier is mandatory.


42
43
44
# File 'lib/treezor_client/models/body.rb', line 42

def sdd_b2b_whitelist
  @sdd_b2b_whitelist
end

#sdd_core_blacklistObject

Core Direct Debit are accepted by default. If a Core mandate is to be refused on reception, it has to be added to this list. If wild char * (star) is used instead of a UMR, all Direct Debit from this beneficiary will be refused. If provided, sepaCreditorIdentifier is mandatory.


45
46
47
# File 'lib/treezor_client/models/body.rb', line 45

def sdd_core_blacklist
  @sdd_core_blacklist
end

#sepa_creditor_identifierObject

Beneficiary SEPA Creditor Identifier. Mandatory to validate incoming direct debit, useless other wise. Between 8 and 35 caracters. If sddB2bWhitelist or sddCoreBlacklist is provided then sepaCreditorIdentifier is mandatory.


39
40
41
# File 'lib/treezor_client/models/body.rb', line 39

def sepa_creditor_identifier
  @sepa_creditor_identifier
end

#tagObject

Custom data that could be used by caller to search the instance.


18
19
20
# File 'lib/treezor_client/models/body.rb', line 18

def tag
  @tag
end

#usable_for_sctObject

Indicated if the beneficiary can be used for SEPA Credit Transfer. This field is a conveniant way to filter all beneficiaries for a user that would like to do a Credit Transfer. Indeed, beneficaries are created automatically when receiving a Core Direct Debit and therefor by looking at the list you won't be able to idnetify which beneficary to use on SCT.


48
49
50
# File 'lib/treezor_client/models/body.rb', line 48

def usable_for_sct
  @usable_for_sct
end

#user_idObject

Beneficiary's userId


21
22
23
# File 'lib/treezor_client/models/body.rb', line 21

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/treezor_client/models/body.rb', line 54

def self.attribute_map
  {
    :'tag' => :'tag',
    :'user_id' => :'userId',
    :'nick_name' => :'nickName',
    :'name' => :'name',
    :'address' => :'address',
    :'iban' => :'iban',
    :'bic' => :'bic',
    :'sepa_creditor_identifier' => :'sepaCreditorIdentifier',
    :'sdd_b2b_whitelist' => :'sddB2bWhitelist',
    :'sdd_core_blacklist' => :'sddCoreBlacklist',
    :'usable_for_sct' => :'usableForSct',
    :'fields' => :'fields'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'tag' => :'String',
    :'user_id' => :'Integer',
    :'nick_name' => :'String',
    :'name' => :'String',
    :'address' => :'String',
    :'iban' => :'String',
    :'bic' => :'String',
    :'sepa_creditor_identifier' => :'String',
    :'sdd_b2b_whitelist' => :'Array<BeneficiariesSddB2bWhitelist>',
    :'sdd_core_blacklist' => :'Array<String>',
    :'usable_for_sct' => :'BOOLEAN',
    :'fields' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/treezor_client/models/body.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tag == o.tag &&
      user_id == o.user_id &&
      nick_name == o.nick_name &&
      name == o.name &&
      address == o.address &&
      iban == o.iban &&
      bic == o.bic &&
      sepa_creditor_identifier == o.sepa_creditor_identifier &&
      sdd_b2b_whitelist == o.sdd_b2b_whitelist &&
      sdd_core_blacklist == o.sdd_core_blacklist &&
      usable_for_sct == o.usable_for_sct &&
      fields == o.fields
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


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
# File 'lib/treezor_client/models/body.rb', line 232

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


298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/treezor_client/models/body.rb', line 298

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


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/treezor_client/models/body.rb', line 211

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

198
199
200
# File 'lib/treezor_client/models/body.rb', line 198

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


204
205
206
# File 'lib/treezor_client/models/body.rb', line 204

def hash
  [tag, user_id, nick_name, name, address, iban, bic, sepa_creditor_identifier, sdd_b2b_whitelist, sdd_core_blacklist, usable_for_sct, fields].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/treezor_client/models/body.rb', line 156

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


278
279
280
# File 'lib/treezor_client/models/body.rb', line 278

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


284
285
286
287
288
289
290
291
292
# File 'lib/treezor_client/models/body.rb', line 284

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


272
273
274
# File 'lib/treezor_client/models/body.rb', line 272

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


171
172
173
174
175
# File 'lib/treezor_client/models/body.rb', line 171

def valid?
  return false if @user_id.nil?
  return false if @name.nil?
  true
end