Skip to main content

swarm

@codebolt/codeboltjs

Variable: swarm

const swarm: {
  applyForVacancy: (swarmId: string, vacancyId: string, agentId: string, message?: string) => Promise<ApplyForVacancyResponse>;
  assignRole: (swarmId: string, roleId: string, agentId: string) => Promise<AssignRoleResponse>;
  closeVacancy: (swarmId: string, vacancyId: string, reason: string) => Promise<CloseVacancyResponse>;
  createRole: (swarmId: string, data: CreateRoleRequest) => Promise<CreateRoleResponse>;
  createSwarm: (data: CreateSwarmRequest) => Promise<CreateSwarmResponse>;
  createTeam: (swarmId: string, data: CreateTeamRequest) => Promise<CreateTeamResponse>;
  createVacancy: (swarmId: string, data: CreateVacancyRequest) => Promise<CreateVacancyResponse>;
  deleteRole: (swarmId: string, roleId: string) => Promise<DeleteRoleResponse>;
  deleteTeam: (swarmId: string, teamId: string) => Promise<DeleteTeamResponse>;
  getAgentsByRole: (swarmId: string, roleId: string) => Promise<GetAgentsByRoleResponse>;
  getDefaultJobGroup: (swarmId: string) => Promise<GetDefaultJobGroupResponse>;
  getRole: (swarmId: string, roleId: string) => Promise<GetRoleResponse>;
  getSwarm: (swarmId: string) => Promise<GetSwarmResponse>;
  getSwarmAgents: (swarmId: string) => Promise<GetSwarmAgentsResponse>;
  getSwarmStatusSummary: (swarmId: string) => Promise<GetStatusSummaryResponse>;
  getTeam: (swarmId: string, teamId: string) => Promise<GetTeamResponse>;
  joinTeam: (swarmId: string, teamId: string, agentId: string) => Promise<JoinTeamResponse>;
  leaveTeam: (swarmId: string, teamId: string, agentId: string) => Promise<LeaveTeamResponse>;
  listRoles: (swarmId: string) => Promise<ListRolesResponse>;
  listSwarms: () => Promise<ListSwarmsResponse>;
  listTeams: (swarmId: string) => Promise<ListTeamsResponse>;
  listVacancies: (swarmId: string) => Promise<ListVacanciesResponse>;
  registerAgent: (swarmId: string, data: AgentRegistration) => Promise<RegisterAgentResponse>;
  unassignRole: (swarmId: string, roleId: string, agentId: string) => Promise<UnassignRoleResponse>;
  unregisterAgent: (swarmId: string, agentId: string) => Promise<UnregisterAgentResponse>;
  updateAgentStatus: (swarmId: string, agentId: string, data: AgentStatusUpdate) => Promise<UpdateStatusResponse>;
};

Defined in: packages/codeboltjs/src/modules/swarm.ts:85

Swarm Module Provides functionality for managing swarms, agents, teams, roles, and vacancies

Type Declaration​

NameTypeDescriptionDefined in
applyForVacancy()(swarmId: string, vacancyId: string, agentId: string, message?: string) => Promise<ApplyForVacancyResponse>Apply for a vacancypackages/codeboltjs/src/modules/swarm.ts:526
assignRole()(swarmId: string, roleId: string, agentId: string) => Promise<AssignRoleResponse>Assign a role to an agentpackages/codeboltjs/src/modules/swarm.ts:399
closeVacancy()(swarmId: string, vacancyId: string, reason: string) => Promise<CloseVacancyResponse>Close a vacancypackages/codeboltjs/src/modules/swarm.ts:554
createRole()(swarmId: string, data: CreateRoleRequest) => Promise<CreateRoleResponse>Create a new role in a swarmpackages/codeboltjs/src/modules/swarm.ts:340
createSwarm()(data: CreateSwarmRequest) => Promise<CreateSwarmResponse>Create a new swarmpackages/codeboltjs/src/modules/swarm.ts:95
createTeam()(swarmId: string, data: CreateTeamRequest) => Promise<CreateTeamResponse>Create a new team in a swarmpackages/codeboltjs/src/modules/swarm.ts:214
createVacancy()(swarmId: string, data: CreateVacancyRequest) => Promise<CreateVacancyResponse>Create a new vacancy in a swarmpackages/codeboltjs/src/modules/swarm.ts:486
deleteRole()(swarmId: string, roleId: string) => Promise<DeleteRoleResponse>Delete a role from a swarmpackages/codeboltjs/src/modules/swarm.ts:462
deleteTeam()(swarmId: string, teamId: string) => Promise<DeleteTeamResponse>Delete a team from a swarmpackages/codeboltjs/src/modules/swarm.ts:316
getAgentsByRole()(swarmId: string, roleId: string) => Promise<GetAgentsByRoleResponse>Get all agents with a specific rolepackages/codeboltjs/src/modules/swarm.ts:442
getDefaultJobGroup()(swarmId: string) => Promise<GetDefaultJobGroupResponse>Get the default job group ID associated with a swarmpackages/codeboltjs/src/modules/swarm.ts:626
getRole()(swarmId: string, roleId: string) => Promise<GetRoleResponse>Get details of a specific rolepackages/codeboltjs/src/modules/swarm.ts:378
getSwarm()(swarmId: string) => Promise<GetSwarmResponse>Get details of a specific swarmpackages/codeboltjs/src/modules/swarm.ts:129
getSwarmAgents()(swarmId: string) => Promise<GetSwarmAgentsResponse>Get all agents in a swarmpackages/codeboltjs/src/modules/swarm.ts:147
getSwarmStatusSummary()(swarmId: string) => Promise<GetStatusSummaryResponse>Get status summary for a swarmpackages/codeboltjs/src/modules/swarm.ts:604
getTeam()(swarmId: string, teamId: string) => Promise<GetTeamResponse>Get details of a specific teampackages/codeboltjs/src/modules/swarm.ts:252
joinTeam()(swarmId: string, teamId: string, agentId: string) => Promise<JoinTeamResponse>Add an agent to a teampackages/codeboltjs/src/modules/swarm.ts:273
leaveTeam()(swarmId: string, teamId: string, agentId: string) => Promise<LeaveTeamResponse>Remove an agent from a teampackages/codeboltjs/src/modules/swarm.ts:295
listRoles()(swarmId: string) => Promise<ListRolesResponse>List all roles in a swarmpackages/codeboltjs/src/modules/swarm.ts:359
listSwarms()() => Promise<ListSwarmsResponse>List all available swarmspackages/codeboltjs/src/modules/swarm.ts:112
listTeams()(swarmId: string) => Promise<ListTeamsResponse>List all teams in a swarmpackages/codeboltjs/src/modules/swarm.ts:233
listVacancies()(swarmId: string) => Promise<ListVacanciesResponse>List all vacancies in a swarmpackages/codeboltjs/src/modules/swarm.ts:505
registerAgent()(swarmId: string, data: AgentRegistration) => Promise<RegisterAgentResponse>Register an agent to a swarmpackages/codeboltjs/src/modules/swarm.ts:170
unassignRole()(swarmId: string, roleId: string, agentId: string) => Promise<UnassignRoleResponse>Unassign a role from an agentpackages/codeboltjs/src/modules/swarm.ts:421
unregisterAgent()(swarmId: string, agentId: string) => Promise<UnregisterAgentResponse>Unregister an agent from a swarmpackages/codeboltjs/src/modules/swarm.ts:190
updateAgentStatus()(swarmId: string, agentId: string, data: AgentStatusUpdate) => Promise<UpdateStatusResponse>Update an agent's statuspackages/codeboltjs/src/modules/swarm.ts:580