class SquareConnect::BreakType

A defined break template that sets an expectation for possible `Break` instances on a `Shift`.

Attributes

break_name[RW]

A human-readable name for this type of break. Will be displayed to employees in Square products.

created_at[RW]

A read-only timestamp in RFC 3339 format.

expected_duration[RW]

Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]MS. The expected length of this break. Precision below minutes is truncated.

id[RW]

UUID for this object.

is_paid[RW]

Whether this break counts towards time worked for compensation purposes.

location_id[RW]

The ID of the business location this type of break applies to.

updated_at[RW]

A read-only timestamp in RFC 3339 format.

version[RW]

Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a "blind" write; potentially overwriting another writer's data.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/break_type.rb, line 41
def self.attribute_map
  {
    :'id' => :'id',
    :'location_id' => :'location_id',
    :'break_name' => :'break_name',
    :'expected_duration' => :'expected_duration',
    :'is_paid' => :'is_paid',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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/break_type.rb, line 70
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/break_type.rb, line 55
def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'break_name' => :'String',
    :'expected_duration' => :'String',
    :'is_paid' => :'BOOLEAN',
    :'version' => :'Integer',
    :'created_at' => :'String',
    :'updated_at' => :'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/break_type.rb, line 218
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      location_id == o.location_id &&
      break_name == o.break_name &&
      expected_duration == o.expected_duration &&
      is_paid == o.is_paid &&
      version == o.version &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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/break_type.rb, line 267
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/break_type.rb, line 333
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
break_name=(break_name) click to toggle source

Custom attribute writer method with validation @param [Object] break_name Value to be assigned

# File lib/square_connect/models/break_type.rb, line 190
def break_name=(break_name)
  if break_name.nil?
    fail ArgumentError, "break_name cannot be nil"
  end

  if break_name.to_s.length < 1
    fail ArgumentError, "invalid value for 'break_name', the character length must be great than or equal to 1."
  end

  @break_name = break_name
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/break_type.rb, line 246
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/break_type.rb, line 233
def eql?(o)
  self == o
end
expected_duration=(expected_duration) click to toggle source

Custom attribute writer method with validation @param [Object] expected_duration Value to be assigned

# File lib/square_connect/models/break_type.rb, line 204
def expected_duration=(expected_duration)
  if expected_duration.nil?
    fail ArgumentError, "expected_duration cannot be nil"
  end

  if expected_duration.to_s.length < 1
    fail ArgumentError, "invalid value for 'expected_duration', the character length must be great than or equal to 1."
  end

  @expected_duration = expected_duration
end
hash() click to toggle source

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

# File lib/square_connect/models/break_type.rb, line 239
def hash
  [id, location_id, break_name, expected_duration, is_paid, version, created_at, updated_at].hash
end
id=(id) click to toggle source

Custom attribute writer method with validation @param [Object] id Value to be assigned

# File lib/square_connect/models/break_type.rb, line 165
def id=(id)

  if !id.nil? && id.to_s.length > 255
    fail ArgumentError, "invalid value for 'id', the character length must be smaller than or equal to 255."
  end

  @id = id
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/break_type.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  if !@id.nil? && @id.to_s.length > 255
    invalid_properties.push("invalid value for 'id', the character length must be smaller than or equal to 255.")
  end

  if @location_id.nil?
    invalid_properties.push("invalid value for 'location_id', location_id cannot be nil.")
  end

  if @location_id.to_s.length < 1
    invalid_properties.push("invalid value for 'location_id', the character length must be great than or equal to 1.")
  end

  if @break_name.nil?
    invalid_properties.push("invalid value for 'break_name', break_name cannot be nil.")
  end

  if @break_name.to_s.length < 1
    invalid_properties.push("invalid value for 'break_name', the character length must be great than or equal to 1.")
  end

  if @expected_duration.nil?
    invalid_properties.push("invalid value for 'expected_duration', expected_duration cannot be nil.")
  end

  if @expected_duration.to_s.length < 1
    invalid_properties.push("invalid value for 'expected_duration', the character length must be great than or equal to 1.")
  end

  if @is_paid.nil?
    invalid_properties.push("invalid value for 'is_paid', is_paid cannot be nil.")
  end

  return invalid_properties
end
location_id=(location_id) click to toggle source

Custom attribute writer method with validation @param [Object] location_id Value to be assigned

# File lib/square_connect/models/break_type.rb, line 176
def location_id=(location_id)
  if location_id.nil?
    fail ArgumentError, "location_id cannot be nil"
  end

  if location_id.to_s.length < 1
    fail ArgumentError, "invalid value for 'location_id', the character length must be great than or equal to 1."
  end

  @location_id = location_id
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/break_type.rb, line 313
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/break_type.rb, line 319
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/break_type.rb, line 307
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/break_type.rb, line 151
def valid?
  return false if !@id.nil? && @id.to_s.length > 255
  return false if @location_id.nil?
  return false if @location_id.to_s.length < 1
  return false if @break_name.nil?
  return false if @break_name.to_s.length < 1
  return false if @expected_duration.nil?
  return false if @expected_duration.to_s.length < 1
  return false if @is_paid.nil?
  return true
end