LettaAPI.Api.Admin (letta_api v1.0.0)

@spec create_organization(
  Tesla.Env.client(),
  LettaAPI.Model.OrganizationCreate.t(),
  keyword()
) ::
  {:ok, LettaAPI.Model.Organization.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Create Org Create a new org in the database

Parameters

connection (LettaAPI.Connection): Connection to server
organization_create (OrganizationCreate):
opts (keyword): Optional parameters

Returns

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

create_organization_0(connection, organization_create, opts \\ [])

@spec create_organization_0(
  Tesla.Env.client(),
  LettaAPI.Model.OrganizationCreate.t(),
  keyword()
) ::
  {:ok, LettaAPI.Model.Organization.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Create Org Create a new org in the database

Parameters

connection (LettaAPI.Connection): Connection to server
organization_create (OrganizationCreate):
opts (keyword): Optional parameters

Returns

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

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

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

@spec create_user_0(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_organization_by_id(connection, org_id, opts \\ [])

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

Delete Org

Parameters

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

Returns

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

delete_organization_by_id_0(connection, org_id, opts \\ [])

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

Delete Org

Parameters

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

Returns

{:ok, LettaAPI.Model.Organization.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

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

@spec delete_user_0(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_orgs(connection, opts \\ [])

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

Get All Orgs Get a list of all orgs in the database

Parameters

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

Returns

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

list_orgs_0(connection, opts \\ [])

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

Get All Orgs Get a list of all orgs in the database

Parameters

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

Returns

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

list_tags_0(connection, opts \\ [])

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

List Tags Get a list of all tags in the database

Parameters

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

Returns

{:ok, [%String.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

list_users_0(connection, opts \\ [])

@spec list_users_0(
  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_organization(connection, org_id, organization_update, opts \\ [])

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

Update Org

Parameters

connection (LettaAPI.Connection): Connection to server
org_id (String.t): The org_id key to be updated.
organization_update (OrganizationUpdate):
opts (keyword): Optional parameters

Returns

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

update_organization_0(connection, org_id, organization_update, opts \\ [])

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

Update Org

Parameters

connection (LettaAPI.Connection): Connection to server
org_id (String.t): The org_id key to be updated.
organization_update (OrganizationUpdate):
opts (keyword): Optional parameters

Returns

{:ok, LettaAPI.Model.Organization.t} 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

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

@spec update_user_0(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