Class: AdvancedBilling::PreviewAllocationsRequest

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

Overview

PreviewAllocationsRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(allocations:, effective_proration_date: SKIP, upgrade_charge: SKIP, downgrade_credit: SKIP, additional_properties: {}) ⇒ PreviewAllocationsRequest

Returns a new instance of PreviewAllocationsRequest.



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

def initialize(allocations:, effective_proration_date: SKIP,
               upgrade_charge: SKIP, downgrade_credit: SKIP,
               additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @allocations = allocations
  @effective_proration_date = effective_proration_date unless effective_proration_date == SKIP
  @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
  @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
end

Instance Attribute Details

#allocations ⇒ Array[CreateAllocation]

TODO: Write general description for this method

Returns:



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

def allocations
  @allocations
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:



31
32
33
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 31

def downgrade_credit
  @downgrade_credit
end

#effective_proration_date ⇒ Date

To calculate proration amounts for a future time. Only within a current subscription period. Only ISO8601 format is supported.

Returns:

  • (Date) 


19
20
21
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 19

def effective_proration_date
  @effective_proration_date
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:



25
26
27
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 25

def upgrade_charge
  @upgrade_charge
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 75

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  allocations = nil
  unless hash['allocations'].nil?
    allocations = []
    hash['allocations'].each do |structure|
      allocations << (CreateAllocation.from_hash(structure) if structure)
    end
  end

  allocations = nil unless hash.key?('allocations')
  effective_proration_date =
    hash.key?('effective_proration_date') ? hash['effective_proration_date'] : SKIP
  upgrade_charge =
    hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
  downgrade_credit =
    hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  PreviewAllocationsRequest.new(allocations: allocations,
                                effective_proration_date: effective_proration_date,
                                upgrade_charge: upgrade_charge,
                                downgrade_credit: downgrade_credit,
                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



34
35
36
37
38
39
40
41
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 34

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['allocations'] = 'allocations'
  @_hash['effective_proration_date'] = 'effective_proration_date'
  @_hash['upgrade_charge'] = 'upgrade_charge'
  @_hash['downgrade_credit'] = 'downgrade_credit'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
56
57
58
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 53

def self.nullables
  %w[
    upgrade_charge
    downgrade_credit
  ]
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
49
50
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 44

def self.optionals
  %w[
    effective_proration_date
    upgrade_charge
    downgrade_credit
  ]
end