Package io.voucherify.client.api

Interface VoucherifyApi

public interface VoucherifyApi

Method Summary

Modifier and Type	Method	Description
AddBalanceResponse	addBalance(java.lang.String code, AddBalance addBalance)
TierResponse	addPromotionTier(java.lang.String id, Tier tier)
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)
CustomEventResponse	createCustomEvent(CustomEvent event)
ExportResponse	createExport(CreateExport createExport)
CreateOrderResponse	createOrder(CreateOrder createOrder)
ProductResponse	createProduct(Product product)
CreatePromotionCampaignResponse	createPromotionCampaign(CreatePromotionCampaign createPromotionCampaign)
SegmentResponse	createSegment(Segment segment)
SKUResponse	createSKU(java.lang.String productId, SKU sku)
BusinessValidationRuleAssignment	createValidationRuleAssignment(java.lang.String id, CreateBusinessValidationRuleAssignment assignment)
BusinessValidationRule	createValidationRules(CreateBusinessValidationRule validationRule)
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	deletePromotionTier(java.lang.String id)
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	deleteValidationRuleAssignment(java.lang.String validationRuleId, java.lang.String assignmentId)
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)
GetOrderResponse	getOrder(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)
BusinessValidationRule	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)
ListPublicationsResponse	list(java.util.Map<java.lang.String,java.lang.Object> filter)
CampaignsResponse	listCampaigns(java.util.Map<java.lang.String,java.lang.Object> filter)
CustomersResponse	listCustomers(java.util.Map<java.lang.String,java.lang.Object> filter)
ListOrdersResponse	listOrders(java.util.Map<java.lang.String,java.lang.Object> filter)
ListPromotionTiersResponse	listPromotionTiers(java.lang.String id)
RedemptionsResponse	listRedemptions(java.util.Map<java.lang.String,java.lang.Object> filter)
BusinessValidationRuleAssignmentList	listValidationRuleAssignments(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> filter)
BusinessValidationRuleList	listValidationRules(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)
RedeemPromotionResponse	redeem(java.lang.String id, RedeemPromotion redeemPromotion)
RedeemVoucherResponse	redeem(java.lang.String code, RedeemVoucher redeemVoucher)
RollbackRedemptionResponse	rollbackRedemption(java.lang.String redemptionId, java.lang.String reason, RollbackRedemption rollbackRedemption)
CampaignResponse	updateCampaign(java.lang.String campaignName, UpdateCampaign updateCampaign)
CustomerResponse	updateCustomer(java.lang.String customerId, Customer customer)
GetOrderResponse	updateOrder(java.lang.String id, UpdateOrder updateOrder)
ProductResponse	updateProduct(java.lang.String id, Product product)
TierResponse	updatePromotionTier(java.lang.String id, Tier tier)
SKUResponse	updateSKU(java.lang.String productId, java.lang.String skuId, SKU sku)
BusinessValidationRule	updateValidationRules(java.lang.String id, UpdateBusinessValidationRule validationRule)
VoucherResponse	updateVoucher(java.lang.String code, VoucherUpdate voucherUpdate)
PromotionValidationResponse	validatePromotion(PromotionValidation promotionValidation)
VoucherValidationResponse	validateVoucher(java.lang.String code, VoucherValidation voucherValidation)

Method Detail

createCampaign

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

addVoucherToCampaign

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

getCampaign

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

listCampaigns

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

updateCampaign

@PUT("/campaigns/{name}")
CampaignResponse updateCampaign(@Path("name")
                                java.lang.String campaignName,
                                @Body
                                UpdateCampaign updateCampaign)

addVoucherToCampaignWithCode

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

deleteCampaign

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

importVouchersToCampaign

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

createCustomer

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

getCustomerById

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

updateCustomer

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

deleteCustomer

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

listCustomers

@GET("/customers")
CustomersResponse listCustomers(@QueryMap
                                java.util.Map<java.lang.String,java.lang.Object> filter)

redeem

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

redeem

@POST("/promotions/tiers/{id}/redemption")
RedeemPromotionResponse redeem(@Path("id")
                               java.lang.String id,
                               @Body
                               RedeemPromotion redeemPromotion)

