Class: XeroRuby::Accounting::Element

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Element

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
118
119
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 73

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_transaction_id ⇒ Object

Returns the value of attribute bank_transaction_id.



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

def bank_transaction_id
  @bank_transaction_id
end

#batch_payment_id ⇒ Object

Unique ID for batch payment object with validation error



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

def batch_payment_id
  @batch_payment_id
end

#contact_id ⇒ Object

Returns the value of attribute contact_id.



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

def contact_id
  @contact_id
end

#credit_note_id ⇒ Object

Returns the value of attribute credit_note_id.



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

def credit_note_id
  @credit_note_id
end

#invoice_id ⇒ Object

Returns the value of attribute invoice_id.



35
36
37
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 35

def invoice_id
  @invoice_id
end

#item_id ⇒ Object

Returns the value of attribute item_id.



38
39
40
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 38

def item_id
  @item_id
end

#purchase_order_id ⇒ Object

Returns the value of attribute purchase_order_id.



41
42
43
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 41

def purchase_order_id
  @purchase_order_id
end

#validation_errors ⇒ Object

Array of Validation Error message



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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'validation_errors' => :'ValidationErrors',
    :'batch_payment_id' => :'BatchPaymentID',
    :'bank_transaction_id' => :'BankTransactionID',
    :'credit_note_id' => :'CreditNoteID',
    :'contact_id' => :'ContactID',
    :'invoice_id' => :'InvoiceID',
    :'item_id' => :'ItemID',
    :'purchase_order_id' => :'PurchaseOrderID'
  }
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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 58

def self.openapi_types
  {
    :'validation_errors' => :'Array<ValidationError>',
    :'batch_payment_id' => :'String',
    :'bank_transaction_id' => :'String',
    :'credit_note_id' => :'String',
    :'contact_id' => :'String',
    :'invoice_id' => :'String',
    :'item_id' => :'String',
    :'purchase_order_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      validation_errors == o.validation_errors &&
      batch_payment_id == o.batch_payment_id &&
      bank_transaction_id == o.bank_transaction_id &&
      credit_note_id == o.credit_note_id &&
      contact_id == o.contact_id &&
      invoice_id == o.invoice_id &&
      item_id == o.item_id &&
      purchase_order_id == o.purchase_order_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



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

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



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

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [validation_errors, batch_payment_id, bank_transaction_id, credit_note_id, contact_id, invoice_id, item_id, purchase_order_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



123
124
125
126
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 123

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 281

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
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



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

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



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

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



130
131
132
 
# File 'lib/xero-ruby/models/accounting/element.rb', line 130

def valid?
  true
end