Constructor Detail

Method Detail

• withRawResponse

   abstract UserServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• feeds

   abstract FeedServiceAsync feeds()

• guides

   abstract GuideServiceAsync guides()

• bulk

   abstract BulkServiceAsync bulk()

• update

   CompletableFuture<User> update(String userId, UserUpdateParams 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.

• update

   CompletableFuture<User> update(String userId, UserUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<User> update(UserUpdateParams params)

• update

   abstract CompletableFuture<User> update(UserUpdateParams params, RequestOptions requestOptions)

• list

   CompletableFuture<UserListPageAsync> list()

  Retrieve a paginated list of users in the environment. Defaults to 50 users per page.

• list

   abstract CompletableFuture<UserListPageAsync> list(UserListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<UserListPageAsync> list(UserListParams params)

• list

   CompletableFuture<UserListPageAsync> list(RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(String userId)

  Permanently delete a user and all associated data.

• delete

   CompletableFuture<String> delete(String userId, UserDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(String userId, UserDeleteParams params)

• delete

   abstract CompletableFuture<String> delete(UserDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(UserDeleteParams params)

• delete

   CompletableFuture<String> delete(String userId, RequestOptions requestOptions)

• get

   CompletableFuture<User> get(String userId)

  Retrieve a specific user by their ID.

• get

   CompletableFuture<User> get(String userId, UserGetParams params, RequestOptions requestOptions)

• get

   CompletableFuture<User> get(String userId, UserGetParams params)

• get

   abstract CompletableFuture<User> get(UserGetParams params, RequestOptions requestOptions)

• get

   CompletableFuture<User> get(UserGetParams params)

• get

   CompletableFuture<User> get(String userId, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String userId, String channelId)

  Retrieves the channel data for a specific user and channel ID.

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String userId, String channelId, UserGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String userId, String channelId, UserGetChannelDataParams params)

• getChannelData

   abstract CompletableFuture<ChannelData> getChannelData(UserGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(UserGetChannelDataParams params)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String userId, String channelId, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String userId, String id)

  Retrieves a specific preference set for a user identified by the preference set ID.

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String userId, String id, UserGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String userId, String id, UserGetPreferencesParams params)

• getPreferences

   abstract CompletableFuture<PreferenceSet> getPreferences(UserGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(UserGetPreferencesParams params)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String userId, String id, RequestOptions requestOptions)

• listMessages

   CompletableFuture<UserListMessagesPageAsync> listMessages(String userId)

  Returns a paginated list of messages for a specific user. Allows filtering by message status and provides various sorting options. Messages outside the account's retention window will not be included in the results.

• listMessages

   CompletableFuture<UserListMessagesPageAsync> listMessages(String userId, UserListMessagesParams params, RequestOptions requestOptions)

• listMessages

   CompletableFuture<UserListMessagesPageAsync> listMessages(String userId, UserListMessagesParams params)

• listMessages

   abstract CompletableFuture<UserListMessagesPageAsync> listMessages(UserListMessagesParams params, RequestOptions requestOptions)

• listMessages

   CompletableFuture<UserListMessagesPageAsync> listMessages(UserListMessagesParams params)

• listMessages

   CompletableFuture<UserListMessagesPageAsync> listMessages(String userId, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String userId)

  Retrieves a list of all preference sets for a specific user.

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String userId, UserListPreferencesParams params, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String userId, UserListPreferencesParams params)

• listPreferences

   abstract CompletableFuture<List<PreferenceSet>> listPreferences(UserListPreferencesParams params, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(UserListPreferencesParams params)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String userId, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<UserListSchedulesPageAsync> listSchedules(String userId)

  Returns a paginated list of schedules for a specific user, in descending order.

• listSchedules

   CompletableFuture<UserListSchedulesPageAsync> listSchedules(String userId, UserListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<UserListSchedulesPageAsync> listSchedules(String userId, UserListSchedulesParams params)

• listSchedules

   abstract CompletableFuture<UserListSchedulesPageAsync> listSchedules(UserListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<UserListSchedulesPageAsync> listSchedules(UserListSchedulesParams params)

• listSchedules

   CompletableFuture<UserListSchedulesPageAsync> listSchedules(String userId, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(String userId)

  Retrieves a paginated list of subscriptions for a specific user, in descending order.

• listSubscriptions

   CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(String userId, UserListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(String userId, UserListSubscriptionsParams params)

• listSubscriptions

   abstract CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(UserListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(UserListSubscriptionsParams params)

• listSubscriptions

   CompletableFuture<UserListSubscriptionsPageAsync> listSubscriptions(String userId, RequestOptions requestOptions)

• merge

   CompletableFuture<User> merge(String userId, UserMergeParams params)

  Merge two users together, where the user specified with the from_user_id param will be merged into the user specified by user_id.

• merge

   CompletableFuture<User> merge(String userId, UserMergeParams params, RequestOptions requestOptions)

• merge

   CompletableFuture<User> merge(UserMergeParams params)

• merge

   abstract CompletableFuture<User> merge(UserMergeParams params, RequestOptions requestOptions)

• setChannelData

   CompletableFuture<ChannelData> setChannelData(String userId, String channelId, UserSetChannelDataParams params)

  Updates or creates channel data for a specific user and channel ID.

• setChannelData

   CompletableFuture<ChannelData> setChannelData(String userId, String channelId, UserSetChannelDataParams params, RequestOptions requestOptions)

• setChannelData

   CompletableFuture<ChannelData> setChannelData(UserSetChannelDataParams params)

• setChannelData

   abstract CompletableFuture<ChannelData> setChannelData(UserSetChannelDataParams params, RequestOptions requestOptions)

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(String userId, String id, UserSetPreferencesParams params)

  Updates a complete preference set for a user. This is a destructive operation that will replace the existing preference set for the user.

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(String userId, String id, UserSetPreferencesParams params, RequestOptions requestOptions)

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(UserSetPreferencesParams params)

• setPreferences

   abstract CompletableFuture<PreferenceSet> setPreferences(UserSetPreferencesParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String userId, String channelId)

  Deletes channel data for a specific user and channel ID.

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String userId, String channelId, UserUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String userId, String channelId, UserUnsetChannelDataParams params)

• unsetChannelData

   abstract CompletableFuture<String> unsetChannelData(UserUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(UserUnsetChannelDataParams params)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String userId, String channelId, RequestOptions requestOptions)