Package com.inteliqua.rest.couponset.client

Class CouponSetClient

java.lang.Object

com.inteliqua.rest.EliquaClientBase

com.inteliqua.rest.EliquaClient

com.inteliqua.rest.couponset.client.CouponSetClient

All Implemented Interfaces:

CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

public class CouponSetClient
extends EliquaClient
implements CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

Client responsible for interacting with the coupon set search API. Extends EliquaClient and implements CrudClient to provides full CRUD functionality for coupon sets.

Field Summary

Fields

Modifier and Type	Field	Description
static String	COUPONSET_SEARCH_URI
static String	SEARCH_PATH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.qivos.util.rest.common.envelope.APIResponseEnvelope	create(CouponSetCreateDto requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope	delete(String code)
String	getResourceURI()	Returns the resource URI for the coupon set search endpoint.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<CouponSetSearchResponsePayload>	search(SearchRequest<CouponSetCriteria> requestBody)	Executes a search for coupon sets based on the provided CouponSetCriteria.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	searchExtended(SearchRequest<CouponSetCriteria> requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope<CouponSetCreateUpdateResponsePayload>	update(CouponSetUpdateDto requestBody, String code)	Updates an existing coupon set identified by the given code.

Methods inherited from class java.lang.Object

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

Field Detail

COUPONSET_SEARCH_URI

public static final String COUPONSET_SEARCH_URI

See Also:

Constant Field Values

SEARCH_PATH

public static final String SEARCH_PATH

See Also:

Constant Field Values

Constructor Detail

CouponSetClient

public CouponSetClient(String host,
                       EliquaAuthenticationProvider eliquaAuthenticationProvider)

Constructs a new CouponSetClient with the given host and authentication provider.

Parameters:

host - the base URL of the API

eliquaAuthenticationProvider - the provider responsible for authentication

Method Detail

search

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

Executes a search for coupon sets based on the provided CouponSetCriteria.

Specified by:

search in interface CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

Parameters:

requestBody - the search request containing the criteria for the coupon set query

Returns:

an APIResponseEnvelope containing the CouponSetSearchResponsePayload

searchExtended

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

Specified by:

searchExtended in interface CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

create

public com.qivos.util.rest.common.envelope.APIResponseEnvelope create(CouponSetCreateDto requestBody)

Specified by:

create in interface CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

update

public com.qivos.util.rest.common.envelope.APIResponseEnvelope<CouponSetCreateUpdateResponsePayload> update(CouponSetUpdateDto requestBody,
                                                                                                            String code)

Updates an existing coupon set identified by the given code.

Specified by:

update in interface CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

Parameters:

requestBody - the update data encapsulated in a CouponSetUpdateDto

code - the unique identifier of the coupon set to update

Returns:

an APIResponseEnvelope containing CouponSetCreateUpdateResponsePayload

delete

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

Specified by:

delete in interface CrudClient<CouponSetCriteria,CouponSetCreateDto,CouponSetUpdateDto>

getResourceURI

public String getResourceURI()

Returns the resource URI for the coupon set search endpoint.

Specified by:

getResourceURI in class EliquaClient

Returns:

the URI path used in HTTP requests for coupon set search