Class: Hubspot::Crm::Extensions::Accounting::InvoiceUpdateResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceUpdateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Returns the value of attribute archived.



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

def archived
  @archived
end

#archived_at ⇒ Object

Returns the value of attribute archived_at.



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

def archived_at
  @archived_at
end

#balance_due ⇒ Object

Returns the value of attribute balance_due.



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

def balance_due
  @balance_due
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#due_date ⇒ Object

Returns the value of attribute due_date.



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

def due_date
  @due_date
end

#external_account_id ⇒ Object

Returns the value of attribute external_account_id.



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

def 
  @external_account_id
end

#external_create_date_time ⇒ Object

Returns the value of attribute external_create_date_time.



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

def external_create_date_time
  @external_create_date_time
end

#external_invoice_number ⇒ Object

Returns the value of attribute external_invoice_number.



20
21
22
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 20

def external_invoice_number
  @external_invoice_number
end

#external_recipient_id ⇒ Object

Returns the value of attribute external_recipient_id.



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

def external_recipient_id
  @external_recipient_id
end

#id ⇒ Object

Returns the value of attribute id.



50
51
52
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 50

def id
  @id
end

#invoice_status ⇒ Object

Returns the value of attribute invoice_status.



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

def invoice_status
  @invoice_status
end

#is_voided ⇒ Object

Returns the value of attribute is_voided.



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

def is_voided
  @is_voided
end

#received_by_recipient_date ⇒ Object

Returns the value of attribute received_by_recipient_date.



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

def received_by_recipient_date
  @received_by_recipient_date
end

#total_amount_billed ⇒ Object

Returns the value of attribute total_amount_billed.



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

def total_amount_billed
  @total_amount_billed
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 75

def self.attribute_map
  {
    :'external_invoice_number' => :'externalInvoiceNumber',
    :'total_amount_billed' => :'totalAmountBilled',
    :'balance_due' => :'balanceDue',
    :'currency_code' => :'currencyCode',
    :'due_date' => :'dueDate',
    :'external_recipient_id' => :'externalRecipientId',
    :'received_by_recipient_date' => :'receivedByRecipientDate',
    :'external_create_date_time' => :'externalCreateDateTime',
    :'is_voided' => :'isVoided',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'archived_at' => :'archivedAt',
    :'archived' => :'archived',
    :'external_account_id' => :'externalAccountId',
    :'invoice_status' => :'invoiceStatus',
    :'id' => :'id'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 97

def self.openapi_types
  {
    :'external_invoice_number' => :'String',
    :'total_amount_billed' => :'Float',
    :'balance_due' => :'Float',
    :'currency_code' => :'String',
    :'due_date' => :'Date',
    :'external_recipient_id' => :'String',
    :'received_by_recipient_date' => :'Integer',
    :'external_create_date_time' => :'Integer',
    :'is_voided' => :'Boolean',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'archived_at' => :'DateTime',
    :'archived' => :'Boolean',
    :'external_account_id' => :'String',
    :'invoice_status' => :'String',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_invoice_number == o.external_invoice_number &&
      total_amount_billed == o.total_amount_billed &&
      balance_due == o.balance_due &&
      currency_code == o.currency_code &&
      due_date == o.due_date &&
      external_recipient_id == o.external_recipient_id &&
      received_by_recipient_date == o.received_by_recipient_date &&
      external_create_date_time == o.external_create_date_time &&
      is_voided == o.is_voided &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      archived_at == o.archived_at &&
      archived == o.archived &&
       == o. &&
      invoice_status == o.invoice_status &&
      id == o.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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 355

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
    Hubspot::Crm::Extensions::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



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 424

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



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

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


314
315
316
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



320
321
322
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 320

def hash
  [external_invoice_number, total_amount_billed, balance_due, currency_code, due_date, external_recipient_id, received_by_recipient_date, external_create_date_time, is_voided, created_at, updated_at, archived_at, archived, , invoice_status, 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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 206

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

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

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

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

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

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

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

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

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

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

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

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



400
401
402
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 400

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 406

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



394
395
396
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 394

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_response.rb', line 261

def valid?
  return false if @total_amount_billed.nil?
  return false if @balance_due.nil?
  return false if @currency_code.nil?
  return false if @due_date.nil?
  return false if @external_recipient_id.nil?
  return false if @is_voided.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @archived.nil?
  return false if @external_account_id.nil?
  return false if @invoice_status.nil?
  invoice_status_validator = EnumAttributeValidator.new('String', ["CREATED", "SENT", "PAID", "CLOSED", "OVERDUE", "VOIDED", "NONE", "UNPAID"])
  return false unless invoice_status_validator.valid?(@invoice_status)
  return false if @id.nil?
  true
end