Class: SquareConnect::CreateCheckoutRequest

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

Overview

Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCheckoutRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
108
109
110
111
112
113
114
115
116
117
118
119
 
# 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

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 `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.



37
38
39
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 37

def additional_recipients
  @additional_recipients
end

#ask_for_shipping_address ⇒ Object

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`.



22
23
24
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 22

def ask_for_shipping_address
  @ask_for_shipping_address
end

#idempotency_key ⇒ Object

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.



16
17
18
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 16

def idempotency_key
  @idempotency_key
end

#merchant_support_email ⇒ Object

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.



25
26
27
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 25

def merchant_support_email
  @merchant_support_email
end

#note ⇒ Object

An optional note to associate with the checkout object. This value cannot exceed 60 characters.



40
41
42
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 40

def note
  @note
end

#order ⇒ Object

The order including line items to be checked out.



19
20
21
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 19

def order
  @order
end

#pre_populate_buyer_email ⇒ Object

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.



28
29
30
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 28

def pre_populate_buyer_email
  @pre_populate_buyer_email
end

#pre_populate_shipping_address ⇒ Object

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.



31
32
33
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 31

def pre_populate_shipping_address
  @pre_populate_shipping_address
end

#redirect_url ⇒ Object

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.



34
35
36
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 34

def redirect_url
  @redirect_url
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# 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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# 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

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# 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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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
156
157
158
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 334

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
343
344
345
346
347
348
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



328
329
330
 
# File 'lib/square_connect/models/create_checkout_request.rb', line 328

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
167
168
169
170
171
172
 
# 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