io.voucherify.client.api

Interface VoucherifyApi

public interface VoucherifyApi

Method Summary

Modifier and Type	Method and Description
AddBalanceResponse	addBalance(java.lang.String code, AddBalance addBalance)
AddVoucherToCampaignResponse	addVoucherToCampaign(java.lang.String campaignName, AddVoucherToCampaign addVoucherToCampaign)
AddVoucherToCampaignResponse	addVoucherToCampaignWithCode(java.lang.String campaignName, java.lang.String voucherCode, AddVoucherToCampaign addVoucherToCampaign)
CampaignResponse	createCampaign(CreateCampaign createCampaign)
CustomerResponse	createCustomer(Customer customer)
ExportResponse	createExport(CreateExport createExport)
ProductResponse	createProduct(Product product)
SegmentResponse	createSegment(Segment segment)
SKUResponse	createSKU(java.lang.String productId, SKU sku)
ValidationRulesResponse	createValidationRules(ValidationRules validationRules)
VoucherResponse	createVoucher(CreateVoucher createVoucher)
VoucherResponse	createVoucher(java.lang.String code, CreateVoucher createVoucher)
java.lang.Void	deleteCampaign(java.lang.String campaignName, java.lang.Boolean force)
java.lang.Void	deleteCustomer(java.lang.String customerId)
java.lang.Void	deleteExport(java.lang.String id)
java.lang.Void	deleteProduct(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params)
java.lang.Void	deleteSegment(java.lang.String id)
java.lang.Void	deleteSKU(java.lang.String productId, java.lang.String skuId, java.util.Map<java.lang.String,java.lang.Object> params)
java.lang.Void	deleteValidationRules(java.lang.String id)
java.lang.Void	deleteVoucher(java.lang.String code, java.lang.Boolean force)
VoucherResponse	disable(java.lang.String code)
VoucherResponse	enable(java.lang.String code)
CampaignResponse	getCampaign(java.lang.String campaignName)
CustomerResponse	getCustomerById(java.lang.String customerId)
ExportResponse	getExport(java.lang.String id)
ProductResponse	getProduct(java.lang.String id)
ProductsResponse	getProducts(java.util.Map<java.lang.String,java.lang.Object> filter)
RedemptionEntryResponse	getRedemption(java.lang.String redemptionId)
SegmentResponse	getSegment(java.lang.String id)
SKUResponse	getSKU(java.lang.String productId, java.lang.String skuId)
SKUsResponse	getSKUs(java.lang.String productId)
ValidationRulesResponse	getValidationRules(java.lang.String id)
VoucherResponse	getVoucher(java.lang.String code)
VoucherRedemptionsResponse	getVoucherRedemptions(java.lang.String code)
java.lang.Void	importVouchers(ImportVouchers vouchers)
java.lang.Void	importVouchersToCampaign(java.lang.String campaignName, CampaignImportVouchers importVouchers)
CampaignsResponse	listCampaigns(java.util.Map<java.lang.String,java.lang.Object> filter)
RedemptionsResponse	listRedemptions(java.util.Map<java.lang.String,java.lang.Object> filter)
VouchersResponse	listVouchers(java.util.Map<java.lang.String,java.lang.Object> filter)
PublishVoucherResponse	publishVoucher(PublishVoucher publishVoucher)
RedeemVoucherResponse	redeem(java.lang.String code, RedeemVoucher redeemVoucher)
RollbackRedemptionResponse	rollbackRedemption(java.lang.String redemptionId, java.lang.String reason, RollbackRedemption rollbackRedemption)
CustomerResponse	updateCustomer(java.lang.String customerId, Customer customer)
ProductResponse	updateProduct(java.lang.String id, Product product)
SKUResponse	updateSKU(java.lang.String productId, java.lang.String skuId, SKU sku)
ValidationRulesResponse	updateValidationRules(java.lang.String id, ValidationRules validationRules)
VoucherResponse	updateVoucher(java.lang.String code, VoucherUpdate voucherUpdate)
VoucherValidationResponse	validateVoucher(java.lang.String code, VoucherValidation voucherValidation)

Method Detail

createCampaign

