Class: SquareConnect::ChargeRequest

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

Overview

Defines the parameters that can be included in the body ofna request to the Charge endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeRequest

Returns a new instance of ChargeRequest.



90
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
130
131
132
133
134
135
136
137
 
# File 'lib/square_connect/models/charge_request.rb', line 90

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[:'idempotency_key']
    self.idempotency_key = attributes[:'idempotency_key']
  end
  
  if attributes[:'amount_money']
    self.amount_money = attributes[:'amount_money']
  end
  
  if attributes[:'card_nonce']
    self.card_nonce = attributes[:'card_nonce']
  end
  
  if attributes[:'customer_card_id']
    self.customer_card_id = attributes[:'customer_card_id']
  end
  
  if attributes[:'delay_capture']
    self.delay_capture = attributes[:'delay_capture']
  end
  
  if attributes[:'reference_id']
    self.reference_id = attributes[:'reference_id']
  end
  
  if attributes[:'note']
    self.note = attributes[:'note']
  end
  
  if attributes[:'customer_id']
    self.customer_id = attributes[:'customer_id']
  end
  
  if attributes[:'billing_address']
    self.billing_address = attributes[:'billing_address']
  end
  
  if attributes[:'shipping_address']
    self.shipping_address = attributes[:'shipping_address']
  end
  
end

Instance Attribute Details

#amount_money ⇒ Object

The amount of money to collect in the transaction.



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

def amount_money
  @amount_money
end

#billing_address ⇒ Object

If available, Postal code in the billing address for US and Canada payments may reduce decline rate.



41
42
43
 
# File 'lib/square_connect/models/charge_request.rb', line 41

def billing_address
  @billing_address
end

#card_nonce ⇒ Object

A nonce representing the credit card to charge for this transaction.nDo not provide a value for this field if you provide a value forn‘customer_card_id`.



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

def card_nonce
  @card_nonce
end

#customer_card_id ⇒ Object

The ID of the customer card on file to charge for this transaction. Donnot provide a value for this field if you provide a value for ‘card_nonce`.



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

def customer_card_id
  @customer_card_id
end

#customer_id ⇒ Object

The ID of the customer to associate this transaction with. This fieldnis required if you provide a value for ‘customer_card_id`, and optionalnotherwise.



38
39
40
 
# File 'lib/square_connect/models/charge_request.rb', line 38

def customer_id
  @customer_id
end

#delay_capture ⇒ Object

If ‘true`, the request will only perform an Auth on the providedncard. You can then later perform either a Capture (with then*CaptureTransaction** endpoint) or a Void (with the VoidTransationnendpoint.



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

def delay_capture
  @delay_capture
end

#idempotency_key ⇒ Object

A value you specify that uniquely identifies thisntransaction among transactions you’ve created.nnIf you’re unsure whether a particular transaction succeeded,nyou can reattempt it with the same idempotency key withoutnworrying about double-charging the buyer. Note that *all other fields*nmust also remain identical in your followup request, or an error will occur.



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

def idempotency_key
  @idempotency_key
end

#note ⇒ Object

An optional note to associate with the transaction.



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

def note
  @note
end

#reference_id ⇒ Object

An optional ID you can associate with the transaction for your ownnpurposes (such as to associate the transaction with an entity ID in yournown database).



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

def reference_id
  @reference_id
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



44
45
46
 
# File 'lib/square_connect/models/charge_request.rb', line 44

def shipping_address
  @shipping_address
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/square_connect/models/charge_request.rb', line 47

def self.attribute_map
  {
    
    :'idempotency_key' => :'idempotency_key',
    
    :'amount_money' => :'amount_money',
    
    :'card_nonce' => :'card_nonce',
    
    :'customer_card_id' => :'customer_card_id',
    
    :'delay_capture' => :'delay_capture',
    
    :'reference_id' => :'reference_id',
    
    :'note' => :'note',
    
    :'customer_id' => :'customer_id',
    
    :'billing_address' => :'billing_address',
    
    :'shipping_address' => :'shipping_address'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/square_connect/models/charge_request.rb', line 74

def self.swagger_types
  {
    :'idempotency_key' => :'String',
    :'amount_money' => :'Money',
    :'card_nonce' => :'String',
    :'customer_card_id' => :'String',
    :'delay_capture' => :'BOOLEAN',
    :'reference_id' => :'String',
    :'note' => :'String',
    :'customer_id' => :'String',
    :'billing_address' => :'Address',
    :'shipping_address' => :'Address'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/square_connect/models/charge_request.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      idempotency_key == o.idempotency_key &&
      amount_money == o.amount_money &&
      card_nonce == o.card_nonce &&
      customer_card_id == o.customer_card_id &&
      delay_capture == o.delay_capture &&
      reference_id == o.reference_id &&
      note == o.note &&
      customer_id == o.customer_id &&
      billing_address == o.billing_address &&
      shipping_address == o.shipping_address
end

#_deserialize(type, value) ⇒ Object 



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

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/square_connect/models/charge_request.rb', line 242

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/square_connect/models/charge_request.rb', line 166

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


156
157
158
 
# File 'lib/square_connect/models/charge_request.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



161
162
163
 
# File 'lib/square_connect/models/charge_request.rb', line 161

def hash
  [idempotency_key, amount_money, card_nonce, customer_card_id, delay_capture, reference_id, note, customer_id, billing_address, shipping_address].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



225
226
227
 
# File 'lib/square_connect/models/charge_request.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



230
231
232
233
234
235
236
237
238
 
# File 'lib/square_connect/models/charge_request.rb', line 230

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 



220
221
222
 
# File 'lib/square_connect/models/charge_request.rb', line 220

def to_s
  to_hash.to_s
end