pl.rspective.voucherify.client.api

Interface VoucherifyApi

public interface VoucherifyApi

An interface used internally to create a Retrofit API.

Method Summary

Modifier and Type	Method and Description
Customer	createCustomer(Customer customer) Create a customer using given Customer
Voucher	createVoucher(Voucher voucher) Create a voucher with generated code.
Voucher	createVoucherWithCode(java.lang.String code, Voucher voucher) Create a voucher with specified code.
com.squareup.okhttp.Response	deleteCustomer(java.lang.String customerId) Delete a Customer by ID
com.squareup.okhttp.Response	disableVoucher(java.lang.String code) Disable a voucher.
com.squareup.okhttp.Response	enableVoucher(java.lang.String code) Enable a voucher.
Voucher	fetch(java.lang.String code) Fetch details for a specific voucher.
Customer	getCustomer(java.lang.String customerId) Get a Customer using Customer ID
RedemptionsList	listRedemptions(RedemptionsFilter filter) List redemptions across all vouchers.
java.util.List<Voucher>	listVouchers(VouchersFilter filter) List vouchers which meet provided filters.
Voucher	publishVoucher(PublishParams publishParams) Publish voucher.
VoucherRedemptionResult	redeem(java.lang.String code, java.lang.String trackingId) Method used to redeem a voucher identified by code
VoucherRedemptionResult	redeem(java.lang.String code, VoucherRedemptionContext redemptionContext) Method used to redeem a voucher and provide a context information.
VoucherRedemption	redemption(java.lang.String code) Fetch information about voucher redemption details
VoucherRedemptionResult	rollbackRedemption(java.lang.String redemptionId, java.lang.String trackingId, java.lang.String reason) Redemption rollback reverts a redemption.
Customer	updateCustomer(java.lang.String customerId, Customer customer) Update a Customer by ID, using given Customer object
Voucher	updateVoucher(java.lang.String code, VoucherUpdate voucherUpdate) Update voucher.

Method Detail

listVouchers

@GET(value="/vouchers/")
java.util.List<Voucher> listVouchers(@QueryMap
                                                               VouchersFilter filter)

List vouchers which meet provided filters.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

a list of user vouchers

fetch

@GET(value="/vouchers/{code}")
Voucher fetch(@Path(value="code")
                                              java.lang.String code)

Fetch details for a specific voucher.

Parameters:

code - code of the voucher

Returns:

details of a the voucher identified by given code

createVoucher

@POST(value="/vouchers/")
Voucher createVoucher(@Body
                                                 Voucher voucher)

Create a voucher with generated code.

Parameters:

voucher - voucher to be created

Returns:

created voucher

createVoucherWithCode

@POST(value="/vouchers/{code}")
Voucher createVoucherWithCode(@Path(value="code")
                                                               java.lang.String code,
                                                               @Body
                                                               Voucher voucher)

Create a voucher with specified code.

Parameters:

voucher - voucher to be created

Returns:

created voucher

updateVoucher

@PUT(value="/vouchers/{code}")
Voucher updateVoucher(@Path(value="code")
                                                      java.lang.String code,
                                                      @Body
                                                      VoucherUpdate voucherUpdate)

Update voucher.

Parameters:

voucherUpdate - voucher fields to be updated

Returns:

updated voucher

disableVoucher

@POST(value="/vouchers/{code}/disable")
com.squareup.okhttp.Response disableVoucher(@Path(value="code")
                                                                                     java.lang.String code)

Disable a voucher.

Parameters:

code - code of a voucher that should be disabled

enableVoucher

@POST(value="/vouchers/{code}/enable")
com.squareup.okhttp.Response enableVoucher(@Path(value="code")
                                                                                   java.lang.String code)

Enable a voucher.

Parameters:

code - code of a voucher that should be enabled

redeem

@POST(value="/vouchers/{code}/redemption")
VoucherRedemptionResult redeem(@Path(value="code")
                                                                           java.lang.String code,
                                                                           @Query(value="tracking_id")
                                                                           java.lang.String trackingId)

Method used to redeem a voucher identified by code

Parameters:

code - code of the voucher

trackingId - an id enabling you to correlate who has redeemed the voucher

Returns:

redeem

@POST(value="/vouchers/{code}/redemption")
VoucherRedemptionResult redeem(@Path(value="code")
                                                                           java.lang.String code,
                                                                           @Body
                                                                           VoucherRedemptionContext redemptionContext)

Method used to redeem a voucher and provide a context information.

Parameters:

code - code of the voucher

redemptionContext - a context in terms of which the voucher is being redeemed (e.g. customer profile)

Returns:

redemption result (including redemption id)

redemption

@GET(value="/vouchers/{code}/redemption")
VoucherRedemption redemption(@Path(value="code")
                                                                        java.lang.String code)

Fetch information about voucher redemption details

Parameters:

code - of the voucher

Returns:

voucher redemption information

publishVoucher

@POST(value="/vouchers/publish")
Voucher publishVoucher(@Body
                                                         PublishParams publishParams)

Publish voucher.

Parameters:

publishParams - voucher code or campaign name with publish details

Returns:

published voucher

listRedemptions

@GET(value="/redemptions")
RedemptionsList listRedemptions(@QueryMap
                                                            RedemptionsFilter filter)

List redemptions across all vouchers.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

a list of redemption details

rollbackRedemption

@POST(value="/redemptions/{id}/rollback")
VoucherRedemptionResult rollbackRedemption(@Path(value="id")
                                                                                      java.lang.String redemptionId,
                                                                                      @Query(value="tracking_id")
                                                                                      java.lang.String trackingId,
                                                                                      @Query(value="reason")
                                                                                      java.lang.String reason)

Redemption rollback reverts a redemption.

Parameters:

redemptionId - (required) id of a redemption

trackingId - (optional) id of a customer

reason - (optional)

Returns:

rollback result (including rollback id, original redemption id, voucher after rollback)

createCustomer

@POST(value="/customers")
Customer createCustomer(@Body
                                                   Customer customer)

Create a customer using given Customer

Parameters:

customer - (required)

Returns:

created User

getCustomer

@GET(value="/customers/{id}")
Customer getCustomer(@Path(value="id")
                                                    java.lang.String customerId)

Get a Customer using Customer ID

Parameters:

customerId - (required)

Returns:

customer with given ID

updateCustomer

@PUT(value="/customers/{id}")
Customer updateCustomer(@Path(value="id")
                                                       java.lang.String customerId,
                                                       @Body
                                                       Customer customer)

Update a Customer by ID, using given Customer object

Parameters:

customerId - (required)

customer - (optional)

Returns:

Updated Customer with given ID

deleteCustomer

@DELETE(value="/customers/{id}")
com.squareup.okhttp.Response deleteCustomer(@Path(value="id")
                                                                              java.lang.String customerId)

Delete a Customer by ID

Parameters:

customerId - (required)

Returns:

Response without data