@POST(value="/campaigns")
CampaignResponse createCampaign(@Body
                                                          CreateCampaign createCampaign)

addVoucherToCampaign

@POST(value="/campaigns/{name}/vouchers")
AddVoucherToCampaignResponse addVoucherToCampaign(@Path(value="name")
                                                                                            java.lang.String campaignName,
                                                                                            @Body
                                                                                            AddVoucherToCampaign addVoucherToCampaign)

getCampaign

@GET(value="/campaigns/{name}")
CampaignResponse getCampaign(@Path(value="name")
                                                             java.lang.String campaignName)

listCampaigns

@GET(value="/campaigns")
CampaignsResponse listCampaigns(@QueryMap
                                                         java.util.Map<java.lang.String,java.lang.Object> filter)

addVoucherToCampaignWithCode

@POST(value="/campaigns/{name}/vouchers/{code}")
AddVoucherToCampaignResponse addVoucherToCampaignWithCode(@Path(value="name")
                                                                                                           java.lang.String campaignName,
                                                                                                           @Path(value="code")
                                                                                                           java.lang.String voucherCode,
                                                                                                           @Body
                                                                                                           AddVoucherToCampaign addVoucherToCampaign)

deleteCampaign

@DELETE(value="/campaigns/{name}")
java.lang.Void deleteCampaign(@Path(value="name")
                                                                 java.lang.String campaignName,
                                                                 @Query(value="force")
                                                                 java.lang.Boolean force)

importVouchersToCampaign

@POST(value="/campaigns/{name}/import")
java.lang.Void importVouchersToCampaign(@Path(value="name")
                                                                                java.lang.String campaignName,
                                                                                @Body
                                                                                CampaignImportVouchers importVouchers)

createCustomer

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

getCustomerById

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

updateCustomer

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

deleteCustomer

@DELETE(value="/customers/{id}")
java.lang.Void deleteCustomer(@Path(value="id")
                                                               java.lang.String customerId)

redeem

@POST(value="/vouchers/{code}/redemption")
RedeemVoucherResponse redeem(@Path(value="code")
                                                                        java.lang.String code,
                                                                        @Body
                                                                        RedeemVoucher redeemVoucher)

listRedemptions

@GET(value="/redemptions")
RedemptionsResponse listRedemptions(@QueryMap
                                                               java.util.Map<java.lang.String,java.lang.Object> filter)

getVoucherRedemptions

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

rollbackRedemption

@POST(value="/redemptions/{id}/rollback")
RollbackRedemptionResponse rollbackRedemption(@Path(value="id")
                                                                                        java.lang.String redemptionId,
                                                                                        @Query(value="reason")
                                                                                        java.lang.String reason,
                                                                                        @Body
                                                                                        RollbackRedemption rollbackRedemption)

getRedemption

@GET(value="/redemptions/{id}")
RedemptionEntryResponse getRedemption(@Path(value="id")
                                                                      java.lang.String redemptionId)

publishVoucher

@POST(value="/vouchers/publish")
PublishVoucherResponse publishVoucher(@Body
                                                                       PublishVoucher publishVoucher)

createExport

@POST(value="/exports")
ExportResponse createExport(@Body
                                                    CreateExport createExport)

getExport

@GET(value="/exports/{id}")
ExportResponse getExport(@Path(value="id")
                                                     java.lang.String id)

deleteExport

@DELETE(value="/exports/{id}")
java.lang.Void deleteExport(@Path(value="id")
                                                           java.lang.String id)

createVoucher

@POST(value="/vouchers")
VoucherResponse createVoucher(@Body
                                                       CreateVoucher createVoucher)

createVoucher

@POST(value="/vouchers/{code}")
VoucherResponse createVoucher(@Path(value="code")
                                                              java.lang.String code,
                                                              @Body
                                                              CreateVoucher createVoucher)

getVoucher

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

updateVoucher

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

deleteVoucher

@DELETE(value="/vouchers/{code}")
java.lang.Void deleteVoucher(@Path(value="code")
                                                               java.lang.String code,
                                                               @Query(value="force")
                                                               java.lang.Boolean force)

listVouchers

