Class TransactionClient
- java.lang.Object
-
- com.inteliqua.rest.EliquaClientBase
-
- com.inteliqua.rest.EliquaClient
-
- com.inteliqua.rest.transaction.client.TransactionClient
-
- All Implemented Interfaces:
CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>
public class TransactionClient extends EliquaClient implements CrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>
Client class for managing transaction-related operations via the Eliqua API. This class handles searching, creating and processing transaction-related requests.It extends
EliquaClientand implementsCrudClientto provide CRUD operations for transactions usingTransactionCriteria,TransactionCreateRequest, andTransactionBasePayload.
-
-
Constructor Summary
Constructors Constructor Description TransactionClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)Constructs a new with the given host and authentication provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponsePayload>create(TransactionCreateRequest requestBody)Creates a new transaction record in the system.com.qivos.util.rest.common.envelope.APIResponseEnvelopedelete(String code)StringgetResourceURI()Retrieves the base resource URI for transaction-related requests.com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponseSearchPayload>search(SearchRequest<TransactionCriteria> requestBody)Searches for transactions based on the given search criteria.com.qivos.util.rest.common.envelope.APIResponseEnvelopesearchExtended(SearchRequest<TransactionCriteria> requestBody)com.qivos.util.rest.common.envelope.APIResponseEnvelopeupdate(TransactionBasePayload requestBody, String code)
-
-
-
Constructor Detail
-
TransactionClient
public TransactionClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)
Constructs a new with the given host and authentication provider.- Parameters:
host- the API host URLeliquaAuthenticationProvider- the authentication provider for API access
-
-
Method Detail
-
search
public com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponseSearchPayload> search(SearchRequest<TransactionCriteria> requestBody)
Searches for transactions based on the given search criteria.- Specified by:
searchin interfaceCrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>- Parameters:
requestBody- criteria encapsulated in aSearchRequest- Returns:
- an
APIResponseEnvelopecontainingTransactionResponseSearchPayload
-
searchExtended
public com.qivos.util.rest.common.envelope.APIResponseEnvelope searchExtended(SearchRequest<TransactionCriteria> requestBody)
- Specified by:
searchExtendedin interfaceCrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>
-
create
public com.qivos.util.rest.common.envelope.APIResponseEnvelope<TransactionResponsePayload> create(TransactionCreateRequest requestBody)
Creates a new transaction record in the system.- Specified by:
createin interfaceCrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>- Parameters:
requestBody- the request object containing the transaction details- Returns:
- an
APIResponseEnvelopecontainingTransactionResponsePayload
-
update
public com.qivos.util.rest.common.envelope.APIResponseEnvelope update(TransactionBasePayload requestBody, String code)
- Specified by:
updatein interfaceCrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>
-
delete
public com.qivos.util.rest.common.envelope.APIResponseEnvelope delete(String code)
- Specified by:
deletein interfaceCrudClient<TransactionCriteria,TransactionCreateRequest,TransactionBasePayload>
-
getResourceURI
public String getResourceURI()
Retrieves the base resource URI for transaction-related requests.- Specified by:
getResourceURIin classEliquaClient- Returns:
- the resource URI as a
String
-
-