Class: SquareConnect::CheckoutApi

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/api/checkout_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CheckoutApi

Returns a new instance of CheckoutApi.



16
17
18
 
# File 'lib/square_connect/api/checkout_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/square_connect/api/checkout_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_checkout(location_id, body, opts = {}) ⇒ CreateCheckoutResponse

CreateCheckout Links a ‘checkoutId` to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

Parameters:

  • location_id —

    The ID of the business location to associate the checkout with.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/square_connect/api/checkout_api.rb', line 26

def create_checkout(location_id, body, opts = {})
  data, _status_code, _headers = create_checkout_with_http_info(location_id, body, opts)
  return data
end

#create_checkout_with_http_info(location_id, body, opts = {}) ⇒ Array<(CreateCheckoutResponse, Fixnum, Hash)>

CreateCheckout Links a &#x60;checkoutId&#x60; to a &#x60;checkout_page_url&#x60; that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

Parameters:

  • location_id —

    The ID of the business location to associate the checkout with.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

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

    the optional parameters

Returns:

  • (Array<(CreateCheckoutResponse, Fixnum, Hash)>) —

    CreateCheckoutResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
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
72
73
74
75
76
77
 
# File 'lib/square_connect/api/checkout_api.rb', line 37

def create_checkout_with_http_info(location_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CheckoutApi.create_checkout ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling CheckoutApi.create_checkout" if location_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling CheckoutApi.create_checkout" if body.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/checkouts".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  
  header_params['Square-Version'] = "2019-06-12"

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateCheckoutResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckoutApi#create_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end