com.squareup.square.models

Class ObtainTokenRequest

java.lang.Object

com.squareup.square.models.ObtainTokenRequest

public class ObtainTokenRequest
extends Object

This is a model class for ObtainTokenRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObtainTokenRequest.Builder Class to build instances of ObtainTokenRequest.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObtainTokenRequest(String clientId, String grantType, io.apimatic.core.types.OptionalNullable<String> clientSecret, io.apimatic.core.types.OptionalNullable<String> code, io.apimatic.core.types.OptionalNullable<String> redirectUri, io.apimatic.core.types.OptionalNullable<String> refreshToken, io.apimatic.core.types.OptionalNullable<String> migrationToken, io.apimatic.core.types.OptionalNullable<List<String>> scopes, io.apimatic.core.types.OptionalNullable<Boolean> shortLived, io.apimatic.core.types.OptionalNullable<String> codeVerifier) Initialization constructor.
	ObtainTokenRequest(String clientId, String grantType, String clientSecret, String code, String redirectUri, String refreshToken, String migrationToken, List<String> scopes, Boolean shortLived, String codeVerifier) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientId() Getter for ClientId.
String	getClientSecret() Getter for ClientSecret.
String	getCode() Getter for Code.
String	getCodeVerifier() Getter for CodeVerifier.
String	getGrantType() Getter for GrantType.
String	getMigrationToken() Getter for MigrationToken.
String	getRedirectUri() Getter for RedirectUri.
String	getRefreshToken() Getter for RefreshToken.
List<String>	getScopes() Getter for Scopes.
Boolean	getShortLived() Getter for ShortLived.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetClientSecret() Internal Getter for ClientSecret.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCode() Internal Getter for Code.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCodeVerifier() Internal Getter for CodeVerifier.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMigrationToken() Internal Getter for MigrationToken.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetRedirectUri() Internal Getter for RedirectUri.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetRefreshToken() Internal Getter for RefreshToken.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetScopes() Internal Getter for Scopes.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetShortLived() Internal Getter for ShortLived.
ObtainTokenRequest.Builder	toBuilder() Builds a new ObtainTokenRequest.Builder object.
String	toString() Converts this ObtainTokenRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObtainTokenRequest

public ObtainTokenRequest(String clientId,
                          String grantType,
                          String clientSecret,
                          String code,
                          String redirectUri,
                          String refreshToken,
                          String migrationToken,
                          List<String> scopes,
                          Boolean shortLived,
                          String codeVerifier)

Initialization constructor.

Parameters:

clientId - String value for clientId.

grantType - String value for grantType.

clientSecret - String value for clientSecret.

code - String value for code.

redirectUri - String value for redirectUri.

refreshToken - String value for refreshToken.

migrationToken - String value for migrationToken.

scopes - List of String value for scopes.

shortLived - Boolean value for shortLived.

codeVerifier - String value for codeVerifier.

ObtainTokenRequest

protected ObtainTokenRequest(String clientId,
                             String grantType,
                             io.apimatic.core.types.OptionalNullable<String> clientSecret,
                             io.apimatic.core.types.OptionalNullable<String> code,
                             io.apimatic.core.types.OptionalNullable<String> redirectUri,
                             io.apimatic.core.types.OptionalNullable<String> refreshToken,
                             io.apimatic.core.types.OptionalNullable<String> migrationToken,
                             io.apimatic.core.types.OptionalNullable<List<String>> scopes,
                             io.apimatic.core.types.OptionalNullable<Boolean> shortLived,
                             io.apimatic.core.types.OptionalNullable<String> codeVerifier)

Initialization constructor.

Parameters:

clientId - String value for clientId.

grantType - String value for grantType.

clientSecret - String value for clientSecret.

code - String value for code.

redirectUri - String value for redirectUri.

refreshToken - String value for refreshToken.

migrationToken - String value for migrationToken.

scopes - List of String value for scopes.

shortLived - Boolean value for shortLived.

codeVerifier - String value for codeVerifier.

Method Detail

getClientId

public String getClientId()

Getter for ClientId. The Square-issued ID of your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps).

Returns:

Returns the String

internalGetClientSecret

