Class: SquareConnect::V1Employee

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

Overview

Represents one of a business’s employees.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Employee

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/square_connect/models/v1_employee.rb', line 101

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?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

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

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

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

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  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?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

end

Instance Attribute Details

#authorized_location_ids ⇒ Object

The IDs of the locations the employee is allowed to clock in at.



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

def authorized_location_ids
  @authorized_location_ids
end

#created_at ⇒ Object

The time when the employee entity was created, in ISO 8601 format.



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

def created_at
  @created_at
end

#email ⇒ Object

The employee’s email address.



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

def email
  @email
end

#external_id ⇒ Object

An ID the merchant can set to associate the employee with an entity in another system.



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

def external_id
  @external_id
end

#first_name ⇒ Object

The employee’s first name.



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

def first_name
  @first_name
end

#id ⇒ Object

The employee’s unique ID.



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

def id
  @id
end

#last_name ⇒ Object

The employee’s last name.



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

def last_name
  @last_name
end

#role_ids ⇒ Object

The ids of the employee’s associated roles. Currently, you can specify only one or zero roles per employee.



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

def role_ids
  @role_ids
end

#status ⇒ Object

CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.



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

def status
  @status
end

#updated_at ⇒ Object

The time when the employee entity was most recently updated, in ISO 8601 format.



43
44
45
 
# File 'lib/square_connect/models/v1_employee.rb', line 43

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/square_connect/models/v1_employee.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'role_ids' => :'role_ids',
    :'authorized_location_ids' => :'authorized_location_ids',
    :'email' => :'email',
    :'status' => :'status',
    :'external_id' => :'external_id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/square_connect/models/v1_employee.rb', line 84

def self.swagger_types
  {
    :'id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'role_ids' => :'Array<String>',
    :'authorized_location_ids' => :'Array<String>',
    :'email' => :'String',
    :'status' => :'String',
    :'external_id' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/square_connect/models/v1_employee.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      role_ids == o.role_ids &&
      authorized_location_ids == o.authorized_location_ids &&
      email == o.email &&
      status == o.status &&
      external_id == o.external_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



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
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/square_connect/models/v1_employee.rb', line 241

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/square_connect/models/v1_employee.rb', line 307

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/square_connect/models/v1_employee.rb', line 220

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


207
208
209
 
# File 'lib/square_connect/models/v1_employee.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/square_connect/models/v1_employee.rb', line 213

def hash
  [id, first_name, last_name, role_ids, authorized_location_ids, email, status, external_id, created_at, updated_at].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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/square_connect/models/v1_employee.rb', line 155

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

  if @last_name.nil?
    invalid_properties.push("invalid value for 'last_name', last_name 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



287
288
289
 
# File 'lib/square_connect/models/v1_employee.rb', line 287

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



293
294
295
296
297
298
299
300
301
 
# File 'lib/square_connect/models/v1_employee.rb', line 293

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



281
282
283
 
# File 'lib/square_connect/models/v1_employee.rb', line 281

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



170
171
172
173
174
175
176
 
# File 'lib/square_connect/models/v1_employee.rb', line 170

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "INACTIVE"])
  return false unless status_validator.valid?(@status)
  return true
end