Class UserUpdateParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class UserUpdateParams implements Params
Create or update a user with the provided identification data. When you identify an existing user, the system merges the properties you specific with what is currently set on the user, updating only the fields included in your requests.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUserUpdateParams.BuilderA builder for UserUpdateParams.
-
Method Summary
Modifier and Type Method Description final Optional<String>userId()final IdentifyUserRequestidentifyUserRequest()A set of parameters to identify a user with. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final UserUpdateParams.BuildertoBuilder()final IdentifyUserRequest_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 UserUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of UserUpdateParams. -
-
Method Detail
-
identifyUserRequest
final IdentifyUserRequest identifyUserRequest()
A set of parameters to identify a user with. Does not include the user ID, as that's specified elsewhere in the request. You can supply any additional properties you'd like to upsert for the user.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final UserUpdateParams.Builder toBuilder()
-
_body
final IdentifyUserRequest _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 UserUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of UserUpdateParams.
The following fields are required:
.identifyUserRequest()
-
-
-
-