Class: SquareConnect::Card
- Inherits:
-
Object
- Object
- SquareConnect::Card
- Defined in:
- lib/square_connect/models/card.rb
Overview
Represents the payment details of a card to be used for payments. These details are determined by the ‘card_nonce` generated by `SqPaymentForm`.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#billing_address ⇒ Object
The billing address for this card.
-
#card_brand ⇒ Object
The card’s brand (such as ‘VISA`).
-
#cardholder_name ⇒ Object
The name of the cardholder.
-
#exp_month ⇒ Object
The expiration month of the associated card as an integer between 1 and 12.
-
#exp_year ⇒ Object
The four-digit year of the card’s expiration date.
-
#fingerprint ⇒ Object
__Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
-
#id ⇒ Object
Unique ID for this card.
-
#last_4 ⇒ Object
The last 4 digits of the card number.
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 = {}) ⇒ Card
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 = {}) ⇒ Card
Initializes the object
91 92 93 94 95 96 97 98 99 100 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 |
# File 'lib/square_connect/models/card.rb', line 91 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?(:'card_brand') self.card_brand = attributes[:'card_brand'] end if attributes.has_key?(:'last_4') self.last_4 = attributes[:'last_4'] end if attributes.has_key?(:'exp_month') self.exp_month = attributes[:'exp_month'] end if attributes.has_key?(:'exp_year') self.exp_year = attributes[:'exp_year'] end if attributes.has_key?(:'cardholder_name') self.cardholder_name = attributes[:'cardholder_name'] end if attributes.has_key?(:'billing_address') self.billing_address = attributes[:'billing_address'] end if attributes.has_key?(:'fingerprint') self.fingerprint = attributes[:'fingerprint'] end end |
Instance Attribute Details
#billing_address ⇒ Object
The billing address for this card.
34 35 36 |
# File 'lib/square_connect/models/card.rb', line 34 def billing_address @billing_address end |
#card_brand ⇒ Object
The card’s brand (such as ‘VISA`). See [CardBrand](#type-cardbrand) for all possible values.
19 20 21 |
# File 'lib/square_connect/models/card.rb', line 19 def card_brand @card_brand end |
#cardholder_name ⇒ Object
The name of the cardholder.
31 32 33 |
# File 'lib/square_connect/models/card.rb', line 31 def cardholder_name @cardholder_name end |
#exp_month ⇒ Object
The expiration month of the associated card as an integer between 1 and 12.
25 26 27 |
# File 'lib/square_connect/models/card.rb', line 25 def exp_month @exp_month end |
#exp_year ⇒ Object
The four-digit year of the card’s expiration date.
28 29 30 |
# File 'lib/square_connect/models/card.rb', line 28 def exp_year @exp_year end |
#fingerprint ⇒ Object
__Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
37 38 39 |
# File 'lib/square_connect/models/card.rb', line 37 def fingerprint @fingerprint end |
#id ⇒ Object
Unique ID for this card. Generated by Square.
16 17 18 |
# File 'lib/square_connect/models/card.rb', line 16 def id @id end |
#last_4 ⇒ Object
The last 4 digits of the card number.
22 23 24 |
# File 'lib/square_connect/models/card.rb', line 22 def last_4 @last_4 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 |
# File 'lib/square_connect/models/card.rb', line 62 def self.attribute_map { :'id' => :'id', :'card_brand' => :'card_brand', :'last_4' => :'last_4', :'exp_month' => :'exp_month', :'exp_year' => :'exp_year', :'cardholder_name' => :'cardholder_name', :'billing_address' => :'billing_address', :'fingerprint' => :'fingerprint' } end |
.swagger_types ⇒ Object
Attribute type mapping.
76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/square_connect/models/card.rb', line 76 def self.swagger_types { :'id' => :'String', :'card_brand' => :'String', :'last_4' => :'String', :'exp_month' => :'Integer', :'exp_year' => :'Integer', :'cardholder_name' => :'String', :'billing_address' => :'Address', :'fingerprint' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/square_connect/models/card.rb', line 158 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && card_brand == o.card_brand && last_4 == o.last_4 && exp_month == o.exp_month && exp_year == o.exp_year && cardholder_name == o.cardholder_name && billing_address == o.billing_address && fingerprint == o.fingerprint end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/square_connect/models/card.rb', line 207 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
273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/square_connect/models/card.rb', line 273 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
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/square_connect/models/card.rb', line 186 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
173 174 175 |
# File 'lib/square_connect/models/card.rb', line 173 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
179 180 181 |
# File 'lib/square_connect/models/card.rb', line 179 def hash [id, card_brand, last_4, exp_month, exp_year, cardholder_name, billing_address, fingerprint].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
133 134 135 136 |
# File 'lib/square_connect/models/card.rb', line 133 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)
253 254 255 |
# File 'lib/square_connect/models/card.rb', line 253 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
259 260 261 262 263 264 265 266 267 |
# File 'lib/square_connect/models/card.rb', line 259 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
247 248 249 |
# File 'lib/square_connect/models/card.rb', line 247 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
140 141 142 143 144 |
# File 'lib/square_connect/models/card.rb', line 140 def valid? card_brand_validator = EnumAttributeValidator.new('String', ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD"]) return false unless card_brand_validator.valid?(@card_brand) return true end |