Constructor Detail

Method Detail

• withRawResponse

   abstract CampaignServiceAsync.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• participant

   abstract ParticipantServiceAsync participant()

• reward

   abstract RewardServiceAsync reward()

  Participant reward retrieval and manual reward operations.

• commission

   abstract CommissionServiceAsync commission()

  Affiliate transaction, commission, and payout operations.

• rewards

   abstract RewardsServiceAsync rewards()

  Campaign reward (CampaignReward) configuration operations.

• design

   abstract DesignServiceAsync design()

  Program Editor Design tab (CampaignDesign) configuration operations.

• emails

   abstract EmailsServiceAsync emails()

  Program Editor Emails tab (CampaignEmails) configuration operations.

• options

   abstract OptionsServiceAsync options()

  Program Editor Options tab (CampaignOptions) configuration operations.

• installation

   abstract InstallationServiceAsync installation()

  Program Editor Installation tab (CampaignInstallation) configuration operations.

• create

   CompletableFuture<Campaign> create(CampaignCreateParams params)

  Creates a new program pre-populated with type-appropriate defaults, plus any optional inline rewards. The new program is created in DRAFT status and owned by the API key's account. Requires a verified account email and a paid plan (referral) or a payment source on file (affiliate); subject to your plan's program limit.

• create

   abstract CompletableFuture<Campaign> create(CampaignCreateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Campaign> update(String id)

  Updates a program's configuration and/or status. Only the fields you send are changed. type and urlId are immutable. Status changes are validated against the allowed transitions; the program cannot be deleted via this endpoint.

• update

   CompletableFuture<Campaign> update(String id, CampaignUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Campaign> update(String id, CampaignUpdateParams params)

• update

   abstract CompletableFuture<Campaign> update(CampaignUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Campaign> update(CampaignUpdateParams params)

• update

   CompletableFuture<Campaign> update(String id, RequestOptions requestOptions)

• clone

   CompletableFuture<Campaign> clone(String id)

  Clones an existing program into a new DRAFT program. Integrations and credentials are not copied; active rewards are cloned.

• clone

   CompletableFuture<Campaign> clone(String id, CampaignCloneParams params, RequestOptions requestOptions)

• clone

   CompletableFuture<Campaign> clone(String id, CampaignCloneParams params)

• clone

   abstract CompletableFuture<Campaign> clone(CampaignCloneParams params, RequestOptions requestOptions)

• clone

   CompletableFuture<Campaign> clone(CampaignCloneParams params)

• clone

   CompletableFuture<Campaign> clone(String id, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Campaign> retrieve(String id)

  Retrieves a program for the given program ID.

• retrieve

   CompletableFuture<Campaign> retrieve(String id, CampaignRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Campaign> retrieve(String id, CampaignRetrieveParams params)

• retrieve

   abstract CompletableFuture<Campaign> retrieve(CampaignRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Campaign> retrieve(CampaignRetrieveParams params)

• retrieve

   CompletableFuture<Campaign> retrieve(String id, RequestOptions requestOptions)

• list

   CompletableFuture<CampaignListResponse> list()

  Retrieves a list of your programs. Deleted programs are not returned.

• list

   abstract CompletableFuture<CampaignListResponse> list(CampaignListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<CampaignListResponse> list(CampaignListParams params)

• list

   CompletableFuture<CampaignListResponse> list(RequestOptions requestOptions)

• createMobileParticipantToken

   CompletableFuture<CampaignCreateMobileParticipantTokenResponse> createMobileParticipantToken(String id, CampaignCreateMobileParticipantTokenParams params)

  Creates or returns a participant using the same input behavior as Add Participant, then returns a participant-scoped token for GrowSurf mobile SDK participant endpoints. Use this endpoint from your backend after your mobile app authenticates a signed-in user. The program must have mobile SDK access enabled.

• createMobileParticipantToken

   CompletableFuture<CampaignCreateMobileParticipantTokenResponse> createMobileParticipantToken(String id, CampaignCreateMobileParticipantTokenParams params, RequestOptions requestOptions)

• createMobileParticipantToken

   CompletableFuture<CampaignCreateMobileParticipantTokenResponse> createMobileParticipantToken(CampaignCreateMobileParticipantTokenParams params)

• createMobileParticipantToken

   abstract CompletableFuture<CampaignCreateMobileParticipantTokenResponse> createMobileParticipantToken(CampaignCreateMobileParticipantTokenParams params, RequestOptions requestOptions)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String id)

  Retrieves a paged list of all participant commissions in an affiliate program.

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String id, CampaignListCommissionsParams params, RequestOptions requestOptions)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String id, CampaignListCommissionsParams params)

• listCommissions

   abstract CompletableFuture<ParticipantCommissionList> listCommissions(CampaignListCommissionsParams params, RequestOptions requestOptions)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(CampaignListCommissionsParams params)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String id, RequestOptions requestOptions)

• listLeaderboard

   CompletableFuture<ParticipantList> listLeaderboard(String id)

  Retrieves participants in leaderboard order for the specified leaderboard type.

• listLeaderboard

   CompletableFuture<ParticipantList> listLeaderboard(String id, CampaignListLeaderboardParams params, RequestOptions requestOptions)

• listLeaderboard

   CompletableFuture<ParticipantList> listLeaderboard(String id, CampaignListLeaderboardParams params)

• listLeaderboard

   abstract CompletableFuture<ParticipantList> listLeaderboard(CampaignListLeaderboardParams params, RequestOptions requestOptions)

• listLeaderboard

   CompletableFuture<ParticipantList> listLeaderboard(CampaignListLeaderboardParams params)

• listLeaderboard

   CompletableFuture<ParticipantList> listLeaderboard(String id, RequestOptions requestOptions)

• listParticipants

   CompletableFuture<ParticipantList> listParticipants(String id)

  Retrieves a paged list of participants in a program.

• listParticipants

   CompletableFuture<ParticipantList> listParticipants(String id, CampaignListParticipantsParams params, RequestOptions requestOptions)

• listParticipants

   CompletableFuture<ParticipantList> listParticipants(String id, CampaignListParticipantsParams params)

• listParticipants

   abstract CompletableFuture<ParticipantList> listParticipants(CampaignListParticipantsParams params, RequestOptions requestOptions)

• listParticipants

   CompletableFuture<ParticipantList> listParticipants(CampaignListParticipantsParams params)

• listParticipants

   CompletableFuture<ParticipantList> listParticipants(String id, RequestOptions requestOptions)

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String id)

  Retrieves a paged list of all participant payouts in an affiliate program.

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String id, CampaignListPayoutsParams params, RequestOptions requestOptions)

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String id, CampaignListPayoutsParams params)

