com.squareup.square.api

Class DefaultMobileAuthorizationApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultMobileAuthorizationApi

All Implemented Interfaces:

MobileAuthorizationApi

public final class DefaultMobileAuthorizationApi
extends BaseApi
implements MobileAuthorizationApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultMobileAuthorizationApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultMobileAuthorizationApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
CreateMobileAuthorizationCodeResponse	createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body) Generates code to authorize a mobile application to connect to a Square card reader.
CompletableFuture<CreateMobileAuthorizationCodeResponse>	createMobileAuthorizationCodeAsync(CreateMobileAuthorizationCodeRequest body) Generates code to authorize a mobile application to connect to a Square card reader.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMobileAuthorizationApi

public DefaultMobileAuthorizationApi(Configuration config,
                                     HttpClient httpClient,
                                     Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultMobileAuthorizationApi

public DefaultMobileAuthorizationApi(Configuration config,
                                     HttpClient httpClient,
                                     Map<String,AuthManager> authManagers,
                                     HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

createMobileAuthorizationCode

public CreateMobileAuthorizationCodeResponse createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body)
                                                                    throws ApiException,
                                                                           IOException

Generates code to authorize a mobile application to connect to a Square card reader. Authorization codes are one-time-use codes 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](https://developer.squareup.com/docs/build-basics/access-tokens).

Specified by:

createMobileAuthorizationCode in interface MobileAuthorizationApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMobileAuthorizationCodeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createMobileAuthorizationCodeAsync

public CompletableFuture<CreateMobileAuthorizationCodeResponse> createMobileAuthorizationCodeAsync(CreateMobileAuthorizationCodeRequest body)

Generates code to authorize a mobile application to connect to a Square card reader. Authorization codes are one-time-use codes 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](https://developer.squareup.com/docs/build-basics/access-tokens).

Specified by:

createMobileAuthorizationCodeAsync in interface MobileAuthorizationApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateMobileAuthorizationCodeResponse response from the API call