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

#to_hash, #to_json

Constructor Details

#initialize(allocations = nil, effective_proration_date = SKIP) ⇒ PreviewAllocationsRequest

Returns a new instance of PreviewAllocationsRequest.



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

def initialize(allocations = nil, effective_proration_date = SKIP)
  @allocations = allocations
  @effective_proration_date = effective_proration_date unless effective_proration_date == 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

#effective_proration_date ⇒ String

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

Returns:

  • (String) 


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

def effective_proration_date
  @effective_proration_date
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 47

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

  # Create object from extracted values.

  PreviewAllocationsRequest.new(allocations,
                                effective_proration_date)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/preview_allocations_request.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    effective_proration_date
  ]
end