ReqManagedAgents.Providers.ClaudeManagedAgents.Client.Behaviour behaviour (ReqManagedAgents v0.13.0)

Copy Markdown View Source

Callback contract for the Managed Agents control plane, so consumers can swap in a mock client in tests. ReqManagedAgents.Providers.ClaudeManagedAgents.Client is the live implementation.

Summary

Types

result()

Callbacks

archive_agent(t, t)
archive_environment(t, t)
archive_session(t, t)
attach_file_to_session(t, t, map)
create_agent(t, map)
create_environment(t, map)
create_session(t, map)
delete_file(t, t)
delete_session(t, t)
download_file(t, t)
get_agent(t, t)
get_environment(t, t)
get_session(t, t)
list_agents(t, map)
list_all_events(t, t, map)
list_environments(t, map)
list_events(t, t, map)
list_files(t, keyword)
list_sessions(t, map)
list_thread_events(t, t, t, map)
list_threads(t, t, map)
send_event(t, t, map)
send_events(t, t, list)
update_agent(t, t, map)
upload_file(t, map)

Types

result()

@type result() :: {:ok, map()} | {:error, term()}

Callbacks

archive_agent(t, t)

@callback archive_agent(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

archive_environment(t, t)

@callback archive_environment(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) ::
  result()

archive_session(t, t)

@callback archive_session(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

attach_file_to_session(t, t, map)

@callback attach_file_to_session(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) :: result()

create_agent(t, map)

@callback create_agent(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), map()) ::
  result()

create_environment(t, map)

@callback create_environment(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  map()
) :: result()

create_session(t, map)

@callback create_session(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), map()) ::
  result()

delete_file(t, t)

@callback delete_file(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

delete_session(t, t)

@callback delete_session(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

download_file(t, t)

@callback download_file(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) ::
  {:ok, binary()} | {:error, term()}

get_agent(t, t)

@callback get_agent(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), String.t()) ::
  result()

get_environment(t, t)

@callback get_environment(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

get_session(t, t)

@callback get_session(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t()
) :: result()

list_agents(t, map)

@callback list_agents(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), map()) ::
  result()

list_all_events(t, t, map)

@callback list_all_events(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) ::
  {:ok, [map()]} | {:error, term()}

list_environments(t, map)

@callback list_environments(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  map()
) :: result()

list_events(t, t, map)

@callback list_events(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) ::
  result()

list_files(t, keyword)

@callback list_files(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  keyword()
) :: result()

list_sessions(t, map)

@callback list_sessions(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), map()) ::
  result()

list_thread_events(t, t, t, map)

@callback list_thread_events(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  String.t(),
  map()
) :: result()

list_threads(t, t, map)

@callback list_threads(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) ::
  result()

send_event(t, t, map)

@callback send_event(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) ::
  result()

send_events(t, t, list)

@callback send_events(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  [map()]
) ::
  result()

update_agent(t, t, map)

@callback update_agent(
  ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(),
  String.t(),
  map()
) ::
  result()

upload_file(t, map)

@callback upload_file(ReqManagedAgents.Providers.ClaudeManagedAgents.Client.t(), map()) ::
  result()