com.squareup.square.api

Interface OAuthApi

All Known Implementing Classes:

DefaultOAuthApi

public interface OAuthApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
ObtainTokenResponse	obtainToken(ObtainTokenRequest body) Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set to `true`, in which case the endpoint returns only an access token.
CompletableFuture<ObtainTokenResponse>	obtainTokenAsync(ObtainTokenRequest body) Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set to `true`, in which case the endpoint returns only an access token.
RenewTokenResponse	renewToken(String clientId, RenewTokenRequest body, String authorization) Deprecated.
CompletableFuture<RenewTokenResponse>	renewTokenAsync(String clientId, RenewTokenRequest body, String authorization) Deprecated.
RevokeTokenResponse	revokeToken(RevokeTokenRequest body, String authorization) Revokes an access token generated with the OAuth flow.
CompletableFuture<RevokeTokenResponse>	revokeTokenAsync(RevokeTokenRequest body, String authorization) Revokes an access token generated with the OAuth flow.

Method Detail

renewToken

@Deprecated
RenewTokenResponse renewToken(String clientId,
                                          RenewTokenRequest body,
                                          String authorization)
                                   throws ApiException,
                                          IOException

Deprecated.

`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after 30 days. You can also renew expired tokens within 15 days of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must recomplete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps).

Parameters:

clientId - Required parameter: Your application ID, which is available in the OAuth page in the [Developer Dashboard](https://developer.squareup.com/apps).

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

authorization - Required parameter: Client APPLICATION_SECRET

Returns:

Returns the RenewTokenResponse 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.

renewTokenAsync

@Deprecated
CompletableFuture<RenewTokenResponse> renewTokenAsync(String clientId,
                                                                  RenewTokenRequest body,
                                                                  String authorization)

Deprecated.

`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after 30 days. You can also renew expired tokens within 15 days of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must recomplete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps).

Parameters:

clientId - Required parameter: Your application ID, which is available in the OAuth page in the [Developer Dashboard](https://developer.squareup.com/apps).

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

authorization - Required parameter: Client APPLICATION_SECRET

Returns:

Returns the RenewTokenResponse response from the API call

revokeToken

RevokeTokenResponse revokeToken(RevokeTokenRequest body,
                                String authorization)
                         throws ApiException,
                                IOException

Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the OAuth page for your application on the Developer Dashboard.

Parameters:

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

authorization - Required parameter: Client APPLICATION_SECRET

Returns:

Returns the RevokeTokenResponse 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.

revokeTokenAsync

CompletableFuture<RevokeTokenResponse> revokeTokenAsync(RevokeTokenRequest body,
                                                        String authorization)

Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the OAuth page for your application on the Developer Dashboard.

Parameters:

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

authorization - Required parameter: Client APPLICATION_SECRET

Returns:

Returns the RevokeTokenResponse response from the API call

obtainToken

ObtainTokenResponse obtainToken(ObtainTokenRequest body)
                         throws ApiException,
                                IOException

Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set to `true`, in which case the endpoint returns only an access token. The `grant_type` parameter specifies the type of OAuth request. If `grant_type` is `authorization_code`, you must include the authorization code you received when a seller granted you authorization. If `grant_type` is `refresh_token`, you must provide a valid refresh token. If you are using an old version of the Square APIs (prior to March 13, 2019), `grant_type` can be `migration_token` and you must provide a valid migration token. You can use the `scopes` parameter to limit the set of permissions granted to the access token and refresh token. You can use the `short_lived` parameter to create an access token that expires in 24 hours. __Note:__ OAuth tokens should be encrypted and stored on a secure server. Application clients should never interact directly with OAuth tokens.

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

obtainTokenAsync

CompletableFuture<ObtainTokenResponse> obtainTokenAsync(ObtainTokenRequest body)

Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set to `true`, in which case the endpoint returns only an access token. The `grant_type` parameter specifies the type of OAuth request. If `grant_type` is `authorization_code`, you must include the authorization code you received when a seller granted you authorization. If `grant_type` is `refresh_token`, you must provide a valid refresh token. If you are using an old version of the Square APIs (prior to March 13, 2019), `grant_type` can be `migration_token` and you must provide a valid migration token. You can use the `scopes` parameter to limit the set of permissions granted to the access token and refresh token. You can use the `short_lived` parameter to create an access token that expires in 24 hours. __Note:__ OAuth tokens should be encrypted and stored on a secure server. Application clients should never interact directly with OAuth tokens.

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 ObtainTokenResponse response from the API call