client.org

Generated methods for the org namespace. Sync owner: WarmHubClient.org. Async owner: AsyncWarmHubClient.org.

Synchronous methods

`add_member`

add_member(org_name: str, email: str, role: Literal['owner', 'admin', 'editor', 'viewer'] = 'editor', *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> OrgMember

org.addMember — mutate org.addMember.

`archive`

archive(org_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.archive — mutate org.archive.

`change_member_role`

change_member_role(org_name: str, email: str, role: Literal['owner', 'admin', 'editor', 'viewer'], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> OrgMember

org.changeMemberRole — mutate org.changeMemberRole.

`clear_member_scopes`

clear_member_scopes(org_name: str, email: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> None

org.clearMemberScopes — mutate org.clearMemberScopes.

`create`

create(name: str, display_name: str | Unset = UNSET, description: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.create — mutate org.create.

`get`

get(org_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.get — query org.get.

`get_caller_role`

get_caller_role(org_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Literal['owner', 'admin', 'editor', 'viewer'] | None

org.getCallerRole — query org.getCallerRole.

`leave`

leave(org_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> None

org.leave — mutate org.leave.

`list`

list(*, include_archived: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> OrgListResponse

org.list — query org.list.

`list_members`

list_members(org_name: str, *, pending: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> OrgMemberList

org.listMembers — query org.listMembers.

`remove_member`

remove_member(org_name: str, email: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> None

org.removeMember — mutate org.removeMember.

`rename`

rename(org_name: str, new_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.rename — mutate org.rename.

`set_description`

set_description(org_name: str, description: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.setDescription — mutate org.setDescription.

`set_display_name`

set_display_name(org_name: str, display_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.setDisplayName — mutate org.setDisplayName.

`set_member_scopes`

set_member_scopes(org_name: str, email: str, scopes: Sequence[Mapping[str, JsonValue]], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> None

org.setMemberScopes — mutate org.setMemberScopes.

`unarchive`

unarchive(org_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.unarchive — mutate org.unarchive.

`update`

update(payload: Mapping[str, JsonValue], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Org

org.update — mutate org.update.

Asynchronous methods