• listPayouts

   abstract CompletableFuture<ParticipantPayoutList> listPayouts(CampaignListPayoutsParams params, RequestOptions requestOptions)

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(CampaignListPayoutsParams params)

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String id, RequestOptions requestOptions)

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String id)

  Retrieves a list of all referrals and email invites made by participants in a program.

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String id, CampaignListReferralsParams params, RequestOptions requestOptions)

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String id, CampaignListReferralsParams params)

• listReferrals

   abstract CompletableFuture<ReferralList> listReferrals(CampaignListReferralsParams params, RequestOptions requestOptions)

• listReferrals

   CompletableFuture<ReferralList> listReferrals(CampaignListReferralsParams params)

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String id, RequestOptions requestOptions)

• retrieveAnalytics

   CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(String id)

  Retrieves analytics for a program.

• retrieveAnalytics

   CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(String id, CampaignRetrieveAnalyticsParams params, RequestOptions requestOptions)

• retrieveAnalytics

   CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(String id, CampaignRetrieveAnalyticsParams params)

• retrieveAnalytics

   abstract CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(CampaignRetrieveAnalyticsParams params, RequestOptions requestOptions)

• retrieveAnalytics

   CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(CampaignRetrieveAnalyticsParams params)

• retrieveAnalytics

   CompletableFuture<CampaignRetrieveAnalyticsResponse> retrieveAnalytics(String id, RequestOptions requestOptions)