Interface OptionsService
-
- All Implemented Interfaces:
public interface OptionsServiceProgram Editor Options tab (
CampaignOptions) configuration operations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceOptionsService.WithRawResponseA view of OptionsService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract OptionsService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract OptionsService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
retrieve
CampaignOptions retrieve(String id)
Retrieves a program's options — the same surface as the dashboard Program Editor's Options tab. Includes reward/fraud approval, anti-fraud lists + toggles, referral cookie/credit windows, reCAPTCHA, payout threshold + tax settings (affiliate only), and notification-email settings.
fraud.recaptcha.secretKeyis never returned.
-
retrieve
CampaignOptions retrieve(String id, OptionRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CampaignOptions retrieve(String id, OptionRetrieveParams params)
-
retrieve
abstract CampaignOptions retrieve(OptionRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CampaignOptions retrieve(OptionRetrieveParams params)
-
retrieve
CampaignOptions retrieve(String id, RequestOptions requestOptions)
-
update
CampaignOptions update(String id, OptionUpdateParams params)
Updates a program's options. Only the fields you send are changed. Some fields are program-type specific (
requireManualRewardApproval/autoFulfillRewardsare referral-only;payoutThreshold/taxDocumentationare affiliate-only, and affiliate programs requirerequireParticipantAuth: true).fraud.recaptcha.secretKeyis write-only.referralCreditWindowDays: nullmeans "never expires".
-
update
CampaignOptions update(String id, OptionUpdateParams params, RequestOptions requestOptions)
-
update
CampaignOptions update(String id)
-
update
CampaignOptions update(OptionUpdateParams params)
-
update
abstract CampaignOptions update(OptionUpdateParams params, RequestOptions requestOptions)
-
update
CampaignOptions update(String id, RequestOptions requestOptions)
-
-
-
-