Class: SquareConnect::ChargeRequest
- Inherits:
-
Object
- Object
- SquareConnect::ChargeRequest
- Defined in:
- lib/square_connect/models/charge_request.rb
Overview
Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint.
Instance Attribute Summary collapse
-
#additional_recipients ⇒ Object
The basic primitive of multi-party transaction.
-
#amount_money ⇒ Object
The amount of money to charge.
-
#billing_address ⇒ Object
The buyer’s billing address.
-
#buyer_email_address ⇒ Object
The buyer’s email address, if available.
-
#card_nonce ⇒ Object
A nonce generated from the ‘SqPaymentForm` that represents the card to charge.
-
#customer_card_id ⇒ Object
The ID of the customer card on file to charge.
-
#customer_id ⇒ Object
The ID of the customer to associate this transaction with.
-
#delay_capture ⇒ Object
If ‘true`, the request will only perform an Auth on the provided card.
-
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this transaction among transactions you’ve created.
-
#note ⇒ Object
An optional note to associate with the transaction.
-
#order_id ⇒ Object
The ID of the order to associate with this transaction.
-
#reference_id ⇒ Object
An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database).
-
#shipping_address ⇒ Object
The buyer’s shipping address, if available.
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 = {}) ⇒ ChargeRequest
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 = {}) ⇒ ChargeRequest
Initializes the object
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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/square_connect/models/charge_request.rb', line 95 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?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'card_nonce') self.card_nonce = attributes[:'card_nonce'] end if attributes.has_key?(:'customer_card_id') self.customer_card_id = attributes[:'customer_card_id'] end if attributes.has_key?(:'delay_capture') self.delay_capture = attributes[:'delay_capture'] end if attributes.has_key?(:'reference_id') self.reference_id = attributes[:'reference_id'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'customer_id') self.customer_id = attributes[:'customer_id'] end if attributes.has_key?(:'billing_address') self.billing_address = attributes[:'billing_address'] end if attributes.has_key?(:'shipping_address') self.shipping_address = attributes[:'shipping_address'] end if attributes.has_key?(:'buyer_email_address') self.buyer_email_address = attributes[:'buyer_email_address'] end if attributes.has_key?(:'order_id') self.order_id = attributes[:'order_id'] end if attributes.has_key?(:'additional_recipients') if (value = attributes[:'additional_recipients']).is_a?(Array) self.additional_recipients = value end end end |
Instance Attribute Details
#additional_recipients ⇒ Object
The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the ‘amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in you charge’s request. The ‘location_id` must be the valid location of the app owner merchant. This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.
52 53 54 |
# File 'lib/square_connect/models/charge_request.rb', line 52 def additional_recipients @additional_recipients end |
#amount_money ⇒ Object
The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of ‘currency` must match the currency associated with the business that is charging the card.
19 20 21 |
# File 'lib/square_connect/models/charge_request.rb', line 19 def amount_money @amount_money end |
#billing_address ⇒ Object
The buyer’s billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor ‘shipping_address` is provided.
40 41 42 |
# File 'lib/square_connect/models/charge_request.rb', line 40 def billing_address @billing_address end |
#buyer_email_address ⇒ Object
The buyer’s email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.
46 47 48 |
# File 'lib/square_connect/models/charge_request.rb', line 46 def buyer_email_address @buyer_email_address end |
#card_nonce ⇒ Object
A nonce generated from the ‘SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`.
22 23 24 |
# File 'lib/square_connect/models/charge_request.rb', line 22 def card_nonce @card_nonce end |
#customer_card_id ⇒ Object
The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for ‘card_nonce`. If you provide this value, you must also provide a value for `customer_id`.
25 26 27 |
# File 'lib/square_connect/models/charge_request.rb', line 25 def customer_card_id @customer_card_id end |
#customer_id ⇒ Object
The ID of the customer to associate this transaction with. This field is required if you provide a value for ‘customer_card_id`, and optional otherwise.
37 38 39 |
# File 'lib/square_connect/models/charge_request.rb', line 37 def customer_id @customer_id end |
#delay_capture ⇒ Object
If ‘true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false`
28 29 30 |
# File 'lib/square_connect/models/charge_request.rb', line 28 def delay_capture @delay_capture end |
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this transaction among transactions you’ve created. If you’re unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information.
16 17 18 |
# File 'lib/square_connect/models/charge_request.rb', line 16 def idempotency_key @idempotency_key end |
#note ⇒ Object
An optional note to associate with the transaction. This value cannot exceed 60 characters.
34 35 36 |
# File 'lib/square_connect/models/charge_request.rb', line 34 def note @note end |
#order_id ⇒ Object
The ID of the order to associate with this transaction. If you provide this value, the ‘amount_money` value of your request must __exactly match__ the `total_money` value of the order’s ‘order_amounts` field.
49 50 51 |
# File 'lib/square_connect/models/charge_request.rb', line 49 def order_id @order_id end |
#reference_id ⇒ Object
An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.
31 32 33 |
# File 'lib/square_connect/models/charge_request.rb', line 31 def reference_id @reference_id end |
#shipping_address ⇒ Object
The buyer’s shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor ‘billing_address` is provided.
43 44 45 |
# File 'lib/square_connect/models/charge_request.rb', line 43 def shipping_address @shipping_address end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/square_connect/models/charge_request.rb', line 56 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', :'buyer_email_address' => :'buyer_email_address', :'order_id' => :'order_id', :'additional_recipients' => :'additional_recipients' } end |
.swagger_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/square_connect/models/charge_request.rb', line 75 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', :'buyer_email_address' => :'String', :'order_id' => :'String', :'additional_recipients' => :'Array<AdditionalRecipient>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/square_connect/models/charge_request.rb', line 306 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 && buyer_email_address == o.buyer_email_address && order_id == o.order_id && additional_recipients == o.additional_recipients end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/square_connect/models/charge_request.rb', line 360 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
426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/square_connect/models/charge_request.rb', line 426 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
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/square_connect/models/charge_request.rb', line 339 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
326 327 328 |
# File 'lib/square_connect/models/charge_request.rb', line 326 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
332 333 334 |
# File 'lib/square_connect/models/charge_request.rb', line 332 def hash [idempotency_key, amount_money, card_nonce, customer_card_id, delay_capture, reference_id, note, customer_id, billing_address, shipping_address, buyer_email_address, order_id, additional_recipients].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
159 160 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 |
# File 'lib/square_connect/models/charge_request.rb', line 159 def list_invalid_properties invalid_properties = Array.new if @idempotency_key.nil? invalid_properties.push("invalid value for 'idempotency_key', idempotency_key cannot be nil.") end if @idempotency_key.to_s.length > 192 invalid_properties.push("invalid value for 'idempotency_key', the character length must be smaller than or equal to 192.") end if @idempotency_key.to_s.length < 1 invalid_properties.push("invalid value for 'idempotency_key', the character length must be great than or equal to 1.") end if @amount_money.nil? invalid_properties.push("invalid value for 'amount_money', amount_money cannot be nil.") end if !@card_nonce.nil? && @card_nonce.to_s.length > 192 invalid_properties.push("invalid value for 'card_nonce', the character length must be smaller than or equal to 192.") end if !@customer_card_id.nil? && @customer_card_id.to_s.length > 192 invalid_properties.push("invalid value for 'customer_card_id', the character length must be smaller than or equal to 192.") end if !@reference_id.nil? && @reference_id.to_s.length > 40 invalid_properties.push("invalid value for 'reference_id', the character length must be smaller than or equal to 40.") end if !@note.nil? && @note.to_s.length > 60 invalid_properties.push("invalid value for 'note', the character length must be smaller than or equal to 60.") end if !@customer_id.nil? && @customer_id.to_s.length > 50 invalid_properties.push("invalid value for 'customer_id', the character length must be smaller than or equal to 50.") end if !@order_id.nil? && @order_id.to_s.length > 192 invalid_properties.push("invalid value for 'order_id', the character length must be smaller than or equal to 192.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
406 407 408 |
# File 'lib/square_connect/models/charge_request.rb', line 406 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
412 413 414 415 416 417 418 419 420 |
# File 'lib/square_connect/models/charge_request.rb', line 412 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
400 401 402 |
# File 'lib/square_connect/models/charge_request.rb', line 400 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/square_connect/models/charge_request.rb', line 206 def valid? return false if @idempotency_key.nil? return false if @idempotency_key.to_s.length > 192 return false if @idempotency_key.to_s.length < 1 return false if @amount_money.nil? return false if !@card_nonce.nil? && @card_nonce.to_s.length > 192 return false if !@customer_card_id.nil? && @customer_card_id.to_s.length > 192 return false if !@reference_id.nil? && @reference_id.to_s.length > 40 return false if !@note.nil? && @note.to_s.length > 60 return false if !@customer_id.nil? && @customer_id.to_s.length > 50 return false if !@order_id.nil? && @order_id.to_s.length > 192 return true end |