Class: AdvancedBilling::ProformaError

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

Overview

ProformaError Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(subscription: SKIP, additional_properties: {}) ⇒ ProformaError

Returns a new instance of ProformaError.



36
37
38
39
40
41
42
43
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 36

def initialize(subscription: SKIP, additional_properties: {})
  # Add additional model properties to the instance.

  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @subscription = subscription unless subscription == SKIP
end

Instance Attribute Details

#subscription ⇒ BaseStringError

The error is base if it is not directly associated with a single attribute.

Returns:



15
16
17
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 15

def subscription
  @subscription
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 46

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  subscription = BaseStringError.from_hash(hash['subscription']) if hash['subscription']

  # Clean out expected properties from Hash.

  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.

  ProformaError.new(subscription: subscription,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



32
33
34
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 32

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
28
29
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 25

def self.optionals
  %w[
    subscription
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



68
69
70
71
72
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 68

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} subscription: #{@subscription.inspect}, additional_properties:"\
  " #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



61
62
63
64
65
 
# File 'lib/advanced_billing/models/proforma_error.rb', line 61

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} subscription: #{@subscription}, additional_properties:"\
  " #{get_additional_properties}>"
end