Class: SquareConnect::Location

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

Overview

Represents one of a business’s locations.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Location

Initializes the object

Parameters:

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

    Model attributes in the form of hash



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
220
221
222
223
224
225
226
227
228
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
 
# File 'lib/square_connect/models/location.rb', line 161

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#address ⇒ Object

The location’s physical address.



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

def address
  @address
end

#business_email ⇒ Object

The email of the location.



64
65
66
 
# File 'lib/square_connect/models/location.rb', line 64

def business_email
  @business_email
end

#business_hours ⇒ Object

The hours of operation for a business location. Default: none; only exists if explicitly set.



61
62
63
 
# File 'lib/square_connect/models/location.rb', line 61

def business_hours
  @business_hours
end

#business_name ⇒ Object

The location’s business_name which is shown to its customers. For example, this is the name printed on its customer’s receipts.



52
53
54
 
# File 'lib/square_connect/models/location.rb', line 52

def business_name
  @business_name
end

#capabilities ⇒ Object

Indicates which Square features are enabled for the location. See [LocationCapability](#type-locationcapability) for possible values



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

def capabilities
  @capabilities
end

#coordinates ⇒ Object

The physical coordinates (latitude and longitude) of the location.



79
80
81
 
# File 'lib/square_connect/models/location.rb', line 79

def coordinates
  @coordinates
end

#country ⇒ Object

The location’s country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values



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

def country
  @country
end

#created_at ⇒ Object

The time when the location was created, in RFC 3339 format.



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

def created_at
  @created_at
end

#currency ⇒ Object

The currency used for all transactions at this location, specified in __ISO 4217 format__. For example, the currency for a location processing transactions in the United States is ‘USD’. See [Currency](#type-currency) for possible values



46
47
48
 
# File 'lib/square_connect/models/location.rb', line 46

def currency
  @currency
end

#description ⇒ Object

The business description of the location.



67
68
69
 
# File 'lib/square_connect/models/location.rb', line 67

def description
  @description
end

#facebook_url ⇒ Object

The Facebook profile URL of the location. The URL should begin with ‘facebook.com/’.



76
77
78
 
# File 'lib/square_connect/models/location.rb', line 76

def facebook_url
  @facebook_url
end

#id ⇒ Object

The location’s unique ID.



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

def id
  @id
end

#instagram_username ⇒ Object

The Instagram username of the location without the ‘



73
74
75
 
# File 'lib/square_connect/models/location.rb', line 73

def instagram_username
  @instagram_username
end

#language_code ⇒ Object

The language associated with the location in [BCP 47 format](tools.ietf.org/html/bcp47#appendix-A).



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

def language_code
  @language_code
end

#merchant_id ⇒ Object

The identifier of the merchant that owns the location.



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

The location’s name. Location names are set by the account owner and displayed in the dashboard as the location’s nickname



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

def name
  @name
end

#phone_number ⇒ Object

The location’s phone_number.



49
50
51
 
# File 'lib/square_connect/models/location.rb', line 49

def phone_number
  @phone_number
end

#status ⇒ Object

The location’s status See [LocationStatus](#type-locationstatus) for possible values



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

def status
  @status
end

#timezone ⇒ Object

The [IANA Timezone Database](www.iana.org/time-zones) identifier for the location’s timezone.



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

def timezone
  @timezone
end

#twitter_username ⇒ Object

The Twitter username of the location without the ‘



70
71
72
 
# File 'lib/square_connect/models/location.rb', line 70

def twitter_username
  @twitter_username
end

#type ⇒ Object

The location’s type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values



55
56
57
 
# File 'lib/square_connect/models/location.rb', line 55

def type
  @type
end

#website_url ⇒ Object

The location’s website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.



58
59
60
 
# File 'lib/square_connect/models/location.rb', line 58

def website_url
  @website_url
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/square_connect/models/location.rb', line 104

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'address' => :'address',
    :'timezone' => :'timezone',
    :'capabilities' => :'capabilities',
    :'status' => :'status',
    :'created_at' => :'created_at',
    :'merchant_id' => :'merchant_id',
    :'country' => :'country',
    :'language_code' => :'language_code',
    :'currency' => :'currency',
    :'phone_number' => :'phone_number',
    :'business_name' => :'business_name',
    :'type' => :'type',
    :'website_url' => :'website_url',
    :'business_hours' => :'business_hours',
    :'business_email' => :'business_email',
    :'description' => :'description',
    :'twitter_username' => :'twitter_username',
    :'instagram_username' => :'instagram_username',
    :'facebook_url' => :'facebook_url',
    :'coordinates' => :'coordinates'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/square_connect/models/location.rb', line 132

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'address' => :'Address',
    :'timezone' => :'String',
    :'capabilities' => :'Array<String>',
    :'status' => :'String',
    :'created_at' => :'String',
    :'merchant_id' => :'String',
    :'country' => :'String',
    :'language_code' => :'String',
    :'currency' => :'String',
    :'phone_number' => :'String',
    :'business_name' => :'String',
    :'type' => :'String',
    :'website_url' => :'String',
    :'business_hours' => :'BusinessHours',
    :'business_email' => :'String',
    :'description' => :'String',
    :'twitter_username' => :'String',
    :'instagram_username' => :'String',
    :'facebook_url' => :'String',
    :'coordinates' => :'Coordinates'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/square_connect/models/location.rb', line 322

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      timezone == o.timezone &&
      capabilities == o.capabilities &&
      status == o.status &&
      created_at == o.created_at &&
      merchant_id == o.merchant_id &&
      country == o.country &&
      language_code == o.language_code &&
      currency == o.currency &&
      phone_number == o.phone_number &&
      business_name == o.business_name &&
      type == o.type &&
      website_url == o.website_url &&
      business_hours == o.business_hours &&
      business_email == o.business_email &&
      description == o.description &&
      twitter_username == o.twitter_username &&
      instagram_username == o.instagram_username &&
      facebook_url == o.facebook_url &&
      coordinates == o.coordinates
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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/square_connect/models/location.rb', line 385

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/square_connect/models/location.rb', line 451

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/square_connect/models/location.rb', line 364

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


351
352
353
 
# File 'lib/square_connect/models/location.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/square_connect/models/location.rb', line 357

def hash
  [id, name, address, timezone, capabilities, status, created_at, merchant_id, country, language_code, currency, phone_number, business_name, type, website_url, business_hours, business_email, description, twitter_username, instagram_username, facebook_url, coordinates].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



261
262
263
264
 
# File 'lib/square_connect/models/location.rb', line 261

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



431
432
433
 
# File 'lib/square_connect/models/location.rb', line 431

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



437
438
439
440
441
442
443
444
445
 
# File 'lib/square_connect/models/location.rb', line 437

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



425
426
427
 
# File 'lib/square_connect/models/location.rb', line 425

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



268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/square_connect/models/location.rb', line 268

def valid?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "INACTIVE"])
  return false unless status_validator.valid?(@status)
  country_validator = EnumAttributeValidator.new('String', ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"])
  return false unless country_validator.valid?(@country)
  currency_validator = EnumAttributeValidator.new('String', ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC"])
  return false unless currency_validator.valid?(@currency)
  type_validator = EnumAttributeValidator.new('String', ["PHYSICAL", "MOBILE"])
  return false unless type_validator.valid?(@type)
  return true
end