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 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 the voucher based on his code

Method Detail

fetch

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

Fetch details for specific voucher

Parameters:

code - of the voucher

Returns:

voucher based on his 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 the voucher based on his code

Parameters:

code - of the voucher

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