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. ExtendsEliquaClientand implements theCrudClientfor sending search requests and parsing responses related toCouponresources.
-
-
Constructor Summary
Constructors Constructor Description CouponClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)Constructs a newCouponClientwith 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.APIResponseEnvelopecreate(CouponRequest requestBody)com.qivos.util.rest.common.envelope.APIResponseEnvelopedelete(String code)StringgetResourceURI()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.APIResponseEnvelopesearchExtended(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.
-
-
-
Constructor Detail
-
CouponClient
public CouponClient(String host, EliquaAuthenticationProvider eliquaAuthenticationProvider)
Constructs a newCouponClientwith the given host and authentication provider.- Parameters:
host- the base URL of the APIeliquaAuthenticationProvider- the provider responsible for authentication
-
-
Method Detail
-
getResourceURI
public String getResourceURI()
Returns the URI path for the coupon resource.- Specified by:
getResourceURIin classEliquaClient- 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:
searchin interfaceCrudClient<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:
searchExtendedin interfaceCrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>
-
delete
public com.qivos.util.rest.common.envelope.APIResponseEnvelope delete(String code)
- Specified by:
deletein interfaceCrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>
-
create
public com.qivos.util.rest.common.envelope.APIResponseEnvelope create(CouponRequest requestBody)
- Specified by:
createin interfaceCrudClient<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:
updatein interfaceCrudClient<CouponCriteria,CouponRequest,CouponUpdateRequest>- Parameters:
requestBody- the update data encapsulated in aCouponUpdateRequest, which must include the coupon set codecode- the unique identifier of the coupon to update- Returns:
- an
APIResponseEnvelopecontaining aPayloadwith the result of the operation
-
-