Class: SquareConnect::BreakType
- Inherits:
-
Object
- Object
- SquareConnect::BreakType
- Defined in:
- lib/square_connect/models/break_type.rb
Overview
A defined break template that sets an expectation for possible ‘Break` instances on a `Shift`.
Instance Attribute Summary collapse
-
#break_name ⇒ Object
A human-readable name for this type of break.
-
#created_at ⇒ Object
A read-only timestamp in RFC 3339 format.
-
#expected_duration ⇒ Object
Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]MS.
-
#id ⇒ Object
UUID for this object.
-
#is_paid ⇒ Object
Whether this break counts towards time worked for compensation purposes.
-
#location_id ⇒ Object
The ID of the business location this type of break applies to.
-
#updated_at ⇒ Object
A read-only timestamp in RFC 3339 format.
-
#version ⇒ Object
Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BreakType
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ BreakType
Initializes the object
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# 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 |
Instance Attribute Details
#break_name ⇒ Object
A human-readable name for this type of break. Will be displayed to employees in Square products.
22 23 24 |
# File 'lib/square_connect/models/break_type.rb', line 22 def break_name @break_name end |
#created_at ⇒ Object
A read-only timestamp in RFC 3339 format.
34 35 36 |
# File 'lib/square_connect/models/break_type.rb', line 34 def created_at @created_at end |
#expected_duration ⇒ Object
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.
25 26 27 |
# File 'lib/square_connect/models/break_type.rb', line 25 def expected_duration @expected_duration end |
#id ⇒ Object
UUID for this object.
16 17 18 |
# File 'lib/square_connect/models/break_type.rb', line 16 def id @id end |
#is_paid ⇒ Object
Whether this break counts towards time worked for compensation purposes.
28 29 30 |
# File 'lib/square_connect/models/break_type.rb', line 28 def is_paid @is_paid end |
#location_id ⇒ Object
The ID of the business location this type of break applies to.
19 20 21 |
# File 'lib/square_connect/models/break_type.rb', line 19 def location_id @location_id end |
#updated_at ⇒ Object
A read-only timestamp in RFC 3339 format.
37 38 39 |
# File 'lib/square_connect/models/break_type.rb', line 37 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 a value is not provided, Square’s servers execute a "blind" write; potentially overwriting another writer’s data.
31 32 33 |
# File 'lib/square_connect/models/break_type.rb', line 31 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
41 42 43 44 45 46 47 48 49 50 51 52 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
55 56 57 58 59 60 61 62 63 64 65 66 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
218 219 220 221 222 223 224 225 226 227 228 229 |
# 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) ⇒ Object
Deserializes the data based on type
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
333 334 335 336 337 338 339 340 341 342 343 344 345 |
# 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# 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) ⇒ Boolean
233 234 235 |
# File 'lib/square_connect/models/break_type.rb', line 233 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
239 240 241 |
# 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# 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 |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
313 314 315 |
# File 'lib/square_connect/models/break_type.rb', line 313 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
319 320 321 322 323 324 325 326 327 |
# 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 ⇒ String
Returns the string representation of the object
307 308 309 |
# File 'lib/square_connect/models/break_type.rb', line 307 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
151 152 153 154 155 156 157 158 159 160 161 |
# 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 |