protected io.apimatic.core.types.OptionalNullable<String> internalGetClientSecret()

Internal Getter for ClientSecret. The Square-issued application secret for your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required when you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow). The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to `authorization_code`. If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE flow only requires `client_id`, `grant_type`, and `refresh_token`.

Returns:

Returns the Internal String

getClientSecret

public String getClientSecret()

Getter for ClientSecret. The Square-issued application secret for your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required when you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow). The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to `authorization_code`. If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE flow only requires `client_id`, `grant_type`, and `refresh_token`.

Returns:

Returns the String

internalGetCode

protected io.apimatic.core.types.OptionalNullable<String> internalGetCode()

Internal Getter for Code. The authorization code to exchange. This code is required if `grant_type` is set to `authorization_code` to indicate that the application wants to exchange an authorization code for an OAuth access token.

Returns:

Returns the Internal String

getCode

public String getCode()

Getter for Code. The authorization code to exchange. This code is required if `grant_type` is set to `authorization_code` to indicate that the application wants to exchange an authorization code for an OAuth access token.

Returns:

Returns the String

internalGetRedirectUri

protected io.apimatic.core.types.OptionalNullable<String> internalGetRedirectUri()

Internal Getter for RedirectUri. The redirect URL assigned on the **OAuth** page for your application in the [Developer Dashboard](https://developer.squareup.com/apps).

Returns:

Returns the Internal String

getRedirectUri

public String getRedirectUri()

Getter for RedirectUri. The redirect URL assigned on the **OAuth** page for your application in the [Developer Dashboard](https://developer.squareup.com/apps).

Returns:

Returns the String

getGrantType

public String getGrantType()

Getter for GrantType. Specifies the method to request an OAuth access token. Valid values are `authorization_code`, `refresh_token`, and `migration_token`.

Returns:

Returns the String

internalGetRefreshToken

protected io.apimatic.core.types.OptionalNullable<String> internalGetRefreshToken()

Internal Getter for RefreshToken. A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` to indicate that the application wants a replacement for an expired OAuth access token.

Returns:

Returns the Internal String

getRefreshToken

public String getRefreshToken()

Getter for RefreshToken. A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` to indicate that the application wants a replacement for an expired OAuth access token.

Returns:

Returns the String

internalGetMigrationToken

protected io.apimatic.core.types.OptionalNullable<String> internalGetMigrationToken()

Internal Getter for MigrationToken. A legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).

Returns:

Returns the Internal String

getMigrationToken

public String getMigrationToken()

Getter for MigrationToken. A legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).

Returns:

Returns the String

internalGetScopes

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetScopes()

Internal Getter for Scopes. A JSON list of strings representing the permissions that the application is requesting. For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`". The access token returned in the response is granted the permissions that comprise the intersection between the requested list of permissions and those that belong to the provided refresh token.

Returns:

Returns the Internal List of String

getScopes

public List<String> getScopes()

Getter for Scopes. A JSON list of strings representing the permissions that the application is requesting. For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`". The access token returned in the response is granted the permissions that comprise the intersection between the requested list of permissions and those that belong to the provided refresh token.

Returns:

Returns the List of String

internalGetShortLived

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetShortLived()

Internal Getter for ShortLived. A Boolean indicating a request for a short-lived access token. The short-lived access token returned in the response expires in 24 hours.

Returns:

Returns the Internal Boolean

getShortLived

public Boolean getShortLived()

Getter for ShortLived. A Boolean indicating a request for a short-lived access token. The short-lived access token returned in the response expires in 24 hours.

Returns:

Returns the Boolean

internalGetCodeVerifier

protected io.apimatic.core.types.OptionalNullable<String> internalGetCodeVerifier()

Internal Getter for CodeVerifier. Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The `code_verifier` is used to verify against the `code_challenge` associated with the `authorization_code`.

Returns:

Returns the Internal String

getCodeVerifier

public String getCodeVerifier()

Getter for CodeVerifier. Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The `code_verifier` is used to verify against the `code_challenge` associated with the `authorization_code`.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this ObtainTokenRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ObtainTokenRequest.Builder toBuilder()

Builds a new ObtainTokenRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new ObtainTokenRequest.Builder object