Class: XeroRuby::Accounting::LinkedTransaction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkedTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#contact_id ⇒ Object

Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.



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

def contact_id
  @contact_id
end

#linked_transaction_id ⇒ Object

The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9



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

def linked_transaction_id
  @linked_transaction_id
end

#source_line_item_id ⇒ Object

The line item identifier from the source transaction.



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

def source_line_item_id
  @source_line_item_id
end

#source_transaction_id ⇒ Object

Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice



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

def source_transaction_id
  @source_transaction_id
end

#source_transaction_type_code ⇒ Object

The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction.



46
47
48
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 46

def source_transaction_type_code
  @source_transaction_type_code
end

#status ⇒ Object

Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.



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

def status
  @status
end

#target_line_item_id ⇒ Object

The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID.



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

def target_line_item_id
  @target_line_item_id
end

#target_transaction_id ⇒ Object

Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice



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

def target_transaction_id
  @target_transaction_id
end

#type ⇒ Object

This will always be BILLABLEEXPENSE. More types may be added in future.



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

def type
  @type
end

#updated_date_utc ⇒ Object

The last modified date in UTC format



43
44
45
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 43

def updated_date_utc
  @updated_date_utc
end

#validation_errors ⇒ Object

Displays array of validation error messages from the API



49
50
51
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 49

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 74

def self.attribute_map
  {
    :'source_transaction_id' => :'SourceTransactionID',
    :'source_line_item_id' => :'SourceLineItemID',
    :'contact_id' => :'ContactID',
    :'target_transaction_id' => :'TargetTransactionID',
    :'target_line_item_id' => :'TargetLineItemID',
    :'linked_transaction_id' => :'LinkedTransactionID',
    :'status' => :'Status',
    :'type' => :'Type',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'source_transaction_type_code' => :'SourceTransactionTypeCode',
    :'validation_errors' => :'ValidationErrors'
  }
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



251
252
253
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 251

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 91

def self.openapi_types
  {
    :'source_transaction_id' => :'String',
    :'source_line_item_id' => :'String',
    :'contact_id' => :'String',
    :'target_transaction_id' => :'String',
    :'target_line_item_id' => :'String',
    :'linked_transaction_id' => :'String',
    :'status' => :'String',
    :'type' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'source_transaction_type_code' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source_transaction_id == o.source_transaction_id &&
      source_line_item_id == o.source_line_item_id &&
      contact_id == o.contact_id &&
      target_transaction_id == o.target_transaction_id &&
      target_line_item_id == o.target_line_item_id &&
      linked_transaction_id == o.linked_transaction_id &&
      status == o.status &&
      type == o.type &&
      updated_date_utc == o.updated_date_utc &&
      source_transaction_type_code == o.source_transaction_type_code &&
      validation_errors == o.validation_errors
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



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
309
310
311
312
313
314
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 279

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 :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) ⇒ 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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 344

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 258

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 244

def hash
  [source_transaction_id, source_line_item_id, contact_id, target_transaction_id, target_line_item_id, linked_transaction_id, status, type, updated_date_utc, source_transaction_type_code, validation_errors].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



171
172
173
174
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



359
360
361
362
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 359

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



324
325
326
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 324

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 330

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



318
319
320
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 318

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



178
179
180
181
182
183
184
185
186
 
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 178

def valid?
  status_validator = EnumAttributeValidator.new('String', ["APPROVED", "DRAFT", "ONDRAFT", "BILLED", "VOIDED"])
  return false unless status_validator.valid?(@status)
  type_validator = EnumAttributeValidator.new('String', ["BILLABLEEXPENSE"])
  return false unless type_validator.valid?(@type)
  source_transaction_type_code_validator = EnumAttributeValidator.new('String', ["ACCPAY", "SPEND"])
  return false unless source_transaction_type_code_validator.valid?(@source_transaction_type_code)
  true
end