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
Voucher	fetch(java.lang.String code) Fetch details for a specific voucher.
VoucherUsage	usage(java.lang.String code) Fetch information about voucher usage details
Voucher	use(java.lang.String code, java.lang.String trackingId) Method used to consume a voucher identified by code
Voucher	use(java.lang.String code, VoucherUsageContext usageContext) Method used to consume a voucher and provide a context information.

Method Detail

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

use

@POST(value="/vouchers/{code}/usage")
Voucher use(@Path(value="code")
                                                   java.lang.String code,
                                                   @Query(value="tracking_id")
                                                   java.lang.String trackingId)

Method used to consume a voucher identified by code

Parameters:

code - code of the voucher

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

Returns:

use

@POST(value="/vouchers/{code}/usage")
Voucher use(@Path(value="code")
                                                   java.lang.String code,
                                                   @Body
                                                   VoucherUsageContext usageContext)

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

Parameters:

code - code of the voucher

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

Returns:

usage

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

Fetch information about voucher usage details

Parameters:

code - of the voucher

Returns:

voucher usage information