Class: NewStoreApi::StockUnallocatedItemsRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/stock_unallocated_items_request.rb

Overview

Use this API to fetch unallocated items, filtered by ATPKeys.

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(atp_keys = nil) ⇒ StockUnallocatedItemsRequest

Returns a new instance of StockUnallocatedItemsRequest.



33
34
35
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 33

def initialize(atp_keys = nil)
  @atp_keys = atp_keys
end

Instance Attribute Details

#atp_keys ⇒ Array[AtpKey]

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 14

def atp_keys
  @atp_keys
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 38

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

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

  # Create object from extracted values.
  StockUnallocatedItemsRequest.new(atp_keys)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 24

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



64
65
66
67
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 64

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



58
59
60
61
 
# File 'lib/new_store_api/models/stock_unallocated_items_request.rb', line 58

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