class SquareConnect::V1ListEmployeesRequest

Attributes

batch_token[RW]

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

begin_created_at[RW]

If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.

begin_updated_at[RW]

If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format

end_created_at[RW]

If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.

end_updated_at[RW]

If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.

external_id[RW]

If provided, the endpoint returns only employee entities with the specified external_id.

limit[RW]

The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.

order[RW]

The order in which employees are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](type-sortorder) for possible values

status[RW]

If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). See [V1ListEmployeesRequestStatus](type-v1listemployeesrequeststatus) for possible values

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_list_employees_request.rb, line 44
def self.attribute_map
  {
    :'order' => :'order',
    :'begin_updated_at' => :'begin_updated_at',
    :'end_updated_at' => :'end_updated_at',
    :'begin_created_at' => :'begin_created_at',
    :'end_created_at' => :'end_created_at',
    :'status' => :'status',
    :'external_id' => :'external_id',
    :'limit' => :'limit',
    :'batch_token' => :'batch_token'
  }
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_list_employees_request.rb, line 75
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?(:'order')
    self.order = attributes[:'order']
  end

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/v1_list_employees_request.rb, line 59
def self.swagger_types
  {
    :'order' => :'String',
    :'begin_updated_at' => :'String',
    :'end_updated_at' => :'String',
    :'begin_created_at' => :'String',
    :'end_created_at' => :'String',
    :'status' => :'String',
    :'external_id' => :'String',
    :'limit' => :'Integer',
    :'batch_token' => :'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_list_employees_request.rb, line 134
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order == o.order &&
      begin_updated_at == o.begin_updated_at &&
      end_updated_at == o.end_updated_at &&
      begin_created_at == o.begin_created_at &&
      end_created_at == o.end_created_at &&
      status == o.status &&
      external_id == o.external_id &&
      limit == o.limit &&
      batch_token == o.batch_token
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_list_employees_request.rb, line 184
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_list_employees_request.rb, line 250
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_list_employees_request.rb, line 163
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_list_employees_request.rb, line 150
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_list_employees_request.rb, line 156
def hash
  [order, begin_updated_at, end_updated_at, begin_created_at, end_created_at, status, external_id, limit, batch_token].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_list_employees_request.rb, line 121
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_list_employees_request.rb, line 230
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_list_employees_request.rb, line 236
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_list_employees_request.rb, line 224
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_list_employees_request.rb, line 128
def valid?
  return true
end