Class: ApiReference::CumulativeGroupedBulkConfig1

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

Overview

Configuration for cumulative_grouped_bulk 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(group:, dimension_values:) ⇒ CumulativeGroupedBulkConfig1

Returns a new instance of CumulativeGroupedBulkConfig1.



38
39
40
41
 
# File 'lib/api_reference/models/cumulative_grouped_bulk_config1.rb', line 38

def initialize(group:, dimension_values:)
  @group = group
  @dimension_values = dimension_values
end

Instance Attribute Details

#dimension_values ⇒ Array[CumulativeGroupedBulkDimensionValue]

Each tier lower bound must have the same group of values.

Returns:



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

def dimension_values
  @dimension_values
end

#group ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def group
  @group
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/api_reference/models/cumulative_grouped_bulk_config1.rb', line 44

def self.from_hash(hash)
  return nil unless hash

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

  dimension_values = nil unless hash.key?('dimension_values')

  # Create object from extracted values.
  CumulativeGroupedBulkConfig1.new(group: group,
                                   dimension_values: dimension_values)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/api_reference/models/cumulative_grouped_bulk_config1.rb', line 67

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.group,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.dimension_values,
                              ->(val) { CumulativeGroupedBulkDimensionValue.validate(val) },
                              is_model_hash: true,
                              is_inner_model_hash: true)
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['group'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['dimension_values'],
                            ->(val) { CumulativeGroupedBulkDimensionValue.validate(val) },
                            is_model_hash: true,
                            is_inner_model_hash: true)
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
 
# File 'lib/api_reference/models/cumulative_grouped_bulk_config1.rb', line 98

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} group: #{@group.inspect}, dimension_values: #{@dimension_values.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



92
93
94
95
 
# File 'lib/api_reference/models/cumulative_grouped_bulk_config1.rb', line 92

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} group: #{@group}, dimension_values: #{@dimension_values}>"
end