coolipy.resources.teams

Teams resource clients (sync + async).

Classes

class AsyncTeams (transport: AsyncTransport)

Expand source code

class AsyncTeams(AsyncResourceBase):
    """Asynchronous client for Coolify teams and shared envs."""

    async def list(self) -> CoolipyAPIResponse[TeamList]:
        """List all teams."""
        return await self._get("/teams", response_model=list[TeamModel])

    async def get(self, team_id: int) -> CoolipyAPIResponse[TeamModel]:
        """Get a team by ID."""
        return await self._get(f"/teams/{team_id}", response_model=TeamModel)

    async def members(self, team_id: int) -> CoolipyAPIResponse[UserList]:
        """List members of a team."""
        return await self._get(f"/teams/{team_id}/members", response_model=list[UserModel])

    async def current(self) -> CoolipyAPIResponse[TeamModel]:
        """Get the authenticated team."""
        return await self._get("/team", response_model=TeamModel)

    async def current_members(self) -> CoolipyAPIResponse[UserList]:
        """List members of the authenticated team."""
        return await self._get("/team/members", response_model=list[UserModel])

    async def envs(self) -> CoolipyAPIResponse[EnvironmentVariableList]:
        """List shared environment variables."""
        return await self._get("/team/envs", response_model=list[EnvironmentVariable])

    async def create_env(
        self, model: EnvironmentVariableCreate
    ) -> CoolipyAPIResponse[UUIDResponse]:
        """Create a shared environment variable."""
        return await self._post("/team/envs", json=_dump(model), response_model=UUIDResponse)

    async def update_env(
        self, model: EnvironmentVariableUpdate
    ) -> CoolipyAPIResponse[EnvironmentVariable]:
        """Update a shared environment variable."""
        return await self._patch(
            "/team/envs", json=_dump(model), response_model=EnvironmentVariable
        )

    async def delete_env(self, env_id: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete a shared environment variable."""
        return await self._delete(f"/team/envs/{env_id}", response_model=MessageResponse)

Asynchronous client for Coolify teams and shared envs.

Ancestors

• coolipy._base.AsyncResourceBase

Methods

async def create_env(self, model: EnvironmentVariableCreate) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

async def create_env(
    self, model: EnvironmentVariableCreate
) -> CoolipyAPIResponse[UUIDResponse]:
    """Create a shared environment variable."""
    return await self._post("/team/envs", json=_dump(model), response_model=UUIDResponse)

Create a shared environment variable.

async def current(self) ‑> coolipy._response.CoolipyAPIResponse[TeamModel]

Expand source code

async def current(self) -> CoolipyAPIResponse[TeamModel]:
    """Get the authenticated team."""
    return await self._get("/team", response_model=TeamModel)

Get the authenticated team.

async def current_members(self) ‑> coolipy._response.CoolipyAPIResponse[list[UserModel]]

Expand source code

async def current_members(self) -> CoolipyAPIResponse[UserList]:
    """List members of the authenticated team."""
    return await self._get("/team/members", response_model=list[UserModel])

List members of the authenticated team.

async def delete_env(self, env_id: str) ‑> coolipy._response.CoolipyAPIResponse[MessageResponse]

Expand source code

async def delete_env(self, env_id: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete a shared environment variable."""
    return await self._delete(f"/team/envs/{env_id}", response_model=MessageResponse)

Delete a shared environment variable.

async def envs(self) ‑> coolipy._response.CoolipyAPIResponse[list[EnvironmentVariable]]

Expand source code

async def envs(self) -> CoolipyAPIResponse[EnvironmentVariableList]:
    """List shared environment variables."""
    return await self._get("/team/envs", response_model=list[EnvironmentVariable])

List shared environment variables.

async def get(self, team_id: int) ‑> coolipy._response.CoolipyAPIResponse[TeamModel]

Expand source code

async def get(self, team_id: int) -> CoolipyAPIResponse[TeamModel]:
    """Get a team by ID."""
    return await self._get(f"/teams/{team_id}", response_model=TeamModel)

Get a team by ID.

async def list(self) ‑> coolipy._response.CoolipyAPIResponse[list[TeamModel]]

Expand source code

async def list(self) -> CoolipyAPIResponse[TeamList]:
    """List all teams."""
    return await self._get("/teams", response_model=list[TeamModel])

List all teams.

async def members(self, team_id: int) ‑> coolipy._response.CoolipyAPIResponse[list[UserModel]]

Expand source code

async def members(self, team_id: int) -> CoolipyAPIResponse[UserList]:
    """List members of a team."""
    return await self._get(f"/teams/{team_id}/members", response_model=list[UserModel])

List members of a team.

async def update_env(self, model: EnvironmentVariableUpdate) ‑> coolipy._response.CoolipyAPIResponse[EnvironmentVariable]

Expand source code

async def update_env(
    self, model: EnvironmentVariableUpdate
) -> CoolipyAPIResponse[EnvironmentVariable]:
    """Update a shared environment variable."""
    return await self._patch(
        "/team/envs", json=_dump(model), response_model=EnvironmentVariable
    )

Update a shared environment variable.

class Teams (transport: SyncTransport)

Expand source code

class Teams(ResourceBase):
    """Synchronous client for Coolify teams and shared envs."""

    def list(self) -> CoolipyAPIResponse[TeamList]:
        """List all teams."""
        return self._get("/teams", response_model=list[TeamModel])

    def get(self, team_id: int) -> CoolipyAPIResponse[TeamModel]:
        """Get a team by ID."""
        return self._get(f"/teams/{team_id}", response_model=TeamModel)

    def members(self, team_id: int) -> CoolipyAPIResponse[UserList]:
        """List members of a team."""
        return self._get(f"/teams/{team_id}/members", response_model=list[UserModel])

    def current(self) -> CoolipyAPIResponse[TeamModel]:
        """Get the authenticated team."""
        return self._get("/team", response_model=TeamModel)

    def current_members(self) -> CoolipyAPIResponse[UserList]:
        """List members of the authenticated team."""
        return self._get("/team/members", response_model=list[UserModel])

    def envs(self) -> CoolipyAPIResponse[EnvironmentVariableList]:
        """List shared environment variables."""
        return self._get("/team/envs", response_model=list[EnvironmentVariable])

    def create_env(self, model: EnvironmentVariableCreate) -> CoolipyAPIResponse[UUIDResponse]:
        """Create a shared environment variable."""
        return self._post("/team/envs", json=_dump(model), response_model=UUIDResponse)

    def update_env(
        self, model: EnvironmentVariableUpdate
    ) -> CoolipyAPIResponse[EnvironmentVariable]:
        """Update a shared environment variable."""
        return self._patch("/team/envs", json=_dump(model), response_model=EnvironmentVariable)

    def delete_env(self, env_id: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete a shared environment variable."""
        return self._delete(f"/team/envs/{env_id}", response_model=MessageResponse)

Synchronous client for Coolify teams and shared envs.

Ancestors

• coolipy._base.ResourceBase

Methods

def create_env(self, model: EnvironmentVariableCreate) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

def create_env(self, model: EnvironmentVariableCreate) -> CoolipyAPIResponse[UUIDResponse]:
    """Create a shared environment variable."""
    return self._post("/team/envs", json=_dump(model), response_model=UUIDResponse)

Create a shared environment variable.

def current(self) ‑> coolipy._response.CoolipyAPIResponse[TeamModel]

Expand source code

def current(self) -> CoolipyAPIResponse[TeamModel]:
    """Get the authenticated team."""
    return self._get("/team", response_model=TeamModel)

Get the authenticated team.

def current_members(self) ‑> coolipy._response.CoolipyAPIResponse[list[UserModel]]

Expand source code

def current_members(self) -> CoolipyAPIResponse[UserList]:
    """List members of the authenticated team."""
    return self._get("/team/members", response_model=list[UserModel])

List members of the authenticated team.

def delete_env(self, env_id: str) ‑> coolipy._response.CoolipyAPIResponse[MessageResponse]

Expand source code

def delete_env(self, env_id: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete a shared environment variable."""
    return self._delete(f"/team/envs/{env_id}", response_model=MessageResponse)

Delete a shared environment variable.

def envs(self) ‑> coolipy._response.CoolipyAPIResponse[list[EnvironmentVariable]]

Expand source code

def envs(self) -> CoolipyAPIResponse[EnvironmentVariableList]:
    """List shared environment variables."""
    return self._get("/team/envs", response_model=list[EnvironmentVariable])

List shared environment variables.

def get(self, team_id: int) ‑> coolipy._response.CoolipyAPIResponse[TeamModel]

Expand source code

def get(self, team_id: int) -> CoolipyAPIResponse[TeamModel]:
    """Get a team by ID."""
    return self._get(f"/teams/{team_id}", response_model=TeamModel)

Get a team by ID.

def list(self) ‑> coolipy._response.CoolipyAPIResponse[list[TeamModel]]

Expand source code

def list(self) -> CoolipyAPIResponse[TeamList]:
    """List all teams."""
    return self._get("/teams", response_model=list[TeamModel])

List all teams.

def members(self, team_id: int) ‑> coolipy._response.CoolipyAPIResponse[list[UserModel]]

Expand source code

def members(self, team_id: int) -> CoolipyAPIResponse[UserList]:
    """List members of a team."""
    return self._get(f"/teams/{team_id}/members", response_model=list[UserModel])

List members of a team.

def update_env(self, model: EnvironmentVariableUpdate) ‑> coolipy._response.CoolipyAPIResponse[EnvironmentVariable]

Expand source code

def update_env(
    self, model: EnvironmentVariableUpdate
) -> CoolipyAPIResponse[EnvironmentVariable]:
    """Update a shared environment variable."""
    return self._patch("/team/envs", json=_dump(model), response_model=EnvironmentVariable)

Update a shared environment variable.