Interface ProfileService
-
- All Implemented Interfaces:
public interface ProfileService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceProfileService.WithRawResponseA view of ProfileService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract ProfileService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract ProfileService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
lists
abstract ListService lists()
-
create
ProfileCreateResponse create(String userId, ProfileCreateParams params)
Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
-
create
ProfileCreateResponse create(String userId, ProfileCreateParams params, RequestOptions requestOptions)
-
create
ProfileCreateResponse create(ProfileCreateParams params)
-
create
abstract ProfileCreateResponse create(ProfileCreateParams params, RequestOptions requestOptions)
-
retrieve
ProfileRetrieveResponse retrieve(String userId)
Returns the specified user profile.
-
retrieve
ProfileRetrieveResponse retrieve(String userId, ProfileRetrieveParams params, RequestOptions requestOptions)
-
retrieve
ProfileRetrieveResponse retrieve(String userId, ProfileRetrieveParams params)
-
retrieve
abstract ProfileRetrieveResponse retrieve(ProfileRetrieveParams params, RequestOptions requestOptions)
-
retrieve
ProfileRetrieveResponse retrieve(ProfileRetrieveParams params)
-
retrieve
ProfileRetrieveResponse retrieve(String userId, RequestOptions requestOptions)
-
update
Unit update(String userId, ProfileUpdateParams params)
Update a profile
-
update
Unit update(String userId, ProfileUpdateParams params, RequestOptions requestOptions)
-
update
Unit update(ProfileUpdateParams params)
-
update
abstract Unit update(ProfileUpdateParams params, RequestOptions requestOptions)
-
delete
Unit delete(String userId, ProfileDeleteParams params, RequestOptions requestOptions)
-
delete
Unit delete(String userId, ProfileDeleteParams params)
-
delete
abstract Unit delete(ProfileDeleteParams params, RequestOptions requestOptions)
-
delete
Unit delete(ProfileDeleteParams params)
-
delete
Unit delete(String userId, RequestOptions requestOptions)
-
replace
ProfileReplaceResponse replace(String userId, ProfileReplaceParams params)
When using
PUT, be sure to include all the key-value pairs required by the recipient's profile. Any key-value pairs that exist in the profile but fail to be included in thePUTrequest will be removed from the profile. Remember, aPUTupdate is a full replacement of the data. For partial updates, use the Patch request.
-
replace
ProfileReplaceResponse replace(String userId, ProfileReplaceParams params, RequestOptions requestOptions)
-
replace
ProfileReplaceResponse replace(ProfileReplaceParams params)
-
replace
abstract ProfileReplaceResponse replace(ProfileReplaceParams params, RequestOptions requestOptions)
-
-
-
-