Class: WalmartApIs::SuccessfulOperation3

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/walmart_ap_is/models/successful_operation3.rb

Overview

SuccessfulOperation3 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(total_elements:, strategy_collections:, additional_properties: nil) ⇒ SuccessfulOperation3

Returns a new instance of SuccessfulOperation3.



38
39
40
41
42
43
44
45
46
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 38

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

  @total_elements = total_elements
  @strategy_collections = strategy_collections
  @additional_properties = additional_properties
end

Instance Attribute Details

#strategy_collections ⇒ Array[StrategyCollection]

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 18

def strategy_collections
  @strategy_collections
end

#total_elements ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 14

def total_elements
  @total_elements
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 49

def self.from_hash(hash)
  return nil unless hash

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

  strategy_collections = nil unless hash.key?('strategyCollections')

  # 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.
  SuccessfulOperation3.new(total_elements: total_elements,
                           strategy_collections: strategy_collections,
                           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/walmart_ap_is/models/successful_operation3.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['total_elements'] = 'totalElements'
  @_hash['strategy_collections'] = 'strategyCollections'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 29

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



86
87
88
89
90
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 86

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
83
 
# File 'lib/walmart_ap_is/models/successful_operation3.rb', line 79

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