Class: MergeAccountingClient::PaymentLineItemRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/payment_line_item_request.rb

Overview

# The PaymentLineItem Object ### Description The ‘PaymentLineItem` object is an applied-to-line on a `Payment` that can either be a `Invoice`, `CreditNote`, or `JournalEntry`. ### Usage Example `Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentLineItemRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 82

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

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

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

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

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

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

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

Instance Attribute Details

#applied_amount ⇒ Object

The amount being applied to the transaction.



20
21
22
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 20

def applied_amount
  @applied_amount
end

#applied_date ⇒ Object

The date the payment portion is applied.



23
24
25
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 23

def applied_date
  @applied_date
end

#integration_params ⇒ Object

Returns the value of attribute integration_params.



34
35
36
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 34

def integration_params
  @integration_params
end

#linked_account_params ⇒ Object

Returns the value of attribute linked_account_params.



36
37
38
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 36

def 
  @linked_account_params
end

#related_object_id ⇒ Object

The Merge ID of the transaction the payment portion is being applied to.



29
30
31
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 29

def related_object_id
  @related_object_id
end

#related_object_type ⇒ Object

The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.



32
33
34
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 32

def related_object_type
  @related_object_type
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



26
27
28
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 26

def remote_id
  @remote_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 39

def self.attribute_map
  {
    :'applied_amount' => :'applied_amount',
    :'applied_date' => :'applied_date',
    :'remote_id' => :'remote_id',
    :'related_object_id' => :'related_object_id',
    :'related_object_type' => :'related_object_type',
    :'integration_params' => :'integration_params',
    :'linked_account_params' => :'linked_account_params'
  }
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



202
203
204
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 202

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
74
75
76
77
78
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 70

def self.openapi_nullable
  Set.new([
    :'applied_amount',
    :'applied_date',
    :'remote_id',
    :'integration_params',
    :'linked_account_params'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 57

def self.openapi_types
  {
    :'applied_amount' => :'String',
    :'applied_date' => :'Time',
    :'remote_id' => :'String',
    :'related_object_id' => :'String',
    :'related_object_type' => :'String',
    :'integration_params' => :'Hash<String, Object>',
    :'linked_account_params' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      applied_amount == o.applied_amount &&
      applied_date == o.applied_date &&
      remote_id == o.remote_id &&
      related_object_id == o.related_object_id &&
      related_object_type == o.related_object_type &&
      integration_params == o.integration_params &&
       == o.
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
269
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 232

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeAccountingClient.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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 303

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


189
190
191
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 195

def hash
  [applied_amount, applied_date, remote_id, related_object_id, related_object_type, integration_params, ].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



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  if !@applied_amount.nil? && @applied_amount.to_s !~ pattern
    invalid_properties.push("invalid value for \"applied_amount\", must conform to the pattern #{pattern}.")
  end

  if !@related_object_type.nil? && @related_object_type.to_s.length < 1
    invalid_properties.push('invalid value for "related_object_type", the character length must be great than or equal to 1.')
  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



279
280
281
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 285

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



273
274
275
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 273

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



146
147
148
149
150
 
# File 'lib/merge_accounting_client/models/payment_line_item_request.rb', line 146

def valid?
  return false if !@applied_amount.nil? && @applied_amount.to_s !~ Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  return false if !@related_object_type.nil? && @related_object_type.to_s.length < 1
  true
end