Class: AdvancedBilling::ComponentCurrencyPrice

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

Overview

ComponentCurrencyPrice Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id: SKIP, currency: SKIP, price: SKIP, formatted_price: SKIP, price_id: SKIP, price_point_id: SKIP, additional_properties: {}) ⇒ ComponentCurrencyPrice

Returns a new instance of ComponentCurrencyPrice.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/advanced_billing/models/component_currency_price.rb', line 65

def initialize(id: SKIP, currency: SKIP, price: SKIP, formatted_price: SKIP,
               price_id: SKIP, price_point_id: SKIP,
               additional_properties: {})
  @id = id unless id == SKIP
  @currency = currency unless currency == SKIP
  @price = price unless price == SKIP
  @formatted_price = formatted_price unless formatted_price == SKIP
  @price_id = price_id unless price_id == SKIP
  @price_point_id = price_point_id unless price_point_id == SKIP

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

Instance Attribute Details

#currencyString

TODO: Write general description for this method

Returns:

  • (String)


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

def currency
  @currency
end

#formatted_priceString

TODO: Write general description for this method

Returns:

  • (String)


26
27
28
# File 'lib/advanced_billing/models/component_currency_price.rb', line 26

def formatted_price
  @formatted_price
end

#idInteger

TODO: Write general description for this method

Returns:

  • (Integer)


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

def id
  @id
end

#priceString

TODO: Write general description for this method

Returns:

  • (String)


22
23
24
# File 'lib/advanced_billing/models/component_currency_price.rb', line 22

def price
  @price
end

#price_idInteger

TODO: Write general description for this method

Returns:

  • (Integer)


30
31
32
# File 'lib/advanced_billing/models/component_currency_price.rb', line 30

def price_id
  @price_id
end

#price_point_idInteger

TODO: Write general description for this method

Returns:

  • (Integer)


34
35
36
# File 'lib/advanced_billing/models/component_currency_price.rb', line 34

def price_point_id
  @price_point_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/advanced_billing/models/component_currency_price.rb', line 82

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  currency = hash.key?('currency') ? hash['currency'] : SKIP
  price = hash.key?('price') ? hash['price'] : SKIP
  formatted_price =
    hash.key?('formatted_price') ? hash['formatted_price'] : SKIP
  price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
  price_point_id =
    hash.key?('price_point_id') ? hash['price_point_id'] : SKIP

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

  # Create object from extracted values.
  ComponentCurrencyPrice.new(id: id,
                             currency: currency,
                             price: price,
                             formatted_price: formatted_price,
                             price_id: price_id,
                             price_point_id: price_point_id,
                             additional_properties: hash)
end

.namesObject

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
# File 'lib/advanced_billing/models/component_currency_price.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['currency'] = 'currency'
  @_hash['price'] = 'price'
  @_hash['formatted_price'] = 'formatted_price'
  @_hash['price_id'] = 'price_id'
  @_hash['price_point_id'] = 'price_point_id'
  @_hash
end

.nullablesObject

An array for nullable fields



61
62
63
# File 'lib/advanced_billing/models/component_currency_price.rb', line 61

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    id
    currency
    price
    formatted_price
    price_id
    price_point_id
  ]
end