From 6534be809997f0b31ec7db0306ba0570c79c816c Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 2 Apr 2022 19:13:10 +0000 Subject: Deploying to docs from @ python-discord/bot-core@765284a5e436f7786619a5ba4c312d75df5e9dee 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- output/botcore.site_api.html | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'output/botcore.site_api.html') diff --git a/output/botcore.site_api.html b/output/botcore.site_api.html index 36f452b2..c972c941 100644 --- a/output/botcore.site_api.html +++ b/output/botcore.site_api.html @@ -3,7 +3,7 @@ - + site_api - Bot Core v4.0.0 @@ -163,13 +163,13 @@
  • Utils
    • +
  • async_stats
  • site_api
    • @@ -214,12 +214,12 @@

    An API wrapper around the Site API.

    -class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
    +class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#

    Bases: object

    A wrapper for the Django Site API.

    -__init__(site_api_url, site_api_token, **session_kwargs)[source]#
    +__init__(site_api_url, site_api_token, **session_kwargs)[source]#

    Initialize a new APIClient instance.

    Parameters
    @@ -233,7 +233,7 @@
    -async close()[source]#
    +async close()[source]#

    Close the aiohttp session.

    Return type
    @@ -243,7 +243,7 @@
    -async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Send a DELETE request to the site API and return the JSON response.

    Parameters
    @@ -263,7 +263,7 @@
    -async get(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with GET passed as the method.

    Return type
    @@ -273,7 +273,7 @@
    -async maybe_raise_for_status(response, should_raise)[source]#
    +async maybe_raise_for_status(response, should_raise)[source]#

    Raise ResponseCodeError for non-OK response if an exception should be raised.

    Parameters
    @@ -292,7 +292,7 @@
    -async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with PATCH passed as the method.

    Return type
    @@ -302,7 +302,7 @@
    -async post(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with POST passed as the method.

    Return type
    @@ -312,7 +312,7 @@
    -async put(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

    Equivalent to APIClient.request() with PUT passed as the method.

    Return type
    @@ -322,7 +322,7 @@
    -async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#
    +async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

    Send an HTTP request to the site API and return the JSON response.

    Parameters
    @@ -347,12 +347,12 @@
    -exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
    +exception ResponseCodeError(response, response_json=None, response_text=None)[source]#

    Bases: ValueError

    Raised in APIClient.request() when a non-OK HTTP response is received.

    -__init__(response, response_json=None, response_text=None)[source]#
    +__init__(response, response_json=None, response_text=None)[source]#

    Initialize a new ResponseCodeError instance.

    Parameters
    @@ -366,7 +366,7 @@
    -__str__()[source]#
    +__str__()[source]#

    Return a string representation of the error.

    @@ -378,14 +378,14 @@
    - +
    Previous
    -
    scheduling
    +
    async_stats
     -- cgit v1.2.3