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 StringAPI_VERSIONprotected StringbaseURL
-
Constructor Summary
Constructors Constructor Description TermsOfServiceApi(Client client)Terms of Service constructor inpackage.TermsOfServiceApi(Client client, String baseURL)Terms of Service constructor inpackage.
-
Method Summary
-
Methods inherited from class com.adyen.Service
createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient
-
-
-
-
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 inpackage.- Parameters:
client-Client(required)
-
-
Method Detail
-
acceptTermsOfService
public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest) throws ApiException, IOException
Accept Terms of Service- Parameters:
id-StringThe 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-StringThe unique identifier of the Terms of Service document. (required)acceptTermsOfServiceRequest-AcceptTermsOfServiceRequest(required)- Returns:
AcceptTermsOfServiceResponse- Throws:
ApiException- if fails to make API callIOException
-
acceptTermsOfService
public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest, RequestOptions requestOptions) throws ApiException, IOException
Accept Terms of Service- Parameters:
id-StringThe 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-StringThe unique identifier of the Terms of Service document. (required)acceptTermsOfServiceRequest-AcceptTermsOfServiceRequest(required)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
AcceptTermsOfServiceResponse- Throws:
ApiException- if fails to make API callIOException
-
getAcceptedTermsOfServiceDocument
public GetAcceptedTermsOfServiceDocumentResponse getAcceptedTermsOfServiceDocument(String id, String termsofserviceacceptancereference) throws ApiException, IOException
Get accepted Terms of Service document- Parameters:
id-StringThe 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-StringAn Adyen-generated reference for the accepted Terms of Service. (required)- Returns:
GetAcceptedTermsOfServiceDocumentResponse- Throws:
ApiException- if fails to make API callIOException
-
getAcceptedTermsOfServiceDocument
public GetAcceptedTermsOfServiceDocumentResponse getAcceptedTermsOfServiceDocument(String id, String termsofserviceacceptancereference, String termsOfServiceDocumentFormat, RequestOptions requestOptions) throws ApiException, IOException
Get accepted Terms of Service document- Parameters:
id-StringThe 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-StringAn Adyen-generated reference for the accepted Terms of Service. (required)termsOfServiceDocumentFormat-StringQuery: The format of the Terms of Service document. Possible values: **JSON**, **PDF**, or **TXT** (optional)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
GetAcceptedTermsOfServiceDocumentResponse- Throws:
ApiException- if fails to make API callIOException
-
getTermsOfServiceDocument
public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest) throws ApiException, IOException
Get Terms of Service document- Parameters:
id-StringThe 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 callIOException
-
getTermsOfServiceDocument
public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException
Get Terms of Service document- Parameters:
id-StringThe 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-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
GetTermsOfServiceDocumentResponse- Throws:
ApiException- if fails to make API callIOException
-
getTermsOfServiceInformationForLegalEntity
public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id) throws ApiException, IOException
Get Terms of Service information for a legal entity- Parameters:
id-StringThe 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 callIOException
-
getTermsOfServiceInformationForLegalEntity
public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException
Get Terms of Service information for a legal entity- Parameters:
id-StringThe 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-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
GetTermsOfServiceAcceptanceInfosResponse- Throws:
ApiException- if fails to make API callIOException
-
getTermsOfServiceStatus
public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id) throws ApiException, IOException
Get Terms of Service status- Parameters:
id-StringThe 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 callIOException
-
getTermsOfServiceStatus
public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id, RequestOptions requestOptions) throws ApiException, IOException
Get Terms of Service status- Parameters:
id-StringThe 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-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
CalculateTermsOfServiceStatusResponse- Throws:
ApiException- if fails to make API callIOException
-
-