Class: SquareConnect::Card

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

Overview

Represents a credit card.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Card

Returns a new instance of Card.



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'card_brand']
    self.card_brand = attributes[:'card_brand']
  end
  
  if attributes[:'last_4']
    self.last_4 = attributes[:'last_4']
  end
  
  if attributes[:'exp_month']
    self.exp_month = attributes[:'exp_month']
  end
  
  if attributes[:'exp_year']
    self.exp_year = attributes[:'exp_year']
  end
  
  if attributes[:'cardholder_name']
    self.cardholder_name = attributes[:'cardholder_name']
  end
  
  if attributes[:'billing_address']
    self.billing_address = attributes[:'billing_address']
  end
  
end

Instance Attribute Details

#billing_address ⇒ Object

The billing address for the card on file.



35
36
37
 
# File 'lib/square_connect/models/card.rb', line 35

def billing_address
  @billing_address
end

#card_brand ⇒ Object

The card’s brand (such as ‘VISA`).



20
21
22
 
# File 'lib/square_connect/models/card.rb', line 20

def card_brand
  @card_brand
end

#cardholder_name ⇒ Object

The cardholder name for the card on file.



32
33
34
 
# File 'lib/square_connect/models/card.rb', line 32

def cardholder_name
  @cardholder_name
end

#exp_month ⇒ Object

The month of the card’s expiration date, which must be between 1-12.



26
27
28
 
# File 'lib/square_connect/models/card.rb', line 26

def exp_month
  @exp_month
end

#exp_year ⇒ Object

The year of the card’s expiration date, which must be a 4-digit year.



29
30
31
 
# File 'lib/square_connect/models/card.rb', line 29

def exp_year
  @exp_year
end

#id ⇒ Object

The card’s unique ID, if any.



17
18
19
 
# File 'lib/square_connect/models/card.rb', line 17

def id
  @id
end

#last_4 ⇒ Object

The last 4 digits of the card’s number.



23
24
25
 
# File 'lib/square_connect/models/card.rb', line 23

def last_4
  @last_4
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/card.rb', line 38

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'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/square_connect/models/card.rb', line 59

def self.swagger_types
  {
    :'id' => :'String',
    :'card_brand' => :'String',
    :'last_4' => :'String',
    :'exp_month' => :'Integer',
    :'exp_year' => :'Integer',
    :'cardholder_name' => :'String',
    :'billing_address' => :'Address'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/square_connect/models/card.rb', line 119

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
end

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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
    _model = SquareConnect.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/square_connect/models/card.rb', line 218

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

build the object from hash



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/square_connect/models/card.rb', line 142

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/square_connect/models/card.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



137
138
139
 
# File 'lib/square_connect/models/card.rb', line 137

def hash
  [id, card_brand, last_4, exp_month, exp_year, cardholder_name, billing_address].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



201
202
203
 
# File 'lib/square_connect/models/card.rb', line 201

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



206
207
208
209
210
211
212
213
214
 
# File 'lib/square_connect/models/card.rb', line 206

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 ⇒ Object 



196
197
198
 
# File 'lib/square_connect/models/card.rb', line 196

def to_s
  to_hash.to_s
end