listRedemptions

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

getVoucherRedemptions

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

rollbackRedemption

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

getRedemption

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

publishVoucher

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

createExport

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

getExport

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

deleteExport

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

list

@GET("/publications")
ListPublicationsResponse list(@QueryMap
                              java.util.Map<java.lang.String,java.lang.Object> filter)

createVoucher

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

createVoucher

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

getVoucher

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

updateVoucher

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

deleteVoucher

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

listVouchers

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

enable

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

disable

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

addBalance

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

importVouchers

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

validateVoucher

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

validatePromotion

@POST("/promotions/validation")
PromotionValidationResponse validatePromotion(@Body
                                              PromotionValidation promotionValidation)

createProduct

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

getProduct

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

updateProduct

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

getProducts

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

deleteProduct

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

createSKU

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

getSKU

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

updateSKU

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

getSKUs

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

deleteSKU

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

createSegment

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

getSegment

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

deleteSegment

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

createValidationRules

@POST("/validation-rules")
BusinessValidationRule createValidationRules(@Body
                                             CreateBusinessValidationRule validationRule)

getValidationRules

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

listValidationRules

@GET("/validation-rules")
BusinessValidationRuleList listValidationRules(@QueryMap
                                               java.util.Map<java.lang.String,java.lang.Object> filter)

updateValidationRules

@PUT("/validation-rules/{id}")
BusinessValidationRule updateValidationRules(@Path("id")
                                             java.lang.String id,
                                             @Body
                                             UpdateBusinessValidationRule validationRule)

deleteValidationRules

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

createValidationRuleAssignment

@POST("/validation-rules/{id}/assignments")
BusinessValidationRuleAssignment createValidationRuleAssignment(@Path("id")
                                                                java.lang.String id,
                                                                @Body
                                                                CreateBusinessValidationRuleAssignment assignment)

deleteValidationRuleAssignment

@DELETE("/validation-rules/{validationRuleId}/assignments/{assignmentId}")
java.lang.Void deleteValidationRuleAssignment(@Path("validationRuleId")
                                              java.lang.String validationRuleId,
                                              @Path("assignmentId")
                                              java.lang.String assignmentId)

listValidationRuleAssignments

@GET("/validation-rules/{id}/assignments")
BusinessValidationRuleAssignmentList listValidationRuleAssignments(@Path("id")
                                                                   java.lang.String id,
                                                                   @QueryMap
                                                                   java.util.Map<java.lang.String,java.lang.Object> filter)

createPromotionCampaign

@POST("/campaigns")
CreatePromotionCampaignResponse createPromotionCampaign(@Body
                                                        CreatePromotionCampaign createPromotionCampaign)

listPromotionTiers

@GET("/promotions/{id}/tiers")
ListPromotionTiersResponse listPromotionTiers(@Path("id")
                                              java.lang.String id)

addPromotionTier

@POST("/promotions/{id}/tiers")
TierResponse addPromotionTier(@Path("id")
                              java.lang.String id,
                              @Body
                              Tier tier)

updatePromotionTier

@PUT("/promotions/tiers/{id}")
TierResponse updatePromotionTier(@Path("id")
                                 java.lang.String id,
                                 @Body
                                 Tier tier)

deletePromotionTier

@DELETE("/promotions/tiers/{id}")
java.lang.Void deletePromotionTier(@Path("id")
                                   java.lang.String id)

createOrder

@POST("/orders")
CreateOrderResponse createOrder(@Body
                                CreateOrder createOrder)

getOrder

@GET("/orders/{id}")
GetOrderResponse getOrder(@Path("id")
                          java.lang.String id)

updateOrder

@PUT("/orders/{id}")
GetOrderResponse updateOrder(@Path("id")
                             java.lang.String id,
                             @Body
                             UpdateOrder updateOrder)

listOrders

@GET("/orders")
ListOrdersResponse listOrders(@QueryMap
                              java.util.Map<java.lang.String,java.lang.Object> filter)

createCustomEvent

@POST("/events")
CustomEventResponse createCustomEvent(@Body
                                      CustomEvent event)