Class ParticipantAddParams
-
- All Implemented Interfaces:
-
com.growsurf.api.core.Params
public final class ParticipantAddParams implements Params
Adds a new participant to the program. If the email already exists, the existing participant is returned.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classParticipantAddParams.BuilderA builder for ParticipantAddParams.
public final classParticipantAddParams.Bodypublic final classParticipantAddParams.MetadataShallow custom metadata object.
public final classParticipantAddParams.ReferralStatus
-
Method Summary
Modifier and Type Method Description final Optional<String>id()final Stringemail()final Optional<String>fingerprint()final Optional<String>firstName()final Optional<String>ipAddress()final Optional<String>lastName()final Optional<ParticipantAddParams.Metadata>metadata()Shallow custom metadata object. final Optional<ParticipantAddParams.ReferralStatus>referralStatus()final Optional<String>referredBy()Referrer participant ID or email address. final JsonField<String>_email()Returns the raw JSON value of email. final JsonField<String>_fingerprint()Returns the raw JSON value of fingerprint. final JsonField<String>_firstName()Returns the raw JSON value of firstName. final JsonField<String>_ipAddress()Returns the raw JSON value of ipAddress. final JsonField<String>_lastName()Returns the raw JSON value of lastName. final JsonField<ParticipantAddParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<ParticipantAddParams.ReferralStatus>_referralStatus()Returns the raw JSON value of referralStatus. final JsonField<String>_referredBy()Returns the raw JSON value of referredBy. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final ParticipantAddParams.BuildertoBuilder()final ParticipantAddParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ParticipantAddParams.Builderbuilder()Returns a mutable builder for constructing an instance of ParticipantAddParams. -
-
Method Detail
-
fingerprint
final Optional<String> fingerprint()
-
metadata
final Optional<ParticipantAddParams.Metadata> metadata()
Shallow custom metadata object.
-
referralStatus
final Optional<ParticipantAddParams.ReferralStatus> referralStatus()
-
referredBy
final Optional<String> referredBy()
Referrer participant ID or email address.
-
_email
final JsonField<String> _email()
Returns the raw JSON value of email.
Unlike email, this method doesn't throw if the JSON field has an unexpected type.
-
_fingerprint
final JsonField<String> _fingerprint()
Returns the raw JSON value of fingerprint.
Unlike fingerprint, this method doesn't throw if the JSON field has an unexpected type.
-
_firstName
final JsonField<String> _firstName()
Returns the raw JSON value of firstName.
Unlike firstName, this method doesn't throw if the JSON field has an unexpected type.
-
_ipAddress
final JsonField<String> _ipAddress()
Returns the raw JSON value of ipAddress.
Unlike ipAddress, this method doesn't throw if the JSON field has an unexpected type.
-
_lastName
final JsonField<String> _lastName()
Returns the raw JSON value of lastName.
Unlike lastName, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<ParticipantAddParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_referralStatus
final JsonField<ParticipantAddParams.ReferralStatus> _referralStatus()
Returns the raw JSON value of referralStatus.
Unlike referralStatus, this method doesn't throw if the JSON field has an unexpected type.
-
_referredBy
final JsonField<String> _referredBy()
Returns the raw JSON value of referredBy.
Unlike referredBy, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_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 ParticipantAddParams.Builder toBuilder()
-
_body
final ParticipantAddParams.Body _body()
-
_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.
-
builder
final static ParticipantAddParams.Builder builder()
Returns a mutable builder for constructing an instance of ParticipantAddParams.
The following fields are required:
.email()
-
-
-
-