Class: SquareConnect::V1Merchant
- Inherits:
-
Object
- Object
- SquareConnect::V1Merchant
- Defined in:
- lib/square_connect/models/v1_merchant.rb
Overview
Defines the fields that are included in the response body of a request to the RetrieveBusiness endpoint.
Instance Attribute Summary collapse
-
#account_capabilities ⇒ Object
Capabilities that are enabled for the merchant’s Square account.
-
#account_type ⇒ Object
Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS).
-
#business_address ⇒ Object
The address of the merchant’s business.
-
#business_name ⇒ Object
The name of the merchant’s business.
-
#business_phone ⇒ Object
The phone number of the merchant’s business.
-
#business_type ⇒ Object
The type of business operated by the merchant.
-
#country_code ⇒ Object
The country associated with the merchant account, in ISO 3166-1-alpha-2 format.
-
#currency_code ⇒ Object
The currency associated with the merchant account, in ISO 4217 format.
-
#email ⇒ Object
The email address associated with the merchant account.
-
#id ⇒ Object
The merchant account’s unique identifier.
-
#language_code ⇒ Object
The language associated with the merchant account, in BCP 47 format.
-
#location_details ⇒ Object
Additional information for a single-location account specified by its associated business account, if it has one.
-
#market_url ⇒ Object
The URL of the merchant’s online store.
-
#name ⇒ Object
The name associated with the merchant account.
-
#shipping_address ⇒ Object
The merchant’s shipping address.
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 = {}) ⇒ V1Merchant
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 = {}) ⇒ V1Merchant
Initializes the object
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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/square_connect/models/v1_merchant.rb', line 105 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?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'account_type') self.account_type = attributes[:'account_type'] end if attributes.has_key?(:'account_capabilities') if (value = attributes[:'account_capabilities']).is_a?(Array) self.account_capabilities = value end end if attributes.has_key?(:'country_code') self.country_code = attributes[:'country_code'] end if attributes.has_key?(:'language_code') self.language_code = attributes[:'language_code'] end if attributes.has_key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.has_key?(:'business_name') self.business_name = attributes[:'business_name'] end if attributes.has_key?(:'business_address') self.business_address = attributes[:'business_address'] end if attributes.has_key?(:'business_phone') self.business_phone = attributes[:'business_phone'] end if attributes.has_key?(:'business_type') self.business_type = attributes[:'business_type'] end if attributes.has_key?(:'shipping_address') self.shipping_address = attributes[:'shipping_address'] end if attributes.has_key?(:'location_details') self.location_details = attributes[:'location_details'] end if attributes.has_key?(:'market_url') self.market_url = attributes[:'market_url'] end end |
Instance Attribute Details
#account_capabilities ⇒ Object
Capabilities that are enabled for the merchant’s Square account. Capabilities that are not listed in this array are not enabled for the account.
28 29 30 |
# File 'lib/square_connect/models/v1_merchant.rb', line 28 def account_capabilities @account_capabilities end |
#account_type ⇒ Object
Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. See [V1MerchantAccountType](#type-v1merchantaccounttype) for possible values
25 26 27 |
# File 'lib/square_connect/models/v1_merchant.rb', line 25 def account_type @account_type end |
#business_address ⇒ Object
The address of the merchant’s business.
43 44 45 |
# File 'lib/square_connect/models/v1_merchant.rb', line 43 def business_address @business_address end |
#business_name ⇒ Object
The name of the merchant’s business.
40 41 42 |
# File 'lib/square_connect/models/v1_merchant.rb', line 40 def business_name @business_name end |
#business_phone ⇒ Object
The phone number of the merchant’s business.
46 47 48 |
# File 'lib/square_connect/models/v1_merchant.rb', line 46 def business_phone @business_phone end |
#business_type ⇒ Object
The type of business operated by the merchant. See [V1MerchantBusinessType](#type-v1merchantbusinesstype) for possible values
49 50 51 |
# File 'lib/square_connect/models/v1_merchant.rb', line 49 def business_type @business_type end |
#country_code ⇒ Object
The country associated with the merchant account, in ISO 3166-1-alpha-2 format.
31 32 33 |
# File 'lib/square_connect/models/v1_merchant.rb', line 31 def country_code @country_code end |
#currency_code ⇒ Object
The currency associated with the merchant account, in ISO 4217 format. For example, the currency code for US dollars is USD.
37 38 39 |
# File 'lib/square_connect/models/v1_merchant.rb', line 37 def currency_code @currency_code end |
#email ⇒ Object
The email address associated with the merchant account.
22 23 24 |
# File 'lib/square_connect/models/v1_merchant.rb', line 22 def email @email end |
#id ⇒ Object
The merchant account’s unique identifier.
16 17 18 |
# File 'lib/square_connect/models/v1_merchant.rb', line 16 def id @id end |
#language_code ⇒ Object
The language associated with the merchant account, in BCP 47 format.
34 35 36 |
# File 'lib/square_connect/models/v1_merchant.rb', line 34 def language_code @language_code end |
#location_details ⇒ Object
Additional information for a single-location account specified by its associated business account, if it has one.
55 56 57 |
# File 'lib/square_connect/models/v1_merchant.rb', line 55 def location_details @location_details end |
#market_url ⇒ Object
The URL of the merchant’s online store.
58 59 60 |
# File 'lib/square_connect/models/v1_merchant.rb', line 58 def market_url @market_url end |
#name ⇒ Object
The name associated with the merchant account.
19 20 21 |
# File 'lib/square_connect/models/v1_merchant.rb', line 19 def name @name end |
#shipping_address ⇒ Object
The merchant’s shipping address.
52 53 54 |
# File 'lib/square_connect/models/v1_merchant.rb', line 52 def shipping_address @shipping_address end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/square_connect/models/v1_merchant.rb', line 62 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'email' => :'email', :'account_type' => :'account_type', :'account_capabilities' => :'account_capabilities', :'country_code' => :'country_code', :'language_code' => :'language_code', :'currency_code' => :'currency_code', :'business_name' => :'business_name', :'business_address' => :'business_address', :'business_phone' => :'business_phone', :'business_type' => :'business_type', :'shipping_address' => :'shipping_address', :'location_details' => :'location_details', :'market_url' => :'market_url' } end |
.swagger_types ⇒ Object
Attribute type mapping.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/square_connect/models/v1_merchant.rb', line 83 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'email' => :'String', :'account_type' => :'String', :'account_capabilities' => :'Array<String>', :'country_code' => :'String', :'language_code' => :'String', :'currency_code' => :'String', :'business_name' => :'String', :'business_address' => :'Address', :'business_phone' => :'V1PhoneNumber', :'business_type' => :'String', :'shipping_address' => :'Address', :'location_details' => :'V1MerchantLocationDetails', :'market_url' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/square_connect/models/v1_merchant.rb', line 190 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && email == o.email && account_type == o.account_type && account_capabilities == o.account_capabilities && country_code == o.country_code && language_code == o.language_code && currency_code == o.currency_code && business_name == o.business_name && business_address == o.business_address && business_phone == o.business_phone && business_type == o.business_type && shipping_address == o.shipping_address && location_details == o.location_details && market_url == o.market_url end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 278 279 280 281 282 |
# File 'lib/square_connect/models/v1_merchant.rb', line 246 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
312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/square_connect/models/v1_merchant.rb', line 312 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
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/square_connect/models/v1_merchant.rb', line 225 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
212 213 214 |
# File 'lib/square_connect/models/v1_merchant.rb', line 212 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
218 219 220 |
# File 'lib/square_connect/models/v1_merchant.rb', line 218 def hash [id, name, email, account_type, account_capabilities, country_code, language_code, currency_code, business_name, business_address, business_phone, business_type, shipping_address, location_details, market_url].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
177 178 179 180 |
# File 'lib/square_connect/models/v1_merchant.rb', line 177 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)
292 293 294 |
# File 'lib/square_connect/models/v1_merchant.rb', line 292 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
298 299 300 301 302 303 304 305 306 |
# File 'lib/square_connect/models/v1_merchant.rb', line 298 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
286 287 288 |
# File 'lib/square_connect/models/v1_merchant.rb', line 286 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
184 185 186 |
# File 'lib/square_connect/models/v1_merchant.rb', line 184 def valid? return true end |