Class: SquareConnect::Checkout

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

Overview

Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Checkout

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
 
# File 'lib/square_connect/models/checkout.rb', line 80

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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'checkout_page_url')
    self.checkout_page_url = attributes[:'checkout_page_url']
  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?(:'order')
    self.order = attributes[:'order']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  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

Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.



43
44
45
 
# File 'lib/square_connect/models/checkout.rb', line 43

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/checkout.rb', line 22

def ask_for_shipping_address
  @ask_for_shipping_address
end

#checkout_page_url ⇒ Object

The URL that the buyer’s browser should be redirected to after the checkout is completed.



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

def checkout_page_url
  @checkout_page_url
end

#created_at ⇒ Object

The time when the checkout was created, in RFC 3339 format.



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

def created_at
  @created_at
end

#id ⇒ Object

ID generated by Square Checkout when a new checkout is requested.



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

def id
  @id
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/checkout.rb', line 25

def merchant_support_email
  @merchant_support_email
end

#order ⇒ Object

Order to be checked out.



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

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/checkout.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/checkout.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.



34
35
36
 
# File 'lib/square_connect/models/checkout.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.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/square_connect/models/checkout.rb', line 47

def self.attribute_map
  {
    :'id' => :'id',
    :'checkout_page_url' => :'checkout_page_url',
    :'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',
    :'order' => :'order',
    :'created_at' => :'created_at',
    :'additional_recipients' => :'additional_recipients'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/square_connect/models/checkout.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'checkout_page_url' => :'String',
    :'ask_for_shipping_address' => :'BOOLEAN',
    :'merchant_support_email' => :'String',
    :'pre_populate_buyer_email' => :'String',
    :'pre_populate_shipping_address' => :'Address',
    :'redirect_url' => :'String',
    :'order' => :'Order',
    :'created_at' => :'String',
    :'additional_recipients' => :'Array<AdditionalRecipient>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      checkout_page_url == o.checkout_page_url &&
      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 &&
      order == o.order &&
      created_at == o.created_at &&
      additional_recipients == o.additional_recipients
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/square_connect/models/checkout.rb', line 196

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/square_connect/models/checkout.rb', line 262

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/square_connect/models/checkout.rb', line 175

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


162
163
164
 
# File 'lib/square_connect/models/checkout.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/square_connect/models/checkout.rb', line 168

def hash
  [id, checkout_page_url, ask_for_shipping_address, merchant_support_email, pre_populate_buyer_email, pre_populate_shipping_address, redirect_url, order, created_at, additional_recipients].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



242
243
244
 
# File 'lib/square_connect/models/checkout.rb', line 242

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



248
249
250
251
252
253
254
255
256
 
# File 'lib/square_connect/models/checkout.rb', line 248

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



236
237
238
 
# File 'lib/square_connect/models/checkout.rb', line 236

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



139
140
141
 
# File 'lib/square_connect/models/checkout.rb', line 139

def valid?
  return true
end