Class: XeroRuby::Accounting::BatchPaymentDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchPaymentDetails

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
89
90
91
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 59

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

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

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

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

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

Instance Attribute Details

#bank_account_nameObject

Name of bank for use with Batch Payments


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

def 
  @bank_account_name
end

#bank_account_numberObject

Bank account number for use with Batch Payments


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

def 
  @bank_account_number
end

#codeObject

(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.


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

def code
  @code
end

#detailsObject

(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18


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

def details
  @details
end

#referenceObject

(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.


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

def reference
  @reference
end

Class Method Details

.attribute_mapObject

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


36
37
38
39
40
41
42
43
44
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 36

def self.attribute_map
  {
    :'bank_account_number' => :'BankAccountNumber',
    :'bank_account_name' => :'BankAccountName',
    :'details' => :'Details',
    :'code' => :'Code',
    :'reference' => :'Reference'
  }
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


163
164
165
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 163

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

.openapi_typesObject

Attribute type mapping.


47
48
49
50
51
52
53
54
55
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 47

def self.openapi_types
  {
    :'bank_account_number' => :'String',
    :'bank_account_name' => :'String',
    :'details' => :'String',
    :'code' => :'String',
    :'reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


138
139
140
141
142
143
144
145
146
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      details == o.details &&
      code == o.code &&
      reference == o.reference
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


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
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 191

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


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 264

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


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 170

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


156
157
158
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 156

def hash
  [, , details, code, reference].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 95

def list_invalid_properties
  invalid_properties = Array.new
  if !@code.nil? && @code.to_s.length > 12
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 12.')
  end

  if !@reference.nil? && @reference.to_s.length > 12
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 12.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object


280
281
282
283
284
285
286
287
288
289
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 280

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


256
257
258
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 256

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


238
239
240
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 238

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


244
245
246
247
248
249
250
251
252
253
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 244

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


232
233
234
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 232

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


110
111
112
113
114
# File 'lib/xero-ruby/models/accounting/batch_payment_details.rb', line 110

def valid?
  return false if !@code.nil? && @code.to_s.length > 12
  return false if !@reference.nil? && @reference.to_s.length > 12
  true
end