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

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

Constructor Details

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

Returns a new instance of CurrencyPrice.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/advanced_billing/models/currency_price.rb', line 77

def initialize(id: SKIP, currency: SKIP, price: SKIP, formatted_price: SKIP,
               price_id: SKIP, price_point_id: SKIP,
               product_price_point_id: SKIP, role: SKIP,
               additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @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
  @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
  @role = role unless role == SKIP
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

#price_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 price_id
  @price_id
end

#price_point_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def price_point_id
  @price_point_id
end

#product_price_point_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/advanced_billing/models/currency_price.rb', line 38

def product_price_point_id
  @product_price_point_id
end

#role ⇒ CurrencyPriceRole

Role for the price.

Returns:



42
43
44
 
# File 'lib/advanced_billing/models/currency_price.rb', line 42

def role
  @role
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/advanced_billing/models/currency_price.rb', line 97

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
  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.
  additional_properties = hash.reject { |k, _| names.value?(k) }

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



73
74
75
 
# File 'lib/advanced_billing/models/currency_price.rb', line 73

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/advanced_billing/models/currency_price.rb', line 59

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

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



138
139
140
141
142
143
144
145
 
# File 'lib/advanced_billing/models/currency_price.rb', line 138

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, currency: #{@currency.inspect}, price:"\
  " #{@price.inspect}, formatted_price: #{@formatted_price.inspect}, price_id:"\
  " #{@price_id.inspect}, price_point_id: #{@price_point_id.inspect}, product_price_point_id:"\
  " #{@product_price_point_id.inspect}, role: #{@role.inspect}, additional_properties:"\
  " #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



129
130
131
132
133
134
135
 
# File 'lib/advanced_billing/models/currency_price.rb', line 129

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, currency: #{@currency}, price: #{@price}, formatted_price:"\
  " #{@formatted_price}, price_id: #{@price_id}, price_point_id: #{@price_point_id},"\
  " product_price_point_id: #{@product_price_point_id}, role: #{@role}, additional_properties:"\
  " #{get_additional_properties}>"
end