@GET(value="/vouchers")
VouchersResponse listVouchers(@QueryMap
                                                      java.util.Map<java.lang.String,java.lang.Object> filter)

enable

@POST(value="/vouchers/{code}/enable")
VoucherResponse enable(@Path(value="code")
                                                              java.lang.String code)

disable

@POST(value="/vouchers/{code}/disable")
VoucherResponse disable(@Path(value="code")
                                                                java.lang.String code)

addBalance

@POST(value="/vouchers/{code}/balance")
AddBalanceResponse addBalance(@Path(value="code")
                                                                      java.lang.String code,
                                                                      @Body
                                                                      AddBalance addBalance)

importVouchers

@POST(value="/vouchers/import")
java.lang.Void importVouchers(@Body
                                                              ImportVouchers vouchers)

validateVoucher

@POST(value="/vouchers/{code}/validate")
VoucherValidationResponse validateVoucher(@Path(value="code")
                                                                                   java.lang.String code,
                                                                                   @Body
                                                                                   VoucherValidation voucherValidation)

createProduct

@POST(value="/products")
ProductResponse createProduct(@Body
                                                       Product product)

getProduct

@GET(value="/products/{id}")
ProductResponse getProduct(@Path(value="id")
                                                        java.lang.String id)

updateProduct

@PUT(value="/products/{id}")
ProductResponse updateProduct(@Path(value="id")
                                                           java.lang.String id,
                                                           @Body
                                                           Product product)

getProducts

@GET(value="/products")
ProductsResponse getProducts(@QueryMap
                                                     java.util.Map<java.lang.String,java.lang.Object> filter)

deleteProduct

@DELETE(value="/products/{id}")
java.lang.Void deleteProduct(@Path(value="id")
                                                             java.lang.String id,
                                                             @QueryMap
                                                             java.util.Map<java.lang.String,java.lang.Object> params)

createSKU

@POST(value="/products/{id}/skus")
SKUResponse createSKU(@Path(value="id")
                                                         java.lang.String productId,
                                                         @Body
                                                         SKU sku)

getSKU

@GET(value="/products/{id}/skus/{skuId}")
SKUResponse getSKU(@Path(value="id")
                                                             java.lang.String productId,
                                                             @Path(value="skuId")
                                                             java.lang.String skuId)

updateSKU

@PUT(value="/products/{id}/skus/{skuId}")
SKUResponse updateSKU(@Path(value="id")
                                                                java.lang.String productId,
                                                                @Path(value="skuId")
                                                                java.lang.String skuId,
                                                                @Body
                                                                SKU sku)

getSKUs

@GET(value="/products/{id}/skus")
SKUsResponse getSKUs(@Path(value="id")
                                                       java.lang.String productId)

deleteSKU

@DELETE(value="/products/{id}/skus/{skuId}")
java.lang.Void deleteSKU(@Path(value="id")
                                                                      java.lang.String productId,
                                                                      @Path(value="skuId")
                                                                      java.lang.String skuId,
                                                                      @QueryMap
                                                                      java.util.Map<java.lang.String,java.lang.Object> params)

createSegment

@POST(value="/segments")
SegmentResponse createSegment(@Body
                                                       Segment segment)

getSegment

@GET(value="/segments/{id}")
SegmentResponse getSegment(@Path(value="id")
                                                        java.lang.String id)

deleteSegment

@DELETE(value="/segments/{id}")
java.lang.Void deleteSegment(@Path(value="id")
                                                             java.lang.String id)

createValidationRules

@POST(value="/validation-rules")
ValidationRulesResponse createValidationRules(@Body
                                                                               ValidationRules validationRules)

getValidationRules

@GET(value="/validation-rules/{id}")
ValidationRulesResponse getValidationRules(@Path(value="id")
                                                                                java.lang.String id)

updateValidationRules

@PUT(value="/validation-rules/{id}")
ValidationRulesResponse updateValidationRules(@Path(value="id")
                                                                                   java.lang.String id,
                                                                                   @Body
                                                                                   ValidationRules validationRules)

deleteValidationRules

@DELETE(value="/validation-rules/{id}")
java.lang.Void deleteValidationRules(@Path(value="id")
                                                                             java.lang.String id)