Package com.inteliqua.rest.transaction.client

Class LoyaltyTransactionClient

java.lang.Object

com.inteliqua.rest.EliquaClientBase

com.inteliqua.rest.EliquaClient

com.inteliqua.rest.transaction.client.LoyaltyTransactionClient

All Implemented Interfaces:

CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

public class LoyaltyTransactionClient
extends EliquaClient
implements CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

Client for handling loyalty transaction operations through the Eliqua API. Extends EliquaClient and Implements CrudClient to provide standard CRUD functionality for loyalty transactions operations including searching and creating new transactions.

Constructor Summary

Constructors

Constructor	Description
LoyaltyTransactionClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)	Constructs a with the given host and authentication provider.

Method Summary

Modifier and Type	Method	Description
com.qivos.util.rest.common.envelope.APIResponseEnvelope<LoyaltyTransactionResponsePayload>	create(LoyaltyTransactionCreateRequest requestBody)	Creates a new loyalty transaction.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	delete(String code)
String	getResourceURI()	Returns the base resource URI for loyalty transaction operations.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<LoyaltyTransactionResponseSearchPayload>	search(SearchRequest<LoyaltyTransactionCriteria> requestBody)	Performs a search operation for loyalty transactions based on the provided criteria.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	searchExtended(SearchRequest<LoyaltyTransactionCriteria> requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope	update(TransactionBasePayload requestBody, String code)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyTransactionClient

public LoyaltyTransactionClient(String host,
                                EliquaAuthenticationProvider eliquaAuthenticationProvider)

Constructs a with the given host and authentication provider.

Parameters:

host - the base URL of the Eliqua API

eliquaAuthenticationProvider - the provider for handling authentication

Method Detail

search

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<LoyaltyTransactionResponseSearchPayload> search(SearchRequest<LoyaltyTransactionCriteria> requestBody)

Performs a search operation for loyalty transactions based on the provided criteria.

Specified by:

search in interface CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

Parameters:

requestBody - the search request containing the criteria

Returns:

an API response containing the search results

searchExtended

public com.qivos.util.rest.common.envelope.APIResponseEnvelope searchExtended(SearchRequest<LoyaltyTransactionCriteria> requestBody)

Specified by:

searchExtended in interface CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

update

public com.qivos.util.rest.common.envelope.APIResponseEnvelope update(TransactionBasePayload requestBody,
                                                                      String code)

Specified by:

update in interface CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

delete

public com.qivos.util.rest.common.envelope.APIResponseEnvelope delete(String code)

Specified by:

delete in interface CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

create

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<LoyaltyTransactionResponsePayload> create(LoyaltyTransactionCreateRequest requestBody)

Creates a new loyalty transaction.

Specified by:

create in interface CrudClient<LoyaltyTransactionCriteria,LoyaltyTransactionCreateRequest,TransactionBasePayload>

Parameters:

requestBody - the request containing the transaction details

Returns:

an API response containing the created transaction details

getResourceURI

public String getResourceURI()

Returns the base resource URI for loyalty transaction operations.

Specified by:

getResourceURI in class EliquaClient

Returns:

the loyalty transactions URI