Http

Table of Contents

• syncopate.http
  • HTTPClient
    • close
    • get
    • post
    • patch
    • delete

syncopate.http

aiohttp-based HTTP client for the Syncopate REST API.

HTTPClient Objects

class HTTPClient()

HTTP client for the Syncopate REST API.

Handles Bot token authentication, JSON serialization, and error mapping to :class:HTTPError.

close

async def close() -> None

Close the underlying HTTP session.

get

async def get(path: str,
              *,
              params: dict[str, str] | None = None) -> dict[str, Any]

Make a GET request.

post

async def post(path: str,
               *,
               json: dict[str, object] | None = None,
               extra_headers: dict[str, str] | None = None) -> dict[str, Any]

Make a POST request.

patch

async def patch(path: str,
                *,
                json: dict[str, object] | None = None) -> dict[str, Any]

Make a PATCH request.

delete

async def delete(path: str) -> None

Make a DELETE request.