Class: DearInventoryRuby::SalePayment

Inherits:
Object
  • Object
show all
Defined in:
lib/dear-inventory-ruby/models/sale_payment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SalePayment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Account Code of the bank/payment account from Chart of accounts. Available for POST/PUT



48
49
50
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 48

def 
  @account
end

#amount ⇒ Object

Payment amount in customer currency. Available for POST/PUT



42
43
44
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 42

def amount
  @amount
end

#credit_id ⇒ Object

Id for Sale Credit entry



57
58
59
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 57

def credit_id
  @credit_id
end

#credit_note_number ⇒ Object

Sale Task Credit Note Number



33
34
35
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 33

def credit_note_number
  @credit_note_number
end

#currency_rate ⇒ Object

Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. Available for POST/PUT



51
52
53
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 51

def currency_rate
  @currency_rate
end

#date_created ⇒ Object

Date of creation payment record.



54
55
56
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 54

def date_created
  @date_created
end

#date_paid ⇒ Object

Date when payment has been made. Available for POST/PUT



45
46
47
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 45

def date_paid
  @date_paid
end

#id ⇒ Object

Identifier of payment. Available for PUT



24
25
26
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 24

def id
  @id
end

#invoice_number ⇒ Object

Sale Task Invoice Number



30
31
32
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 30

def invoice_number
  @invoice_number
end

#reference ⇒ Object

Payment reference number. Available for POST/PUT



39
40
41
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 39

def reference
  @reference
end

#sale_id ⇒ Object

Unique DEAR Sale ID



18
19
20
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 18

def sale_id
  @sale_id
end

#sale_order_number ⇒ Object

Sale Order Number



27
28
29
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 27

def sale_order_number
  @sale_order_number
end

#task_id ⇒ Object

Unique DEAR Sale Task ID. Available for POST



21
22
23
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 21

def task_id
  @task_id
end

#type ⇒ Object

Available values are PREPAYMENT,PAYMENT,REFUND. Available for POST



36
37
38
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 36

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 60

def self.attribute_map
  {
    :'sale_id' => :'SaleID',
    :'task_id' => :'TaskID',
    :'id' => :'ID',
    :'sale_order_number' => :'SaleOrderNumber',
    :'invoice_number' => :'InvoiceNumber',
    :'credit_note_number' => :'CreditNoteNumber',
    :'type' => :'Type',
    :'reference' => :'Reference',
    :'amount' => :'Amount',
    :'date_paid' => :'DatePaid',
    :'account' => :'Account',
    :'currency_rate' => :'CurrencyRate',
    :'date_created' => :'DateCreated',
    :'credit_id' => :'CreditID'
  }
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



226
227
228
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 226

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 100

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 80

def self.openapi_types
  {
    :'sale_id' => :'String',
    :'task_id' => :'String',
    :'id' => :'String',
    :'sale_order_number' => :'String',
    :'invoice_number' => :'String',
    :'credit_note_number' => :'String',
    :'type' => :'String',
    :'reference' => :'String',
    :'amount' => :'Float',
    :'date_paid' => :'Date',
    :'account' => :'String',
    :'currency_rate' => :'Float',
    :'date_created' => :'Date',
    :'credit_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sale_id == o.sale_id &&
      task_id == o.task_id &&
      id == o.id &&
      sale_order_number == o.sale_order_number &&
      invoice_number == o.invoice_number &&
      credit_note_number == o.credit_note_number &&
      type == o.type &&
      reference == o.reference &&
      amount == o.amount &&
      date_paid == o.date_paid &&
       == o. &&
      currency_rate == o.currency_rate &&
      date_created == o.date_created &&
      credit_id == o.credit_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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 254

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 323

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 233

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


213
214
215
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



219
220
221
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 219

def hash
  [sale_id, task_id, id, sale_order_number, invoice_number, credit_note_number, type, reference, amount, date_paid, , currency_rate, date_created, credit_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



179
180
181
182
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  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



299
300
301
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 305

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



293
294
295
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 293

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



186
187
188
 
# File 'lib/dear-inventory-ruby/models/sale_payment.rb', line 186

def valid?
  true
end