scorable.projects

Classes

Projects

Projects API

Module Contents

class scorable.projects.Projects(client_context: scorable.utils.ClientContextCallable)

Projects API

Note

The construction of the API instance should be handled by accessing an attribute of a scorable.client.Scorable instance.

Parameters:

client_context (scorable.utils.ClientContextCallable)

async acreate(*, name: str, description: str = '', is_default: bool | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.project.Project

Asynchronously create a new project.

Parameters:

  • name (str)

  • description (str)

  • is_default (Optional[bool])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.project.Project

async adelete(project_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → None

Asynchronously delete a project.

Parameters:

  • project_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

None

async alist(*, limit: int = 100, _request_timeout: int | None = None) → AsyncIterator[scorable.generated.openapi_aclient.models.project.Project]

Asynchronously iterate through all projects in your organization.

Parameters:

  • limit (int) – Number of entries to iterate through at most.

  • _request_timeout (Optional[int])

Return type:

AsyncIterator[scorable.generated.openapi_aclient.models.project.Project]

async aretrieve(project_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.project.Project

Asynchronously retrieve a project by ID.

Parameters:

  • project_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.project.Project

async aupdate(project_id: str, *, name: str | None = None, description: str | None = None, is_default: bool | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.project.Project

Asynchronously update a project.

Parameters:

  • project_id (str)

  • name (Optional[str])

  • description (Optional[str])

  • is_default (Optional[bool])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.project.Project

create(*, name: str, description: str = '', is_default: bool | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.project.Project

Create a new project.

Parameters:

  • name (str) – Name of the project.

  • description (str) – Optional description.

  • is_default (Optional[bool]) – If True, this project becomes the organization’s default and any previously default project is atomically demoted.

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.project.Project

delete(project_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → None

Delete a project.

Parameters:

  • project_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

None

list(*, limit: int = 100, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → Iterator[scorable.generated.openapi_client.models.project.Project]

Iterate through all projects in your organization.

Parameters:

  • limit (int) – Number of entries to iterate through at most.

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

Iterator[scorable.generated.openapi_client.models.project.Project]

retrieve(project_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.project.Project

Retrieve a project by ID.

Parameters:

  • project_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.project.Project

update(project_id: str, *, name: str | None = None, description: str | None = None, is_default: bool | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.project.Project

Update a project.

Pass is_default=True to atomically promote this project to the organization’s default and demote the previous default. The backend rejects is_default=False (the default is moved by promoting a different project, not cleared directly).

Parameters:

  • project_id (str)

  • name (Optional[str])

  • description (Optional[str])

  • is_default (Optional[bool])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.project.Project

client_context