Class: SquareConnect::V1ListEmployeesRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ListEmployeesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 96

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

Instance Attribute Details

#batch_token ⇒ Object

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



40
41
42
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 40

def batch_token
  @batch_token
end

#begin_created_at ⇒ Object

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



25
26
27
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 25

def begin_created_at
  @begin_created_at
end

#begin_updated_at ⇒ Object

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



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

def begin_updated_at
  @begin_updated_at
end

#end_created_at ⇒ Object

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



28
29
30
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 28

def end_created_at
  @end_created_at
end

#end_updated_at ⇒ Object

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



22
23
24
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 22

def end_updated_at
  @end_updated_at
end

#external_id ⇒ Object

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



34
35
36
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 34

def external_id
  @external_id
end

#limit ⇒ Object

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



37
38
39
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 37

def limit
  @limit
end

#order ⇒ Object

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



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

def order
  @order
end

#status ⇒ Object

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



31
32
33
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 31

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 65

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

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 80

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 179

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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 229

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 295

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 208

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


195
196
197
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 201

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 ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



142
143
144
145
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  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



275
276
277
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 281

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



269
270
271
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 269

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



149
150
151
152
153
154
155
 
# File 'lib/square_connect/models/v1_list_employees_request.rb', line 149

def valid?
  order_validator = EnumAttributeValidator.new('String', ["DESC", "ASC"])
  return false unless order_validator.valid?(@order)
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "INACTIVE"])
  return false unless status_validator.valid?(@status)
  return true
end