class SquareConnect::CreateCheckoutRequest
Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.
Attributes
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 `total_money` calculated by Square for your order. 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.
If `true`, Square Checkout
will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`.
A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout
for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information.
The email address to display on the Square Checkout
confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set.
An optional note to associate with the checkout object. This value cannot exceed 60 characters.
The order including line items to be checked out.
If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set.
If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default: none; only exists if explicitly set.
The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url
is `www.example.com/order-complete`, a successful transaction redirects the customer to: `www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout
will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default: none; only exists if explicitly set.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/create_checkout_request.rb, line 44 def self.attribute_map { :'idempotency_key' => :'idempotency_key', :'order' => :'order', :'ask_for_shipping_address' => :'ask_for_shipping_address', :'merchant_support_email' => :'merchant_support_email', :'pre_populate_buyer_email' => :'pre_populate_buyer_email', :'pre_populate_shipping_address' => :'pre_populate_shipping_address', :'redirect_url' => :'redirect_url', :'additional_recipients' => :'additional_recipients', :'note' => :'note' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/create_checkout_request.rb, line 75 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?(:'order') self.order = attributes[:'order'] end if attributes.has_key?(:'ask_for_shipping_address') self.ask_for_shipping_address = attributes[:'ask_for_shipping_address'] end if attributes.has_key?(:'merchant_support_email') self.merchant_support_email = attributes[:'merchant_support_email'] end if attributes.has_key?(:'pre_populate_buyer_email') self.pre_populate_buyer_email = attributes[:'pre_populate_buyer_email'] end if attributes.has_key?(:'pre_populate_shipping_address') self.pre_populate_shipping_address = attributes[:'pre_populate_shipping_address'] end if attributes.has_key?(:'redirect_url') self.redirect_url = attributes[:'redirect_url'] end if attributes.has_key?(:'additional_recipients') if (value = attributes[:'additional_recipients']).is_a?(Array) self.additional_recipients = value end end if attributes.has_key?(:'note') self.note = attributes[:'note'] end end
Attribute type mapping.
# File lib/square_connect/models/create_checkout_request.rb, line 59 def self.swagger_types { :'idempotency_key' => :'String', :'order' => :'CreateOrderRequest', :'ask_for_shipping_address' => :'BOOLEAN', :'merchant_support_email' => :'String', :'pre_populate_buyer_email' => :'String', :'pre_populate_shipping_address' => :'Address', :'redirect_url' => :'String', :'additional_recipients' => :'Array<ChargeRequestAdditionalRecipient>', :'note' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/create_checkout_request.rb, line 238 def ==(o) return true if self.equal?(o) self.class == o.class && idempotency_key == o.idempotency_key && order == o.order && ask_for_shipping_address == o.ask_for_shipping_address && merchant_support_email == o.merchant_support_email && pre_populate_buyer_email == o.pre_populate_buyer_email && pre_populate_shipping_address == o.pre_populate_shipping_address && redirect_url == o.redirect_url && additional_recipients == o.additional_recipients && note == o.note end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/square_connect/models/create_checkout_request.rb, line 288 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/square_connect/models/create_checkout_request.rb, line 354 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/square_connect/models/create_checkout_request.rb, line 267 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/create_checkout_request.rb, line 254 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/create_checkout_request.rb, line 260 def hash [idempotency_key, order, ask_for_shipping_address, merchant_support_email, pre_populate_buyer_email, pre_populate_shipping_address, redirect_url, additional_recipients, note].hash end
Custom attribute writer method with validation @param [Object] idempotency_key
Value to be assigned
# File lib/square_connect/models/create_checkout_request.rb, line 176 def idempotency_key=(idempotency_key) if idempotency_key.nil? fail ArgumentError, "idempotency_key cannot be nil" end if idempotency_key.to_s.length > 192 fail ArgumentError, "invalid value for 'idempotency_key', the character length must be smaller than or equal to 192." end if idempotency_key.to_s.length < 1 fail ArgumentError, "invalid value for 'idempotency_key', the character length must be great than or equal to 1." end @idempotency_key = idempotency_key end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/create_checkout_request.rb, line 123 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 @order.nil? invalid_properties.push("invalid value for 'order', order cannot be nil.") end if !@merchant_support_email.nil? && @merchant_support_email.to_s.length > 254 invalid_properties.push("invalid value for 'merchant_support_email', the character length must be smaller than or equal to 254.") end if !@pre_populate_buyer_email.nil? && @pre_populate_buyer_email.to_s.length > 254 invalid_properties.push("invalid value for 'pre_populate_buyer_email', the character length must be smaller than or equal to 254.") end if !@redirect_url.nil? && @redirect_url.to_s.length > 800 invalid_properties.push("invalid value for 'redirect_url', the character length must be smaller than or equal to 800.") 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 return invalid_properties end
Custom attribute writer method with validation @param [Object] merchant_support_email
Value to be assigned
# File lib/square_connect/models/create_checkout_request.rb, line 194 def merchant_support_email=(merchant_support_email) if !merchant_support_email.nil? && merchant_support_email.to_s.length > 254 fail ArgumentError, "invalid value for 'merchant_support_email', the character length must be smaller than or equal to 254." end @merchant_support_email = merchant_support_email end
Custom attribute writer method with validation @param [Object] note Value to be assigned
# File lib/square_connect/models/create_checkout_request.rb, line 227 def note=(note) if !note.nil? && note.to_s.length > 60 fail ArgumentError, "invalid value for 'note', the character length must be smaller than or equal to 60." end @note = note end
Custom attribute writer method with validation @param [Object] pre_populate_buyer_email
Value to be assigned
# File lib/square_connect/models/create_checkout_request.rb, line 205 def pre_populate_buyer_email=(pre_populate_buyer_email) if !pre_populate_buyer_email.nil? && pre_populate_buyer_email.to_s.length > 254 fail ArgumentError, "invalid value for 'pre_populate_buyer_email', the character length must be smaller than or equal to 254." end @pre_populate_buyer_email = pre_populate_buyer_email end
Custom attribute writer method with validation @param [Object] redirect_url
Value to be assigned
# File lib/square_connect/models/create_checkout_request.rb, line 216 def redirect_url=(redirect_url) if !redirect_url.nil? && redirect_url.to_s.length > 800 fail ArgumentError, "invalid value for 'redirect_url', the character length must be smaller than or equal to 800." end @redirect_url = redirect_url end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/create_checkout_request.rb, line 340 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/create_checkout_request.rb, line 328 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/square_connect/models/create_checkout_request.rb, line 162 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 @order.nil? return false if !@merchant_support_email.nil? && @merchant_support_email.to_s.length > 254 return false if !@pre_populate_buyer_email.nil? && @pre_populate_buyer_email.to_s.length > 254 return false if !@redirect_url.nil? && @redirect_url.to_s.length > 800 return false if !@note.nil? && @note.to_s.length > 60 return true end