Constructor Detail

Method Detail

• withRawResponse

   abstract CampaignService.WithRawResponse withRawResponse()

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

• withOptions

   abstract CampaignService 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 ParticipantService participant()

• reward

   abstract RewardService reward()

  Participant reward retrieval and manual reward operations.

• commission

   abstract CommissionService commission()

  Affiliate transaction, commission, and payout operations.

• retrieve

   Campaign retrieve(String id)

  Retrieves a program for the given program ID.

• retrieve

   Campaign retrieve(String id, CampaignRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Campaign retrieve(String id, CampaignRetrieveParams params)

• retrieve

   abstract Campaign retrieve(CampaignRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Campaign retrieve(CampaignRetrieveParams params)

• retrieve

   Campaign retrieve(String id, RequestOptions requestOptions)

• list

   CampaignListResponse list()

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

• list

   abstract CampaignListResponse list(CampaignListParams params, RequestOptions requestOptions)

• list

   CampaignListResponse list(CampaignListParams params)

• list

   CampaignListResponse list(RequestOptions requestOptions)

• listCommissions

   ParticipantCommissionList listCommissions(String id)

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

• listCommissions

   ParticipantCommissionList listCommissions(String id, CampaignListCommissionsParams params, RequestOptions requestOptions)

• listCommissions

   ParticipantCommissionList listCommissions(String id, CampaignListCommissionsParams params)

• listCommissions

   abstract ParticipantCommissionList listCommissions(CampaignListCommissionsParams params, RequestOptions requestOptions)

• listCommissions

   ParticipantCommissionList listCommissions(CampaignListCommissionsParams params)

• listCommissions

   ParticipantCommissionList listCommissions(String id, RequestOptions requestOptions)

• listLeaderboard

   ParticipantList listLeaderboard(String id)

  Retrieves participants in leaderboard order for the specified leaderboard type.

• listLeaderboard

   ParticipantList listLeaderboard(String id, CampaignListLeaderboardParams params, RequestOptions requestOptions)

• listLeaderboard

   ParticipantList listLeaderboard(String id, CampaignListLeaderboardParams params)

• listLeaderboard

   abstract ParticipantList listLeaderboard(CampaignListLeaderboardParams params, RequestOptions requestOptions)

• listLeaderboard

   ParticipantList listLeaderboard(CampaignListLeaderboardParams params)

• listLeaderboard

   ParticipantList listLeaderboard(String id, RequestOptions requestOptions)

• listParticipants

   ParticipantList listParticipants(String id)

  Retrieves a paged list of participants in a program.

• listParticipants

   ParticipantList listParticipants(String id, CampaignListParticipantsParams params, RequestOptions requestOptions)

• listParticipants

   ParticipantList listParticipants(String id, CampaignListParticipantsParams params)

• listParticipants

   abstract ParticipantList listParticipants(CampaignListParticipantsParams params, RequestOptions requestOptions)

• listParticipants

   ParticipantList listParticipants(CampaignListParticipantsParams params)

• listParticipants

   ParticipantList listParticipants(String id, RequestOptions requestOptions)

• listPayouts

   ParticipantPayoutList listPayouts(String id)

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

• listPayouts

   ParticipantPayoutList listPayouts(String id, CampaignListPayoutsParams params, RequestOptions requestOptions)

• listPayouts

   ParticipantPayoutList listPayouts(String id, CampaignListPayoutsParams params)

• listPayouts

   abstract ParticipantPayoutList listPayouts(CampaignListPayoutsParams params, RequestOptions requestOptions)

• listPayouts

   ParticipantPayoutList listPayouts(CampaignListPayoutsParams params)

• listPayouts

   ParticipantPayoutList listPayouts(String id, RequestOptions requestOptions)

• listReferrals

   ReferralList listReferrals(String id)

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

• listReferrals

   ReferralList listReferrals(String id, CampaignListReferralsParams params, RequestOptions requestOptions)

• listReferrals

   ReferralList listReferrals(String id, CampaignListReferralsParams params)

• listReferrals

   abstract ReferralList listReferrals(CampaignListReferralsParams params, RequestOptions requestOptions)

• listReferrals

   ReferralList listReferrals(CampaignListReferralsParams params)

• listReferrals

   ReferralList listReferrals(String id, RequestOptions requestOptions)

• retrieveAnalytics

   CampaignRetrieveAnalyticsResponse retrieveAnalytics(String id)

  Retrieves analytics for a program.

• retrieveAnalytics

   CampaignRetrieveAnalyticsResponse retrieveAnalytics(String id, CampaignRetrieveAnalyticsParams params, RequestOptions requestOptions)

• retrieveAnalytics

   CampaignRetrieveAnalyticsResponse retrieveAnalytics(String id, CampaignRetrieveAnalyticsParams params)

• retrieveAnalytics

   abstract CampaignRetrieveAnalyticsResponse retrieveAnalytics(CampaignRetrieveAnalyticsParams params, RequestOptions requestOptions)

• retrieveAnalytics

   CampaignRetrieveAnalyticsResponse retrieveAnalytics(CampaignRetrieveAnalyticsParams params)

• retrieveAnalytics

   CampaignRetrieveAnalyticsResponse retrieveAnalytics(String id, RequestOptions requestOptions)