Robot V1
get_robots_v1(project_name_or_id, query=None, sort=None, page=1, page_size=10, limit=None)
async
Get all robot v1 accounts for the specified project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_name_or_id
|
Union[str, int]
|
The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs. |
required |
query
|
Optional[str]
|
A query string to filter the robots |
None
|
sort
|
Optional[str]
|
The sort order of the robots |
None
|
page
|
int
|
The page of results to return |
1
|
page_size
|
int
|
The number of results to return per page |
10
|
limit
|
Optional[int]
|
The maximum number of results to return |
None
|
Returns:
| Type | Description |
|---|---|
List[Robot]
|
The robot v1 accounts for the project. |
create_robot_v1(project_name_or_id, robot)
async
Create a robot v1 account for the specified project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_name_or_id
|
Union[str, int]
|
The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs. |
required |
robot
|
RobotCreateV1
|
The robot v1 account to create. |
required |
Returns:
| Type | Description |
|---|---|
RobotCreated
|
The created robot v1 account. |
get_robot_v1(project_name_or_id, robot_id)
async
Get a robot v1 account for the specified project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_name_or_id
|
Union[str, int]
|
The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs. |
required |
robot_id
|
int
|
The ID of the robot v1 account to get. |
required |
Returns:
| Type | Description |
|---|---|
Robot
|
The robot v1 account. |
update_robot_v1(project_name_or_id, robot_id, robot)
async
Update a robot v1 account for the specified project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_name_or_id
|
Union[str, int]
|
The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs. |
required |
robot_id
|
int
|
The ID of the robot v1 account to update. |
required |
robot
|
Robot
|
The updated robot v1 account. |
required |
delete_robot_v1(project_name_or_id, robot_id)
async
Delete a robot v1 account for the specified project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_name_or_id
|
Union[str, int]
|
The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs. |
required |
robot_id
|
int
|
The ID of the robot v1 account to delete. |
required |