coolipy.resources.s3_storages

S3 storage resource clients (sync + async).

Classes

class AsyncS3Storages (transport: AsyncTransport)

Expand source code

class AsyncS3Storages(AsyncResourceBase):
    """Asynchronous client for Coolify S3 storages."""

    async def list(self) -> CoolipyAPIResponse[S3StorageList]:
        """List all S3 storages."""
        return await self._get("/s3-storages", response_model=list[S3StorageModel])

    async def get(self, uuid: str) -> CoolipyAPIResponse[S3StorageModel]:
        """Get an S3 storage by UUID."""
        return await self._get(f"/s3-storages/{uuid}", response_model=S3StorageModel)

    async def create(self, model: S3StorageCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
        """Create an S3 storage."""
        return await self._post("/s3-storages", json=_dump(model), response_model=UUIDResponse)

    async def update(
        self, uuid: str, model: S3StorageUpdateModel
    ) -> CoolipyAPIResponse[S3StorageModel]:
        """Update an S3 storage by UUID."""
        return await self._patch(
            f"/s3-storages/{uuid}", json=_dump(model), response_model=S3StorageModel
        )

    async def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete an S3 storage by UUID."""
        return await self._delete(f"/s3-storages/{uuid}", response_model=MessageResponse)

    async def validate(self, uuid: str) -> CoolipyAPIResponse[Any]:
        """Validate an S3 storage by UUID."""
        return await self._post(f"/s3-storages/{uuid}/validate")

Asynchronous client for Coolify S3 storages.

Ancestors

• coolipy._base.AsyncResourceBase

Methods

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

Expand source code

async def create(self, model: S3StorageCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
    """Create an S3 storage."""
    return await self._post("/s3-storages", json=_dump(model), response_model=UUIDResponse)

Create an S3 storage.

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

Expand source code

async def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete an S3 storage by UUID."""
    return await self._delete(f"/s3-storages/{uuid}", response_model=MessageResponse)

Delete an S3 storage by UUID.

async def get(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[S3StorageModel]

Expand source code

async def get(self, uuid: str) -> CoolipyAPIResponse[S3StorageModel]:
    """Get an S3 storage by UUID."""
    return await self._get(f"/s3-storages/{uuid}", response_model=S3StorageModel)

Get an S3 storage by UUID.

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

Expand source code

async def list(self) -> CoolipyAPIResponse[S3StorageList]:
    """List all S3 storages."""
    return await self._get("/s3-storages", response_model=list[S3StorageModel])

List all S3 storages.

async def update(self, uuid: str, model: S3StorageUpdateModel) ‑> coolipy._response.CoolipyAPIResponse[S3StorageModel]

Expand source code

async def update(
    self, uuid: str, model: S3StorageUpdateModel
) -> CoolipyAPIResponse[S3StorageModel]:
    """Update an S3 storage by UUID."""
    return await self._patch(
        f"/s3-storages/{uuid}", json=_dump(model), response_model=S3StorageModel
    )

Update an S3 storage by UUID.

async def validate(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[typing.Any]

Expand source code

async def validate(self, uuid: str) -> CoolipyAPIResponse[Any]:
    """Validate an S3 storage by UUID."""
    return await self._post(f"/s3-storages/{uuid}/validate")

Validate an S3 storage by UUID.

class S3Storages (transport: SyncTransport)

Expand source code

class S3Storages(ResourceBase):
    """Synchronous client for Coolify S3 storages."""

    def list(self) -> CoolipyAPIResponse[S3StorageList]:
        """List all S3 storages."""
        return self._get("/s3-storages", response_model=list[S3StorageModel])

    def get(self, uuid: str) -> CoolipyAPIResponse[S3StorageModel]:
        """Get an S3 storage by UUID."""
        return self._get(f"/s3-storages/{uuid}", response_model=S3StorageModel)

    def create(self, model: S3StorageCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
        """Create an S3 storage."""
        return self._post("/s3-storages", json=_dump(model), response_model=UUIDResponse)

    def update(self, uuid: str, model: S3StorageUpdateModel) -> CoolipyAPIResponse[S3StorageModel]:
        """Update an S3 storage by UUID."""
        return self._patch(f"/s3-storages/{uuid}", json=_dump(model), response_model=S3StorageModel)

    def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete an S3 storage by UUID."""
        return self._delete(f"/s3-storages/{uuid}", response_model=MessageResponse)

    def validate(self, uuid: str) -> CoolipyAPIResponse[Any]:
        """Validate an S3 storage by UUID."""
        return self._post(f"/s3-storages/{uuid}/validate")

Synchronous client for Coolify S3 storages.

Ancestors

• coolipy._base.ResourceBase

Methods

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

Expand source code

def create(self, model: S3StorageCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
    """Create an S3 storage."""
    return self._post("/s3-storages", json=_dump(model), response_model=UUIDResponse)

Create an S3 storage.

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

Expand source code

def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete an S3 storage by UUID."""
    return self._delete(f"/s3-storages/{uuid}", response_model=MessageResponse)

Delete an S3 storage by UUID.

def get(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[S3StorageModel]

Expand source code

def get(self, uuid: str) -> CoolipyAPIResponse[S3StorageModel]:
    """Get an S3 storage by UUID."""
    return self._get(f"/s3-storages/{uuid}", response_model=S3StorageModel)

Get an S3 storage by UUID.

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

Expand source code

def list(self) -> CoolipyAPIResponse[S3StorageList]:
    """List all S3 storages."""
    return self._get("/s3-storages", response_model=list[S3StorageModel])

List all S3 storages.

def update(self, uuid: str, model: S3StorageUpdateModel) ‑> coolipy._response.CoolipyAPIResponse[S3StorageModel]

Expand source code

def update(self, uuid: str, model: S3StorageUpdateModel) -> CoolipyAPIResponse[S3StorageModel]:
    """Update an S3 storage by UUID."""
    return self._patch(f"/s3-storages/{uuid}", json=_dump(model), response_model=S3StorageModel)

Update an S3 storage by UUID.

def validate(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[typing.Any]

Expand source code

def validate(self, uuid: str) -> CoolipyAPIResponse[Any]:
    """Validate an S3 storage by UUID."""
    return self._post(f"/s3-storages/{uuid}/validate")

Validate an S3 storage by UUID.