Class: AdvancedBilling::AllocationPreviewItem

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

Overview

AllocationPreviewItem Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(component_id: SKIP, subscription_id: SKIP, quantity: SKIP, previous_quantity: SKIP, memo: SKIP, timestamp: SKIP, proration_upgrade_scheme: SKIP, proration_downgrade_scheme: SKIP, accrue_charge: SKIP, upgrade_charge: SKIP, downgrade_credit: SKIP, price_point_id: SKIP, interval: SKIP, interval_unit: SKIP, previous_price_point_id: SKIP, price_point_handle: SKIP, price_point_name: SKIP, component_handle: SKIP, additional_properties: {}) ⇒ AllocationPreviewItem

Returns a new instance of AllocationPreviewItem.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 163

def initialize(component_id: SKIP, subscription_id: SKIP, quantity: SKIP,
               previous_quantity: SKIP, memo: SKIP, timestamp: SKIP,
               proration_upgrade_scheme: SKIP,
               proration_downgrade_scheme: SKIP, accrue_charge: SKIP,
               upgrade_charge: SKIP, downgrade_credit: SKIP,
               price_point_id: SKIP, interval: SKIP, interval_unit: SKIP,
               previous_price_point_id: SKIP, price_point_handle: SKIP,
               price_point_name: SKIP, component_handle: SKIP,
               additional_properties: {})
  @component_id = component_id unless component_id == SKIP
  @subscription_id = subscription_id unless subscription_id == SKIP
  @quantity = quantity unless quantity == SKIP
  @previous_quantity = previous_quantity unless previous_quantity == SKIP
  @memo = memo unless memo == SKIP
  @timestamp = timestamp unless timestamp == SKIP
  @proration_upgrade_scheme = proration_upgrade_scheme unless proration_upgrade_scheme == SKIP
  unless proration_downgrade_scheme == SKIP
    @proration_downgrade_scheme =
      proration_downgrade_scheme
  end
  @accrue_charge = accrue_charge unless accrue_charge == SKIP
  @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
  @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
  @price_point_id = price_point_id unless price_point_id == SKIP
  @interval = interval unless interval == SKIP
  @interval_unit = interval_unit unless interval_unit == SKIP
  @previous_price_point_id = previous_price_point_id unless previous_price_point_id == SKIP
  @price_point_handle = price_point_handle unless price_point_handle == SKIP
  @price_point_name = price_point_name unless price_point_name == SKIP
  @component_handle = component_handle unless component_handle == SKIP

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

Instance Attribute Details

#accrue_charge ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


46
47
48
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 46

def accrue_charge
  @accrue_charge
end

#component_handle ⇒ String

A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled.

Returns:

  • (String) 


101
102
103
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 101

def component_handle
  @component_handle
end

#component_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def component_id
  @component_id
end

#downgrade_credit ⇒ CreditType

The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: ‘full`, `prorated`, `none`.

Returns:



58
59
60
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 58

def downgrade_credit
  @downgrade_credit
end

#interval ⇒ Integer

The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled.

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 71

def interval
  @interval
end

#interval_unit ⇒ IntervalUnit

A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled.

Returns:



77
78
79
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 77

def interval_unit
  @interval_unit
end

#memo ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def memo
  @memo
end

#previous_price_point_id ⇒ Integer

A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled.

Returns:

  • (Integer) 


83
84
85
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 83

def previous_price_point_id
  @previous_price_point_id
end

#previous_quantity ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def previous_quantity
  @previous_quantity
end

#price_point_handle ⇒ String

A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled.

Returns:

  • (String) 


89
90
91
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 89

def price_point_handle
  @price_point_handle
end

#price_point_id ⇒ Integer

The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: ‘full`, `prorated`, `none`.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 64

def price_point_id
  @price_point_id
end

#price_point_name ⇒ String

A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled.

Returns:

  • (String) 


95
96
97
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 95

def price_point_name
  @price_point_name
end

#proration_downgrade_scheme ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def proration_downgrade_scheme
  @proration_downgrade_scheme
end

#proration_upgrade_scheme ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def proration_upgrade_scheme
  @proration_upgrade_scheme
end

#quantity ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def quantity
  @quantity
end

#subscription_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def subscription_id
  @subscription_id
