Package com.inteliqua.rest.coupon.client

Class CouponClient

java.lang.Object

com.inteliqua.rest.EliquaClientBase

com.inteliqua.rest.EliquaClient

com.inteliqua.rest.coupon.client.CouponClient

All Implemented Interfaces:

CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

public class CouponClient
extends EliquaClient
implements CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

Client responsible for interacting with the coupon search API. Extends EliquaClient and implements the CrudClient for sending search requests and parsing responses related to Coupon resources.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.qivos.util.rest.common.envelope.APIResponseEnvelope	create(CouponRequest requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope	delete(String code)
String	getResourceURI()	Returns the URI path for the coupon resource.
com.qivos.util.rest.common.envelope.APIResponseEnvelope<CouponSearchResponsePayload>	search(SearchRequest<CouponCriteria> requestBody)	Executes a search request for coupons using the provided criteria.
com.qivos.util.rest.common.envelope.APIResponseEnvelope	searchExtended(SearchRequest<CouponCriteria> requestBody)
com.qivos.util.rest.common.envelope.APIResponseEnvelope<com.qivos.util.rest.common.envelope.Payload>	update(CouponUpdateRequest requestBody, String code)	Updates an existing coupon identified by its code and associated coupon set code.

Methods inherited from class java.lang.Object

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

Constructor Detail

CouponClient

public CouponClient(String host,
                    EliquaAuthenticationProvider eliquaAuthenticationProvider)

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

Parameters:

host - the base URL of the API

eliquaAuthenticationProvider - the provider responsible for authentication

Method Detail

getResourceURI

public String getResourceURI()

Returns the URI path for the coupon resource.

Specified by:

getResourceURI in class EliquaClient

Returns:

the resource URI used in HTTP requests

search

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

Executes a search request for coupons using the provided criteria.

Specified by:

search in interface CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

Parameters:

requestBody - the search request payload

Returns:

the response envelope containing the list of matching coupons

searchExtended

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

Specified by:

searchExtended in interface CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

delete

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

Specified by:

delete in interface CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

create

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

Specified by:

create in interface CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

update

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

Updates an existing coupon identified by its code and associated coupon set code.

Specified by:

update in interface CrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>

Parameters:

requestBody - the update data encapsulated in a CouponUpdateRequest, which must include the coupon set code

code - the unique identifier of the coupon to update

Returns:

an APIResponseEnvelope containing a Payload with the result of the operation