LettaAPI.Api.Users (letta_api v1.0.0)

API calls for all endpoints tagged Users.

Summary

Functions

create_user(connection, user_create, opts \\ [])

Create User Create a new user in the database

delete_user(connection, user_id, opts \\ [])

Delete User

list_users(connection, opts \\ [])

List Users Get a list of all users in the database

update_user(connection, user_update, opts \\ [])

Update User Update a user in the database

Functions

create_user(connection, user_create, opts \\ [])

@spec create_user(Tesla.Env.client(), LettaAPI.Model.UserCreate.t(), keyword()) ::
  {:ok, LettaAPI.Model.User.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Create User Create a new user in the database

Parameters

connection (LettaAPI.Connection): Connection to server
user_create (UserCreate):
opts (keyword): Optional parameters

Returns

{:ok, LettaAPI.Model.User.t} on success
{:error, Tesla.Env.t} on failure

delete_user(connection, user_id, opts \\ [])

@spec delete_user(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.User.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Delete User

Parameters

connection (LettaAPI.Connection): Connection to server
user_id (String.t): The user_id key to be deleted.
opts (keyword): Optional parameters

Returns

{:ok, LettaAPI.Model.User.t} on success
{:error, Tesla.Env.t} on failure

list_users(connection, opts \\ [])

@spec list_users(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [LettaAPI.Model.User.t()]}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

List Users Get a list of all users in the database

Parameters

connection (LettaAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :after (String.t):
- :limit (integer()):

Returns

{:ok, [%User{}, ...]} on success
{:error, Tesla.Env.t} on failure

update_user(connection, user_update, opts \\ [])

@spec update_user(Tesla.Env.client(), LettaAPI.Model.UserUpdate.t(), keyword()) ::
  {:ok, LettaAPI.Model.User.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Update User Update a user in the database

Parameters

connection (LettaAPI.Connection): Connection to server
user_update (UserUpdate):
opts (keyword): Optional parameters

Returns

{:ok, LettaAPI.Model.User.t} on success
{:error, Tesla.Env.t} on failure