Class: Hubspot::Crm::Extensions::Accounting::AccountingExtensionInvoice

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb

Overview

Representation of an invoice in the external accounting system.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountingExtensionInvoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 114

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_due ⇒ Object

The total amount due.



23
24
25
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 23

def amount_due
  @amount_due
end

#balance ⇒ Object

The remaining outstanding balance due.



26
27
28
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 26

def balance
  @balance
end

#currency ⇒ Object

The ISO 4217 currency code that represents the currency of this invoice.



38
39
40
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 38

def currency
  @currency
end

#customer_id ⇒ Object

The ID of the customer that this invoice is for.



35
36
37
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 35

def customer_id
  @customer_id
end

#customer_name ⇒ Object

The name of the customer that this invoice is for.



44
45
46
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 44

def customer_name
  @customer_name
end

#due_date ⇒ Object

The due date for payment of the invoice, in ISO-8601 date format (yyyy-MM-dd)



29
30
31
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 29

def due_date
  @due_date
end

#invoice_link ⇒ Object

A link to the invoice in the external accounting system.



41
42
43
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 41

def invoice_link
  @invoice_link
end

#invoice_number ⇒ Object

The invoice number



32
33
34
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 32

def invoice_number
  @invoice_number
end

#status ⇒ Object

The currency status of the invoice.



47
48
49
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 47

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 72

def self.attribute_map
  {
    :'amount_due' => :'amountDue',
    :'balance' => :'balance',
    :'due_date' => :'dueDate',
    :'invoice_number' => :'invoiceNumber',
    :'customer_id' => :'customerId',
    :'currency' => :'currency',
    :'invoice_link' => :'invoiceLink',
    :'customer_name' => :'customerName',
    :'status' => :'status'
  }
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



250
251
252
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 250

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 92

def self.openapi_types
  {
    :'amount_due' => :'Float',
    :'balance' => :'Float',
    :'due_date' => :'Date',
    :'invoice_number' => :'String',
    :'customer_id' => :'String',
    :'currency' => :'String',
    :'invoice_link' => :'String',
    :'customer_name' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount_due == o.amount_due &&
      balance == o.balance &&
      due_date == o.due_date &&
      invoice_number == o.invoice_number &&
      customer_id == o.customer_id &&
      currency == o.currency &&
      invoice_link == o.invoice_link &&
      customer_name == o.customer_name &&
      status == o.status
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



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
315
316
317
318
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 281

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Crm::Extensions::Accounting.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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 352

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 257

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


237
238
239
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



243
244
245
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 243

def hash
  [amount_due, balance, due_date, invoice_number, customer_id, currency, invoice_link, customer_name, status].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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  if @amount_due.nil?
    invalid_properties.push('invalid value for "amount_due", amount_due cannot be nil.')
  end

  if @due_date.nil?
    invalid_properties.push('invalid value for "due_date", due_date cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @invoice_link.nil?
    invalid_properties.push('invalid value for "invoice_link", invoice_link cannot be nil.')
  end

  if @customer_name.nil?
    invalid_properties.push('invalid value for "customer_name", customer_name cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  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



328
329
330
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 334

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



322
323
324
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 322

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



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb', line 197

def valid?
  return false if @amount_due.nil?
  return false if @due_date.nil?
  return false if @currency.nil?
  return false if @invoice_link.nil?
  return false if @customer_name.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["CREATED", "SENT", "PAID", "CLOSED", "OVERDUE", "VOIDED"])
  return false unless status_validator.valid?(@status)
  true
end