Constructor Detail

Method Detail

• withRawResponse

   abstract RewardsServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract RewardsServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• create

   CompletableFuture<Reward> create(String id, RewardCreateParams params)

  Creates a new campaign reward (CampaignReward) with a GrowSurf-assigned ID. The reward type must be compatible with the program type (affiliate programs support only AFFILIATE rewards; referral programs support all other types). Enabling an active reward of a type automatically enables that reward type on the program.

• create

   CompletableFuture<Reward> create(String id, RewardCreateParams params, RequestOptions requestOptions)

• create

   CompletableFuture<Reward> create(RewardCreateParams params)

• create

   abstract CompletableFuture<Reward> create(RewardCreateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Reward> update(String campaignRewardId, RewardUpdateParams params)

  Updates an existing campaign reward (CampaignReward). The reward type is immutable and cannot be changed. When the update replaces metadata, renamed keys automatically rewrite any {{campaignReward[…]}} references in campaign copy; removing a key that campaign copy still references returns a 409 listing the referencing fields.

• update

   CompletableFuture<Reward> update(String campaignRewardId, RewardUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Reward> update(RewardUpdateParams params)

• update

   abstract CompletableFuture<Reward> update(RewardUpdateParams params, RequestOptions requestOptions)

• list

   CompletableFuture<CampaignRewardListResponse> list(String id)

  Retrieves the list of a program's configured rewards (CampaignRewards) — the same set embedded in the rewards array of the campaign response. Delete a reward with DELETE /campaign/{id}/reward-configs/{campaignRewardId}.

• list

   CompletableFuture<CampaignRewardListResponse> list(String id, RewardListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<CampaignRewardListResponse> list(String id, RewardListParams params)

• list

   abstract CompletableFuture<CampaignRewardListResponse> list(RewardListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<CampaignRewardListResponse> list(RewardListParams params)

• list

   CompletableFuture<CampaignRewardListResponse> list(String id, RequestOptions requestOptions)

• delete

   CompletableFuture<DeleteRewardResponse> delete(String campaignRewardId, RewardDeleteParams params)

  Deletes a campaign reward (CampaignReward). The reward is deactivated, removed from the program's reward set, and any connected upfront-discount coupons are cleaned up. If campaign copy still references any of the reward's metadata keys via {{campaignReward[…]}} tokens, the delete returns a 409 listing the referencing fields — update those fields first.

• delete

   CompletableFuture<DeleteRewardResponse> delete(String campaignRewardId, RewardDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<DeleteRewardResponse> delete(RewardDeleteParams params)

• delete

   abstract CompletableFuture<DeleteRewardResponse> delete(RewardDeleteParams params, RequestOptions requestOptions)