All Implemented Interfaces:: com.growsurf.api.core.Params


public final class ParticipantListReferralsParams
 implements Params

Retrieves referrals and email invites made by a participant.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ParticipantListReferralsParams.Builder`	A builder for ParticipantListReferralsParams.
`public final class`	`ParticipantListReferralsParams.SortBy`	Field used to sort referral results.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`
`final Optional<String>`	`participantIdOrEmail()`
`final Optional<Boolean>`	`desc()`	Return results in descending order when true.
`final Optional<String>`	`email()`	URL-encoded email value to filter referral results.
`final Optional<String>`	`firstName()`	First name value to filter results.
`final Optional<String>`	`lastName()`	Last name value to filter results.
`final Optional<Long>`	`limit()`	Number of results to return.
`final Optional<String>`	`nextId()`	ID to start the next paged result set with.
`final Optional<Long>`	`offset()`	Offset number used to skip through a result set.
`final Optional<ReferralStatus>`	`referralStatus()`
`final Optional<ParticipantListReferralsParams.SortBy>`	`sortBy()`	Field used to sort referral results.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final ParticipantListReferralsParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ParticipantListReferralsParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ParticipantListReferralsParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
  - participantIdOrEmail
```
 final Optional<String> participantIdOrEmail()
```
  - desc
```
 final Optional<Boolean> desc()
```
    Return results in descending order when true.
  - email
```
 final Optional<String> email()
```
    URL-encoded email value to filter referral results.
  - firstName
```
 final Optional<String> firstName()
```
    First name value to filter results.
  - lastName
```
 final Optional<String> lastName()
```
    Last name value to filter results.
  - limit
```
 final Optional<Long> limit()
```
    Number of results to return. Maximum 100.
  - nextId
```
 final Optional<String> nextId()
```
    ID to start the next paged result set with.
  - offset
```
 final Optional<Long> offset()
```
    Offset number used to skip through a result set.
  - referralStatus
```
 final Optional<ReferralStatus> referralStatus()
```
  - sortBy
```
 final Optional<ParticipantListReferralsParams.SortBy> sortBy()
```
    Field used to sort referral results.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final ParticipantListReferralsParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ParticipantListReferralsParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ParticipantListReferralsParams.
    The following fields are required:
    .id()

Class ParticipantListReferralsParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

participantIdOrEmail

desc

email

firstName

lastName

limit

nextId

offset

referralStatus

sortBy

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder