Class: SquareConnect::WorkweekConfig

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

Overview

Sets the Day of the week and hour of the day that a business starts a work week. Used for the calculation of overtime pay.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkweekConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/square_connect/models/workweek_config.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?(:'id')
    self.id = attributes[:'id']
  end

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

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

Instance Attribute Details

#created_at ⇒ Object

A read-only timestamp in RFC 3339 format; presented in UTC



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

def created_at
  @created_at
end

#id ⇒ Object

UUID for this object



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

def id
  @id
end

#start_of_day_local_time ⇒ Object

The local time at which a business week cuts over. Represented as a string in ‘HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated).



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

def start_of_day_local_time
  @start_of_day_local_time
end

#start_of_week ⇒ Object

The day of the week on which a business week cuts over for compensation purposes. See [Weekday](#type-weekday) for possible values



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

def start_of_week
  @start_of_week
end

#updated_at ⇒ Object

A read-only timestamp in RFC 3339 format; presented in UTC



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

def updated_at
  @updated_at
end

#version ⇒ Object

Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/square_connect/models/workweek_config.rb', line 35

def self.attribute_map
  {
    :'id' => :'id',
    :'start_of_week' => :'start_of_week',
    :'start_of_day_local_time' => :'start_of_day_local_time',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/workweek_config.rb', line 47

def self.swagger_types
  {
    :'id' => :'String',
    :'start_of_week' => :'String',
    :'start_of_day_local_time' => :'String',
    :'version' => :'Integer',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/square_connect/models/workweek_config.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      start_of_week == o.start_of_week &&
      start_of_day_local_time == o.start_of_day_local_time &&
      version == o.version &&
      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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/square_connect/models/workweek_config.rb', line 183

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



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/square_connect/models/workweek_config.rb', line 249

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/square_connect/models/workweek_config.rb', line 162

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


149
150
151
 
# File 'lib/square_connect/models/workweek_config.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/square_connect/models/workweek_config.rb', line 155

def hash
  [id, start_of_week, start_of_day_local_time, version, 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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/square_connect/models/workweek_config.rb', line 94

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

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

  if @start_of_day_local_time.to_s.length < 1
    invalid_properties.push("invalid value for 'start_of_day_local_time', the character length must be great than or equal to 1.")
  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



229
230
231
 
# File 'lib/square_connect/models/workweek_config.rb', line 229

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



235
236
237
238
239
240
241
242
243
 
# File 'lib/square_connect/models/workweek_config.rb', line 235

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



223
224
225
 
# File 'lib/square_connect/models/workweek_config.rb', line 223

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



113
114
115
116
117
118
 
# File 'lib/square_connect/models/workweek_config.rb', line 113

def valid?
  return false if @start_of_week.nil?
  return false if @start_of_day_local_time.nil?
  return false if @start_of_day_local_time.to_s.length < 1
  return true
end