From 71117376b610d01b0083b09111d19f4be1d44f80 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sun, 26 Jun 2022 15:29:39 +0000 Subject: Deploying to docs from @ python-discord/bot-core@e00696e8996686686496edfbca51200afe951aee 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/botcore.site_api.html | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) (limited to 'main/output/botcore.site_api.html') diff --git a/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 03b1d8e4..49514d7f 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -10,9 +10,9 @@ + - @@ -204,6 +204,14 @@ main +
  • + v7.1.3 +
    • + +
  • + v7.1.2 +
    • +
  • v7.1.1
    • @@ -266,12 +274,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
    @@ -285,7 +293,7 @@
    -async close()[source]#
    +async close()[source]#

    Close the aiohttp session.

    Return type
    @@ -295,7 +303,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
    @@ -315,7 +323,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
    @@ -325,7 +333,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
    @@ -344,7 +352,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
    @@ -354,7 +362,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
    @@ -364,7 +372,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
    @@ -374,7 +382,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
    @@ -399,12 +407,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
    @@ -418,7 +426,7 @@
    -__str__()[source]#
    +__str__()[source]#

    Return a string representation of the error.

    -- cgit v1.2.3