From 7a1270a3782f04548c8c9527006cd1ae6a04b51b Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sat, 23 Jul 2022 15:20:09 +0000 Subject: Deploying to docs from @ python-discord/bot-core@94c4b408f1afa604ae6907aa28ab694870af20f2 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/botcore.site_api.html | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 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 9252f0ea..71182234 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -3,7 +3,7 @@ - + site_api - Bot Core Latest (7.5.0) @@ -183,6 +183,7 @@

Other:

@@ -309,12 +310,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:
@@ -329,7 +330,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type:
@@ -340,7 +341,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:
@@ -361,7 +362,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:
@@ -372,7 +373,7 @@
-async static maybe_raise_for_status(response, should_raise)[source]#
+async static maybe_raise_for_status(response, should_raise)[source]#

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

Parameters:
@@ -392,7 +393,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:
@@ -403,7 +404,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:
@@ -414,7 +415,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:
@@ -425,7 +426,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:
@@ -452,12 +453,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:
@@ -472,7 +473,7 @@
-__str__()[source]#
+__str__()[source]#

Return a string representation of the error.

@@ -485,12 +486,12 @@