Class: SquareConnect::MobileAuthorizationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MobileAuthorizationApi

Returns a new instance of MobileAuthorizationApi.



16
17
18
 
# File 'lib/square_connect/api/mobile_authorization_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/mobile_authorization_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_mobile_authorization_code(body, opts = {}) ⇒ CreateMobileAuthorizationCodeResponse

CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. Important: The ‘Authorization` header you provide to this endpoint must have the following format: “` Authorization: Bearer ACCESS_TOKEN “` Replace `ACCESS_TOKEN` with a [valid production authorization credential](docs.connect.squareup.com/get-started#step-4-understand-the-different-application-credentials).

Parameters:

  • 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:



25
26
27
28
 
# File 'lib/square_connect/api/mobile_authorization_api.rb', line 25

def create_mobile_authorization_code(body, opts = {})
  data, _status_code, _headers = create_mobile_authorization_code_with_http_info(body, opts)
  return data
end

#create_mobile_authorization_code_with_http_info(body, opts = {}) ⇒ Array<(CreateMobileAuthorizationCodeResponse, Fixnum, Hash)>

CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. Important: The &#x60;Authorization&#x60; header you provide to this endpoint must have the following format: &#x60;&#x60;&#x60; Authorization: Bearer ACCESS_TOKEN &#x60;&#x60;&#x60; Replace &#x60;ACCESS_TOKEN&#x60; with a [valid production authorization credential](docs.connect.squareup.com/get-started#step-4-understand-the-different-application-credentials).

Parameters:

  • 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:



35
36
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
 
# File 'lib/square_connect/api/mobile_authorization_api.rb', line 35

def create_mobile_authorization_code_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileAuthorizationApi.create_mobile_authorization_code ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MobileAuthorizationApi.create_mobile_authorization_code" if body.nil?
  # resource path
  local_var_path = "/mobile/authorization-code".sub('{format}','json')

  # 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 => 'CreateMobileAuthorizationCodeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileAuthorizationApi#create_mobile_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end