Skip to main content

Pools

Named groupings of library items.

Access it as client.pools on a Strongly client, or the same path on AsyncStrongly with await. All methods exist on both with identical signatures.

Quick start​

from strongly import Strongly

client = Strongly()

# List (auto-paginates as you iterate)  # filters: scope, counts
for pool in client.pools.list():
    print(pool.id)

Methods​

Core​

list​

list(*, scope: str | None = None, counts: bool | None = None) -> SyncPaginator[Pool]

List the pools you may see.

Parameters

  • scope (str | None, optional): Only custom, imprint, org-global or agent pools. org-global makes sure your organization's pool exists first.
  • counts (bool | None, optional): Add each pool's item counts.

create​

create(*, name: str, description: str | None = None, scope: str | None = None) -> Pool

Create a pool (scope custom, the default, or imprint).

retrieve​

retrieve(pool_id: str) -> Pool

Get a pool with its item counts.

update​

update(pool_id: str, *, name: str | None = None, description: str | None = None) -> Pool

Rename a pool or change its description.

delete​

delete(pool_id: str) -> None

Delete a pool; its items stay in the library. An org-global or agent pool cannot be.

Other​

add_member​

add_member(resource_id: str, *, user_id: str, role: str) -> Permissions

Share the resource with a user.

Parameters

  • resource_id (str): The resource's id.
  • user_id (str): The user to share it with.
  • role (str): "editor" (use and change it) or "user" (use it only; types without a use-only tier, such as knowledge bases, take "editor" only).

permissions​

permissions(resource_id: str) -> Permissions

Return who can reach the resource: its owner, members and their roles, and visibility.

Parameters

  • resource_id (str): The resource's id.

remove_member​

remove_member(resource_id: str, user_id: str) -> None

Stop sharing the resource with a user.

Parameters

  • resource_id (str): The resource's id.
  • user_id (str): The user to stop sharing it with.

set_visibility​

set_visibility(resource_id: str, visibility: str) -> Permissions

Make the resource public (every user can find and use it) or private.

Parameters

  • resource_id (str): The resource's id.
  • visibility (str): "public" or "private".