ExStreamClient.Operations.Users (ExStreamClient v0.1.0)
View SourceModules for interacting with the `users` group of OpenAI APIs
API Reference: https://platform.openai.com/docs/api-reference/users
Summary
Functions
@spec block_users(ExStreamClient.Model.BlockUsersRequest.t()) :: {:ok, ExStreamClient.Model.BlockUsersResponse.t()} | {:error, any()}
Block users
### Required Arguments:
- `payload`: BlockUsersRequest
@spec deactivate_user(String.t(), ExStreamClient.Model.DeactivateUserRequest.t()) :: {:ok, ExStreamClient.Model.DeactivateUserResponse.t()} | {:error, any()}
Deactivates user with possibility to activate it back
Sends events:
user.deactivated
### Required Arguments:
- `user_id` - `payload`: DeactivateUserRequest
@spec deactivate_users(ExStreamClient.Model.DeactivateUsersRequest.t()) :: {:ok, ExStreamClient.Model.DeactivateUsersResponse.t()} | {:error, any()}
Deactivate users in batches
Sends events:
user.deactivated
### Required Arguments:
- `payload`: DeactivateUsersRequest
@spec delete_users(ExStreamClient.Model.DeleteUsersRequest.t()) :: {:ok, ExStreamClient.Model.DeleteUsersResponse.t()} | {:error, any()}
Deletes users and optionally all their belongings asynchronously.
Sends events:
channel.deleted
user.deleted
### Required Arguments:
- `payload`: DeleteUsersRequest
@spec export_user(String.t()) :: {:ok, ExStreamClient.Model.ExportUserResponse.t()} | {:error, any()}
Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
### Required Arguments:
- `user_id`
@spec get_blocked_users([{:user_id, String.t()}]) :: {:ok, ExStreamClient.Model.GetBlockedUsersResponse.t()} | {:error, any()}
Get list of blocked Users
### Required Arguments:
### Optional Arguments:
- `user_id`
@spec query_users([{:payload, ExStreamClient.Model.QueryUsersPayload.t()}]) :: {:ok, ExStreamClient.Model.QueryUsersResponse.t()} | {:error, any()}
Find and filter users
### Required Arguments:
### Optional Arguments:
- `payload`: QueryUsersPayload
@spec reactivate_user(String.t(), ExStreamClient.Model.ReactivateUserRequest.t()) :: {:ok, ExStreamClient.Model.ReactivateUserResponse.t()} | {:error, any()}
Activates user who's been deactivated previously
Sends events:
user.reactivated
### Required Arguments:
- `user_id` - `payload`: ReactivateUserRequest
@spec reactivate_users(ExStreamClient.Model.ReactivateUsersRequest.t()) :: {:ok, ExStreamClient.Model.ReactivateUsersResponse.t()} | {:error, any()}
Reactivate users in batches
Sends events:
user.reactivated
user.reactivated
### Required Arguments:
- `payload`: ReactivateUsersRequest
@spec restore_users(ExStreamClient.Model.RestoreUsersRequest.t()) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Restore soft deleted users
### Required Arguments:
- `payload`: RestoreUsersRequest
@spec unblock_users(ExStreamClient.Model.UnblockUsersRequest.t()) :: {:ok, ExStreamClient.Model.UnblockUsersResponse.t()} | {:error, any()}
Unblock users
### Required Arguments:
- `payload`: UnblockUsersRequest
@spec update_users(ExStreamClient.Model.UpdateUsersRequest.t()) :: {:ok, ExStreamClient.Model.UpdateUsersResponse.t()} | {:error, any()}
Update or create users in bulk
Sends events:
user.updated
### Required Arguments:
- `payload`: UpdateUsersRequest
@spec update_users_partial(ExStreamClient.Model.UpdateUsersPartialRequest.t()) :: {:ok, ExStreamClient.Model.UpdateUsersResponse.t()} | {:error, any()}
Updates certain fields of the user
Sends events:
user.presence.changed
user.updated
user.presence.changed
### Required Arguments:
- `payload`: UpdateUsersPartialRequest