Class: WalmartApIs::CreateQuerySpecification

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

Overview

CreateQuerySpecification 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(query:, pagination: SKIP, additional_properties: nil) ⇒ CreateQuerySpecification

Returns a new instance of CreateQuerySpecification.



42
43
44
45
46
47
48
49
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 42

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

  @query = query
  @pagination = pagination unless pagination == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#pagination ⇒ Pagination2

Structured query string. Format TBD pending ADR: GraphQL vs Walmart-native query DSL (Pod 4).

Returns:



20
21
22
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 20

def pagination
  @pagination
end

#query ⇒ String

Structured query string. Format TBD pending ADR: GraphQL vs Walmart-native query DSL (Pod 4).

Returns:

  • (String) 


15
16
17
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 15

def query
  @query
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  query = hash.key?('query') ? hash['query'] : nil
  pagination = Pagination2.from_hash(hash['pagination']) if hash['pagination']

  # 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.
  CreateQuerySpecification.new(query: query,
                               pagination: pagination,
                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 23

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

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 31

def self.optionals
  %w[
    pagination
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 80

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/walmart_ap_is/models/create_query_specification.rb', line 73

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