Class: AdvancedBilling::CustomerError

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

Overview

CustomerError 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(customer: SKIP, additional_properties: {}) ⇒ CustomerError

Returns a new instance of CustomerError.



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

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

  @customer = customer unless customer == SKIP
end

Instance Attribute Details

#customer ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def customer
  @customer
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

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

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

  # Create object from extracted values.
  CustomerError.new(customer: customer,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/advanced_billing/models/customer_error.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/advanced_billing/models/customer_error.rb', line 31

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/advanced_billing/models/customer_error.rb', line 24

def self.optionals
  %w[
    customer
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (CustomerError | Hash) —

    value against the validation is performed.



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

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

  return false unless value.instance_of? Hash

  true
end