end

#timestamp ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def timestamp
  @timestamp
end

#upgrade_charge ⇒ CreditType

The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided. Available values: ‘full`, `prorated`, `none`.

Returns:



52
53
54
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 52

def upgrade_charge
  @upgrade_charge
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 201

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
  subscription_id =
    hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
  quantity = hash.key?('quantity') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:AllocationPreviewItemQuantity), hash['quantity']
  ) : SKIP
  previous_quantity = hash.key?('previous_quantity') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:AllocationPreviewItemPreviousQuantity), hash['previous_quantity']
  ) : SKIP
  memo = hash.key?('memo') ? hash['memo'] : SKIP
  timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
  proration_upgrade_scheme =
    hash.key?('proration_upgrade_scheme') ? hash['proration_upgrade_scheme'] : SKIP
  proration_downgrade_scheme =
    hash.key?('proration_downgrade_scheme') ? hash['proration_downgrade_scheme'] : SKIP
  accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
  upgrade_charge =
    hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
  downgrade_credit =
    hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
  price_point_id =
    hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
  interval = hash.key?('interval') ? hash['interval'] : SKIP
  interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
  previous_price_point_id =
    hash.key?('previous_price_point_id') ? hash['previous_price_point_id'] : SKIP
  price_point_handle =
    hash.key?('price_point_handle') ? hash['price_point_handle'] : SKIP
  price_point_name =
    hash.key?('price_point_name') ? hash['price_point_name'] : SKIP
  component_handle =
    hash.key?('component_handle') ? hash['component_handle'] : SKIP

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

  # Create object from extracted values.
  AllocationPreviewItem.new(component_id: component_id,
                            subscription_id: subscription_id,
                            quantity: quantity,
                            previous_quantity: previous_quantity,
                            memo: memo,
                            timestamp: timestamp,
                            proration_upgrade_scheme: proration_upgrade_scheme,
                            proration_downgrade_scheme: proration_downgrade_scheme,
                            accrue_charge: accrue_charge,
                            upgrade_charge: upgrade_charge,
                            downgrade_credit: downgrade_credit,
                            price_point_id: price_point_id,
                            interval: interval,
                            interval_unit: interval_unit,
                            previous_price_point_id: previous_price_point_id,
                            price_point_handle: price_point_handle,
                            price_point_name: price_point_name,
                            component_handle: component_handle,
                            additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 104

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['component_id'] = 'component_id'
  @_hash['subscription_id'] = 'subscription_id'
  @_hash['quantity'] = 'quantity'
  @_hash['previous_quantity'] = 'previous_quantity'
  @_hash['memo'] = 'memo'
  @_hash['timestamp'] = 'timestamp'
  @_hash['proration_upgrade_scheme'] = 'proration_upgrade_scheme'
  @_hash['proration_downgrade_scheme'] = 'proration_downgrade_scheme'
  @_hash['accrue_charge'] = 'accrue_charge'
  @_hash['upgrade_charge'] = 'upgrade_charge'
  @_hash['downgrade_credit'] = 'downgrade_credit'
  @_hash['price_point_id'] = 'price_point_id'
  @_hash['interval'] = 'interval'
  @_hash['interval_unit'] = 'interval_unit'
  @_hash['previous_price_point_id'] = 'previous_price_point_id'
  @_hash['price_point_handle'] = 'price_point_handle'
  @_hash['price_point_name'] = 'price_point_name'
  @_hash['component_handle'] = 'component_handle'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 152

def self.nullables
  %w[
    memo
    timestamp
    upgrade_charge
    downgrade_credit
    interval_unit
    component_handle
  ]
end

.optionals ⇒ Object

An array for optional fields



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 128

def self.optionals
  %w[
    component_id
    subscription_id
    quantity
    previous_quantity
    memo
    timestamp
    proration_upgrade_scheme
    proration_downgrade_scheme
    accrue_charge
    upgrade_charge
    downgrade_credit
    price_point_id
    interval
    interval_unit
    previous_price_point_id
    price_point_handle
    price_point_name
    component_handle
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



265
266
267
268
269
270
271
 
# File 'lib/advanced_billing/models/allocation_preview_item.rb', line 265

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

  return false unless value.instance_of? Hash

  true
end