Class: ApiReference::PriceIntervalFixedFeeQuantityTransitionParams

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb

Overview

PriceIntervalFixedFeeQuantityTransitionParams 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(quantity:, effective_date:, additional_properties: nil) ⇒ PriceIntervalFixedFeeQuantityTransitionParams

Returns a new instance of PriceIntervalFixedFeeQuantityTransitionParams.



38
39
40
41
42
43
44
45
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 38

def initialize(quantity:, effective_date:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @quantity = quantity
  @effective_date = effective_date
  @additional_properties = additional_properties
end

Instance Attribute Details

#effective_date ⇒ Object

The date that the fixed fee quantity transition should take effect.

Returns:

  • (Object) 


18
19
20
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 18

def effective_date
  @effective_date
end

#quantity ⇒ Integer

The quantity of the fixed fee quantity transition.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 14

def quantity
  @quantity
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  quantity = hash.key?('quantity') ? hash['quantity'] : nil
  effective_date = hash.key?('effective_date') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate), hash['effective_date']
  ) : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  PriceIntervalFixedFeeQuantityTransitionParams.new(quantity: quantity,
                                                    effective_date: effective_date,
                                                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 29

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 78

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.quantity,
                            ->(val) { val.instance_of? Integer }) and
        UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
                       .validate(value.effective_date)
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['quantity'],
                          ->(val) { val.instance_of? Integer }) and
      UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
                     .validate(value['effective_date'])
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



106
107
108
109
110
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 106

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} quantity: #{@quantity.inspect}, effective_date: #{@effective_date.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



99
100
101
102
103
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 99

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} quantity: #{@quantity}, effective_date: #{@effective_date},"\
  " additional_properties: #{@additional_properties}>"
end

#to_union_type_effective_date ⇒ Object 



70
71
72
73
74
 
# File 'lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb', line 70

def to_union_type_effective_date
  UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
                 .validate(effective_date)
                 .serialize(effective_date)
end