Class: SquareConnect::BatchRetrieveCatalogObjectsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/batch_retrieve_catalog_objects_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchRetrieveCatalogObjectsRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 40

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'object_ids')
    if (value = attributes[:'object_ids']).is_a?(Array)
      self.object_ids = value
    end
  end

  if attributes.has_key?(:'include_related_objects')
    self.include_related_objects = attributes[:'include_related_objects']
  end

end

Instance Attribute Details

If ‘true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.



19
20
21
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 19

def include_related_objects
  @include_related_objects
end

#object_ids ⇒ Object

The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved.



16
17
18
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 16

def object_ids
  @object_ids
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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

def self.attribute_map
  {
    :'object_ids' => :'object_ids',
    :'include_related_objects' => :'include_related_objects'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 31

def self.swagger_types
  {
    :'object_ids' => :'Array<String>',
    :'include_related_objects' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



78
79
80
81
82
83
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 78

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object_ids == o.object_ids &&
      include_related_objects == o.include_related_objects
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 121

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = SquareConnect.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 187

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 100

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


87
88
89
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 87

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



93
94
95
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 93

def hash
  [object_ids, include_related_objects].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



60
61
62
63
64
65
66
67
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 60

def list_invalid_properties
  invalid_properties = Array.new
  if @object_ids.nil?
    invalid_properties.push("invalid value for 'object_ids', object_ids cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 167

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 173

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



161
162
163
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 161

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



71
72
73
74
 
# File 'lib/square_connect/models/batch_retrieve_catalog_objects_request.rb', line 71

def valid?
  return false if @object_ids.nil?
  return true
end