ExStreamClient.Operations.Users (ExStreamClient v0.1.0)

View Source
Modules for interacting with the `users` group of OpenAI APIs

API Reference: https://platform.openai.com/docs/api-reference/users

Summary

Functions

block_users(payload)

Block users


### Required Arguments:
    - `payload`: BlockUsersRequest

deactivate_user(user_id, payload)

Deactivates user with possibility to activate it back

Sends events:

  • user.deactivated

    ### Required Arguments:

      - `user_id`
      - `payload`: DeactivateUserRequest

deactivate_users(payload)

Deactivate users in batches

Sends events:

  • user.deactivated

    ### Required Arguments:

      - `payload`: DeactivateUsersRequest

delete_users(payload)

Deletes users and optionally all their belongings asynchronously.

Sends events:

  • channel.deleted

  • user.deleted

    ### Required Arguments:

      - `payload`: DeleteUsersRequest

export_user(user_id)

@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`

get_blocked_users(opts \\ [])

@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`

query_users(opts \\ [])

@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

reactivate_user(user_id, payload)

Activates user who's been deactivated previously

Sends events:

  • user.reactivated

    ### Required Arguments:

      - `user_id`
      - `payload`: ReactivateUserRequest

reactivate_users(payload)

Reactivate users in batches

Sends events:

  • user.reactivated

  • user.reactivated

    ### Required Arguments:

      - `payload`: ReactivateUsersRequest

restore_users(payload)

@spec restore_users(ExStreamClient.Model.RestoreUsersRequest.t()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Restore soft deleted users


### Required Arguments:
    - `payload`: RestoreUsersRequest

unblock_users(payload)

Unblock users


### Required Arguments:
    - `payload`: UnblockUsersRequest

update_users(payload)

Update or create users in bulk

Sends events:

  • user.updated

    ### Required Arguments:

      - `payload`: UpdateUsersRequest

update_users_partial(payload)

Updates certain fields of the user

Sends events:

  • user.presence.changed

  • user.updated

  • user.presence.changed

    ### Required Arguments:

      - `payload`: UpdateUsersPartialRequest