Constructor Detail

Method Detail

• withRawResponse

   abstract ParticipantServiceAsync.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• retrieve

   CompletableFuture<Participant> retrieve(String participantIdOrEmail, ParticipantRetrieveParams params)

  Retrieves a single participant by GrowSurf participant ID or email address.

• retrieve

   CompletableFuture<Participant> retrieve(String participantIdOrEmail, ParticipantRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Participant> retrieve(ParticipantRetrieveParams params)

• retrieve

   abstract CompletableFuture<Participant> retrieve(ParticipantRetrieveParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Participant> update(String participantIdOrEmail, ParticipantUpdateParams params)

  Updates a participant by GrowSurf participant ID or email address.

• update

   CompletableFuture<Participant> update(String participantIdOrEmail, ParticipantUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<Participant> update(ParticipantUpdateParams params)

• update

   abstract CompletableFuture<Participant> update(ParticipantUpdateParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<ParticipantDeleteResponse> delete(String participantIdOrEmail, ParticipantDeleteParams params)

  Removes a participant by GrowSurf participant ID or email address.

• delete

   CompletableFuture<ParticipantDeleteResponse> delete(String participantIdOrEmail, ParticipantDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<ParticipantDeleteResponse> delete(ParticipantDeleteParams params)

• delete

   abstract CompletableFuture<ParticipantDeleteResponse> delete(ParticipantDeleteParams params, RequestOptions requestOptions)

• add

   CompletableFuture<Participant> add(String id, ParticipantAddParams params)

  Adds a new participant to the program. If the email already exists, the existing participant is returned.

• add

   CompletableFuture<Participant> add(String id, ParticipantAddParams params, RequestOptions requestOptions)

• add

   CompletableFuture<Participant> add(ParticipantAddParams params)

• add

   abstract CompletableFuture<Participant> add(ParticipantAddParams params, RequestOptions requestOptions)

• createMobileToken

   CompletableFuture<ParticipantCreateMobileTokenResponse> createMobileToken(String participantIdOrEmail, ParticipantCreateMobileTokenParams params)

  Creates a participant-scoped token for GrowSurf mobile SDK participant endpoints. The program must have mobile SDK access enabled.

• createMobileToken

   CompletableFuture<ParticipantCreateMobileTokenResponse> createMobileToken(String participantIdOrEmail, ParticipantCreateMobileTokenParams params, RequestOptions requestOptions)

• createMobileToken

   CompletableFuture<ParticipantCreateMobileTokenResponse> createMobileToken(ParticipantCreateMobileTokenParams params)

• createMobileToken

   abstract CompletableFuture<ParticipantCreateMobileTokenResponse> createMobileToken(ParticipantCreateMobileTokenParams params, RequestOptions requestOptions)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String participantIdOrEmail, ParticipantListCommissionsParams params)

  Retrieves a paged list of commissions earned by a participant.

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(String participantIdOrEmail, ParticipantListCommissionsParams params, RequestOptions requestOptions)

• listCommissions

   CompletableFuture<ParticipantCommissionList> listCommissions(ParticipantListCommissionsParams params)

• listCommissions

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

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String participantIdOrEmail, ParticipantListPayoutsParams params)

  Retrieves a paged list of payouts that belong to a participant.

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(String participantIdOrEmail, ParticipantListPayoutsParams params, RequestOptions requestOptions)

• listPayouts

   CompletableFuture<ParticipantPayoutList> listPayouts(ParticipantListPayoutsParams params)

• listPayouts

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

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String participantIdOrEmail, ParticipantListReferralsParams params)

  Retrieves referrals and email invites made by a participant.

• listReferrals

   CompletableFuture<ReferralList> listReferrals(String participantIdOrEmail, ParticipantListReferralsParams params, RequestOptions requestOptions)

• listReferrals

   CompletableFuture<ReferralList> listReferrals(ParticipantListReferralsParams params)

• listReferrals

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

• listRewards

   CompletableFuture<ParticipantListRewardsResponse> listRewards(String participantIdOrEmail, ParticipantListRewardsParams params)

  Retrieves a paged list of rewards earned by a participant.

• listRewards

   CompletableFuture<ParticipantListRewardsResponse> listRewards(String participantIdOrEmail, ParticipantListRewardsParams params, RequestOptions requestOptions)

• listRewards

   CompletableFuture<ParticipantListRewardsResponse> listRewards(ParticipantListRewardsParams params)

• listRewards

   abstract CompletableFuture<ParticipantListRewardsResponse> listRewards(ParticipantListRewardsParams params, RequestOptions requestOptions)

• recordTransaction

   CompletableFuture<ParticipantRecordTransactionResponse> recordTransaction(String participantIdOrEmail, ParticipantRecordTransactionParams params)

  Records a sale made by a referred customer and generates affiliate commissions for their referrer when applicable.

• recordTransaction

   CompletableFuture<ParticipantRecordTransactionResponse> recordTransaction(String participantIdOrEmail, ParticipantRecordTransactionParams params, RequestOptions requestOptions)

• recordTransaction

   CompletableFuture<ParticipantRecordTransactionResponse> recordTransaction(ParticipantRecordTransactionParams params)

• recordTransaction

   abstract CompletableFuture<ParticipantRecordTransactionResponse> recordTransaction(ParticipantRecordTransactionParams params, RequestOptions requestOptions)

• sendInvites

   CompletableFuture<ParticipantSendInvitesResponse> sendInvites(String participantIdOrEmail, ParticipantSendInvitesParams params)

  Sends email invites on behalf of a participant to a list of email addresses.

• sendInvites

   CompletableFuture<ParticipantSendInvitesResponse> sendInvites(String participantIdOrEmail, ParticipantSendInvitesParams params, RequestOptions requestOptions)

• sendInvites

   CompletableFuture<ParticipantSendInvitesResponse> sendInvites(ParticipantSendInvitesParams params)

• sendInvites

   abstract CompletableFuture<ParticipantSendInvitesResponse> sendInvites(ParticipantSendInvitesParams params, RequestOptions requestOptions)

• triggerReferral

   CompletableFuture<ParticipantTriggerReferralResponse> triggerReferral(String participantIdOrEmail, ParticipantTriggerReferralParams params)

  Triggers referral credit for an existing referred participant by GrowSurf participant ID or email address.

• triggerReferral

   CompletableFuture<ParticipantTriggerReferralResponse> triggerReferral(String participantIdOrEmail, ParticipantTriggerReferralParams params, RequestOptions requestOptions)

• triggerReferral

   CompletableFuture<ParticipantTriggerReferralResponse> triggerReferral(ParticipantTriggerReferralParams params)

• triggerReferral

   abstract CompletableFuture<ParticipantTriggerReferralResponse> triggerReferral(ParticipantTriggerReferralParams params, RequestOptions requestOptions)