Class ParticipantUpdateParams
-
- All Implemented Interfaces:
-
com.growsurf.api.core.Params
public final class ParticipantUpdateParams implements Params
Updates a participant by GrowSurf participant ID or email address.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classParticipantUpdateParams.BuilderA builder for ParticipantUpdateParams.
public final classParticipantUpdateParams.Bodypublic final classParticipantUpdateParams.MetadataShallow custom metadata object.
public final classParticipantUpdateParams.ReferralStatus
-
Method Summary
Modifier and Type Method Description final Stringid()final Optional<String>participantIdOrEmail()final Optional<String>email()final Optional<String>firstName()final Optional<String>lastName()final Optional<ParticipantUpdateParams.Metadata>metadata()Shallow custom metadata object. final Optional<ParticipantUpdateParams.ReferralStatus>referralStatus()final Optional<String>referredBy()final Optional<Boolean>unsubscribed()final Optional<List<String>>vanityKeys()final JsonField<String>_email()Returns the raw JSON value of email. final JsonField<String>_firstName()Returns the raw JSON value of firstName. final JsonField<String>_lastName()Returns the raw JSON value of lastName. final JsonField<ParticipantUpdateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<ParticipantUpdateParams.ReferralStatus>_referralStatus()Returns the raw JSON value of referralStatus. final JsonField<String>_referredBy()Returns the raw JSON value of referredBy. final JsonField<Boolean>_unsubscribed()Returns the raw JSON value of unsubscribed. final JsonField<List<String>>_vanityKeys()Returns the raw JSON value of vanityKeys. 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 ParticipantUpdateParams.BuildertoBuilder()final ParticipantUpdateParams.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 ParticipantUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ParticipantUpdateParams. -
-
Method Detail
-
participantIdOrEmail
final Optional<String> participantIdOrEmail()
-
metadata
final Optional<ParticipantUpdateParams.Metadata> metadata()
Shallow custom metadata object.
-
referralStatus
final Optional<ParticipantUpdateParams.ReferralStatus> referralStatus()
-
referredBy
final Optional<String> referredBy()
-
unsubscribed
final Optional<Boolean> unsubscribed()
-
vanityKeys
final Optional<List<String>> vanityKeys()
-
_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.
-
_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.
-
_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<ParticipantUpdateParams.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<ParticipantUpdateParams.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.
-
_unsubscribed
final JsonField<Boolean> _unsubscribed()
Returns the raw JSON value of unsubscribed.
Unlike unsubscribed, this method doesn't throw if the JSON field has an unexpected type.
-
_vanityKeys
final JsonField<List<String>> _vanityKeys()
Returns the raw JSON value of vanityKeys.
Unlike vanityKeys, 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 ParticipantUpdateParams.Builder toBuilder()
-
_body
final ParticipantUpdateParams.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 ParticipantUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of ParticipantUpdateParams.
The following fields are required:
.id()
-
-
-
-