Package app.knock.api.models.users
See: Description
-
Class Summary Class Description Builder A builder for IdentifyUserRequest. IdentifyUserRequest A set of parameters to identify a user with. Builder A builder for InlineIdentifyUserRequest. InlineIdentifyUserRequest A set of parameters to inline-identify a user with. Builder A builder for User. User A /concepts/users represents an individual in your system who can receive notifications through Knock. Builder A builder for UserDeleteParams. UserDeleteParams Permanently delete a user and all associated data. Builder A builder for UserGetChannelDataParams. UserGetChannelDataParams Retrieves the channel data for a specific user and channel ID. Builder A builder for UserGetParams. UserGetParams Retrieve a specific user by their ID. Builder A builder for UserGetPreferencesParams. UserGetPreferencesParams Retrieves a specific preference set for a user identified by the preference set ID. Builder A builder for UserListMessagesPage. AutoPager UserListMessagesPage Builder A builder for UserListMessagesPageAsync. AutoPager UserListMessagesPageAsync Builder A builder for UserListMessagesPageResponse. UserListMessagesPageResponse A paginated list of messages. Builder A builder for UserListMessagesParams. EngagementStatus Builder A builder for InsertedAt. InsertedAt Status UserListMessagesParams Returns a paginated list of messages for a specific user. Builder A builder for UserListPage. AutoPager UserListPage Builder A builder for UserListPageAsync. AutoPager UserListPageAsync Builder A builder for UserListPageResponse. UserListPageResponse A paginated list of users. Builder A builder for UserListParams. Include UserListParams Retrieve a paginated list of users in the environment. Builder A builder for UserListPreferencesParams. UserListPreferencesParams Retrieves a list of all preference sets for a specific user. Builder A builder for UserListSchedulesPage. AutoPager UserListSchedulesPage Builder A builder for UserListSchedulesPageAsync. AutoPager UserListSchedulesPageAsync Builder A builder for UserListSchedulesPageResponse. UserListSchedulesPageResponse A response containing a list of schedules. Builder A builder for UserListSchedulesParams. UserListSchedulesParams Returns a paginated list of schedules for a specific user, in descending order. Builder A builder for UserListSubscriptionsPage. AutoPager UserListSubscriptionsPage Builder A builder for UserListSubscriptionsPageAsync. AutoPager UserListSubscriptionsPageAsync Builder A builder for UserListSubscriptionsPageResponse. UserListSubscriptionsPageResponse A response containing a list of subscriptions. Builder A builder for UserListSubscriptionsParams. Include UserListSubscriptionsParams Retrieves a paginated list of subscriptions for a specific user, in descending order. Builder A builder for UserMergeParams. Builder A builder for Body. Body A set of parameters to merge one user into another. UserMergeParams Merge two users together, where the user specified with the from_user_idparam will be merged into the user specified byuser_id.Builder A builder for UserSetChannelDataParams. UserSetChannelDataParams Updates or creates channel data for a specific user and channel ID. Builder A builder for UserSetPreferencesParams. UserSetPreferencesParams Updates a complete preference set for a user. Builder A builder for UserUnsetChannelDataParams. UserUnsetChannelDataParams Deletes channel data for a specific user and channel ID. Builder A builder for UserUpdateParams. UserUpdateParams Create or update a user with the provided identification data. -
Enum Summary Enum Description Known An enum containing EngagementStatus's known values. Value An enum containing EngagementStatus's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Include's known values. Value An enum containing Include's known values, as well as an _UNKNOWN member. Known An enum containing Include's known values. Value An enum containing Include's known values, as well as an _UNKNOWN member.