Constructor Detail

Method Detail

• withRawResponse

   abstract UserService.WithRawResponse withRawResponse()

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

• feeds

   abstract FeedService feeds()

• guides

   abstract GuideService guides()

• bulk

   abstract BulkService bulk()

• update

   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

   User update(String userId, UserUpdateParams params, RequestOptions requestOptions)

• update

   User update(UserUpdateParams params)

• update

   abstract User update(UserUpdateParams params, RequestOptions requestOptions)

• list

   UserListPage list()

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

• list

   abstract UserListPage list(UserListParams params, RequestOptions requestOptions)

• list

   UserListPage list(UserListParams params)

• list

   UserListPage list(RequestOptions requestOptions)

• delete

   String delete(String userId)

  Permanently delete a user and all associated data.

• delete

   String delete(String userId, UserDeleteParams params, RequestOptions requestOptions)

• delete

   String delete(String userId, UserDeleteParams params)

• delete

   abstract String delete(UserDeleteParams params, RequestOptions requestOptions)

• delete

   String delete(UserDeleteParams params)

• delete

   String delete(String userId, RequestOptions requestOptions)

• get

   User get(String userId)

  Retrieve a specific user by their ID.

• get

   User get(String userId, UserGetParams params, RequestOptions requestOptions)

• get

   User get(String userId, UserGetParams params)

• get

   abstract User get(UserGetParams params, RequestOptions requestOptions)

• get

   User get(UserGetParams params)

• get

   User get(String userId, RequestOptions requestOptions)

• getChannelData

   ChannelData getChannelData(String userId, String channelId)

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

• getChannelData

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

• getChannelData

   ChannelData getChannelData(String userId, String channelId, UserGetChannelDataParams params)

• getChannelData

   abstract ChannelData getChannelData(UserGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   ChannelData getChannelData(UserGetChannelDataParams params)

• getChannelData

   ChannelData getChannelData(String userId, String channelId, RequestOptions requestOptions)

• getPreferences

   PreferenceSet getPreferences(String userId, String id)

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

• getPreferences

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

• getPreferences

   PreferenceSet getPreferences(String userId, String id, UserGetPreferencesParams params)

• getPreferences

   abstract PreferenceSet getPreferences(UserGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   PreferenceSet getPreferences(UserGetPreferencesParams params)

• getPreferences

   PreferenceSet getPreferences(String userId, String id, RequestOptions requestOptions)

• listMessages

   UserListMessagesPage 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

   UserListMessagesPage listMessages(String userId, UserListMessagesParams params, RequestOptions requestOptions)

• listMessages

   UserListMessagesPage listMessages(String userId, UserListMessagesParams params)

• listMessages

   abstract UserListMessagesPage listMessages(UserListMessagesParams params, RequestOptions requestOptions)

• listMessages

   UserListMessagesPage listMessages(UserListMessagesParams params)

• listMessages

   UserListMessagesPage listMessages(String userId, RequestOptions requestOptions)

• listPreferences

   List<PreferenceSet> listPreferences(String userId)

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

• listPreferences

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

• listPreferences

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

• listPreferences

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

• listPreferences

   List<PreferenceSet> listPreferences(UserListPreferencesParams params)

• listPreferences

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

• listSchedules

   UserListSchedulesPage listSchedules(String userId)

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

• listSchedules

   UserListSchedulesPage listSchedules(String userId, UserListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   UserListSchedulesPage listSchedules(String userId, UserListSchedulesParams params)

• listSchedules

   abstract UserListSchedulesPage listSchedules(UserListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   UserListSchedulesPage listSchedules(UserListSchedulesParams params)

• listSchedules

   UserListSchedulesPage listSchedules(String userId, RequestOptions requestOptions)

• listSubscriptions

   UserListSubscriptionsPage listSubscriptions(String userId)

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

• listSubscriptions

   UserListSubscriptionsPage listSubscriptions(String userId, UserListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   UserListSubscriptionsPage listSubscriptions(String userId, UserListSubscriptionsParams params)

• listSubscriptions

   abstract UserListSubscriptionsPage listSubscriptions(UserListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   UserListSubscriptionsPage listSubscriptions(UserListSubscriptionsParams params)

• listSubscriptions

   UserListSubscriptionsPage listSubscriptions(String userId, RequestOptions requestOptions)

• merge

   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

   User merge(String userId, UserMergeParams params, RequestOptions requestOptions)

• merge

   User merge(UserMergeParams params)

• merge

   abstract User merge(UserMergeParams params, RequestOptions requestOptions)

• setChannelData

   ChannelData setChannelData(String userId, String channelId, UserSetChannelDataParams params)

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

• setChannelData

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

• setChannelData

   ChannelData setChannelData(UserSetChannelDataParams params)

• setChannelData

   abstract ChannelData setChannelData(UserSetChannelDataParams params, RequestOptions requestOptions)

• setPreferences

   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

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

• setPreferences

   PreferenceSet setPreferences(UserSetPreferencesParams params)

• setPreferences

   abstract PreferenceSet setPreferences(UserSetPreferencesParams params, RequestOptions requestOptions)

• unsetChannelData

   String unsetChannelData(String userId, String channelId)

  Deletes channel data for a specific user and channel ID.

• unsetChannelData

   String unsetChannelData(String userId, String channelId, UserUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   String unsetChannelData(String userId, String channelId, UserUnsetChannelDataParams params)

• unsetChannelData

   abstract String unsetChannelData(UserUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   String unsetChannelData(UserUnsetChannelDataParams params)

• unsetChannelData

   String unsetChannelData(String userId, String channelId, RequestOptions requestOptions)