Class: AdvancedBilling::Proration

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

Overview

Proration Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(preserve_period: SKIP, additional_properties: {}) ⇒ Proration

Returns a new instance of Proration.



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

def initialize(preserve_period: SKIP, additional_properties: {})
  @preserve_period = preserve_period unless preserve_period == SKIP

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

Instance Attribute Details

#preserve_period ⇒ TrueClass | FalseClass

The alternative to sending preserve_period as a direct attribute to migration

Returns:

  • (TrueClass | FalseClass) 


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

def preserve_period
  @preserve_period
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
59
 
# File 'lib/advanced_billing/models/proration.rb', line 46

def self.from_hash(hash)
  return nil unless hash

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

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  Proration.new(preserve_period: preserve_period,
                additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    preserve_period
  ]
end