Class: ApiReference::NewDimensionalPriceConfiguration

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

Overview

NewDimensionalPriceConfiguration 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(dimension_values:, dimensional_price_group_id: SKIP, external_dimensional_price_group_id: SKIP, additional_properties: nil) ⇒ NewDimensionalPriceConfiguration

Returns a new instance of NewDimensionalPriceConfiguration.



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

def initialize(dimension_values:, dimensional_price_group_id: SKIP,
               external_dimensional_price_group_id: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  unless dimensional_price_group_id == SKIP
    @dimensional_price_group_id =
      dimensional_price_group_id
  end
  unless external_dimensional_price_group_id == SKIP
    @external_dimensional_price_group_id =
      external_dimensional_price_group_id
  end
  @dimension_values = dimension_values
  @additional_properties = additional_properties
end

Instance Attribute Details

#dimension_values ⇒ Array[String]

The list of dimension values matching (in order) the dimensions of the price group

Returns:

  • (Array[String]) 


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

def dimension_values
  @dimension_values
end

#dimensional_price_group_id ⇒ String

The id of the dimensional price group to include this price in

Returns:

  • (String) 


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

def dimensional_price_group_id
  @dimensional_price_group_id
end

#external_dimensional_price_group_id ⇒ String

The external id of the dimensional price group to include this price in

Returns:

  • (String) 


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

def external_dimensional_price_group_id
  @external_dimensional_price_group_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 70

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  dimension_values =
    hash.key?('dimension_values') ? hash['dimension_values'] : nil
  dimensional_price_group_id =
    hash.key?('dimensional_price_group_id') ? hash['dimensional_price_group_id'] : SKIP
  external_dimensional_price_group_id =
    hash.key?('external_dimensional_price_group_id') ? hash['external_dimensional_price_group_id'] : SKIP

  # 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.
  NewDimensionalPriceConfiguration.new(dimension_values: dimension_values,
                                       dimensional_price_group_id: dimensional_price_group_id,
                                       external_dimensional_price_group_id: external_dimensional_price_group_id,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



44
45
46
47
48
49
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 44

def self.nullables
  %w[
    dimensional_price_group_id
    external_dimensional_price_group_id
  ]
end

.optionals ⇒ Object

An array for optional fields



36
37
38
39
40
41
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 36

def self.optionals
  %w[
    dimensional_price_group_id
    external_dimensional_price_group_id
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 97

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.dimension_values,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['dimension_values'],
                        ->(val) { val.instance_of? String })
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



118
119
120
121
122
123
124
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 118

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



110
111
112
113
114
115
 
# File 'lib/api_reference/models/new_dimensional_price_configuration.rb', line 110

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