Class: ApiReference::Maximum

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

Overview

Maximum 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(maximum_amount:, filters:, applies_to_price_ids:, additional_properties: nil) ⇒ Maximum

Returns a new instance of Maximum.



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/api_reference/models/maximum.rb', line 44

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

  @maximum_amount = maximum_amount
  @filters = filters
  @applies_to_price_ids = applies_to_price_ids
  @additional_properties = additional_properties
end

Instance Attribute Details

#applies_to_price_ids ⇒ Array[String]

List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.

Returns:

  • (Array[String]) 


23
24
25
 
# File 'lib/api_reference/models/maximum.rb', line 23

def applies_to_price_ids
  @applies_to_price_ids
end

#filters ⇒ Array[PriceFilter]

The filters that determine which prices to apply this maximum to.

Returns:



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

def filters
  @filters
end

#maximum_amount ⇒ String

Maximum amount applied

Returns:

  • (String) 


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

def maximum_amount
  @maximum_amount
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/api_reference/models/maximum.rb', line 56

def self.from_hash(hash)
  return nil unless hash

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

  filters = nil unless hash.key?('filters')
  applies_to_price_ids =
    hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : 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.
  Maximum.new(maximum_amount: maximum_amount,
              filters: filters,
              applies_to_price_ids: applies_to_price_ids,
              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/api_reference/models/maximum.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['maximum_amount'] = 'maximum_amount'
  @_hash['filters'] = 'filters'
  @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



40
41
42
 
# File 'lib/api_reference/models/maximum.rb', line 40

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
 
# File 'lib/api_reference/models/maximum.rb', line 35

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (Maximum | Hash) —

    value against the validation is performed.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/api_reference/models/maximum.rb', line 91

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.maximum_amount,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.filters,
                              ->(val) { PriceFilter.validate(val) },
                              is_model_hash: true,
                              is_inner_model_hash: true) and
        APIHelper.valid_type?(value.applies_to_price_ids,
                              ->(val) { val.instance_of? String })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['maximum_amount'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['filters'],
                            ->(val) { PriceFilter.validate(val) },
                            is_model_hash: true,
                            is_inner_model_hash: true) and
      APIHelper.valid_type?(value['applies_to_price_ids'],
                            ->(val) { val.instance_of? String })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



128
129
130
131
132
133
 
# File 'lib/api_reference/models/maximum.rb', line 128

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



120
121
122
123
124
125
 
# File 'lib/api_reference/models/maximum.rb', line 120

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