class SquareConnect::V1PageCell

V1PageCell

Attributes

column[RW]

The column of the cell. Always an integer between 0 and 4, inclusive.

object_id[RW]

The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER.

object_type[RW]

The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). See [V1PageCellObjectType](type-v1pagecellobjecttype) for possible values

page_id[RW]

The unique identifier of the page the cell is included on.

placeholder_type[RW]

For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. See [V1PageCellPlaceholderType](type-v1pagecellplaceholdertype) for possible values

row[RW]

The row of the cell. Always an integer between 0 and 4, inclusive.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/v1_page_cell.rb, line 35
def self.attribute_map
  {
    :'page_id' => :'page_id',
    :'row' => :'row',
    :'column' => :'column',
    :'object_type' => :'object_type',
    :'object_id' => :'object_id',
    :'placeholder_type' => :'placeholder_type'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/square_connect/models/v1_page_cell.rb, line 60
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?(:'page_id')
    self.page_id = attributes[:'page_id']
  end

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/v1_page_cell.rb, line 47
def self.swagger_types
  {
    :'page_id' => :'String',
    :'row' => :'Integer',
    :'column' => :'Integer',
    :'object_type' => :'String',
    :'object_id' => :'String',
    :'placeholder_type' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/square_connect/models/v1_page_cell.rb, line 107
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      page_id == o.page_id &&
      row == o.row &&
      column == o.column &&
      object_type == o.object_type &&
      object_id == o.object_id &&
      placeholder_type == o.placeholder_type
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/square_connect/models/v1_page_cell.rb, line 154
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/square_connect/models/v1_page_cell.rb, line 220
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/square_connect/models/v1_page_cell.rb, line 133
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/square_connect/models/v1_page_cell.rb, line 120
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/square_connect/models/v1_page_cell.rb, line 126
def hash
  [page_id, row, column, object_type, object_id, placeholder_type].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/square_connect/models/v1_page_cell.rb, line 94
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/v1_page_cell.rb, line 200
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/v1_page_cell.rb, line 206
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/square_connect/models/v1_page_cell.rb, line 194
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/square_connect/models/v1_page_cell.rb, line 101
def valid?
  return true
end