Class: AdvancedBilling::CurrencyPrice

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

Overview

CurrencyPrice 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, product_price_point_id: SKIP, role: SKIP, additional_properties: {}) ⇒ CurrencyPrice

Returns a new instance of CurrencyPrice.



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

def initialize(id: SKIP, currency: SKIP, price: SKIP, formatted_price: SKIP,
               product_price_point_id: SKIP, role: 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
  @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
  @role = role unless role == SKIP

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

Instance Attribute Details

#currency ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def currency
  @currency
end

#formatted_price ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def formatted_price
  @formatted_price
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#price ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def price
  @price
end

#product_price_point_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def product_price_point_id
  @product_price_point_id
end

#role ⇒ CurrencyPriceRole

Role for the price.

Returns:



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

def role
  @role
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/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
  product_price_point_id =
    hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
  role = hash.key?('role') ? hash['role'] : SKIP

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

  # Create object from extracted values.
  CurrencyPrice.new(id: id,
                    currency: currency,
                    price: price,
                    formatted_price: formatted_price,
                    product_price_point_id: product_price_point_id,
                    role: role,
                    additional_properties: hash)
end

.names ⇒ Object

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/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['product_price_point_id'] = 'product_price_point_id'
  @_hash['role'] = 'role'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    id
    currency
    price
    formatted_price
    product_price_point_id
    role
  ]
end