Class: AdvancedBilling::AppliedCreditNoteData

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/applied_credit_note_data.rb

Overview

AppliedCreditNoteData Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(uid: SKIP, number: SKIP, additional_properties: {}) ⇒ AppliedCreditNoteData

Returns a new instance of AppliedCreditNoteData.



41
42
43
44
45
46
47
48
49
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 41

def initialize(uid: SKIP, number: SKIP, additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @uid = uid unless uid == SKIP
  @number = number unless number == SKIP
end

Instance Attribute Details

#number ⇒ String

The number of the credit note

Returns:

  • (String) 


18
19
20
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 18

def number
  @number
end

#uid ⇒ String

The UID of the credit note

Returns:

  • (String) 


14
15
16
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 14

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  uid = hash.key?('uid') ? hash['uid'] : SKIP
  number = hash.key?('number') ? hash['number'] : SKIP

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  AppliedCreditNoteData.new(uid: uid,
                            number: number,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uid'] = 'uid'
  @_hash['number'] = 'number'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 29

def self.optionals
  %w[
    uid
    number
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



70
71
72
73
74
75
76
 
# File 'lib/advanced_billing/models/applied_credit_note_data.rb', line 70

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end