Interface RewardsService
-
- All Implemented Interfaces:
public interface RewardsServiceProgram reward (
CampaignReward) configuration operations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceRewardsService.WithRawResponseA view of RewardsService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract RewardsService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract RewardsService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
Reward create(String id, RewardCreateParams params)
Creates a new program reward (
CampaignReward) with a server-generated ID. The reward type must be compatible with the program type (affiliate programs support onlyAFFILIATErewards; referral programs support all other types). Enabling an active reward of a type automatically enables that reward type on the program.
-
create
Reward create(String id, RewardCreateParams params, RequestOptions requestOptions)
-
create
Reward create(RewardCreateParams params)
-
create
abstract Reward create(RewardCreateParams params, RequestOptions requestOptions)
-
update
Reward update(String rewardId, RewardUpdateParams params)
Updates an existing program reward (
CampaignReward). The rewardtypeis immutable and cannot be changed.
-
update
Reward update(String rewardId, RewardUpdateParams params, RequestOptions requestOptions)
-
update
Reward update(RewardUpdateParams params)
-
update
abstract Reward update(RewardUpdateParams params, RequestOptions requestOptions)
-
list
CampaignRewardListResponse list(String id)
Retrieves the list of a program's configured rewards (
CampaignRewards). Returns the active, visible, and enabled rewards — the same set embedded in therewardsarray of the campaign response.
-
list
CampaignRewardListResponse list(String id, RewardListParams params, RequestOptions requestOptions)
-
list
CampaignRewardListResponse list(String id, RewardListParams params)
-
list
abstract CampaignRewardListResponse list(RewardListParams params, RequestOptions requestOptions)
-
list
CampaignRewardListResponse list(RewardListParams params)
-
list
CampaignRewardListResponse list(String id, RequestOptions requestOptions)
-
delete
DeleteRewardResponse delete(String rewardId, RewardDeleteParams params)
Deletes a program reward (
CampaignReward). The reward is deactivated, removed from the program's reward set, and any connected upfront-discount coupons are cleaned up.
-
delete
DeleteRewardResponse delete(String rewardId, RewardDeleteParams params, RequestOptions requestOptions)
-
delete
DeleteRewardResponse delete(RewardDeleteParams params)
-
delete
abstract DeleteRewardResponse delete(RewardDeleteParams params, RequestOptions requestOptions)
-
-
-
-