Class: ApiReference::MaxGroupTieredPackageConfig1

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

Overview

Configuration for max_group_tiered_package pricing

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(tiers:, package_size:, grouping_key:) ⇒ MaxGroupTieredPackageConfig1

Returns a new instance of MaxGroupTieredPackageConfig1.



46
47
48
49
50
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 46

def initialize(tiers:, package_size:, grouping_key:)
  @tiers = tiers
  @package_size = package_size
  @grouping_key = grouping_key
end

Instance Attribute Details

#grouping_key ⇒ String

The event property used to group before tiering the group with the highest value

Returns:

  • (String) 


25
26
27
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 25

def grouping_key
  @grouping_key
end

#package_size ⇒ String

Apply tiered pricing to the largest group after grouping with the provided key.

Returns:

  • (String) 


20
21
22
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 20

def package_size
  @package_size
end

#tiers ⇒ Array[MaxGroupTieredTierItem]

Apply tiered pricing to the largest group after grouping with the provided key.

Returns:



15
16
17
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 15

def tiers
  @tiers
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 53

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
  tiers = nil
  unless hash['tiers'].nil?
    tiers = []
    hash['tiers'].each do |structure|
      tiers << (MaxGroupTieredTierItem.from_hash(structure) if structure)
    end
  end

  tiers = nil unless hash.key?('tiers')
  package_size = hash.key?('package_size') ? hash['package_size'] : nil
  grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil

  # Create object from extracted values.
  MaxGroupTieredPackageConfig1.new(tiers: tiers,
                                   package_size: package_size,
                                   grouping_key: grouping_key)
end

.names ⇒ Object

A mapping from model property names to API property names.



28
29
30
31
32
33
34
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 28

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['tiers'] = 'tiers'
  @_hash['package_size'] = 'package_size'
  @_hash['grouping_key'] = 'grouping_key'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



42
43
44
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 42

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 37

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
97
98
99
100
101
102
103
104
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 78

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.tiers,
                            ->(val) { MaxGroupTieredTierItem.validate(val) },
                            is_model_hash: true,
                            is_inner_model_hash: true) and
        APIHelper.valid_type?(value.package_size,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.grouping_key,
                              ->(val) { val.instance_of? String })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['tiers'],
                          ->(val) { MaxGroupTieredTierItem.validate(val) },
                          is_model_hash: true,
                          is_inner_model_hash: true) and
      APIHelper.valid_type?(value['package_size'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['grouping_key'],
                            ->(val) { val.instance_of? String })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



114
115
116
117
118
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 114

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



107
108
109
110
111
 
# File 'lib/api_reference/models/max_group_tiered_package_config1.rb', line 107

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