com.squareup.square.models

Class ObtainTokenResponse

java.lang.Object

com.squareup.square.models.ObtainTokenResponse

public class ObtainTokenResponse
extends Object

This is a model class for ObtainTokenResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ObtainTokenResponse(String accessToken, String tokenType, String expiresAt, String merchantId, String subscriptionId, String planId, String idToken, String refreshToken, Boolean shortLived, List<Error> errors) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() Getter for AccessToken.
HttpContext	getContext()
List<Error>	getErrors() Getter for Errors.
String	getExpiresAt() Getter for ExpiresAt.
String	getIdToken() Getter for IdToken.
String	getMerchantId() Getter for MerchantId.
String	getPlanId() Getter for PlanId.
String	getRefreshToken() Getter for RefreshToken.
Boolean	getShortLived() Getter for ShortLived.
String	getSubscriptionId() Getter for SubscriptionId.
String	getTokenType() Getter for TokenType.
int	hashCode()
ObtainTokenResponse.Builder	toBuilder() Builds a new ObtainTokenResponse.Builder object.
String	toString() Converts this ObtainTokenResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObtainTokenResponse

public ObtainTokenResponse(String accessToken,
                           String tokenType,
                           String expiresAt,
                           String merchantId,
                           String subscriptionId,
                           String planId,
                           String idToken,
                           String refreshToken,
                           Boolean shortLived,
                           List<Error> errors)

Initialization constructor.

Parameters:

accessToken - String value for accessToken.

tokenType - String value for tokenType.

expiresAt - String value for expiresAt.

merchantId - String value for merchantId.

subscriptionId - String value for subscriptionId.

planId - String value for planId.

idToken - String value for idToken.

refreshToken - String value for refreshToken.

shortLived - Boolean value for shortLived.

errors - List of Error value for errors.

Method Detail

getContext

public HttpContext getContext()

getAccessToken

public String getAccessToken()

Getter for AccessToken. A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).

Returns:

Returns the String

getTokenType

public String getTokenType()

Getter for TokenType. This value is always _bearer_.

Returns:

Returns the String

getExpiresAt

public String getExpiresAt()

Getter for ExpiresAt. The date when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.

Returns:

Returns the String

getMerchantId

public String getMerchantId()

Getter for MerchantId. The ID of the authorizing merchant's business.

Returns:

Returns the String

getSubscriptionId

public String getSubscriptionId()

Getter for SubscriptionId. __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.

Returns:

Returns the String

getPlanId

public String getPlanId()

Getter for PlanId. __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.

Returns:

Returns the String

getIdToken

public String getIdToken()

Getter for IdToken. The OpenID token belonging to this person. This token is only present if the OPENID scope is included in the authorization request.

Returns:

Returns the String

getRefreshToken

public String getRefreshToken()

Getter for RefreshToken. A refresh token. OAuth refresh tokens are 64 bytes long. For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope).

Returns:

Returns the String

getShortLived

public Boolean getShortLived()

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

Returns:

Returns the Boolean

getErrors

public List<Error> getErrors()

Getter for Errors. Any errors that occurred during the request.

Returns:

Returns the List of Error

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 ObtainTokenResponse into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ObtainTokenResponse.Builder toBuilder()

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

Returns:

a new ObtainTokenResponse.Builder object