Package com.adyen.service.legalentitymanagement

Class TermsOfServiceApi

java.lang.Object

com.adyen.Service

com.adyen.service.legalentitymanagement.TermsOfServiceApi

public class TermsOfServiceApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TermsOfServiceApi(Client client)	Terms of Service constructor in package.
TermsOfServiceApi(Client client, String baseURL)	Terms of Service constructor in package.

Method Summary

Modifier and Type	Method	Description
AcceptTermsOfServiceResponse	acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest)	Accept Terms of Service
AcceptTermsOfServiceResponse	acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest, RequestOptions requestOptions)	Accept Terms of Service
GetAcceptedTermsOfServiceDocumentResponse	getAcceptedTermsOfServiceDocument(String id, String termsofserviceacceptancereference)	Get accepted Terms of Service document
GetAcceptedTermsOfServiceDocumentResponse	getAcceptedTermsOfServiceDocument(String id, String termsofserviceacceptancereference, String termsOfServiceDocumentFormat, RequestOptions requestOptions)	Get accepted Terms of Service document
GetTermsOfServiceDocumentResponse	getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest)	Get Terms of Service document
GetTermsOfServiceDocumentResponse	getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest, RequestOptions requestOptions)	Get Terms of Service document
GetTermsOfServiceAcceptanceInfosResponse	getTermsOfServiceInformationForLegalEntity(String id)	Get Terms of Service information for a legal entity
GetTermsOfServiceAcceptanceInfosResponse	getTermsOfServiceInformationForLegalEntity(String id, RequestOptions requestOptions)	Get Terms of Service information for a legal entity
CalculateTermsOfServiceStatusResponse	getTermsOfServiceStatus(String id)	Get Terms of Service status
CalculateTermsOfServiceStatusResponse	getTermsOfServiceStatus(String id, RequestOptions requestOptions)	Get Terms of Service status

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

TermsOfServiceApi

public TermsOfServiceApi(Client client)

Terms of Service constructor in package.

Parameters:

client - Client (required)

TermsOfServiceApi

public TermsOfServiceApi(Client client,
                         String baseURL)

Terms of Service constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

acceptTermsOfService

public AcceptTermsOfServiceResponse acceptTermsOfService(String id,
                                                         String termsofservicedocumentid,
                                                         AcceptTermsOfServiceRequest acceptTermsOfServiceRequest)
                                                  throws ApiException,
                                                         IOException

Accept Terms of Service

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. For legal representatives of individuals, this is the ID of the individual. (required)

termsofservicedocumentid - String The unique identifier of the Terms of Service document. (required)

acceptTermsOfServiceRequest - AcceptTermsOfServiceRequest (required)

Returns:

AcceptTermsOfServiceResponse

Throws:

ApiException - if fails to make API call

IOException

acceptTermsOfService

public AcceptTermsOfServiceResponse acceptTermsOfService(String id,
                                                         String termsofservicedocumentid,
                                                         AcceptTermsOfServiceRequest acceptTermsOfServiceRequest,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Accept Terms of Service

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. For legal representatives of individuals, this is the ID of the individual. (required)

termsofservicedocumentid - String The unique identifier of the Terms of Service document. (required)

acceptTermsOfServiceRequest - AcceptTermsOfServiceRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

AcceptTermsOfServiceResponse

Throws:

ApiException - if fails to make API call

IOException

getAcceptedTermsOfServiceDocument

public GetAcceptedTermsOfServiceDocumentResponse getAcceptedTermsOfServiceDocument(String id,
                                                                                   String termsofserviceacceptancereference)
                                                                            throws ApiException,
                                                                                   IOException

Get accepted Terms of Service document

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorship, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

termsofserviceacceptancereference - String An Adyen-generated reference for the accepted Terms of Service. (required)

Returns:

GetAcceptedTermsOfServiceDocumentResponse

Throws:

ApiException - if fails to make API call

IOException

getAcceptedTermsOfServiceDocument

public GetAcceptedTermsOfServiceDocumentResponse getAcceptedTermsOfServiceDocument(String id,
                                                                                   String termsofserviceacceptancereference,
                                                                                   String termsOfServiceDocumentFormat,
                                                                                   RequestOptions requestOptions)
                                                                            throws ApiException,
                                                                                   IOException

Get accepted Terms of Service document

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorship, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

termsofserviceacceptancereference - String An Adyen-generated reference for the accepted Terms of Service. (required)

termsOfServiceDocumentFormat - String Query: The format of the Terms of Service document. Possible values: **JSON**, **PDF**, or **TXT** (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

GetAcceptedTermsOfServiceDocumentResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceDocument

public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id,
                                                                   GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest)
                                                            throws ApiException,
                                                                   IOException

Get Terms of Service document

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

getTermsOfServiceDocumentRequest - GetTermsOfServiceDocumentRequest (required)

Returns:

GetTermsOfServiceDocumentResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceDocument

public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id,
                                                                   GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest,
                                                                   RequestOptions requestOptions)
                                                            throws ApiException,
                                                                   IOException

Get Terms of Service document

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

getTermsOfServiceDocumentRequest - GetTermsOfServiceDocumentRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

GetTermsOfServiceDocumentResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceInformationForLegalEntity

public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id)
                                                                                    throws ApiException,
                                                                                           IOException

Get Terms of Service information for a legal entity

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

Returns:

GetTermsOfServiceAcceptanceInfosResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceInformationForLegalEntity

public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id,
                                                                                           RequestOptions requestOptions)
                                                                                    throws ApiException,
                                                                                           IOException

Get Terms of Service information for a legal entity

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

GetTermsOfServiceAcceptanceInfosResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceStatus

public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id)
                                                              throws ApiException,
                                                                     IOException

Get Terms of Service status

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

Returns:

CalculateTermsOfServiceStatusResponse

Throws:

ApiException - if fails to make API call

IOException

getTermsOfServiceStatus

public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id,
                                                                     RequestOptions requestOptions)
                                                              throws ApiException,
                                                                     IOException

Get Terms of Service status

Parameters:

id - String The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

CalculateTermsOfServiceStatusResponse

Throws:

ApiException - if fails to make API call

IOException