mirror
/
Rapptz.discord.py
mirror of https://github.com/Rapptz/discord.py
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4780 Commits
17 Branches
80 Tags
121 MiB
 
Tree: cc152c0892
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cc152c0892'
${ noResults }
Rapptz.discord.py/discord/http.py

4700 lines
184 KiB
Raw Blame History

"""
The MIT License (MIT)
Copyright (c) 2015-present Rapptz
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
from __future__ import annotations
import asyncio
import logging
from random import choice, choices
import ssl
import string
from typing import (
Any,
Callable,
ClassVar,
Coroutine,
Dict,
Iterable,
List,
Literal,
Mapping,
NamedTuple,
Optional,
overload,
Sequence,
TYPE_CHECKING,
Type,
TypeVar,
Union,
)
from urllib.parse import quote as _uriquote
from collections import deque
import datetime
import aiohttp
from .enums import RelationshipAction, InviteType
from .errors import (
HTTPException,
RateLimited,
Forbidden,
NotFound,
LoginFailure,
DiscordServerError,
GatewayNotFound,
CaptchaRequired,
)
from .file import _FileBase, File
from .tracking import ContextProperties
from . import utils
from .mentions import AllowedMentions
from .utils import MISSING
if TYPE_CHECKING:
from typing_extensions import Self
from .channel import TextChannel, DMChannel, GroupChannel, PartialMessageable, VoiceChannel, ForumChannel
from .handlers import CaptchaHandler
from .threads import Thread
from .mentions import AllowedMentions
from .message import Attachment, Message
from .flags import MessageFlags
from .enums import ChannelType, InteractionType
from .embeds import Embed
from .types import (
application,
audit_log,
automod,
billing,
channel,
emoji,
entitlements,
experiment,
guild,
integration,
invite,
library,
member,
message,
oauth2,
payments,
profile,
promotions,
read_state,
template,
role,
user,
webhook,
widget,
team,
threads,
scheduled_event,
store,
subscriptions,
sticker,
welcome_screen,
)
from .types.snowflake import Snowflake, SnowflakeList
from types import TracebackType
T = TypeVar('T')
BE = TypeVar('BE', bound=BaseException)
Response = Coroutine[Any, Any, T]
MessageableChannel = Union[TextChannel, Thread, DMChannel, GroupChannel, PartialMessageable, VoiceChannel, ForumChannel]
INTERNAL_API_VERSION = 9
CIPHERS = (
'TLS_GREASE_5A',
'TLS_AES_128_GCM_SHA256',
'TLS_AES_256_GCM_SHA384',
'TLS_CHACHA20_POLY1305_SHA256',
'ECDHE-ECDSA-AES128-GCM-SHA256',
'ECDHE-RSA-AES128-GCM-SHA256',
'ECDHE-ECDSA-AES256-GCM-SHA384',
'ECDHE-RSA-AES256-GCM-SHA384',
'ECDHE-ECDSA-CHACHA20-POLY1305',
'ECDHE-RSA-CHACHA20-POLY1305',
'ECDHE-RSA-AES128-SHA',
'ECDHE-RSA-AES256-SHA',
'AES128-GCM-SHA256',
'AES256-GCM-SHA384',
'AES128-SHA',
'AES256-SHA',
)
_log = logging.getLogger(__name__)
async def json_or_text(response: aiohttp.ClientResponse) -> Union[Dict[str, Any], str]:
text = await response.text(encoding='utf-8')
try:
if response.headers['content-type'] == 'application/json':
return utils._from_json(text)
except KeyError:
# Thanks Cloudflare
pass
return text
async def _gen_session(session: Optional[aiohttp.ClientSession]) -> aiohttp.ClientSession:
connector = None
if session:
connector = session.connector
original = getattr(connector, '_ssl', None)
if isinstance(original, ssl.SSLContext):
ctx = original
else:
ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
if session is not None and original is not None:
if isinstance(original, bool) and not original:
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE
elif isinstance(original, aiohttp.Fingerprint):
return session # Cannot continue
ctx.minimum_version = ssl.TLSVersion.TLSv1_2
ctx.maximum_version = ssl.TLSVersion.TLSv1_3
ctx.set_ciphers(':'.join(CIPHERS))
ctx.options |= ssl.OP_NO_SSLv2
ctx.options |= ssl.OP_NO_SSLv3
ctx.options |= ssl.OP_NO_COMPRESSION
ctx.set_ecdh_curve('prime256v1')
if connector is not None:
connector._ssl = ctx # type: ignore # Private attribute assignment
else:
connector = aiohttp.TCPConnector(limit=0, ssl=ctx)
if session is not None:
session._connector = connector
else:
session = aiohttp.ClientSession(connector=connector)
return session
class MultipartParameters(NamedTuple):
payload: Optional[Dict[str, Any]]
multipart: Optional[List[Dict[str, Any]]]
files: Optional[Sequence[File]]
def __enter__(self) -> Self:
return self
def __exit__(
self,
exc_type: Optional[Type[BE]],
exc: Optional[BE],
traceback: Optional[TracebackType],
) -> None:
if self.files:
for file in self.files:
file.close()
def handle_message_parameters(
content: Optional[str] = MISSING,
*,
username: str = MISSING,
avatar_url: Any = MISSING,
tts: bool = False,
nonce: Optional[Union[int, str]] = MISSING,
flags: MessageFlags = MISSING,
file: _FileBase = MISSING,
files: Sequence[_FileBase] = MISSING,
embed: Optional[Embed] = MISSING,
embeds: Sequence[Embed] = MISSING,
attachments: Sequence[Union[Attachment, _FileBase]] = MISSING,
allowed_mentions: Optional[AllowedMentions] = MISSING,
message_reference: Optional[message.MessageReference] = MISSING,
stickers: Optional[SnowflakeList] = MISSING,
previous_allowed_mentions: Optional[AllowedMentions] = None,
mention_author: Optional[bool] = None,
thread_name: str = MISSING,
channel_payload: Dict[str, Any] = MISSING,
) -> MultipartParameters:
if files is not MISSING and file is not MISSING:
raise TypeError('Cannot mix file and files keyword arguments.')
if embeds is not MISSING and embed is not MISSING:
raise TypeError('Cannot mix embed and embeds keyword arguments.')
if file is not MISSING:
files = [file]
if attachments is not MISSING and files is not MISSING:
raise TypeError('Cannot mix attachments and files keyword arguments.')
payload: Any = {'tts': tts}
if embeds is not MISSING:
if len(embeds) > 10:
raise ValueError('embeds has a maximum of 10 elements.')
payload['embeds'] = [e.to_dict() for e in embeds]
if embed is not MISSING:
if embed is None:
payload['embeds'] = []
else:
payload['embeds'] = [embed.to_dict()]
if content is not MISSING:
if content is not None:
payload['content'] = str(content)
else:
payload['content'] = None
if nonce is MISSING:
payload['nonce'] = utils._generate_nonce()
elif nonce:
payload['nonce'] = nonce
if message_reference is not MISSING:
payload['message_reference'] = message_reference
if stickers is not MISSING:
if stickers is not None:
payload['sticker_ids'] = stickers
else:
payload['sticker_ids'] = []
if avatar_url:
payload['avatar_url'] = str(avatar_url)
if username:
payload['username'] = username
if flags is not MISSING:
payload['flags'] = flags.value
if thread_name is not MISSING:
payload['thread_name'] = thread_name
if allowed_mentions:
if previous_allowed_mentions is not None:
payload['allowed_mentions'] = previous_allowed_mentions.merge(allowed_mentions).to_dict()
else:
payload['allowed_mentions'] = allowed_mentions.to_dict()
elif previous_allowed_mentions is not None:
payload['allowed_mentions'] = previous_allowed_mentions.to_dict()
if mention_author is not None:
if 'allowed_mentions' not in payload:
payload['allowed_mentions'] = AllowedMentions().to_dict()
payload['allowed_mentions']['replied_user'] = mention_author
if attachments is MISSING:
attachments = files
else:
files = [a for a in attachments if isinstance(a, _FileBase)]
if attachments is not MISSING:
file_index = 0
attachments_payload = []
for attachment in attachments:
if isinstance(attachment, _FileBase):
attachments_payload.append(attachment.to_dict(file_index))
file_index += 1
else:
attachments_payload.append(attachment.to_dict())
payload['attachments'] = attachments_payload
if channel_payload is not MISSING:
payload = {
'message': payload,
}
payload.update(channel_payload)
# Legacy uploading
multipart = []
to_upload = [file for file in files if isinstance(file, File)] if files else None
if to_upload:
multipart.append({'name': 'payload_json', 'value': utils._to_json(payload)})
payload = None
for index, file in enumerate(to_upload):
multipart.append(
{
'name': f'files[{index}]',
'value': file.fp,
'filename': file.filename,
'content_type': 'application/octet-stream',
}
)
return MultipartParameters(payload=payload, multipart=multipart, files=to_upload)
def _gen_accept_encoding_header():
return 'gzip, deflate, br' if aiohttp.http_parser.HAS_BROTLI else 'gzip, deflate' # type: ignore
class Route:
BASE: ClassVar[str] = f'https://discord.com/api/v{INTERNAL_API_VERSION}'
def __init__(self, method: str, path: str, *, metadata: Optional[str] = None, **parameters: Any) -> None:
self.path: str = path
self.method: str = method
# Metadata is a special string used to differentiate between known sub rate limits
# Since these can't be handled generically, this is the next best way to do so.
self.metadata: Optional[str] = metadata
url = self.BASE + self.path
if parameters:
url = url.format_map({k: _uriquote(v) if isinstance(v, str) else v for k, v in parameters.items()})
self.url: str = url
# Major parameters
self.channel_id: Optional[Snowflake] = parameters.get('channel_id')
self.guild_id: Optional[Snowflake] = parameters.get('guild_id')
self.webhook_id: Optional[Snowflake] = parameters.get('webhook_id')
self.webhook_token: Optional[str] = parameters.get('webhook_token')
@property
def key(self) -> str:
"""The bucket key is used to represent the route in various mappings."""
if self.metadata:
return f'{self.method} {self.path}:{self.metadata}'
return f'{self.method} {self.path}'
@property
def major_parameters(self) -> str:
"""Returns the major parameters formatted a string.
This needs to be appended to a bucket hash to constitute as a full rate limit key.
"""
return '+'.join(
str(k) for k in (self.channel_id, self.guild_id, self.webhook_id, self.webhook_token) if k is not None
)
class Ratelimit:
"""Represents a Discord rate limit.
This is similar to a semaphore except tailored to Discord's rate limits. This is aware of
the expiry of a token window, along with the number of tokens available. The goal of this
design is to increase throughput of requests being sent concurrently rather than forcing
everything into a single lock queue per route.
"""
__slots__ = (
'limit',
'remaining',
'outgoing',
'reset_after',
'expires',
'dirty',
'_last_request',
'_max_ratelimit_timeout',
'_loop',
'_pending_requests',
'_sleeping',
)
def __init__(self, max_ratelimit_timeout: Optional[float]) -> None:
self.limit: int = 1
self.remaining: int = self.limit
self.outgoing: int = 0
self.reset_after: float = 0.0
self.expires: Optional[float] = None
self.dirty: bool = False
self._max_ratelimit_timeout: Optional[float] = max_ratelimit_timeout
self._loop: asyncio.AbstractEventLoop = asyncio.get_running_loop()
self._pending_requests: deque[asyncio.Future[Any]] = deque()
# Only a single rate limit object should be sleeping at a time.
# The object that is sleeping is ultimately responsible for freeing the semaphore
# for the requests currently pending.
self._sleeping: asyncio.Lock = asyncio.Lock()
self._last_request: float = self._loop.time()
def __repr__(self) -> str:
return (
f'<RateLimitBucket limit={self.limit} remaining={self.remaining} pending_requests={len(self._pending_requests)}>'
)
def reset(self):
self.remaining = self.limit - self.outgoing
self.expires = None
self.reset_after = 0.0
self.dirty = False
def update(self, response: aiohttp.ClientResponse, *, use_clock: bool = False) -> None:
headers = response.headers
self.limit = int(headers.get('X-Ratelimit-Limit', 1))
if self.dirty:
self.remaining = min(int(headers.get('X-Ratelimit-Remaining', 0)), self.limit - self.outgoing)
else:
self.remaining = int(headers.get('X-Ratelimit-Remaining', 0))
self.dirty = True
reset_after = headers.get('X-Ratelimit-Reset-After')
if use_clock or not reset_after:
utc = datetime.timezone.utc
now = datetime.datetime.now(utc)
reset = datetime.datetime.fromtimestamp(float(headers['X-Ratelimit-Reset']), utc)
self.reset_after = (reset - now).total_seconds()
else:
self.reset_after = float(reset_after)
self.expires = self._loop.time() + self.reset_after
def _wake_next(self) -> None:
while self._pending_requests:
future = self._pending_requests.popleft()
if not future.done():
future.set_result(None)
break
def _wake(self, count: int = 1, *, exception: Optional[RateLimited] = None) -> None:
awaken = 0
while self._pending_requests:
future = self._pending_requests.popleft()
if not future.done():
if exception:
future.set_exception(exception)
else:
future.set_result(None)
awaken += 1
if awaken >= count:
break
async def _refresh(self) -> None:
error = self._max_ratelimit_timeout and self.reset_after > self._max_ratelimit_timeout
exception = RateLimited(self.reset_after) if error else None
async with self._sleeping:
if not error:
await asyncio.sleep(self.reset_after)
self.reset()
self._wake(self.remaining, exception=exception)
def is_expired(self) -> bool:
return self.expires is not None and self._loop.time() > self.expires
def is_inactive(self) -> bool:
delta = self._loop.time() - self._last_request
return delta >= 300 and self.outgoing == 0 and len(self._pending_requests) == 0
async def acquire(self) -> None:
self._last_request = self._loop.time()
if self.is_expired():
self.reset()
if self._max_ratelimit_timeout is not None and self.expires is not None:
# Check if we can pre-emptively block this request for having too large of a timeout
current_reset_after = self.expires - self._loop.time()
if current_reset_after > self._max_ratelimit_timeout:
raise RateLimited(current_reset_after)
while self.remaining <= 0:
future = self._loop.create_future()
self._pending_requests.append(future)
try:
await future
except:
future.cancel()
if self.remaining > 0 and not future.cancelled():
self._wake_next()
raise
self.remaining -= 1
self.outgoing += 1
async def __aenter__(self) -> Self:
await self.acquire()
return self
async def __aexit__(self, type: Type[BE], value: BE, traceback: TracebackType) -> None:
self.outgoing -= 1
tokens = self.remaining - self.outgoing
# Check whether the rate limit needs to be pre-emptively slept on
# Note that this is a Lock to prevent multiple rate limit objects from sleeping at once
if not self._sleeping.locked():
if tokens <= 0:
await self._refresh()
elif self._pending_requests:
exception = (
RateLimited(self.reset_after)
if self._max_ratelimit_timeout and self.reset_after > self._max_ratelimit_timeout
else None
)
self._wake(tokens, exception=exception)
# For some reason, the Discord voice websocket expects this header to be
# completely lowercase while aiohttp respects spec and does it as case-insensitive
aiohttp.hdrs.WEBSOCKET = 'websocket' # type: ignore
try:
# Support brotli if installed
aiohttp.client_reqrep.ClientRequest.DEFAULT_HEADERS[aiohttp.hdrs.ACCEPT_ENCODING] = _gen_accept_encoding_header() # type: ignore
except Exception:
# aiohttp does it for us on newer versions anyway
pass
class _FakeResponse:
def __init__(self, reason: str, status: int) -> None:
self.reason = reason
self.status = status
class HTTPClient:
"""Represents an HTTP client sending HTTP requests to the Discord API."""
def __init__(
self,
loop: asyncio.AbstractEventLoop,
connector: Optional[aiohttp.BaseConnector] = None,
*,
proxy: Optional[str] = None,
proxy_auth: Optional[aiohttp.BasicAuth] = None,
unsync_clock: bool = True,
http_trace: Optional[aiohttp.TraceConfig] = None,
captcha_handler: Optional[CaptchaHandler] = None,
max_ratelimit_timeout: Optional[float] = None,
locale: Callable[[], str] = lambda: 'en-US',
) -> None:
self.loop: asyncio.AbstractEventLoop = loop
self.connector: aiohttp.BaseConnector = connector or MISSING
self.__session: aiohttp.ClientSession = MISSING
# Route key -> Bucket hash
self._bucket_hashes: Dict[str, str] = {}
# Bucket Hash + Major Parameters -> Rate limit
# or
# Route key + Major Parameters -> Rate limit
# When the key is the latter, it is used for temporary
# one shot requests that don't have a bucket hash
# When this reaches 256 elements, it will try to evict based off of expiry
self._buckets: Dict[str, Ratelimit] = {}
self._global_over: asyncio.Event = MISSING
self.token: Optional[str] = None
self.ack_token: Optional[str] = None
self.proxy: Optional[str] = proxy
self.proxy_auth: Optional[aiohttp.BasicAuth] = proxy_auth
self.http_trace: Optional[aiohttp.TraceConfig] = http_trace
self.use_clock: bool = not unsync_clock
self.captcha_handler: Optional[CaptchaHandler] = captcha_handler
self.max_ratelimit_timeout: Optional[float] = max(30.0, max_ratelimit_timeout) if max_ratelimit_timeout else None
self.get_locale: Callable[[], str] = locale
self.super_properties: Dict[str, Any] = {}
self.encoded_super_properties: str = MISSING
self._started: bool = False
def __del__(self) -> None:
session = self.__session
if session:
try:
session.connector._close() # type: ignore # Handled below
except AttributeError:
pass
def clear(self) -> None:
if self.__session and self.__session.closed:
self.__session = MISSING
async def startup(self) -> None:
if self._started:
return
self._global_over = asyncio.Event()
self._global_over.set()
if self.connector is MISSING or self.connector.closed:
self.connector = aiohttp.TCPConnector(limit=0)
self.__session = session = await _gen_session(
aiohttp.ClientSession(
connector=self.connector, trace_configs=None if self.http_trace is None else [self.http_trace]
)
)
self.super_properties, self.encoded_super_properties = sp, _ = await utils._get_info(session)
_log.info('Found user agent %s, build number %s.', sp.get('browser_user_agent'), sp.get('client_build_number'))
if self.captcha_handler is not None:
await self.captcha_handler.startup()
self._started = True
async def ws_connect(self, url: str, *, compress: int = 0) -> aiohttp.ClientWebSocketResponse:
kwargs: Dict[str, Any] = {
'proxy_auth': self.proxy_auth,
'proxy': self.proxy,
'max_msg_size': 0,
'timeout': 30.0,
'autoclose': False,
'headers': {
'Accept-Language': 'en-US',
'Cache-Control': 'no-cache',
'Connection': 'Upgrade',
'Origin': 'https://discord.com',
'Pragma': 'no-cache',
'Sec-WebSocket-Extensions': 'permessage-deflate; client_max_window_bits',
'User-Agent': self.user_agent,
},
'compress': compress,
}
return await self.__session.ws_connect(url, **kwargs)
@property
def browser_version(self) -> str:
return self.super_properties['browser_version']
@property
def user_agent(self) -> str:
return self.super_properties['browser_user_agent']
def _try_clear_expired_ratelimits(self) -> None:
if len(self._buckets) < 256:
return
keys = [key for key, bucket in self._buckets.items() if bucket.is_inactive()]
for key in keys:
del self._buckets[key]
def get_ratelimit(self, key: str) -> Ratelimit:
try:
value = self._buckets[key]
except KeyError:
self._buckets[key] = value = Ratelimit(self.max_ratelimit_timeout)
self._try_clear_expired_ratelimits()
return value
async def request(
self,
route: Route,
*,
files: Optional[Sequence[File]] = None,
form: Optional[List[Dict[str, Any]]] = None,
**kwargs: Any,
) -> Any:
method = route.method
url = route.url
captcha_handler = self.captcha_handler
route_key = route.key
if not self._started:
await self.startup()
bucket_hash = None
try:
bucket_hash = self._bucket_hashes[route_key]
except KeyError:
key = f'{route_key}:{route.major_parameters}'
else:
key = f'{bucket_hash}:{route.major_parameters}'
ratelimit = self.get_ratelimit(key)
# Header creation
headers = {
'Accept-Language': 'en-US',
'Cache-Control': 'no-cache',
'Connection': 'keep-alive',
'Origin': 'https://discord.com',
'Pragma': 'no-cache',
'Referer': 'https://discord.com/channels/@me',
'Sec-CH-UA': '"Google Chrome";v="{0}", "Chromium";v="{0}", ";Not-A.Brand";v="24"'.format(
self.browser_version.split('.')[0]
),
'Sec-CH-UA-Mobile': '?0',
'Sec-CH-UA-Platform': '"Windows"',
'Sec-Fetch-Dest': 'empty',
'Sec-Fetch-Mode': 'cors',
'Sec-Fetch-Site': 'same-origin',
'User-Agent': self.user_agent,
'X-Discord-Locale': self.get_locale(),
'X-Debug-Options': 'bugReporterEnabled',
'X-Super-Properties': self.encoded_super_properties,
}
# This header isn't really necessary
# Timezones are annoying, so if it errors, we don't care
try:
from tzlocal import get_localzone_name
timezone = get_localzone_name()
except Exception:
pass
else:
if timezone:
headers['X-Discord-Timezone'] = timezone
if self.token is not None and kwargs.get('auth', True):
headers['Authorization'] = self.token
reason = kwargs.pop('reason', None)
if reason:
headers['X-Audit-Log-Reason'] = _uriquote(reason)
payload = kwargs.pop('json', None)
if payload is not None:
headers['Content-Type'] = 'application/json'
kwargs['data'] = utils._to_json(payload)
if 'context_properties' in kwargs:
props = kwargs.pop('context_properties')
if isinstance(props, ContextProperties):
headers['X-Context-Properties'] = props.value
if kwargs.pop('super_properties_to_track', False):
headers['X-Track'] = headers.pop('X-Super-Properties')
kwargs['headers'] = headers
# Proxy support
if self.proxy is not None:
kwargs['proxy'] = self.proxy
if self.proxy_auth is not None:
kwargs['proxy_auth'] = self.proxy_auth
if not self._global_over.is_set():
await self._global_over.wait()
response: Optional[aiohttp.ClientResponse] = None
data: Optional[Union[Dict[str, Any], str]] = None
failed = 0 # Number of 500'd requests
async with ratelimit:
for tries in range(5):
if files:
for f in files:
f.reset(seek=tries)
if form:
# With quote_fields=True '[' and ']' in file field names are escaped, which Discord does not support
form_data = aiohttp.FormData(quote_fields=False)
for params in form:
form_data.add_field(**params)
kwargs['data'] = form_data
if failed:
headers['X-Failed-Requests'] = str(failed)
try:
async with self.__session.request(method, url, **kwargs) as response:
_log.debug('%s %s with %s has returned %s.', method, url, kwargs.get('data'), response.status)
data = await json_or_text(response)
# Update and use rate limit information if the bucket header is present
discord_hash = response.headers.get('X-Ratelimit-Bucket')
# I am unsure if X-Ratelimit-Bucket is always available
# However, X-Ratelimit-Remaining has been a consistent cornerstone that worked
has_ratelimit_headers = 'X-Ratelimit-Remaining' in response.headers
if discord_hash is not None:
# If the hash Discord has provided is somehow different from our current hash something changed
if bucket_hash != discord_hash:
if bucket_hash is not None:
# If the previous hash was an actual Discord hash then this means the
# hash has changed sporadically.
# This can be due to two reasons
# 1. It's a sub-ratelimit which is hard to handle
# 2. The rate limit information genuinely changed
# There is no good way to discern these, Discord doesn't provide a way to do so.
# At best, there will be some form of logging to help catch it.
# Alternating sub-ratelimits means that the requests oscillate between
# different underlying rate limits -- this can lead to unexpected 429s
# It is unavoidable.
fmt = 'A route (%s) has changed hashes: %s -> %s.'
_log.debug(fmt, route_key, bucket_hash, discord_hash)
self._bucket_hashes[route_key] = discord_hash
recalculated_key = discord_hash + route.major_parameters
self._buckets[recalculated_key] = ratelimit
self._buckets.pop(key, None)
elif route_key not in self._bucket_hashes:
fmt = '%s has found its initial rate limit bucket hash (%s).'
_log.debug(fmt, route_key, discord_hash)
self._bucket_hashes[route_key] = discord_hash
self._buckets[discord_hash + route.major_parameters] = ratelimit
if has_ratelimit_headers:
if response.status != 429:
ratelimit.update(response, use_clock=self.use_clock)
if ratelimit.remaining == 0:
_log.debug(
'A rate limit bucket (%s) has been exhausted. Pre-emptively rate limiting...',
discord_hash or route_key,
)
# 202s must be retried
if response.status == 202 and isinstance(data, dict) and 'retry_after' in data:
# Sometimes retry_after is 0, but that's undesirable
retry_after: float = data['retry_after'] or 0.25
_log.debug('%s %s received a 202. Retrying in %s seconds...', method, url, retry_after)
await asyncio.sleep(retry_after)
continue
# Request was successful so just return the text/json
if 300 > response.status >= 200:
_log.debug('%s %s has received %s.', method, url, data)
return data
# Rate limited
if response.status == 429:
if not response.headers.get('Via') or isinstance(data, str):
# Banned by Cloudflare more than likely.
raise HTTPException(response, data)
if ratelimit.remaining > 0:
# According to night
# https://github.com/discord/discord-api-docs/issues/2190#issuecomment-816363129
# Remaining > 0 and 429 means that a sub ratelimit was hit.
# It is unclear what should happen in these cases other than just using the retry_after
# value in the body.
_log.debug(
'%s %s received a 429 despite having %s remaining requests. This is a sub-ratelimit.',
method,
url,
ratelimit.remaining,
)
retry_after: float = data['retry_after']
if self.max_ratelimit_timeout and retry_after > self.max_ratelimit_timeout:
_log.warning(
'We are being rate limited. %s %s responded with 429. Timeout of %.2f was too long, erroring instead.',
method,
url,
retry_after,
)
raise RateLimited(retry_after)
fmt = 'We are being rate limited. %s %s responded with 429. Retrying in %.2f seconds.'
_log.warning(fmt, method, url, retry_after)
_log.debug(
'Rate limit is being handled by bucket hash %s with %r major parameters.',
bucket_hash,
route.major_parameters,
)
# Check if it's a global rate limit
is_global = data.get('global', False)
if is_global:
_log.warning('Global rate limit has been hit. Retrying in %.2f seconds.', retry_after)
self._global_over.clear()
await asyncio.sleep(retry_after)
_log.debug('Done sleeping for the rate limit. Retrying...')
# Release the global lock now that the rate limit passed
if is_global:
self._global_over.set()
_log.debug('Global rate limit is now over.')
continue
# Unconditional retry
if response.status in {500, 502, 504, 507, 522, 523, 524}:
failed += 1
await asyncio.sleep(1 + tries * 2)
continue
# Usual error cases
if response.status == 403:
raise Forbidden(response, data)
elif response.status == 404:
raise NotFound(response, data)
elif response.status >= 500:
raise DiscordServerError(response, data)
else:
if isinstance(data, dict) and 'captcha_key' in data:
raise CaptchaRequired(response, data)
raise HTTPException(response, data)
# This is handling exceptions from the request
except OSError as e:
# Connection reset by peer
if tries < 4 and e.errno in (54, 10054):
failed += 1
await asyncio.sleep(1 + tries * 2)
continue
raise
# Captcha handling
except CaptchaRequired as e:
# The way captcha handling works is completely transparent
# The user is expected to provide a handler that will be called to return a solution
# Then, we just insert the solution + rqtoken (if applicable) into the headers and retry the request
if captcha_handler is None or tries == 4:
raise
else:
headers['X-Captcha-Key'] = await captcha_handler.fetch_token(e.json, self.proxy, self.proxy_auth)
rqtoken = e.json.get('captcha_rqtoken')
if rqtoken:
headers['X-Captcha-Rqtoken'] = rqtoken
if response is not None:
# We've run out of retries, raise
if response.status >= 500:
raise DiscordServerError(response, data)
raise HTTPException(response, data)
raise RuntimeError('Unreachable code in HTTP handling')
async def get_from_cdn(self, url: str) -> bytes:
async with self.__session.get(url) as resp:
if resp.status == 200:
return await resp.read()
elif resp.status == 404:
raise NotFound(resp, 'asset not found')
elif resp.status == 403:
raise Forbidden(resp, 'cannot retrieve asset')
else:
raise HTTPException(resp, 'failed to get asset')
raise RuntimeError('Unreachable code in HTTP handling')
async def upload_to_cloud(self, url: str, file: Union[File, str], hash: Optional[str] = None) -> Any:
response: Optional[aiohttp.ClientResponse] = None
data: Optional[Union[Dict[str, Any], str]] = None
# aiohttp helpfully sets the content type for us,
# but Google explodes if we do that; therefore, empty string
headers = {'Content-Type': ''}
if hash:
headers['Content-MD5'] = hash
for tries in range(5):
if isinstance(file, File):
file.reset(seek=tries)
try:
async with self.__session.put(url, data=getattr(file, 'fp', file), headers=headers) as response:
_log.debug('PUT %s with %s has returned %s.', url, file, response.status)
data = await json_or_text(response)
# Request was successful so just return the text/json
if 300 > response.status >= 200:
_log.debug('PUT %s has received %s.', url, data)
return data
# Unconditional retry
if response.status in {500, 502, 504}:
await asyncio.sleep(1 + tries * 2)
continue
# Usual error cases
if response.status == 403:
raise Forbidden(response, data)
elif response.status == 404:
raise NotFound(response, data)
elif response.status >= 500:
raise DiscordServerError(response, data)
else:
raise HTTPException(response, data)
except OSError as e:
# Connection reset by peer
if tries < 4 and e.errno in (54, 10054):
await asyncio.sleep(1 + tries * 2)
continue
raise
if response is not None:
# We've run out of retries, raise
if response.status >= 500:
raise DiscordServerError(response, data)
raise HTTPException(response, data)
# State management
async def close(self) -> None:
if self.__session:
await self.__session.close()
# Login management
def _token(self, token: str) -> None:
self.token = token
self.ack_token = None
async def static_login(self, token: str) -> user.User:
old_token, self.token = self.token, token
try:
data = await self.get_me()
except HTTPException as exc:
self.token = old_token
if exc.status == 401:
raise LoginFailure('Improper token has been passed') from exc
raise
return data
# Self user
def get_me(self, with_analytics_token: bool = True) -> Response[user.User]:
params = {'with_analytics_token': str(with_analytics_token).lower()}
return self.request(Route('GET', '/users/@me'), params=params)
def edit_profile(self, payload: Dict[str, Any]) -> Response[user.User]:
return self.request(Route('PATCH', '/users/@me'), json=payload)
def pomelo(self, username: str) -> Response[user.User]:
payload = {'username': username}
return self.request(Route('POST', '/users/@me/pomelo'), json=payload)
def pomelo_suggestion(self) -> Response[user.PomeloSuggestion]:
return self.request(Route('GET', '/users/@me/pomelo-suggestions'))
def pomelo_attempt(self, username: str) -> Response[user.PomeloAttempt]:
payload = {'username': username}
return self.request(Route('POST', '/users/@me/pomelo-attempt'), json=payload)
# PM functionality
def start_group(self, recipients: SnowflakeList) -> Response[channel.GroupDMChannel]:
payload = {
'recipients': recipients,
}
props = ContextProperties.from_new_group_dm() # New Group DM button
return self.request(Route('POST', '/users/@me/channels'), json=payload, context_properties=props)
def add_group_recipient(self, channel_id: Snowflake, user_id: Snowflake, nick: Optional[str] = None) -> Response[None]:
payload = None
if nick:
payload = {'nick': nick}
props = ContextProperties.from_add_friends_to_dm()
return self.request(
Route('PUT', '/channels/{channel_id}/recipients/{user_id}', channel_id=channel_id, user_id=user_id),
json=payload,
context_properties=props,
)
def remove_group_recipient(self, channel_id: Snowflake, user_id: Snowflake) -> Response[None]:
return self.request(
Route('DELETE', '/channels/{channel_id}/recipients/{user_id}', channel_id=channel_id, user_id=user_id)
)
def get_private_channels(self) -> Response[List[Union[channel.DMChannel, channel.GroupDMChannel]]]:
return self.request(Route('GET', '/users/@me/channels'))
def start_private_message(self, user_id: Snowflake) -> Response[channel.DMChannel]:
payload = {
'recipients': [user_id],
}
props = ContextProperties.empty() # {}
return self.request(Route('POST', '/users/@me/channels'), json=payload, context_properties=props)
def accept_message_request(self, channel_id: Snowflake) -> Response[channel.DMChannel]:
payload = {
'consent_status': 2,
}
return self.request(Route('PUT', '/channels/{channel_id}/recipients/@me', channel_id=channel_id), json=payload)
def decline_message_request(self, channel_id: Snowflake) -> Response[channel.DMChannel]:
return self.request(Route('DELETE', '/channels/{channel_id}/recipients/@me', channel_id=channel_id))
def mark_message_request(self, channel_id: Snowflake) -> Response[channel.DMChannel]:
payload = {
'consent_status': 1,
}
return self.request(Route('PUT', '/channels/{channel_id}/recipients/@me', channel_id=channel_id), json=payload)
def reset_message_request(self, channel_id: Snowflake) -> Response[channel.DMChannel]:
payload = {
'consent_status': 0,
}
return self.request(Route('PUT', '/channels/{channel_id}/recipients/@me', channel_id=channel_id), json=payload)
# Message management
def send_message(
self,
channel_id: Snowflake,
*,
params: MultipartParameters,
) -> Response[message.Message]:
r = Route('POST', '/channels/{channel_id}/messages', channel_id=channel_id)
if params.files:
return self.request(r, files=params.files, form=params.multipart)
else:
return self.request(r, json=params.payload)
def send_greet(
self,
channel_id: Snowflake,
sticker_id: Snowflake,
*,
allowed_mentions: Optional[AllowedMentions] = None,
message_reference: Optional[message.MessageReference] = None,
) -> Response[message.Message]:
payload: Dict[str, Any] = {'sticker_ids': [sticker_id]}
if allowed_mentions:
payload['allowed_mentions'] = allowed_mentions.to_dict()
if message_reference:
payload['message_reference'] = message_reference
return self.request(Route('POST', '/channels/{channel_id}/greet', channel_id=channel_id), json=payload)
def send_typing(self, channel_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/channels/{channel_id}/typing', channel_id=channel_id))
async def ack_message(
self,
channel_id: Snowflake,
message_id: Snowflake,
*,
manual: bool = False,
mention_count: Optional[int] = None,
flags: Optional[int] = None,
last_viewed: Optional[int] = None,
) -> None:
r = Route('POST', '/channels/{channel_id}/messages/{message_id}/ack', channel_id=channel_id, message_id=message_id)
payload = {}
if manual:
payload['manual'] = True
else:
payload['token'] = self.ack_token
if mention_count is not None:
payload['mention_count'] = mention_count
if flags is not None:
payload['flags'] = flags
if last_viewed is not None:
payload['last_viewed'] = last_viewed
data: read_state.AcknowledgementToken = await self.request(r, json=payload)
self.ack_token = data.get('token') if data else None
def ack_guild_feature(
self, guild_id: Snowflake, type: int, entity_id: Snowflake
) -> Response[read_state.AcknowledgementToken]:
return self.request(
Route('POST', '/guilds/{guild_id}/ack/{type}/{entity_id}', guild_id=guild_id, type=type, entity_id=entity_id),
json={},
)
def ack_user_feature(self, type: int, entity_id: Snowflake) -> Response[read_state.AcknowledgementToken]:
return self.request(Route('POST', '/users/@me/{type}/{entity_id}/ack', type=type, entity_id=entity_id), json={})
def ack_bulk(self, read_states: List[read_state.BulkReadState]) -> Response[None]:
payload = {'read_states': read_states}
return self.request(Route('POST', '/read-states/ack-bulk'), json=payload)
def ack_guild(self, guild_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/guilds/{guild_id}/ack', guild_id=guild_id))
def delete_read_state(self, channel_id: Snowflake, type: int) -> Response[None]:
payload = {'version': 2, 'read_state_type': type} # Read state protocol version 2
return self.request(Route('DELETE', '/channels/{channel_id}/messages/ack', channel_id=channel_id), json=payload)
def delete_message(
self, channel_id: Snowflake, message_id: Snowflake, *, reason: Optional[str] = None
) -> Response[None]:
# Special case certain sub-rate limits
# https://github.com/discord/discord-api-docs/issues/1092
# https://github.com/discord/discord-api-docs/issues/1295
difference = utils.utcnow() - utils.snowflake_time(int(message_id))
metadata: Optional[str] = None
if difference <= datetime.timedelta(seconds=10):
metadata = 'sub-10-seconds'
elif difference >= datetime.timedelta(days=14):
metadata = 'older-than-two-weeks'
r = Route(
'DELETE',
'/channels/{channel_id}/messages/{message_id}',
channel_id=channel_id,
message_id=message_id,
metadata=metadata,
)
return self.request(r, reason=reason)
def edit_message(
self, channel_id: Snowflake, message_id: Snowflake, *, params: MultipartParameters
) -> Response[message.Message]:
r = Route('PATCH', '/channels/{channel_id}/messages/{message_id}', channel_id=channel_id, message_id=message_id)
if params.files:
return self.request(r, files=params.files, form=params.multipart)
else:
return self.request(r, json=params.payload)
def add_reaction(self, channel_id: Snowflake, message_id: Snowflake, emoji: str) -> Response[None]:
r = Route(
'PUT',
'/channels/{channel_id}/messages/{message_id}/reactions/{emoji}/@me',
channel_id=channel_id,
message_id=message_id,
emoji=emoji,
)
return self.request(r)
def remove_reaction(
self, channel_id: Snowflake, message_id: Snowflake, emoji: str, member_id: Snowflake
) -> Response[None]:
r = Route(
'DELETE',
'/channels/{channel_id}/messages/{message_id}/reactions/{emoji}/{member_id}',
channel_id=channel_id,
message_id=message_id,
member_id=member_id,
emoji=emoji,
)
return self.request(r)
def remove_own_reaction(self, channel_id: Snowflake, message_id: Snowflake, emoji: str) -> Response[None]:
r = Route(
'DELETE',
'/channels/{channel_id}/messages/{message_id}/reactions/{emoji}/@me',
channel_id=channel_id,
message_id=message_id,
emoji=emoji,
)
return self.request(r)
def get_reaction_users(
self,
channel_id: Snowflake,
message_id: Snowflake,
emoji: str,
limit: int,
after: Optional[Snowflake] = None,
) -> Response[List[user.User]]:
r = Route(
'GET',
'/channels/{channel_id}/messages/{message_id}/reactions/{emoji}',
channel_id=channel_id,
message_id=message_id,
emoji=emoji,
)
params: Dict[str, Any] = {
'limit': limit,
}
if after:
params['after'] = after
return self.request(r, params=params)
def clear_reactions(self, channel_id: Snowflake, message_id: Snowflake) -> Response[None]:
r = Route(
'DELETE',
'/channels/{channel_id}/messages/{message_id}/reactions',
channel_id=channel_id,
message_id=message_id,
)
return self.request(r)
def clear_single_reaction(self, channel_id: Snowflake, message_id: Snowflake, emoji: str) -> Response[None]:
r = Route(
'DELETE',
'/channels/{channel_id}/messages/{message_id}/reactions/{emoji}',
channel_id=channel_id,
message_id=message_id,
emoji=emoji,
)
return self.request(r)
async def get_message(self, channel_id: Snowflake, message_id: Snowflake) -> message.Message:
data = await self.logs_from(channel_id, 1, around=message_id)
try:
msg = data[0]
except IndexError:
raise NotFound(_FakeResponse('Not Found', 404), 'message not found') # type: ignore # _FakeResponse is not a real response
if int(msg['id']) != message_id:
raise NotFound(_FakeResponse('Not Found', 404), 'message not found') # type: ignore # _FakeResponse is not a real Response
return msg
def get_channel(self, channel_id: Snowflake) -> Response[channel.Channel]:
return self.request(Route('GET', '/channels/{channel_id}', channel_id=channel_id))
def logs_from(
self,
channel_id: Snowflake,
limit: int,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
around: Optional[Snowflake] = None,
) -> Response[List[message.Message]]:
params: Dict[str, Any] = {
'limit': limit,
}
if before is not None:
params['before'] = before
if after is not None:
params['after'] = after
if around is not None:
params['around'] = around
return self.request(Route('GET', '/channels/{channel_id}/messages', channel_id=channel_id), params=params)
def search_guild(self, guild_id: Snowflake, payload: Dict[str, Any]) -> Response[message.MessageSearchResult]:
return self.request(Route('GET', '/guilds/{guild_id}/messages/search', guild_id=guild_id), params=payload)
def search_channel(self, channel_id: Snowflake, payload: Dict[str, Any]) -> Response[message.MessageSearchResult]:
return self.request(Route('GET', '/channels/{channel_id}/messages/search', channel_id=channel_id), params=payload)
def search_user(self, payload: Dict[str, Any]) -> Response[message.MessageSearchResult]:
return self.request(Route('GET', '/users/@me/messages/search'), json=payload)
def publish_message(self, channel_id: Snowflake, message_id: Snowflake) -> Response[message.Message]:
r = Route(
'POST',
'/channels/{channel_id}/messages/{message_id}/crosspost',
channel_id=channel_id,
message_id=message_id,
)
return self.request(r)
def pin_message(self, channel_id: Snowflake, message_id: Snowflake, reason: Optional[str] = None) -> Response[None]:
r = Route(
'PUT',
'/channels/{channel_id}/pins/{message_id}',
channel_id=channel_id,
message_id=message_id,
)
return self.request(r, reason=reason)
def unpin_message(self, channel_id: Snowflake, message_id: Snowflake, reason: Optional[str] = None) -> Response[None]:
r = Route(
'DELETE',
'/channels/{channel_id}/pins/{message_id}',
channel_id=channel_id,
message_id=message_id,
)
return self.request(r, reason=reason)
def pins_from(self, channel_id: Snowflake) -> Response[List[message.Message]]:
return self.request(Route('GET', '/channels/{channel_id}/pins', channel_id=channel_id))
def ack_pins(self, channel_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/channels/{channel_id}/pins/ack', channel_id=channel_id))
def get_attachment_urls(
self, channel_id: Snowflake, attachments: List[message.UploadedAttachment]
) -> Response[message.CloudAttachments]:
payload = {'files': attachments}
return self.request(Route('POST', '/channels/{channel_id}/attachments', channel_id=channel_id), json=payload)
def delete_attachment(self, uploaded_filename: str) -> Response[None]:
return self.request(Route('DELETE', '/attachments/{uploaded_filename}', uploaded_filename=uploaded_filename))
# Member management
def kick(self, user_id: Snowflake, guild_id: Snowflake, reason: Optional[str] = None) -> Response[None]:
r = Route('DELETE', '/guilds/{guild_id}/members/{user_id}', guild_id=guild_id, user_id=user_id)
return self.request(r, reason=reason)
def ban(
self,
user_id: Snowflake,
guild_id: Snowflake,
delete_message_seconds: int = 86400, # one day
reason: Optional[str] = None,
) -> Response[None]:
r = Route('PUT', '/guilds/{guild_id}/bans/{user_id}', guild_id=guild_id, user_id=user_id)
payload = {
'delete_message_seconds': delete_message_seconds,
}
return self.request(r, json=payload, reason=reason)
def unban(self, user_id: Snowflake, guild_id: Snowflake, *, reason: Optional[str] = None) -> Response[None]:
r = Route('DELETE', '/guilds/{guild_id}/bans/{user_id}', guild_id=guild_id, user_id=user_id)
return self.request(r, reason=reason)
def guild_voice_state(
self,
user_id: Snowflake,
guild_id: Snowflake,
*,
mute: Optional[bool] = None,
deafen: Optional[bool] = None,
reason: Optional[str] = None,
) -> Response[member.Member]:
r = Route('PATCH', '/guilds/{guild_id}/members/{user_id}', guild_id=guild_id, user_id=user_id)
payload = {}
if mute is not None:
payload['mute'] = mute
if deafen is not None:
payload['deaf'] = deafen
return self.request(r, json=payload, reason=reason)
def edit_my_voice_state(self, guild_id: Snowflake, payload: Dict[str, Any]) -> Response[None]: # TODO: remove payload
r = Route('PATCH', '/guilds/{guild_id}/voice-states/@me', guild_id=guild_id)
return self.request(r, json=payload)
def edit_voice_state(
self, guild_id: Snowflake, user_id: Snowflake, payload: Dict[str, Any]
) -> Response[None]: # TODO: remove payload
r = Route('PATCH', '/guilds/{guild_id}/voice-states/{user_id}', guild_id=guild_id, user_id=user_id)
return self.request(r, json=payload)
def edit_me(
self,
guild_id: Snowflake,
*,
nick: Optional[str] = MISSING,
avatar: Optional[bytes] = MISSING,
reason: Optional[str] = None,
) -> Response[member.MemberWithUser]:
payload = {}
if nick is not MISSING:
payload['nick'] = nick
if avatar is not MISSING:
r = Route('PATCH', '/guilds/{guild_id}/members/@me', guild_id=guild_id)
payload['avatar'] = avatar
else:
r = choice(
(
Route('PATCH', '/guilds/{guild_id}/members/@me/nick', guild_id=guild_id),
Route('PATCH', '/guilds/{guild_id}/members/@me', guild_id=guild_id),
)
)
return self.request(r, json=payload, reason=reason)
def edit_member(
self,
guild_id: Snowflake,
user_id: Snowflake,
*,
reason: Optional[str] = None,
**fields: Any, # TODO: Is this cheating
) -> Response[member.MemberWithUser]:
r = Route('PATCH', '/guilds/{guild_id}/members/{user_id}', guild_id=guild_id, user_id=user_id)
return self.request(r, json=fields, reason=reason)
# Channel management
def edit_channel(
self,
channel_id: Snowflake,
*,
reason: Optional[str] = None,
**options: Any, # TODO: Is this cheating
) -> Response[channel.Channel]:
r = Route('PATCH', '/channels/{channel_id}', channel_id=channel_id)
valid_keys = ( # TODO: Why is this being validated?
'name',
'parent_id',
'topic',
'bitrate',
'nsfw',
'user_limit',
'position',
'permission_overwrites',
'rate_limit_per_user',
'type',
'rtc_region',
'video_quality_mode',
'archived',
'auto_archive_duration',
'locked',
'invitable',
'default_auto_archive_duration',
'flags',
'icon',
'owner',
'default_thread_rate_limit_per_user',
'default_reaction_emoji',
'available_tags',
'applied_tags',
'default_forum_layout',
'default_sort_order',
)
payload = {k: v for k, v in options.items() if k in valid_keys}
return self.request(r, reason=reason, json=payload)
def bulk_channel_update(
self,
guild_id: Snowflake,
data: List[guild.ChannelPositionUpdate],
*,
reason: Optional[str] = None,
) -> Response[None]:
r = Route('PATCH', '/guilds/{guild_id}/channels', guild_id=guild_id)
return self.request(r, json=data, reason=reason)
def create_channel(
self,
guild_id: Snowflake,
channel_type: channel.ChannelType,
*,
reason: Optional[str] = None,
**options: Any, # TODO: Is this cheating
) -> Response[channel.GuildChannel]:
payload = { # TODO: WTF is happening here??
'type': channel_type,
}
valid_keys = (
'name',
'parent_id',
'topic',
'bitrate',
'nsfw',
'user_limit',
'position',
'permission_overwrites',
'rate_limit_per_user',
'rtc_region',
'video_quality_mode',
'default_auto_archive_duration',
'default_thread_rate_limit_per_user',
'default_sort_order',
'default_reaction_emoji',
'default_forum_layout',
'available_tags',
)
payload.update({k: v for k, v in options.items() if k in valid_keys and v is not None})
return self.request(Route('POST', '/guilds/{guild_id}/channels', guild_id=guild_id), json=payload, reason=reason)
def delete_channel(
self, channel_id: Snowflake, *, reason: Optional[str] = None, silent: bool = MISSING
) -> Response[channel.Channel]:
params = {}
if silent is not MISSING:
params['silent'] = str(silent).lower()
return self.request(Route('DELETE', '/channels/{channel_id}', channel_id=channel_id), params=params, reason=reason)
# Thread management
def start_thread_with_message(
self,
channel_id: Snowflake,
message_id: Snowflake,
*,
name: str,
auto_archive_duration: threads.ThreadArchiveDuration,
rate_limit_per_user: Optional[int] = None,
location: str = MISSING,
reason: Optional[str] = None,
) -> Response[threads.Thread]:
route = Route(
'POST', '/channels/{channel_id}/messages/{message_id}/threads', channel_id=channel_id, message_id=message_id
)
payload = {
'name': name,
'location': location if location is not MISSING else choice(('Message', 'Reply Chain Nudge')),
'auto_archive_duration': auto_archive_duration,
'type': 11,
}
if rate_limit_per_user is not None:
payload['rate_limit_per_user'] = rate_limit_per_user
return self.request(route, json=payload, reason=reason)
def start_thread_without_message(
self,
channel_id: Snowflake,
*,
name: str,
auto_archive_duration: threads.ThreadArchiveDuration,
type: threads.ThreadType,
invitable: bool = True,
rate_limit_per_user: Optional[int] = None,
reason: Optional[str] = None,
) -> Response[threads.Thread]:
r = Route('POST', '/channels/{channel_id}/threads', channel_id=channel_id)
payload = {
'auto_archive_duration': auto_archive_duration,
'location': choice(('Plus Button', 'Thread Browser Toolbar')),
'name': name,
'type': type,
}
if invitable is not MISSING:
payload['invitable'] = invitable
if rate_limit_per_user is not None:
payload['rate_limit_per_user'] = rate_limit_per_user
return self.request(r, json=payload, reason=reason)
def start_thread_in_forum(
self,
channel_id: Snowflake,
*,
params: MultipartParameters,
reason: Optional[str] = None,
) -> Response[threads.ForumThread]:
query = {'use_nested_fields': 1}
r = Route('POST', '/channels/{channel_id}/threads', channel_id=channel_id)
if params.files:
return self.request(r, files=params.files, form=params.multipart, params=query, reason=reason)
else:
return self.request(r, json=params.payload, params=query, reason=reason)
def join_thread(self, channel_id: Snowflake) -> Response[None]:
r = Route('POST', '/channels/{channel_id}/thread-members/@me', channel_id=channel_id)
params = {'location': choice(('Banner', 'Toolbar Overflow', 'Sidebar Overflow', 'Context Menu'))}
return self.request(r, params=params)
def add_user_to_thread(
self, channel_id: Snowflake, user_id: Snowflake
) -> Response[None]: # TODO: Find a way to test private thread stuff
r = Route('PUT', '/channels/{channel_id}/thread-members/{user_id}', channel_id=channel_id, user_id=user_id)
return self.request(r)
def leave_thread(self, channel_id: Snowflake) -> Response[None]:
r = Route('DELETE', '/channels/{channel_id}/thread-members/@me', channel_id=channel_id)
params = {'location': choice(('Toolbar Overflow', 'Context Menu', 'Sidebar Overflow'))}
return self.request(r, params=params)
def remove_user_from_thread(self, channel_id: Snowflake, user_id: Snowflake) -> Response[None]:
r = Route('DELETE', '/channels/{channel_id}/thread-members/{user_id}', channel_id=channel_id, user_id=user_id)
params = {'location': 'Context Menu'}
return self.request(r, params=params)
def get_public_archived_threads(
self, channel_id: Snowflake, before: Optional[Snowflake] = None, limit: int = 50
) -> Response[threads.ThreadPaginationPayload]:
route = Route('GET', '/channels/{channel_id}/threads/archived/public', channel_id=channel_id)
params = {}
if before:
params['before'] = before
if limit and limit != 50:
params['limit'] = limit
return self.request(route, params=params)
def get_private_archived_threads(
self, channel_id: Snowflake, before: Optional[Snowflake] = None, limit: int = 50
) -> Response[threads.ThreadPaginationPayload]:
route = Route('GET', '/channels/{channel_id}/threads/archived/private', channel_id=channel_id)
params = {}
if before:
params['before'] = before
if limit and limit != 50:
params['limit'] = limit
return self.request(route, params=params)
def get_joined_private_archived_threads(
self, channel_id: Snowflake, before: Optional[Snowflake] = None, limit: int = 50
) -> Response[threads.ThreadPaginationPayload]:
route = Route('GET', '/channels/{channel_id}/users/@me/threads/archived/private', channel_id=channel_id)
params = {}
if before:
params['before'] = before
if limit and limit != 50:
params['limit'] = limit
return self.request(route, params=params)
def create_forum_tag(
self,
channel_id: Snowflake,
*,
name: str,
emoji_id: Optional[Snowflake] = None,
emoji_name: Optional[str] = None,
moderated: bool = False,
reason: Optional[str] = None,
) -> Response[channel.ForumChannel]:
payload: Dict[str, Any] = {
'name': name,
}
if emoji_id:
payload['emoji_id'] = emoji_id
if emoji_name:
payload['emoji_name'] = emoji_name
if moderated:
payload['moderated'] = True
return self.request(Route('POST', '/channels/{channel_id}/tags', channel_id=channel_id), json=payload, reason=reason)
def edit_forum_tag(
self,
channel_id: Snowflake,
tag_id: Snowflake,
*,
name: str,
emoji_id: Optional[Snowflake] = None,
emoji_name: Optional[str] = None,
moderated: bool = False,
reason: Optional[str] = None,
) -> Response[channel.ForumChannel]:
payload: Dict[str, Any] = {
'name': name,
'emoji_id': emoji_id,
'emoji_name': emoji_name,
'moderated': moderated,
}
return self.request(
Route('PUT', '/channels/{channel_id}/tags/{tag_id}', channel_id=channel_id, tag_id=tag_id),
json=payload,
reason=reason,
)
def delete_forum_tag(self, channel_id: Snowflake, tag_id: Snowflake) -> Response[channel.ForumChannel]:
return self.request(Route('DELETE', '/channels/{channel_id}/tags/{tag_id}', channel_id=channel_id, tag_id=tag_id))
# Webhook management
def create_webhook(
self,
channel_id: Snowflake,
*,
name: str,
avatar: Optional[bytes] = None,
reason: Optional[str] = None,
) -> Response[webhook.Webhook]:
payload: Dict[str, Any] = {
'name': name,
}
if avatar is not None:
payload['avatar'] = avatar
r = Route('POST', '/channels/{channel_id}/webhooks', channel_id=channel_id)
return self.request(r, json=payload, reason=reason)
def channel_webhooks(self, channel_id: Snowflake) -> Response[List[webhook.Webhook]]:
return self.request(Route('GET', '/channels/{channel_id}/webhooks', channel_id=channel_id))
def guild_webhooks(self, guild_id: Snowflake) -> Response[List[webhook.Webhook]]:
return self.request(Route('GET', '/guilds/{guild_id}/webhooks', guild_id=guild_id))
def get_webhook(self, webhook_id: Snowflake) -> Response[webhook.Webhook]:
return self.request(Route('GET', '/webhooks/{webhook_id}', webhook_id=webhook_id))
def follow_webhook(
self,
channel_id: Snowflake,
webhook_channel_id: Snowflake,
reason: Optional[str] = None,
) -> Response[None]:
r = Route('POST', '/channels/{channel_id}/followers', channel_id=channel_id)
payload = {
'webhook_channel_id': str(webhook_channel_id),
}
return self.request(r, json=payload, reason=reason)
# Guild management
def get_guilds(self, with_counts: bool = True) -> Response[List[guild.UserGuild]]:
params = {'with_counts': str(with_counts).lower()}
return self.request(Route('GET', '/users/@me/guilds'), params=params, super_properties_to_track=True)
def join_guild(
self,
guild_id: Snowflake,
lurker: bool,
session_id: Optional[str] = MISSING,
load_id: str = MISSING,
location: str = MISSING,
) -> Response[guild.Guild]:
params = {
'lurker': str(lurker).lower(),
}
if lurker:
params['session_id'] = session_id or utils._generate_session_id()
if load_id is not MISSING:
params['recommendation_load_id'] = load_id
params['location'] = 'Guild%20Discovery'
if location is not MISSING:
params['location'] = location
props = ContextProperties.empty() if lurker else ContextProperties.from_lurking()
return self.request(
Route('PUT', '/guilds/{guild_id}/members/@me', guild_id=guild_id),
context_properties=props,
params=params,
json={},
)
def leave_guild(self, guild_id: Snowflake, lurking: bool = False) -> Response[None]:
r = Route('DELETE', '/users/@me/guilds/{guild_id}', guild_id=guild_id)
payload = {'lurking': lurking}
return self.request(r, json=payload)
def get_guild(self, guild_id: Snowflake, with_counts: bool = True) -> Response[guild.Guild]:
params = {'with_counts': str(with_counts).lower()}
return self.request(Route('GET', '/guilds/{guild_id}', guild_id=guild_id), params=params)
def get_guild_preview(self, guild_id: Snowflake) -> Response[guild.GuildPreview]:
return self.request(Route('GET', '/guilds/{guild_id}/preview', guild_id=guild_id))
def delete_guild(self, guild_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/guilds/{guild_id}/delete', guild_id=guild_id))
def create_guild(
self, name: str, icon: Optional[str] = None, *, template: str = '2TffvPucqHkN'
) -> Response[guild.Guild]:
payload = {
'name': name,
'icon': icon,
'system_channel_id': None,
'channels': [],
'guild_template_code': template, # API go brrr
}
return self.request(Route('POST', '/guilds'), json=payload)
def edit_guild(self, guild_id: Snowflake, *, reason: Optional[str] = None, **fields: Any) -> Response[guild.Guild]:
valid_keys = ( # TODO: is this necessary?
'name',
'icon',
'afk_timeout',
'owner_id',
'afk_channel_id',
'splash',
'discovery_splash',
'features',
'verification_level',
'system_channel_id',
'default_message_notifications',
'description',
'explicit_content_filter',
'banner',
'system_channel_flags',
'rules_channel_id',
'public_updates_channel_id',
'preferred_locale',
'premium_progress_bar_enabled',
)
payload = {k: v for k, v in fields.items() if k in valid_keys}
return self.request(Route('PATCH', '/guilds/{guild_id}', guild_id=guild_id), json=payload, reason=reason)
def edit_guild_mfa_level(
self, guild_id: Snowflake, *, mfa_level: int, reason: Optional[str] = None
) -> Response[guild.GuildMFALevel]:
payload = {'level': mfa_level}
return self.request(Route('POST', '/guilds/{guild_id}/mfa', guild_id=guild_id), json=payload, reason=reason)
def edit_guild_settings(self, guild_id: Snowflake, fields): # TODO: type
return self.request(Route('PATCH', '/users/@me/guilds/{guild_id}/settings', guild_id=guild_id), json=fields)
def get_template(self, code: str) -> Response[template.Template]:
return self.request(Route('GET', '/guilds/templates/{code}', code=code))
def guild_templates(self, guild_id: Snowflake) -> Response[List[template.Template]]:
return self.request(Route('GET', '/guilds/{guild_id}/templates', guild_id=guild_id))
def create_template(self, guild_id: Snowflake, payload: Dict[str, Any]) -> Response[template.Template]:
return self.request(Route('POST', '/guilds/{guild_id}/templates', guild_id=guild_id), json=payload)
def sync_template(self, guild_id: Snowflake, code: str) -> Response[template.Template]:
return self.request(Route('PUT', '/guilds/{guild_id}/templates/{code}', guild_id=guild_id, code=code))
def edit_template(self, guild_id: Snowflake, code: str, payload: Dict[str, Any]) -> Response[template.Template]:
valid_keys = (
'name',
'description',
)
payload = {k: v for k, v in payload.items() if k in valid_keys}
return self.request(
Route('PATCH', '/guilds/{guild_id}/templates/{code}', guild_id=guild_id, code=code), json=payload
)
def delete_template(self, guild_id: Snowflake, code: str) -> Response[None]:
return self.request(Route('DELETE', '/guilds/{guild_id}/templates/{code}', guild_id=guild_id, code=code))
def create_from_template(self, code: str, name: str, icon: Optional[str]) -> Response[guild.Guild]:
payload = {
'name': name,
'icon': icon,
}
return self.request(Route('POST', '/guilds/templates/{code}', code=code), json=payload)
def get_bans(
self,
guild_id: Snowflake,
limit: Optional[int] = None,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
) -> Response[List[guild.Ban]]:
params: Dict[str, Any] = {}
if limit is not None:
params['limit'] = limit
if before is not None:
params['before'] = before
if after is not None:
params['after'] = after
return self.request(Route('GET', '/guilds/{guild_id}/bans', guild_id=guild_id), params=params)
def get_ban(self, user_id: Snowflake, guild_id: Snowflake) -> Response[guild.Ban]:
return self.request(Route('GET', '/guilds/{guild_id}/bans/{user_id}', guild_id=guild_id, user_id=user_id))
def get_vanity_code(self, guild_id: Snowflake) -> Response[invite.VanityInvite]:
return self.request(Route('GET', '/guilds/{guild_id}/vanity-url', guild_id=guild_id))
def change_vanity_code(self, guild_id: Snowflake, code: str, *, reason: Optional[str] = None) -> Response[None]:
payload = {'code': code}
return self.request(Route('PATCH', '/guilds/{guild_id}/vanity-url', guild_id=guild_id), json=payload, reason=reason)
def get_all_guild_channels(self, guild_id: Snowflake) -> Response[List[guild.GuildChannel]]:
return self.request(Route('GET', '/guilds/{guild_id}/channels', guild_id=guild_id))
def get_top_guild_channels(self, guild_id: Snowflake) -> Response[List[Snowflake]]:
return self.request(Route('GET', '/guilds/{guild_id}/top-read-channels', guild_id=guild_id))
def get_member(self, guild_id: Snowflake, member_id: Snowflake) -> Response[member.MemberWithUser]:
return self.request(Route('GET', '/guilds/{guild_id}/members/{member_id}', guild_id=guild_id, member_id=member_id))
def prune_members(
self,
guild_id: Snowflake,
days: int,
compute_prune_count: bool,
roles: Iterable[str],
*,
reason: Optional[str] = None,
) -> Response[guild.GuildPrune]:
payload: Dict[str, Any] = {
'days': days,
'compute_prune_count': str(compute_prune_count).lower(),
}
if roles:
payload['include_roles'] = ', '.join(roles)
return self.request(Route('POST', '/guilds/{guild_id}/prune', guild_id=guild_id), json=payload, reason=reason)
def estimate_pruned_members(
self,
guild_id: Snowflake,
days: int,
roles: Iterable[str],
) -> Response[guild.GuildPrune]:
params: Dict[str, Any] = {
'days': days,
}
if roles:
params['include_roles'] = ', '.join(roles)
return self.request(Route('GET', '/guilds/{guild_id}/prune', guild_id=guild_id), params=params)
def get_sticker(self, sticker_id: Snowflake) -> Response[sticker.Sticker]:
return self.request(Route('GET', '/stickers/{sticker_id}', sticker_id=sticker_id))
def get_sticker_guild(self, sticker_id: Snowflake) -> Response[guild.Guild]:
return self.request(Route('GET', '/stickers/{sticker_id}/guild', sticker_id=sticker_id))
def list_premium_sticker_packs(
self, country: str = 'US', locale: str = 'en-US', payment_source_id: Optional[Snowflake] = None
) -> Response[sticker.ListPremiumStickerPacks]:
params: Dict[str, Snowflake] = {
'country_code': country,
'locale': locale,
}
if payment_source_id:
params['payment_source_id'] = payment_source_id
return self.request(Route('GET', '/sticker-packs'), params=params)
def get_sticker_pack(self, pack_id: Snowflake):
return self.request(Route('GET', '/sticker-packs/{pack_id}', pack_id=pack_id))
def get_all_guild_stickers(self, guild_id: Snowflake) -> Response[List[sticker.GuildSticker]]:
return self.request(Route('GET', '/guilds/{guild_id}/stickers', guild_id=guild_id))
def get_guild_sticker(self, guild_id: Snowflake, sticker_id: Snowflake) -> Response[sticker.GuildSticker]:
r = Route('GET', '/guilds/{guild_id}/stickers/{sticker_id}', guild_id=guild_id, sticker_id=sticker_id)
return self.request(r)
def create_guild_sticker(
self, guild_id: Snowflake, payload: Dict[str, Any], file: File, reason: Optional[str]
) -> Response[sticker.GuildSticker]:
initial_bytes = file.fp.read(16)
try:
mime_type = utils._get_mime_type_for_image(initial_bytes)
except ValueError:
if initial_bytes.startswith(b'{'):
mime_type = 'application/json'
else:
mime_type = 'application/octet-stream'
finally:
file.reset()
form: List[Dict[str, Any]] = [
{
'name': 'file',
'value': file.fp,
'filename': file.filename,
'content_type': mime_type,
}
]
for k, v in payload.items():
form.append(
{
'name': k,
'value': v,
}
)
return self.request(
Route('POST', '/guilds/{guild_id}/stickers', guild_id=guild_id), form=form, files=[file], reason=reason
)
def modify_guild_sticker(
self,
guild_id: Snowflake,
sticker_id: Snowflake,
payload: Dict[str, Any],
reason: Optional[str],
) -> Response[sticker.GuildSticker]:
return self.request(
Route('PATCH', '/guilds/{guild_id}/stickers/{sticker_id}', guild_id=guild_id, sticker_id=sticker_id),
json=payload,
reason=reason,
)
def delete_guild_sticker(self, guild_id: Snowflake, sticker_id: Snowflake, reason: Optional[str]) -> Response[None]:
return self.request(
Route('DELETE', '/guilds/{guild_id}/stickers/{sticker_id}', guild_id=guild_id, sticker_id=sticker_id),
reason=reason,
)
def get_all_custom_emojis(self, guild_id: Snowflake) -> Response[List[emoji.Emoji]]:
return self.request(Route('GET', '/guilds/{guild_id}/emojis', guild_id=guild_id))
def get_custom_emoji(self, guild_id: Snowflake, emoji_id: Snowflake) -> Response[emoji.Emoji]:
return self.request(Route('GET', '/guilds/{guild_id}/emojis/{emoji_id}', guild_id=guild_id, emoji_id=emoji_id))
def get_top_emojis(self, guild_id: Snowflake) -> Response[emoji.TopEmojis]:
return self.request(Route('GET', '/guilds/{guild_id}/top-emojis', guild_id=guild_id))
def get_emoji_guild(self, emoji_id: Snowflake) -> Response[guild.Guild]:
return self.request(Route('GET', '/emojis/{emoji_id}', emoji_id=emoji_id))
def create_custom_emoji(
self,
guild_id: Snowflake,
name: str,
image: str,
*,
roles: Optional[SnowflakeList] = None,
reason: Optional[str] = None,
) -> Response[emoji.Emoji]:
payload: Dict[str, Any] = {
'name': name,
'image': image,
}
if roles:
payload['roles'] = roles
r = Route('POST', '/guilds/{guild_id}/emojis', guild_id=guild_id)
return self.request(r, json=payload, reason=reason)
def delete_custom_emoji(
self,
guild_id: Snowflake,
emoji_id: Snowflake,
*,
reason: Optional[str] = None,
) -> Response[None]:
r = Route('DELETE', '/guilds/{guild_id}/emojis/{emoji_id}', guild_id=guild_id, emoji_id=emoji_id)
return self.request(r, reason=reason)
def edit_custom_emoji(
self,
guild_id: Snowflake,
emoji_id: Snowflake,
*,
payload: Dict[str, Any], # TODO: Is this cheating?
reason: Optional[str] = None,
) -> Response[emoji.Emoji]:
r = Route('PATCH', '/guilds/{guild_id}/emojis/{emoji_id}', guild_id=guild_id, emoji_id=emoji_id)
return self.request(r, json=payload, reason=reason)
def get_member_verification(
self, guild_id: Snowflake, *, with_guild: bool = False, invite: str = MISSING
): # TODO: return type
params = {
'with_guild': str(with_guild).lower(),
}
if invite is not MISSING:
params['invite_code'] = invite
return self.request(Route('GET', '/guilds/{guild_id}/member-verification', guild_id=guild_id), params=params)
def accept_member_verification(
self, guild_id: Snowflake, **payload
) -> Response[None]: # payload is the same as the above return type
return self.request(Route('PUT', '/guilds/{guild_id}/requests/@me', guild_id=guild_id), json=payload)
def get_all_integrations(
self,
guild_id: Snowflake,
*,
include_applications: bool = True,
include_role_connections_metadata: bool = False,
has_commands: bool = False,
) -> Response[List[integration.Integration]]:
params = {
'include_applications': str(include_applications).lower(),
}
if include_role_connections_metadata:
params['include_role_connections_metadata'] = 'true'
if has_commands:
params['has_commands'] = 'true'
return self.request(Route('GET', '/guilds/{guild_id}/integrations', guild_id=guild_id), params=params)
def create_integration(
self, guild_id: Snowflake, type: integration.IntegrationType, id: int, *, reason: Optional[str] = None
) -> Response[None]:
payload = {
'type': type,
'id': id,
}
return self.request(Route('POST', '/guilds/{guild_id}/integrations', guild_id=guild_id), json=payload, reason=reason)
def edit_integration(self, guild_id: Snowflake, integration_id: Snowflake, **payload: Any) -> Response[None]:
return self.request(
Route(
'PATCH', '/guilds/{guild_id}/integrations/{integration_id}', guild_id=guild_id, integration_id=integration_id
),
json=payload,
)
def sync_integration(self, guild_id: Snowflake, integration_id: Snowflake) -> Response[None]:
return self.request(
Route(
'POST',
'/guilds/{guild_id}/integrations/{integration_id}/sync',
guild_id=guild_id,
integration_id=integration_id,
)
)
def delete_integration(
self, guild_id: Snowflake, integration_id: Snowflake, *, reason: Optional[str] = None
) -> Response[None]:
r = Route(
'DELETE', '/guilds/{guild_id}/integrations/{integration_id}', guild_id=guild_id, integration_id=integration_id
)
return self.request(r, reason=reason)
def get_audit_logs(
self,
guild_id: Snowflake,
limit: int = 100,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
user_id: Optional[Snowflake] = None,
action_type: Optional[audit_log.AuditLogEvent] = None,
) -> Response[audit_log.AuditLog]:
r = Route('GET', '/guilds/{guild_id}/audit-logs', guild_id=guild_id)
params: Dict[str, Any] = {'limit': limit}
if before:
params['before'] = before
if after is not None:
params['after'] = after
if user_id:
params['user_id'] = user_id
if action_type:
params['action_type'] = action_type
return self.request(r, params=params)
def get_widget(self, guild_id: Snowflake) -> Response[widget.Widget]:
return self.request(Route('GET', '/guilds/{guild_id}/widget.json', guild_id=guild_id))
def edit_widget(
self, guild_id: Snowflake, payload: widget.EditWidgetSettings, reason: Optional[str] = None
) -> Response[widget.WidgetSettings]:
return self.request(Route('PATCH', '/guilds/{guild_id}/widget', guild_id=guild_id), json=payload, reason=reason)
def get_welcome_screen(self, guild_id: Snowflake) -> Response[welcome_screen.WelcomeScreen]:
return self.request(Route('GET', '/guilds/{guild_id}/welcome-screen', guild_id=guild_id))
def edit_welcome_screen(
self, guild_id: Snowflake, payload: dict, reason: Optional[str] = None
) -> Response[welcome_screen.WelcomeScreen]:
return self.request(
Route('PATCH', '/guilds/{guild_id}/welcome-screen', guild_id=guild_id), json=payload, reason=reason
)
# Invite management
def accept_invite(
self,
invite_id: str,
type: InviteType,
session_id: Optional[str] = None,
*,
guild_id: Snowflake = MISSING,
channel_id: Snowflake = MISSING,
channel_type: ChannelType = MISSING,
message: Optional[Message] = None,
): # TODO: response type
if message: # Invite Button Embed
props = ContextProperties.from_invite_button_embed(
guild_id=getattr(message.guild, 'id', None),
channel_id=message.channel.id,
channel_type=getattr(message.channel, 'type', None),
message_id=message.id,
)
elif type is InviteType.guild or type is InviteType.group_dm: # Join Guild, Accept Invite Page
props = choice(
(
ContextProperties.from_accept_invite_page,
ContextProperties.from_join_guild,
)
)(guild_id=guild_id, channel_id=channel_id, channel_type=channel_type)
else: # Accept Invite Page
props = ContextProperties.from_accept_invite_page(
guild_id=guild_id, channel_id=channel_id, channel_type=channel_type
)
payload = {}
if session_id is not None:
payload['session_id'] = session_id
return self.request(
Route('POST', '/invites/{invite_id}', invite_id=invite_id), context_properties=props, json=payload
)
def create_invite(
self,
channel_id: Snowflake,
*,
reason: Optional[str] = None,
max_age: int = 0,
max_uses: int = 0,
temporary: bool = False,
unique: bool = True,
validate: Optional[str] = None,
target_type: Optional[invite.InviteTargetType] = None,
target_user_id: Optional[Snowflake] = None,
target_application_id: Optional[Snowflake] = None,
) -> Response[invite.Invite]:
payload = {
'max_age': max_age,
'max_uses': max_uses,
'target_type': target_type,
'temporary': temporary,
'validate': validate,
}
if unique:
payload['unique'] = unique
if target_user_id:
payload['target_user_id'] = target_user_id
if target_application_id:
payload['target_application_id'] = str(target_application_id)
props = choice(
(
ContextProperties.from_guild_header,
ContextProperties.from_context_menu,
)
)()
return self.request(
Route('POST', '/channels/{channel_id}/invites', channel_id=channel_id),
reason=reason,
json=payload,
context_properties=props,
)
def create_group_invite(self, channel_id: Snowflake, *, max_age: int = 86400) -> Response[invite.Invite]:
payload = {
'max_age': max_age,
}
props = ContextProperties.from_group_dm_invite_create()
return self.request(
Route('POST', '/channels/{channel_id}/invites', channel_id=channel_id), json=payload, context_properties=props
)
def create_friend_invite(self) -> Response[invite.Invite]:
return self.request(Route('POST', '/users/@me/invites'), json={}, context_properties=ContextProperties.empty())
def get_invite(
self,
invite_id: str,
*,
with_counts: bool = True,
with_expiration: bool = True,
guild_scheduled_event_id: Optional[Snowflake] = None,
input_value: Optional[str] = None,
) -> Response[invite.Invite]:
params: Dict[str, Any] = {
'with_counts': str(with_counts).lower(),
'with_expiration': str(with_expiration).lower(),
}
if input_value:
params['inputValue'] = input_value
if guild_scheduled_event_id:
params['guild_scheduled_event_id'] = guild_scheduled_event_id
return self.request(Route('GET', '/invites/{invite_id}', invite_id=invite_id), params=params)
def invites_from(self, guild_id: Snowflake) -> Response[List[invite.Invite]]:
return self.request(Route('GET', '/guilds/{guild_id}/invites', guild_id=guild_id))
def invites_from_channel(self, channel_id: Snowflake) -> Response[List[invite.Invite]]:
return self.request(Route('GET', '/channels/{channel_id}/invites', channel_id=channel_id))
def get_friend_invites(self) -> Response[List[invite.Invite]]:
return self.request(Route('GET', '/users/@me/invites'), context_properties=ContextProperties.empty())
def delete_invite(self, invite_id: str, *, reason: Optional[str] = None) -> Response[invite.Invite]:
return self.request(Route('DELETE', '/invites/{invite_id}', invite_id=invite_id), reason=reason)
def delete_friend_invites(self) -> Response[List[invite.Invite]]:
return self.request(Route('DELETE', '/users/@me/invites'), context_properties=ContextProperties.empty())
# Role management
def get_roles(self, guild_id: Snowflake) -> Response[List[role.Role]]:
return self.request(Route('GET', '/guilds/{guild_id}/roles', guild_id=guild_id))
def edit_role(
self, guild_id: Snowflake, role_id: Snowflake, *, reason: Optional[str] = None, **fields: Any
) -> Response[role.Role]:
r = Route('PATCH', '/guilds/{guild_id}/roles/{role_id}', guild_id=guild_id, role_id=role_id)
valid_keys = ('name', 'permissions', 'color', 'hoist', 'icon', 'unicode_emoji', 'mentionable')
payload = {k: v for k, v in fields.items() if k in valid_keys}
return self.request(r, json=payload, reason=reason)
def delete_role(self, guild_id: Snowflake, role_id: Snowflake, *, reason: Optional[str] = None) -> Response[None]:
r = Route('DELETE', '/guilds/{guild_id}/roles/{role_id}', guild_id=guild_id, role_id=role_id)
return self.request(r, reason=reason)
def replace_roles(
self,
user_id: Snowflake,
guild_id: Snowflake,
role_ids: List[int],
*,
reason: Optional[str] = None,
) -> Response[member.MemberWithUser]:
return self.edit_member(guild_id=guild_id, user_id=user_id, roles=role_ids, reason=reason)
def create_role(self, guild_id: Snowflake, *, reason: Optional[str] = None, **fields: Any) -> Response[role.Role]:
r = Route('POST', '/guilds/{guild_id}/roles', guild_id=guild_id)
return self.request(r, json=fields, reason=reason)
def move_role_position(
self,
guild_id: Snowflake,
positions: List[guild.RolePositionUpdate],
*,
reason: Optional[str] = None,
) -> Response[List[role.Role]]:
r = Route('PATCH', '/guilds/{guild_id}/roles', guild_id=guild_id)
return self.request(r, json=positions, reason=reason)
def add_role(
self, guild_id: Snowflake, user_id: Snowflake, role_id: Snowflake, *, reason: Optional[str] = None
) -> Response[None]:
r = Route(
'PUT',
'/guilds/{guild_id}/members/{user_id}/roles/{role_id}',
guild_id=guild_id,
user_id=user_id,
role_id=role_id,
)
return self.request(r, reason=reason)
def remove_role(
self, guild_id: Snowflake, user_id: Snowflake, role_id: Snowflake, *, reason: Optional[str] = None
) -> Response[None]:
r = Route(
'DELETE',
'/guilds/{guild_id}/members/{user_id}/roles/{role_id}',
guild_id=guild_id,
user_id=user_id,
role_id=role_id,
)
return self.request(r, reason=reason)
def get_role_members(self, guild_id: Snowflake, role_id: Snowflake) -> Response[List[Snowflake]]:
return self.request(
Route('GET', '/guilds/{guild_id}/roles/{role_id}/member-ids', guild_id=guild_id, role_id=role_id)
)
def add_members_to_role(
self, guild_id: Snowflake, role_id: Snowflake, member_ids: Sequence[Snowflake], *, reason: Optional[str]
) -> Response[Dict[Snowflake, member.MemberWithUser]]:
payload = {'member_ids': member_ids}
return self.request(
Route('PATCH', '/guilds/{guild_id}/roles/{role_id}/members', guild_id=guild_id, role_id=role_id),
json=payload,
reason=reason,
)
def get_role_member_counts(self, guild_id: Snowflake) -> Response[Dict[Snowflake, int]]:
return self.request(Route('GET', '/guilds/{guild_id}/roles/member-counts', guild_id=guild_id))
def edit_channel_permissions(
self,
channel_id: Snowflake,
target: Snowflake,
allow: str,
deny: str,
type: channel.OverwriteType,
*,
reason: Optional[str] = None,
) -> Response[None]:
payload = {'id': target, 'allow': allow, 'deny': deny, 'type': type}
r = Route('PUT', '/channels/{channel_id}/permissions/{target}', channel_id=channel_id, target=target)
return self.request(r, json=payload, reason=reason)
def delete_channel_permissions(
self, channel_id: Snowflake, target: Snowflake, *, reason: Optional[str] = None
) -> Response[None]:
r = Route('DELETE', '/channels/{channel_id}/permissions/{target}', channel_id=channel_id, target=target)
return self.request(r, reason=reason)
# Voice management
def move_member(
self,
user_id: Snowflake,
guild_id: Snowflake,
channel_id: Snowflake,
*,
reason: Optional[str] = None,
) -> Response[member.MemberWithUser]:
return self.edit_member(guild_id=guild_id, user_id=user_id, channel_id=channel_id, reason=reason)
def get_ringability(self, channel_id: Snowflake):
return self.request(Route('GET', '/channels/{channel_id}/call', channel_id=channel_id))
def ring(self, channel_id: Snowflake, *recipients: Snowflake) -> Response[None]:
payload = {'recipients': recipients or None}
return self.request(Route('POST', '/channels/{channel_id}/call/ring', channel_id=channel_id), json=payload)
def stop_ringing(self, channel_id: Snowflake, *recipients: Snowflake) -> Response[None]:
r = Route('POST', '/channels/{channel_id}/call/stop-ringing', channel_id=channel_id)
payload = {'recipients': recipients}
return self.request(r, json=payload)
def change_call_voice_region(self, channel_id: int, voice_region: str): # TODO: return type
payload = {'region': voice_region}
return self.request(Route('PATCH', '/channels/{channel_id}/call', channel_id=channel_id), json=payload)
# Stage instance management
# TODO: Check all :(
def get_stage_instance(self, channel_id: Snowflake) -> Response[channel.StageInstance]:
return self.request(Route('GET', '/stage-instances/{channel_id}', channel_id=channel_id))
def create_stage_instance(self, *, reason: Optional[str], **payload: Any) -> Response[channel.StageInstance]:
valid_keys = (
'channel_id',
'topic',
'privacy_level',
'send_start_notification',
)
payload = {k: v for k, v in payload.items() if k in valid_keys}
return self.request(Route('POST', '/stage-instances'), json=payload, reason=reason)
def edit_stage_instance(self, channel_id: Snowflake, *, reason: Optional[str] = None, **payload: Any) -> Response[None]:
r = Route('PATCH', '/stage-instances/{channel_id}', channel_id=channel_id)
valid_keys = (
'topic',
'privacy_level',
)
payload = {k: v for k, v in payload.items() if k in valid_keys}
return self.request(r, json=payload, reason=reason)
def delete_stage_instance(self, channel_id: Snowflake, *, reason: Optional[str] = None) -> Response[None]:
return self.request(Route('DELETE', '/stage-instances/{channel_id}', channel_id=channel_id), reason=reason)
# Guild scheduled event management
@overload
def get_scheduled_events(
self, guild_id: Snowflake, with_user_count: Literal[True]
) -> Response[List[scheduled_event.GuildScheduledEventWithUserCount]]:
...
@overload
def get_scheduled_events(
self, guild_id: Snowflake, with_user_count: Literal[False]
) -> Response[List[scheduled_event.GuildScheduledEvent]]:
...
@overload
def get_scheduled_events(
self, guild_id: Snowflake, with_user_count: bool
) -> Union[
Response[List[scheduled_event.GuildScheduledEventWithUserCount]], Response[List[scheduled_event.GuildScheduledEvent]]
]:
...
def get_scheduled_events(self, guild_id: Snowflake, with_user_count: bool) -> Response[Any]:
params = {'with_user_count': str(with_user_count).lower()}
return self.request(Route('GET', '/guilds/{guild_id}/scheduled-events', guild_id=guild_id), params=params)
def get_subscribed_scheduled_events(
self, guild_id: Snowflake
) -> Response[List[scheduled_event.SubscribedGuildScheduledEvent]]:
params = {'guild_ids': guild_id}
return self.request(Route('GET', '/users/@me/scheduled-events'), params=params)
def create_guild_scheduled_event(
self, guild_id: Snowflake, *, reason: Optional[str] = None, **payload: Any
) -> Response[scheduled_event.GuildScheduledEvent]:
valid_keys = (
'channel_id',
'entity_metadata',
'name',
'privacy_level',
'scheduled_start_time',
'scheduled_end_time',
'description',
'entity_type',
'image',
)
payload = {k: v for k, v in payload.items() if k in valid_keys}
return self.request(
Route('POST', '/guilds/{guild_id}/scheduled-events', guild_id=guild_id), json=payload, reason=reason
)
@overload
def get_scheduled_event(
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, with_user_count: Literal[True]
) -> Response[scheduled_event.GuildScheduledEventWithUserCount]:
...
@overload
def get_scheduled_event(
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, with_user_count: Literal[False]
) -> Response[scheduled_event.GuildScheduledEvent]:
...
@overload
def get_scheduled_event(
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, with_user_count: bool
) -> Union[Response[scheduled_event.GuildScheduledEventWithUserCount], Response[scheduled_event.GuildScheduledEvent]]:
...
def get_scheduled_event(
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, with_user_count: bool
) -> Response[Any]:
params = {'with_user_count': int(with_user_count)}
return self.request(
Route(
'GET',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
params=params,
)
def edit_scheduled_event(
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, *, reason: Optional[str] = None, **payload: Any
) -> Response[scheduled_event.GuildScheduledEvent]:
valid_keys = (
'channel_id',
'entity_metadata',
'name',
'privacy_level',
'scheduled_start_time',
'scheduled_end_time',
'status',
'description',
'entity_type',
'image',
)
payload = {k: v for k, v in payload.items() if k in valid_keys}
return self.request(
Route(
'PATCH',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
json=payload,
reason=reason,
)
def delete_scheduled_event(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
*,
reason: Optional[str] = None,
) -> Response[None]:
return self.request(
Route(
'DELETE',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
reason=reason,
)
@overload
def get_scheduled_event_users(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
limit: int,
with_member: Literal[True],
before: Optional[Snowflake] = ...,
after: Optional[Snowflake] = ...,
) -> Response[scheduled_event.ScheduledEventUsersWithMember]:
...
@overload
def get_scheduled_event_users(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
limit: int,
with_member: Literal[False],
before: Optional[Snowflake] = ...,
after: Optional[Snowflake] = ...,
) -> Response[scheduled_event.ScheduledEventUsers]:
...
@overload
def get_scheduled_event_users(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
limit: int,
with_member: bool,
before: Optional[Snowflake] = ...,
after: Optional[Snowflake] = ...,
) -> Union[Response[scheduled_event.ScheduledEventUsersWithMember], Response[scheduled_event.ScheduledEventUsers]]:
...
def get_scheduled_event_users(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
limit: int,
with_member: bool,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
) -> Response[Any]:
params: Dict[str, Any] = {
'limit': limit,
'with_member': str(with_member).lower(),
}
if before is not None:
params['before'] = before
if after is not None:
params['after'] = after
return self.request(
Route(
'GET',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
params=params,
)
def create_scheduled_event_user(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
) -> Response[scheduled_event.SubscribedGuildScheduledEvent]:
return self.request(
Route(
'PUT',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users/@me',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
)
def delete_scheduled_event_user(
self,
guild_id: Snowflake,
guild_scheduled_event_id: Snowflake,
) -> Response[None]:
return self.request(
Route(
'DELETE',
'/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users/@me',
guild_id=guild_id,
guild_scheduled_event_id=guild_scheduled_event_id,
),
)
# Guild automod management
def get_auto_moderation_rules(self, guild_id: Snowflake) -> Response[List[automod.AutoModerationRule]]:
return self.request(Route('GET', '/guilds/{guild_id}/auto-moderation/rules', guild_id=guild_id))
def get_auto_moderation_rule(self, guild_id: Snowflake, rule_id: Snowflake) -> Response[automod.AutoModerationRule]:
return self.request(
Route('GET', '/guilds/{guild_id}/auto-moderation/rules/{rule_id}', guild_id=guild_id, rule_id=rule_id)
)
def create_auto_moderation_rule(
self, guild_id: Snowflake, *, reason: Optional[str], **payload: Any
) -> Response[automod.AutoModerationRule]:
valid_keys = (
'name',
'event_type',
'trigger_type',
'trigger_metadata',
'actions',
'enabled',
'exempt_roles',
'exempt_channels',
)
payload = {k: v for k, v in payload.items() if k in valid_keys and v is not None}
return self.request(
Route('POST', '/guilds/{guild_id}/auto-moderation/rules', guild_id=guild_id), json=payload, reason=reason
)
def edit_auto_moderation_rule(
self, guild_id: Snowflake, rule_id: Snowflake, *, reason: Optional[str], **payload: Any
) -> Response[automod.AutoModerationRule]:
valid_keys = (
'name',
'event_type',
'trigger_metadata',
'actions',
'enabled',
'exempt_roles',
'exempt_channels',
)
payload = {k: v for k, v in payload.items() if k in valid_keys and v is not None}
return self.request(
Route('PATCH', '/guilds/{guild_id}/auto-moderation/rules/{rule_id}', guild_id=guild_id, rule_id=rule_id),
json=payload,
reason=reason,
)
def delete_auto_moderation_rule(
self, guild_id: Snowflake, rule_id: Snowflake, *, reason: Optional[str]
) -> Response[None]:
return self.request(
Route('DELETE', '/guilds/{guild_id}/auto-moderation/rules/{rule_id}', guild_id=guild_id, rule_id=rule_id),
reason=reason,
)
# Misc. guild management
def get_admin_server_eligibility(self, guild_id: Snowflake) -> Response[guild.AdminServerEligibility]:
return self.request(Route('GET', '/guilds/{guild_id}/admin-server-eligibility', guild_id=guild_id))
def join_admin_server(self, guild_id: Snowflake) -> Response[guild.Guild]:
return self.request(Route('POST', '/guilds/{guild_id}/join-admin-server', guild_id=guild_id))
def migrate_command_scope(self, guild_id: Snowflake) -> Response[guild.CommandScopeMigration]:
return self.request(Route('POST', '/guilds/{guild_id}/migrate-command-scope', guild_id=guild_id))
# Relationships
def get_relationships(self) -> Response[List[user.Relationship]]:
return self.request(Route('GET', '/users/@me/relationships'))
def remove_relationship(self, user_id: Snowflake, *, action: RelationshipAction) -> Response[None]:
if action is RelationshipAction.deny_request: # User Profile, Friends, DM Channel
props = choice(
(
ContextProperties.from_friends,
ContextProperties.from_user_profile,
ContextProperties.from_dm_channel,
)
)()
elif action in (
RelationshipAction.unfriend,
RelationshipAction.unblock,
): # Friends, ContextMenu, User Profile, DM Channel
props = choice(
(
ContextProperties.from_contextmenu,
ContextProperties.from_user_profile,
ContextProperties.from_friends,
ContextProperties.from_dm_channel,
)
)()
elif action == RelationshipAction.remove_pending_request: # Friends
props = ContextProperties.from_friends()
else:
props = ContextProperties.empty()
return self.request(Route('DELETE', '/users/@me/relationships/{user_id}', user_id=user_id), context_properties=props)
def add_relationship(
self, user_id: Snowflake, type: Optional[int] = None, *, action: RelationshipAction
) -> Response[None]:
r = Route('PUT', '/users/@me/relationships/{user_id}', user_id=user_id)
payload = {}
if type is not None:
payload['type'] = type
if action is RelationshipAction.accept_request: # User Profile, Friends, DM Channel
props = choice(
(
ContextProperties.from_friends,
ContextProperties.from_user_profile,
ContextProperties.from_dm_channel,
)
)()
elif action is RelationshipAction.block: # Friends, ContextMenu, User Profile, DM Channel.
props = choice(
(
ContextProperties.from_contextmenu,
ContextProperties.from_user_profile,
ContextProperties.from_friends,
ContextProperties.from_dm_channel,
)
)()
elif action is RelationshipAction.send_friend_request: # ContextMenu, User Profile, DM Channel
props = choice(
(
ContextProperties.from_contextmenu,
ContextProperties.from_user_profile,
ContextProperties.from_dm_channel,
)
)()
elif action is RelationshipAction.friend_suggestion: # Friends
props = ContextProperties.from_friends()
payload['from_friend_suggestion'] = True
else:
props = ContextProperties.empty()
return self.request(r, context_properties=props, json=payload)
def send_friend_request(self, username: str, discriminator: Snowflake) -> Response[None]:
r = Route('POST', '/users/@me/relationships')
props = choice((ContextProperties.from_add_friend, ContextProperties.from_group_dm))() # Friends, Group DM
payload = {'username': username, 'discriminator': int(discriminator) or None}
return self.request(r, json=payload, context_properties=props)
def edit_relationship(self, user_id: Snowflake, **payload) -> Response[None]:
return self.request(Route('PATCH', '/users/@me/relationships/{user_id}', user_id=user_id), json=payload)
def get_friend_suggestions(self) -> Response[List[user.FriendSuggestion]]:
return self.request(Route('GET', '/friend-suggestions'))
def delete_friend_suggestion(self, user_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/friend-suggestions/{user_id}', user_id=user_id))
# Connections
def get_connections(self) -> Response[List[user.Connection]]:
return self.request(Route('GET', '/users/@me/connections'))
def edit_connection(self, type: str, id: str, **payload) -> Response[user.Connection]:
return self.request(Route('PATCH', '/users/@me/connections/{type}/{id}', type=type, id=id), json=payload)
def refresh_connection(self, type: str, id: str, **payload) -> Response[None]:
return self.request(Route('POST', '/users/@me/connections/{type}/{id}/refresh', type=type, id=id), json=payload)
def delete_connection(self, type: str, id: str) -> Response[None]:
return self.request(Route('DELETE', '/users/@me/connections/{type}/{id}', type=type, id=id))
def get_reddit_connection_subreddits(self, id: str) -> Response[List[dict]]:
return self.request(Route('GET', '/users/@me/connections/reddit/{id}/subreddits', id=id))
def authorize_connection(
self,
type: str,
two_way_link_type: Optional[str] = None,
two_way_user_code: Optional[str] = None,
continuation: bool = False,
) -> Response[user.ConnectionAuthorization]:
params = {}
if two_way_link_type is not None:
params['two_way_link'] = 'true'
params['two_way_link_type'] = two_way_link_type
if two_way_user_code is not None:
params['two_way_link'] = 'true'
params['two_way_user_code'] = two_way_user_code
if continuation:
params['continuation'] = 'true'
return self.request(Route('GET', '/connections/{type}/authorize', type=type), params=params)
def add_connection(
self,
type: str,
code: str,
state: str,
*,
two_way_link_code: Optional[str] = None,
insecure: bool,
friend_sync: bool,
) -> Response[None]:
payload = {'code': code, 'state': state, 'insecure': insecure, 'friend_sync': friend_sync}
if two_way_link_code is not None:
payload['two_way_link_code'] = two_way_link_code
return self.request(Route('POST', '/connections/{type}/callback', type=type), json=payload)
def get_connection_token(self, type: str, id: str) -> Response[user.ConnectionAccessToken]:
return self.request(Route('GET', '/users/@me/connections/{type}/{id}/access-token', type=type, id=id))
# Applications / Store
def get_my_applications(self, *, with_team_applications: bool = True) -> Response[List[application.Application]]:
params = {'with_team_applications': str(with_team_applications).lower()}
return self.request(Route('GET', '/applications'), params=params)
def get_my_application(self, app_id: Snowflake) -> Response[application.Application]:
return self.request(Route('GET', '/applications/{app_id}', app_id=app_id), super_properties_to_track=True)
def edit_application(self, app_id: Snowflake, payload: dict) -> Response[application.Application]:
return self.request(
Route('PATCH', '/applications/{app_id}', app_id=app_id), super_properties_to_track=True, json=payload
)
def delete_application(self, app_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/applications/{app_id}/delete', app_id=app_id), super_properties_to_track=True)
def transfer_application(self, app_id: Snowflake, team_id: Snowflake) -> Response[application.Application]:
payload = {'team_id': team_id}
return self.request(
Route('POST', '/applications/{app_id}/transfer', app_id=app_id), json=payload, super_properties_to_track=True
)
def get_partial_application(self, app_id: Snowflake) -> Response[application.PartialApplication]:
return self.request(Route('GET', '/oauth2/applications/{app_id}/rpc', app_id=app_id))
def get_public_application(
self, app_id: Snowflake, with_guild: bool = False
) -> Response[application.PartialApplication]:
params = {'with_guild': str(with_guild).lower()}
return self.request(Route('GET', '/applications/{app_id}/public', app_id=app_id), params=params)
def get_public_applications(self, app_ids: Sequence[Snowflake]) -> Response[List[application.PartialApplication]]:
return self.request(Route('GET', '/applications/public'), params={'application_ids': app_ids})
def create_app(self, name: str, team_id: Optional[Snowflake] = None) -> Response[application.Application]:
payload = {'name': name, team_id: team_id}
return self.request(Route('POST', '/applications'), json=payload)
def get_app_entitlements(
self,
app_id: Snowflake,
*,
user_id: Optional[Snowflake] = None,
guild_id: Optional[Snowflake] = None,
sku_ids: Optional[Sequence[Snowflake]] = None,
with_payments: bool = False,
exclude_ended: bool = False,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
limit: int = 100,
) -> Response[List[entitlements.Entitlement]]:
params: Dict[str, Any] = {'with_payments': str(with_payments).lower(), 'exclude_ended': str(exclude_ended).lower()}
if user_id:
params['user_id'] = user_id
if guild_id:
params['guild_id'] = guild_id
if sku_ids:
params['sku_ids'] = sku_ids
if before:
params['before'] = before
if after:
params['after'] = after
if limit != 100:
params['limit'] = limit
return self.request(Route('GET', '/applications/{app_id}/entitlements', app_id=app_id), params=params)
def get_app_entitlement(
self, app_id: Snowflake, entitlement_id: Snowflake, with_payments: bool = False
) -> Response[entitlements.Entitlement]:
params = {'with_payments': str(with_payments).lower()}
return self.request(
Route(
'GET', '/applications/{app_id}/entitlements/{entitlement_id}', app_id=app_id, entitlement_id=entitlement_id
),
params=params,
)
def delete_app_entitlement(self, app_id: Snowflake, entitlement_id: Snowflake) -> Response[None]:
return self.request(
Route(
'DELETE',
'/applications/{app_id}/entitlements/{entitlement_id}',
app_id=app_id,
entitlement_id=entitlement_id,
)
)
def consume_app_entitlement(self, app_id: Snowflake, entitlement_id: Snowflake) -> Response[None]:
return self.request(
Route(
'POST',
'/applications/{app_id}/entitlements/{entitlement_id}/consume',
app_id=app_id,
entitlement_id=entitlement_id,
)
)
def get_user_app_entitlements(
self, app_id: Snowflake, *, sku_ids: Optional[Sequence[Snowflake]] = None, exclude_consumed: bool = True
) -> Response[List[entitlements.Entitlement]]:
params: Dict[str, Any] = {'exclude_consumed': str(exclude_consumed).lower()}
if sku_ids:
params['sku_ids'] = sku_ids
return self.request(Route('GET', '/users/@me/applications/{app_id}/entitlements', app_id=app_id, params=params))
def get_user_entitlements(
self, with_sku: bool = True, with_application: bool = True, entitlement_type: Optional[int] = None
) -> Response[List[entitlements.Entitlement]]:
params: Dict[str, Any] = {'with_sku': str(with_sku).lower(), 'with_application': str(with_application).lower()}
if entitlement_type is not None:
params['entitlement_type'] = entitlement_type
return self.request(Route('GET', '/users/@me/entitlements'), params=params)
def get_giftable_entitlements(
self, country_code: Optional[str] = None, payment_source_id: Optional[Snowflake] = None
) -> Response[List[entitlements.Entitlement]]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
return self.request(Route('GET', '/users/@me/entitlements/gifts'), params=params)
def get_guild_entitlements(
self, guild_id: Snowflake, with_sku: bool = True, with_application: bool = True, exclude_deleted: bool = False
) -> Response[List[entitlements.Entitlement]]:
params: Dict[str, Any] = {
'with_sku': str(with_sku).lower(),
'with_application': str(with_application).lower(),
'exclude_deleted': str(exclude_deleted).lower(),
}
return self.request(Route('GET', '/guilds/{guild_id}/entitlements', guild_id=guild_id), params=params)
def get_app_skus(
self,
app_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
localize: bool = True,
with_bundled_skus: bool = True,
) -> Response[List[store.SKU]]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
if with_bundled_skus:
params['with_bundled_skus'] = 'true'
return self.request(
Route('GET', '/applications/{app_id}/skus', app_id=app_id), params=params, super_properties_to_track=True
)
def create_sku(self, payload: dict) -> Response[store.SKU]:
return self.request(Route('POST', '/store/skus'), json=payload, super_properties_to_track=True)
def get_app_discoverability(self, app_id: Snowflake) -> Response[application.ApplicationDiscoverability]:
return self.request(
Route('GET', '/applications/{app_id}/discoverability-state', app_id=app_id), super_properties_to_track=True
)
def get_embedded_activity_config(self, app_id: Snowflake) -> Response[application.EmbeddedActivityConfig]:
return self.request(
Route('GET', '/applications/{app_id}/embedded-activity-config', app_id=app_id), super_properties_to_track=True
)
def edit_embedded_activity_config(
self,
app_id: Snowflake,
*,
supported_platforms: Optional[List[str]] = None,
platform_config: Optional[
Dict[application.EmbeddedActivityPlatform, application.EmbeddedActivityPlatformConfig]
] = None,
orientation_lock_state: Optional[int] = None,
tablet_orientation_lock_state: Optional[int] = None,
requires_age_gate: Optional[bool] = None,
shelf_rank: Optional[int] = None,
free_period_starts_at: Optional[str] = None,
free_period_ends_at: Optional[str] = None,
preview_video_asset_id: Optional[Snowflake] = MISSING,
) -> Response[application.EmbeddedActivityConfig]:
payload = {}
if supported_platforms is not None:
payload['supported_platforms'] = supported_platforms
if platform_config is not None:
payload['client_platform_config'] = platform_config
if orientation_lock_state is not None:
payload['default_orientation_lock_state'] = orientation_lock_state
if tablet_orientation_lock_state is not None:
payload['default_tablet_orientation_lock_state'] = tablet_orientation_lock_state
if requires_age_gate is not None:
payload['requires_age_gate'] = requires_age_gate
if shelf_rank is not None:
payload['shelf_rank'] = shelf_rank
if free_period_starts_at is not None:
payload['free_period_starts_at'] = free_period_starts_at
if free_period_ends_at is not None:
payload['free_period_ends_at'] = free_period_ends_at
if preview_video_asset_id is not MISSING:
payload['activity_preview_video_asset_id'] = preview_video_asset_id
return self.request(
Route('PATCH', '/applications/{app_id}/embedded-activity-config', app_id=app_id),
json=payload,
super_properties_to_track=True,
)
def get_app_whitelisted(self, app_id: Snowflake) -> Response[List[application.WhitelistedUser]]:
return self.request(
Route('GET', '/oauth2/applications/{app_id}/allowlist', app_id=app_id), super_properties_to_track=True
)
def add_app_whitelist(
self, app_id: Snowflake, username: str, discriminator: Snowflake
) -> Response[application.WhitelistedUser]:
payload = {'username': username, 'discriminator': str(discriminator) or None}
return self.request(
Route('POST', '/oauth2/applications/{app_id}/allowlist', app_id=app_id),
json=payload,
super_properties_to_track=True,
)
def delete_app_whitelist(self, app_id: Snowflake, user_id: Snowflake):
return self.request(
Route('DELETE', '/oauth2/applications/{app_id}/allowlist/{user_id}', app_id=app_id, user_id=user_id),
super_properties_to_track=True,
)
def get_app_assets(self, app_id: Snowflake) -> Response[List[application.Asset]]:
return self.request(Route('GET', '/oauth2/applications/{app_id}/assets', app_id=app_id))
def get_store_assets(self, app_id: Snowflake) -> Response[List[application.StoreAsset]]:
return self.request(
Route('GET', '/store/applications/{app_id}/assets', app_id=app_id), super_properties_to_track=True
)
def create_asset(self, app_id: Snowflake, name: str, type: int, image: str) -> Response[application.Asset]:
payload = {'name': name, 'type': type, 'image': image}
return self.request(
Route('POST', '/oauth2/applications/{app_id}/assets', app_id=app_id),
json=payload,
super_properties_to_track=True,
)
def create_store_asset(self, app_id: Snowflake, file: File) -> Response[application.StoreAsset]:
initial_bytes = file.fp.read(16)
try:
mime_type = utils._get_mime_type_for_image(initial_bytes, True)
except ValueError:
if initial_bytes.startswith(b'{'):
mime_type = 'application/json'
else:
mime_type = 'application/octet-stream'
finally:
file.reset()
form: List[Dict[str, Any]] = [
{
'name': 'assets', # Not a typo
'value': file.fp,
'filename': file.filename,
'content_type': mime_type,
}
]
return self.request(Route('POST', '/store/applications/{app_id}/assets', app_id=app_id), form=form, files=[file])
def delete_asset(self, app_id: Snowflake, asset_id: Snowflake) -> Response[None]:
return self.request(
Route('DELETE', '/oauth2/applications/{app_id}/assets/{asset_id}', app_id=app_id, asset_id=asset_id),
super_properties_to_track=True,
)
def delete_store_asset(self, app_id: Snowflake, asset_id: Snowflake) -> Response[None]:
return self.request(
Route('DELETE', '/store/applications/{app_id}/assets/{asset_id}', app_id=app_id, asset_id=asset_id),
super_properties_to_track=True,
)
def create_team(self, name: str):
payload = {'name': name}
return self.request(Route('POST', '/teams'), json=payload, super_properties_to_track=True)
def get_teams(self, *, include_payout_account_status: bool = False) -> Response[List[team.Team]]:
params = {}
if include_payout_account_status:
params['include_payout_account_status'] = 'true'
return self.request(Route('GET', '/teams'), params=params)
def get_team(self, team_id: Snowflake) -> Response[team.Team]:
return self.request(Route('GET', '/teams/{team_id}', team_id=team_id), super_properties_to_track=True)
def edit_team(self, team_id: Snowflake, payload: dict) -> Response[team.Team]:
return self.request(
Route('PATCH', '/teams/{team_id}', team_id=team_id), json=payload, super_properties_to_track=True
)
def delete_team(self, team_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/teams/{team_id}/delete', team_id=team_id), super_properties_to_track=True)
def get_team_applications(self, team_id: Snowflake) -> Response[List[application.Application]]:
return self.request(Route('GET', '/teams/{team_id}/applications', team_id=team_id), super_properties_to_track=True)
def get_team_members(self, team_id: Snowflake) -> Response[List[team.TeamMember]]:
return self.request(Route('GET', '/teams/{team_id}/members', team_id=team_id), super_properties_to_track=True)
def invite_team_member(self, team_id: Snowflake, username: str, discriminator: Snowflake):
payload = {'username': username, 'discriminator': str(discriminator) or None}
return self.request(
Route('POST', '/teams/{team_id}/members', team_id=team_id), json=payload, super_properties_to_track=True
)
def remove_team_member(self, team_id: Snowflake, user_id: Snowflake):
return self.request(
Route('DELETE', '/teams/{team_id}/members/{user_id}', team_id=team_id, user_id=user_id),
super_properties_to_track=True,
)
def create_team_company(self, team_id: Snowflake, name: str) -> Response[application.Company]:
payload = {'name': name}
return self.request(
Route('POST', '/teams/{team_id}/companies', team_id=team_id), json=payload, super_properties_to_track=True
)
def search_companies(self, query: str) -> Response[List[application.Company]]:
# This endpoint 204s without a query?
params = {'query': query}
data = self.request(Route('GET', '/companies'), params=params, super_properties_to_track=True)
return data or []
def get_team_payouts(
self, team_id: Snowflake, *, limit: int = 96, before: Optional[Snowflake] = None
) -> Response[List[team.TeamPayout]]:
params: Dict[str, Any] = {'limit': limit}
if before is not None:
params['before'] = before
return self.request(
Route('GET', '/teams/{team_id}/payouts', team_id=team_id), params=params, super_properties_to_track=True
)
def get_team_payout_report(self, team_id: Snowflake, payout_id: Snowflake, type: str) -> Response[bytes]:
params = {'type': type}
return self.request(
Route('GET', '/teams/{team_id}/payouts/{payout_id}/report', team_id=team_id, payout_id=payout_id),
params=params,
super_properties_to_track=True,
)
def botify_app(self, app_id: Snowflake) -> Response[application.OptionalToken]:
return self.request(
Route('POST', '/applications/{app_id}/bot', app_id=app_id), json={}, super_properties_to_track=True
)
def edit_bot(self, app_id: Snowflake, payload: dict) -> Response[user.User]:
return self.request(
Route('PATCH', '/applications/{app_id}/bot', app_id=app_id), json=payload, super_properties_to_track=True
)
def reset_secret(self, app_id: Snowflake) -> Response[application.Secret]:
return self.request(Route('POST', '/applications/{app_id}/reset', app_id=app_id), super_properties_to_track=True)
def reset_bot_token(self, app_id: Snowflake) -> Response[application.Token]:
return self.request(Route('POST', '/applications/{app_id}/bot/reset', app_id=app_id), super_properties_to_track=True)
def get_detectable_applications(self) -> Response[List[application.PartialApplication]]:
return self.request(Route('GET', '/applications/detectable'))
def get_guild_applications(
self,
guild_id: Snowflake,
*,
type: Optional[int] = None,
include_team: bool = False,
channel_id: Optional[Snowflake] = None,
) -> Response[List[application.PartialApplication]]:
params = {}
if type is not None:
params['type'] = type
if include_team:
params['include_team'] = 'true'
if channel_id is not None:
params['channel_id'] = channel_id
return self.request(Route('GET', '/guilds/{guild_id}/applications', guild_id=guild_id), params=params)
def get_app_ticket(self, app_id: Snowflake, test_mode: bool = False) -> Response[application.Ticket]:
payload = {'test_mode': test_mode}
return self.request(Route('POST', '/users/@me/applications/{app_id}/ticket', app_id=app_id), json=payload)
def get_app_entitlement_ticket(self, app_id: Snowflake, test_mode: bool = False) -> Response[application.Ticket]:
payload = {'test_mode': test_mode}
return self.request(
Route('POST', '/users/@me/applications/{app_id}/entitlement-ticket', app_id=app_id), json=payload
)
def get_app_activity_statistics(self, app_id: Snowflake) -> Response[List[application.ActivityStatistics]]:
return self.request(Route('GET', '/activities/statistics/applications/{app_id}', app_id=app_id))
def get_activity_statistics(self) -> Response[List[application.ActivityStatistics]]:
return self.request(Route('GET', '/users/@me/activities/statistics/applications'))
def get_global_activity_statistics(self) -> Response[List[application.GlobalActivityStatistics]]:
return self.request(Route('GET', '/activities'))
def get_app_manifest_labels(self, app_id: Snowflake) -> Response[List[application.ManifestLabel]]:
return self.request(
Route('GET', '/applications/{app_id}/manifest-labels', app_id=app_id), super_properties_to_track=True
)
def get_app_branches(self, app_id: Snowflake) -> Response[List[application.Branch]]:
return self.request(Route('GET', '/applications/{app_id}/branches', app_id=app_id))
def create_app_branch(self, app_id: Snowflake, name: str) -> Response[application.Branch]:
payload = {'name': name}
return self.request(Route('POST', '/applications/{app_id}/branches', app_id=app_id), json=payload)
def delete_app_branch(self, app_id: Snowflake, branch_id: Snowflake) -> Response[None]:
return self.request(
Route('DELETE', '/applications/{app_id}/branches/{branch_id}', app_id=app_id, branch_id=branch_id)
)
def get_branch_builds(self, app_id: Snowflake, branch_id: Snowflake) -> Response[List[application.Build]]:
return self.request(
Route('GET', '/applications/{app_id}/branches/{branch_id}/builds', app_id=app_id, branch_id=branch_id)
)
def get_branch_build(self, app_id: Snowflake, branch_id: Snowflake, build_id: Snowflake) -> Response[application.Build]:
return self.request(
Route(
'GET',
'/applications/{app_id}/branches/{branch_id}/builds/{build_id}',
app_id=app_id,
branch_id=branch_id,
build_id=build_id,
)
)
def get_latest_branch_build(self, app_id: Snowflake, branch_id: Snowflake) -> Response[application.Build]:
return self.request(
Route('GET', '/applications/{app_id}/branches/{branch_id}/builds/latest', app_id=app_id, branch_id=branch_id)
)
def get_live_branch_build(
self, app_id: Snowflake, branch_id: Snowflake, locale: str, platform: str
) -> Response[application.Build]:
params = {'locale': locale, 'platform': platform}
return self.request(
Route('GET', '/applications/{app_id}/branches/{branch_id}/builds/live', app_id=app_id, branch_id=branch_id),
params=params,
)
def get_build_ids(self, branch_ids: Sequence[Snowflake]) -> Response[List[application.Branch]]:
payload = {'branch_ids': branch_ids}
return self.request(Route('POST', '/branches'), json=payload)
def create_branch_build(
self, app_id: Snowflake, branch_id: Snowflake, payload: dict
) -> Response[application.CreatedBuild]:
return self.request(
Route('POST', '/applications/{app_id}/branches/{branch_id}/builds', app_id=app_id, branch_id=branch_id),
json=payload,
)
def edit_build(self, app_id: Snowflake, build_id: Snowflake, status: str) -> Response[None]:
payload = {'status': status}
return self.request(
Route('PATCH', '/applications/{app_id}/builds/{build_id}', app_id=app_id, build_id=build_id), json=payload
)
def delete_build(self, app_id: Snowflake, build_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/applications/{app_id}/builds/{build_id}', app_id=app_id, build_id=build_id))
def get_branch_build_size(
self, app_id: Snowflake, branch_id: Snowflake, build_id: Snowflake, manifest_ids: Sequence[Snowflake]
) -> Response[application.BranchSize]:
payload = {'manifest_ids': manifest_ids}
return self.request(
Route(
'POST',
'/applications/{app_id}/branches/{branch_id}/builds/{build_id}/size',
app_id=app_id,
branch_id=branch_id,
build_id=build_id,
),
json=payload,
)
def get_branch_build_download_signatures(
self, app_id: Snowflake, branch_id: Snowflake, build_id: Snowflake, manifest_label_ids: Sequence[Snowflake]
) -> Response[Dict[str, application.DownloadSignature]]:
params = {'branch_id': branch_id, 'build_id': build_id}
payload = {'manifest_label_ids': manifest_label_ids}
return self.request(
Route(
'POST',
'/applications/{app_id}/download-signatures',
app_id=app_id,
),
params=params,
json=payload,
)
def get_build_upload_urls(
self, app_id: Snowflake, build_id: Snowflake, files: Sequence[File], hash: bool = True
) -> Response[List[application.CreatedBuildFile]]:
payload = {'files': []}
for file in files:
# We create a new ID and set it as the filename
id = ''.join(choices(string.ascii_letters + string.digits, k=32)).upper()
file.filename = id
data = {'id': file.filename}
if hash:
data['md5_hash'] = file.b64_md5
payload['files'].append(data)
return self.request(
Route('POST', '/applications/{app_id}/builds/{build_id}/files', app_id=app_id, build_id=build_id), json=payload
)
def publish_build(self, app_id: Snowflake, branch_id: Snowflake, build_id: Snowflake) -> Response[None]:
return self.request(
Route(
'POST',
'/applications/{app_id}/branches/{branch_id}/builds/{build_id}/publish',
app_id=app_id,
branch_id=branch_id,
build_id=build_id,
)
)
def promote_build(self, app_id: Snowflake, branch_id: Snowflake, target_branch_id: Snowflake) -> Response[None]:
return self.request(
Route(
'PUT',
'/applications/{app_id}/branches/{branch_id}/promote/{target_branch_id}',
app_id=app_id,
branch_id=branch_id,
target_branch_id=target_branch_id,
)
)
def get_store_listing(
self,
listing_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
localize: bool = True,
) -> Response[store.StoreListing]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/listings/{listing_id}', app_id=listing_id), params=params)
def get_store_listing_by_sku(
self,
sku_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
localize: bool = True,
) -> Response[store.StoreListing]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/published-listings/skus/{sku_id}', sku_id=sku_id), params=params)
def get_sku_store_listings(
self,
sku_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[int] = None,
localize: bool = True,
) -> Response[List[store.StoreListing]]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/skus/{sku_id}/listings', sku_id=sku_id), params=params)
def get_store_listing_subscription_plans(
self,
sku_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
include_unpublished: bool = False,
revenue_surface: Optional[int] = None,
) -> Response[List[subscriptions.SubscriptionPlan]]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if include_unpublished:
params['include_unpublished'] = 'true'
if revenue_surface:
params['revenue_surface'] = revenue_surface
return self.request(Route('GET', '/store/published-listings/skus/{sku_id}/subscription-plans', sku_id=sku_id))
def get_store_listings_subscription_plans(
self,
sku_ids: Sequence[Snowflake],
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
include_unpublished: bool = False,
revenue_surface: Optional[int] = None,
) -> Response[List[subscriptions.SubscriptionPlan]]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if include_unpublished:
params['include_unpublished'] = 'true'
if revenue_surface:
params['revenue_surface'] = revenue_surface
return self.request(Route('GET', '/store/published-listings/skus/subscription-plans'), params={'sku_ids': sku_ids})
def get_app_store_listings(
self,
app_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[int] = None,
localize: bool = True,
) -> Response[List[store.StoreListing]]:
params = {'application_id': app_id}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/published-listings/skus'), params=params)
def get_app_store_listing(
self,
app_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[int] = None,
localize: bool = True,
) -> Response[store.StoreListing]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(
Route('GET', '/store/published-listings/applications/{application_id}', application_id=app_id), params=params
)
def get_apps_store_listing(
self,
app_ids: Sequence[Snowflake],
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
localize: bool = True,
) -> Response[List[store.StoreListing]]:
params: Dict[str, Any] = {'application_ids': app_ids}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/published-listings/applications'), params=params)
def create_store_listing(
self, application_id: Snowflake, sku_id: Snowflake, payload: dict
) -> Response[store.StoreListing]:
return self.request(
Route('POST', '/store/listings'),
json={**payload, 'application_id': application_id, 'sku_id': sku_id},
super_properties_to_track=True,
)
def edit_store_listing(self, listing_id: Snowflake, payload: dict) -> Response[store.StoreListing]:
return self.request(
Route('PATCH', '/store/listings/{listing_id}', listing_id=listing_id),
json=payload,
super_properties_to_track=True,
)
def get_sku(
self,
sku_id: Snowflake,
*,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
localize: bool = True,
) -> Response[store.SKU]:
params = {}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
if not localize:
params['localize'] = 'false'
return self.request(Route('GET', '/store/skus/{sku_id}', sku_id=sku_id), params=params)
def edit_sku(self, sku_id: Snowflake, payload: dict) -> Response[store.SKU]:
return self.request(
Route('PATCH', '/store/skus/{sku_id}', sku_id=sku_id), json=payload, super_properties_to_track=True
)
def preview_sku_purchase(
self,
sku_id: Snowflake,
payment_source_id: Snowflake,
subscription_plan_id: Optional[Snowflake] = None,
*,
test_mode: bool = False,
) -> Response[store.SKUPrice]:
params = {'payment_source_id': payment_source_id}
if subscription_plan_id:
params['subscription_plan_id'] = subscription_plan_id
if test_mode:
params['test_mode'] = 'true'
return self.request(
Route('GET', '/store/skus/{sku_id}/purchase', sku_id=sku_id),
params=params,
context_properties=ContextProperties.empty(),
)
def purchase_sku(
self,
sku_id: Snowflake,
payment_source_id: Optional[Snowflake] = None,
*,
subscription_plan_id: Optional[Snowflake] = None,
expected_amount: Optional[int] = None,
expected_currency: Optional[str] = None,
gift: bool = False,
gift_style: Optional[int] = None,
test_mode: bool = False,
payment_source_token: Optional[str] = None,
purchase_token: Optional[str] = None,
return_url: Optional[str] = None,
gateway_checkout_context: Optional[str] = None,
) -> Response[store.SKUPurchase]:
payload = {
'gift': gift,
'purchase_token': purchase_token,
'gateway_checkout_context': gateway_checkout_context,
}
if payment_source_id:
payload['payment_source_id'] = payment_source_id
payload['payment_source_token'] = payment_source_token
if subscription_plan_id:
payload['sku_subscription_plan_id'] = subscription_plan_id
if expected_amount is not None:
payload['expected_amount'] = expected_amount
if expected_currency:
payload['expected_currency'] = expected_currency
if gift_style:
payload['gift_style'] = gift_style
if test_mode:
payload['test_mode'] = True
if return_url:
payload['return_url'] = return_url
return self.request(
Route('POST', '/store/skus/{sku_id}/purchase', sku_id=sku_id),
json=payload,
context_properties=ContextProperties.empty(),
)
def create_sku_discount(self, sku_id: Snowflake, user_id: Snowflake, percent_off: int, ttl: int = 600) -> Response[None]:
payload = {'percent_off': percent_off, 'ttl': ttl}
return self.request(
Route('PUT', '/store/skus/{sku_id}/discounts/{user_id}', sku_id=sku_id, user_id=user_id), json=payload
)
def delete_sku_discount(self, sku_id: Snowflake, user_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/store/skus/{sku_id}/discounts/{user_id}', sku_id=sku_id, user_id=user_id))
def get_eula(self, eula_id: Snowflake) -> Response[application.EULA]:
return self.request(Route('GET', '/store/eulas/{eula_id}', eula_id=eula_id))
def get_price_tiers(self, type: Optional[int] = None, guild_id: Optional[Snowflake] = None) -> Response[List[int]]:
params = {}
if type:
params['price_tier_type'] = type
if guild_id:
params['guild_id'] = guild_id
return self.request(Route('GET', '/store/price-tiers'), params=params, super_properties_to_track=True)
def get_price_tier(self, price_tier: Snowflake) -> Response[Dict[str, int]]:
return self.request(
Route('GET', '/store/price-tiers/{price_tier}', price_tier=price_tier), super_properties_to_track=True
)
def create_achievement(
self,
app_id: Snowflake,
*,
name: str,
name_localizations: Optional[Mapping[str, str]] = None,
description: str,
description_localizations: Optional[Mapping[str, str]] = None,
icon: str,
secure: bool,
secret: bool,
) -> Response[application.Achievement]:
payload = {
'name': {
'default': name,
'localizations': {str(k): v for k, v in (name_localizations or {}).items()},
},
'description': {
'default': description,
'localizations': {str(k): v for k, v in (description_localizations or {}).items()},
},
'icon': icon,
'secure': secure,
'secret': secret,
}
return self.request(
Route('POST', '/applications/{app_id}/achievements', app_id=app_id), json=payload, super_properties_to_track=True
)
def get_achievements(self, app_id: Snowflake) -> Response[List[application.Achievement]]:
return self.request(
Route('GET', '/applications/{app_id}/achievements', app_id=app_id), super_properties_to_track=True
)
def get_my_achievements(self, app_id: Snowflake) -> Response[List[application.Achievement]]:
return self.request(Route('GET', '/users/@me/applications/{app_id}/achievements', app_id=app_id))
def get_achievement(self, app_id: Snowflake, achievement_id: Snowflake) -> Response[application.Achievement]:
return self.request(
Route(
'GET', '/applications/{app_id}/achievements/{achievement_id}', app_id=app_id, achievement_id=achievement_id
),
super_properties_to_track=True,
)
def edit_achievement(
self, app_id: Snowflake, achievement_id: Snowflake, payload: dict
) -> Response[application.Achievement]:
return self.request(
Route(
'PATCH', '/applications/{app_id}/achievements/{achievement_id}', app_id=app_id, achievement_id=achievement_id
),
json=payload,
super_properties_to_track=True,
)
def update_user_achievement(
self, app_id: Snowflake, achievement_id: Snowflake, user_id: Snowflake, percent_complete: int
) -> Response[None]:
payload = {'percent_complete': percent_complete}
return self.request(
Route(
'PUT',
'/users/{user_id}/applications/{app_id}/achievements/{achievement_id}',
user_id=user_id,
app_id=app_id,
achievement_id=achievement_id,
),
json=payload,
)
def delete_achievement(self, app_id: Snowflake, achievement_id: Snowflake) -> Response[None]:
return self.request(
Route(
'DELETE',
'/applications/{app_id}/achievements/{achievement_id}',
app_id=app_id,
achievement_id=achievement_id,
),
super_properties_to_track=True,
)
def get_gift_batches(self, app_id: Snowflake) -> Response[List[entitlements.GiftBatch]]:
return self.request(
Route('GET', '/applications/{app_id}/gift-code-batches', app_id=app_id), super_properties_to_track=True
)
def get_gift_batch_csv(self, app_id: Snowflake, batch_id: Snowflake) -> Response[bytes]:
return self.request(
Route('GET', '/applications/{app_id}/gift-code-batches/{batch_id}', app_id=app_id, batch_id=batch_id),
super_properties_to_track=True,
)
def create_gift_batch(
self,
app_id: Snowflake,
sku_id: Snowflake,
amount: int,
description: str,
*,
entitlement_branches: Optional[Sequence[Snowflake]] = None,
entitlement_starts_at: Optional[str] = None,
entitlement_ends_at: Optional[str] = None,
) -> Response[entitlements.GiftBatch]:
payload = {
'sku_id': sku_id,
'amount': str(amount),
'description': description,
'entitlement_branches': entitlement_branches or [],
'entitlement_starts_at': entitlement_starts_at or '',
'entitlement_ends_at': entitlement_ends_at or '',
}
return self.request(
Route('POST', '/applications/{app_id}/gift-code-batches', app_id=app_id),
json=payload,
super_properties_to_track=True,
)
def get_gift(
self,
code: str,
country_code: Optional[str] = None,
payment_source_id: Optional[Snowflake] = None,
with_application: bool = False,
with_subscription_plan: bool = True,
) -> Response[entitlements.Gift]:
params: Dict[str, Any] = {
'with_application': str(with_application).lower(),
'with_subscription_plan': str(with_subscription_plan).lower(),
}
if country_code:
params['country_code'] = country_code
if payment_source_id:
params['payment_source_id'] = payment_source_id
return self.request(Route('GET', '/entitlements/gift-codes/{code}', code=code), params=params)
def get_sku_gifts(
self, sku_id: Snowflake, subscription_plan_id: Optional[Snowflake] = None
) -> Response[List[entitlements.Gift]]:
params: Dict[str, Any] = {'sku_id': sku_id}
if subscription_plan_id:
params['subscription_plan_id'] = subscription_plan_id
return self.request(Route('GET', '/users/@me/entitlements/gift-codes'), params=params)
def create_gift(
self, sku_id: Snowflake, *, subscription_plan_id: Optional[Snowflake] = None, gift_style: Optional[int] = None
) -> Response[entitlements.Gift]:
payload: Dict[str, Any] = {'sku_id': sku_id}
if subscription_plan_id:
payload['subscription_plan_id'] = subscription_plan_id
if gift_style:
payload['gift_style'] = gift_style
return self.request(Route('POST', '/users/@me/entitlements/gift-codes'), json=payload)
def redeem_gift(
self,
code: str,
payment_source_id: Optional[Snowflake] = None,
channel_id: Optional[Snowflake] = None,
gateway_checkout_context: Optional[str] = None,
) -> Response[entitlements.Entitlement]:
payload: Dict[str, Any] = {'channel_id': channel_id, 'gateway_checkout_context': gateway_checkout_context}
if payment_source_id:
payload['payment_source_id'] = payment_source_id
return self.request(Route('POST', '/entitlements/gift-codes/{code}/redeem', code=code), json=payload)
def delete_gift(self, code: str) -> Response[None]:
return self.request(Route('DELETE', '/users/@me/entitlements/gift-codes/{code}', code=code))
# Billing
def get_payment_sources(self) -> Response[List[billing.PaymentSource]]:
return self.request(Route('GET', '/users/@me/billing/payment-sources'))
def get_payment_source(self, source_id: Snowflake) -> Response[billing.PaymentSource]:
return self.request(Route('GET', '/users/@me/billing/payment-sources/{source_id}', source_id=source_id))
def create_payment_source(
self,
*,
token: str,
payment_gateway: int,
billing_address: dict,
billing_address_token: Optional[str] = None,
return_url: Optional[str] = None,
bank: Optional[str] = None,
) -> Response[billing.PaymentSource]:
payload = {
'token': token,
'payment_gateway': int(payment_gateway),
'billing_address': billing_address,
}
if billing_address_token:
payload['billing_address_token'] = billing_address_token
if return_url:
payload['return_url'] = return_url
if bank:
payload['bank'] = bank
return self.request(Route('POST', '/users/@me/billing/payment-sources'), json=payload)
def edit_payment_source(self, source_id: Snowflake, payload: dict) -> Response[billing.PaymentSource]:
return self.request(
Route('PATCH', '/users/@me/billing/payment-sources/{source_id}', source_id=source_id), json=payload
)
def delete_payment_source(self, source_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/users/@me/billing/payment-sources/{source_id}', source_id=source_id))
def validate_billing_address(self, address: dict) -> Response[billing.BillingAddressToken]:
payload = {'billing_address': address}
return self.request(Route('POST', '/users/@me/billing/payment-sources/validate-billing-address'), json=payload)
def get_subscriptions(
self, limit: Optional[int] = None, include_inactive: bool = False
) -> Response[List[subscriptions.Subscription]]:
params = {}
if limit:
params['limit'] = limit
if include_inactive:
params['include_inactive'] = 'true'
return self.request(Route('GET', '/users/@me/billing/subscriptions'), params=params)
def get_subscription(self, subscription_id: Snowflake) -> Response[subscriptions.Subscription]:
return self.request(
Route('GET', '/users/@me/billing/subscriptions/{subscription_id}', subscription_id=subscription_id)
)
def create_subscription(
self,
items: List[dict],
payment_source_id: int,
currency: str,
*,
trial_id: Optional[Snowflake] = None,
payment_source_token: Optional[str] = None,
return_url: Optional[str] = None,
purchase_token: Optional[str] = None,
gateway_checkout_context: Optional[str] = None,
code: Optional[str] = None,
metadata: Optional[dict] = None,
) -> Response[subscriptions.Subscription]:
payload = {
'items': items,
'payment_source_id': payment_source_id,
'currency': currency,
'trial_id': trial_id,
'payment_source_token': payment_source_token,
'return_url': return_url,
'purchase_token': purchase_token,
'gateway_checkout_context': gateway_checkout_context,
}
if code:
payload['code'] = code
if metadata:
payload['metadata'] = metadata
return self.request(Route('POST', '/users/@me/billing/subscriptions'), json=payload)
def edit_subscription(
self,
subscription_id: Snowflake,
location: Optional[Union[str, List[str]]] = None,
location_stack: Optional[Union[str, List[str]]] = None,
**payload: dict,
) -> Response[subscriptions.Subscription]:
params = {}
if location:
params['location'] = location
if location_stack:
params['location_stack'] = location_stack
return self.request(
Route('PATCH', '/users/@me/billing/subscriptions/{subscription_id}', subscription_id=subscription_id),
params=params,
json=payload,
)
def delete_subscription(
self,
subscription_id: Snowflake,
location: Optional[Union[str, List[str]]] = None,
location_stack: Optional[Union[str, List[str]]] = None,
) -> Response[None]:
params = {}
if location:
params['location'] = location
if location_stack:
params['location_stack'] = location_stack
return self.request(
Route('DELETE', '/users/@me/billing/subscriptions/{subscription_id}', subscription_id=subscription_id),
params=params,
)
def preview_subscriptions_update(
self,
items: List[dict],
currency: str,
payment_source_id: Optional[Snowflake] = None,
trial_id: Optional[Snowflake] = None,
apply_entitlements: bool = MISSING,
renewal: bool = MISSING,
code: Optional[str] = None,
metadata: Optional[dict] = None,
) -> Response[subscriptions.SubscriptionInvoice]:
payload: Dict[str, Any] = {
'items': items,
'currency': currency,
'payment_source_id': payment_source_id,
'trial_id': trial_id,
}
if apply_entitlements is not MISSING:
payload['apply_entitlements'] = apply_entitlements
if renewal is not MISSING:
payload['renewal'] = renewal
if code:
payload['code'] = code
if metadata:
payload['metadata'] = metadata
return self.request(Route('POST', '/users/@me/billing/subscriptions/preview'), json=payload)
def get_subscription_preview(self, subscription_id: Snowflake) -> Response[subscriptions.SubscriptionInvoice]:
return self.request(
Route('GET', '/users/@me/billing/subscriptions/{subscription_id}/preview', subscription_id=subscription_id)
)
def preview_subscription_update(
self, subscription_id: Snowflake, **payload
) -> Response[subscriptions.SubscriptionInvoice]:
return self.request(
Route('PATCH', '/users/@me/billing/subscriptions/{subscription_id}/preview', subscription_id=subscription_id),
json=payload,
)
def get_subscription_invoices(self, subscription_id: Snowflake) -> Response[List[subscriptions.SubscriptionInvoice]]:
return self.request(
Route('GET', '/users/@me/billing/subscriptions/{subscription_id}/invoices', subscription_id=subscription_id)
)
def get_applied_guild_subscriptions(self) -> Response[List[subscriptions.PremiumGuildSubscription]]:
return self.request(Route('GET', '/users/@me/guilds/premium/subscriptions'))
def get_guild_subscriptions(self, guild_id: Snowflake) -> Response[List[subscriptions.PremiumGuildSubscription]]:
return self.request(Route('GET', '/guilds/{guild_id}/premium/subscriptions', guild_id=guild_id))
def delete_guild_subscription(self, guild_id: Snowflake, subscription_id: Snowflake) -> Response[None]:
return self.request(
Route(
'DELETE',
'/guilds/{guild_id}/premium/subscriptions/{subscription_id}',
guild_id=guild_id,
subscription_id=subscription_id,
)
)
def get_guild_subscriptions_cooldown(self) -> Response[subscriptions.PremiumGuildSubscriptionCooldown]:
return self.request(Route('GET', '/users/@me/guilds/premium/subscriptions/cooldown'))
def get_guild_subscription_slots(self) -> Response[List[subscriptions.PremiumGuildSubscriptionSlot]]:
return self.request(Route('GET', '/users/@me/guilds/premium/subscription-slots'))
def apply_guild_subscription_slots(
self, guild_id: Snowflake, slot_ids: Sequence[Snowflake]
) -> Response[List[subscriptions.PremiumGuildSubscription]]:
payload = {'user_premium_guild_subscription_slot_ids': slot_ids}
return self.request(Route('PUT', '/guilds/{guild_id}/premium/subscriptions', guild_id=guild_id), json=payload)
def cancel_guild_subscription_slot(self, slot_id: Snowflake) -> Response[subscriptions.PremiumGuildSubscriptionSlot]:
return self.request(Route('POST', '/users/@me/guilds/premium/subscription-slots/{slot_id}/cancel', slot_id=slot_id))
def uncancel_guild_subscription_slot(self, slot_id: Snowflake) -> Response[subscriptions.PremiumGuildSubscriptionSlot]:
return self.request(
Route('POST', '/users/@me/guilds/premium/subscription-slots/{slot_id}/uncancel', slot_id=slot_id)
)
def pay_invoice(
self,
subscription_id: Snowflake,
invoice_id: Snowflake,
payment_source_id: Optional[Snowflake],
payment_source_token: Optional[str] = None,
currency: str = 'usd',
return_url: Optional[str] = None,
) -> Response[subscriptions.Subscription]:
payload = {
'payment_source_id': payment_source_id,
}
if payment_source_id:
payload.update(
{
'payment_source_token': payment_source_token,
'currency': currency,
'return_url': return_url,
}
)
return self.request(
Route(
'POST',
'/users/@me/billing/subscriptions/{subscription_id}/invoices/{invoice_id}/pay',
subscription_id=subscription_id,
invoice_id=invoice_id,
),
json=payload,
)
def get_payments(
self, limit: int, before: Optional[Snowflake] = None, after: Optional[Snowflake] = None
) -> Response[List[payments.Payment]]:
params: Dict[str, Snowflake] = {'limit': limit}
if before:
params['before'] = before
if after:
params['after'] = after
return self.request(Route('GET', '/users/@me/billing/payments'), params=params)
def get_payment(self, payment_id: Snowflake) -> Response[payments.Payment]:
return self.request(Route('GET', '/users/@me/billing/payments/{payment_id}', payment_id=payment_id))
def void_payment(self, payment_id: Snowflake) -> Response[None]:
return self.request(Route('POST', '/users/@me/billing/payments/{payment_id}/void', payment_id=payment_id))
def refund_payment(self, payment_id: Snowflake, reason: Optional[int] = None) -> Response[None]:
payload = {'reason': reason}
return self.request(
Route('POST', '/users/@me/billing/payments/{payment_id}/refund', payment_id=payment_id), json=payload
)
def get_promotions(self, locale: str = 'en-US') -> Response[List[promotions.Promotion]]:
params = {'locale': locale}
return self.request(Route('GET', '/outbound-promotions'), params=params)
def get_claimed_promotions(self, locale: str = 'en-US') -> Response[List[promotions.ClaimedPromotion]]:
params = {'locale': locale}
return self.request(Route('GET', '/users/@me/outbound-promotions/codes'), params=params)
def claim_promotion(self, promotion_id: Snowflake) -> Response[promotions.ClaimedPromotion]:
return self.request(Route('POST', '/outbound-promotions/{promotion_id}/claim', promotion_id=promotion_id))
def get_trial_offer(self) -> Response[promotions.TrialOffer]:
return self.request(Route('GET', '/users/@me/billing/user-trial-offer'))
def ack_trial_offer(self, trial_id: Snowflake) -> Response[promotions.TrialOffer]:
return self.request(Route('POST', '/users/@me/billing/user-trial-offer/{trial_id}/ack', trial_id=trial_id))
def get_pricing_promotion(self) -> Response[promotions.WrappedPricingPromotion]:
return self.request(Route('GET', '/users/@me/billing/localized-pricing-promo'))
def get_premium_usage(self) -> Response[billing.PremiumUsage]:
return self.request(Route('GET', '/users/@me/premium-usage'))
# OAuth2
def get_oauth2_tokens(self) -> Response[List[oauth2.OAuth2Token]]:
return self.request(Route('GET', '/oauth2/tokens'))
def revoke_oauth2_token(self, token_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/oauth2/tokens/{token_id}', token_id=token_id))
def get_guild_webhook_channels(self, guild_id: Snowflake) -> Response[List[oauth2.WebhookChannel]]:
params = {'guild_id': guild_id}
return self.request(Route('GET', '/oauth2/authorize/webhook-channels'), params=params)
def get_oauth2_authorization(
self,
application_id: Snowflake,
scopes: List[str],
response_type: Optional[str] = None,
redirect_uri: Optional[str] = None,
code_challenge_method: Optional[str] = None,
code_challenge: Optional[str] = None,
state: Optional[str] = None,
) -> Response[oauth2.OAuth2Authorization]:
params = {'client_id': application_id, 'scope': ' '.join(scopes)}
if response_type:
params['response_type'] = response_type
if redirect_uri:
params['redirect_uri'] = redirect_uri
if code_challenge_method:
params['code_challenge_method'] = code_challenge_method
if code_challenge:
params['code_challenge'] = code_challenge
if state:
params['state'] = state
return self.request(Route('GET', '/oauth2/authorize'), params=params)
def authorize_oauth2(
self,
application_id: Snowflake,
scopes: List[str],
response_type: Optional[str] = None,
redirect_uri: Optional[str] = None,
code_challenge_method: Optional[str] = None,
code_challenge: Optional[str] = None,
state: Optional[str] = None,
guild_id: Optional[Snowflake] = None,
webhook_channel_id: Optional[Snowflake] = None,
permissions: Optional[Snowflake] = None,
) -> Response[oauth2.OAuth2Location]:
params = {'client_id': application_id, 'scope': ' '.join(scopes)}
payload: Dict[str, Any] = {'authorize': True}
if response_type:
params['response_type'] = response_type
if redirect_uri:
params['redirect_uri'] = redirect_uri
if code_challenge_method:
params['code_challenge_method'] = code_challenge_method
if code_challenge:
params['code_challenge'] = code_challenge
if state:
params['state'] = state
if guild_id:
payload['guild_id'] = str(guild_id)
payload['permissions'] = '0'
if webhook_channel_id:
payload['webhook_channel_id'] = str(webhook_channel_id)
if permissions:
payload['permissions'] = str(permissions)
return self.request(Route('POST', '/oauth2/authorize'), params=params, json=payload)
# Active Developer Program
def enroll_active_developer(
self, application_id: Snowflake, channel_id: Snowflake
) -> Response[application.ActiveDeveloperResponse]:
payload = {'application_id': application_id, 'channel_id': channel_id}
return self.request(Route('POST', '/developers/active-program'), json=payload, super_properties_to_track=True)
def unenroll_active_developer(self) -> Response[None]:
return self.request(Route('DELETE', '/developers/active-program'), super_properties_to_track=True)
# Misc
async def get_gateway(self, *, encoding: str = 'json', zlib: bool = True) -> str:
try:
data = await self.request(Route('GET', '/gateway'))
except HTTPException as exc:
raise GatewayNotFound() from exc
if zlib:
value = '{0}?encoding={1}&v={2}&compress=zlib-stream'
else:
value = '{0}?encoding={1}&v={2}'
return value.format(data['url'], encoding, INTERNAL_API_VERSION)
def get_user(self, user_id: Snowflake) -> Response[user.APIUser]:
return self.request(Route('GET', '/users/{user_id}', user_id=user_id))
def get_user_profile(
self,
user_id: Snowflake,
guild_id: Optional[Snowflake] = None,
*,
with_mutual_guilds: bool = True,
with_mutual_friends_count: bool = False,
) -> Response[profile.Profile]:
params: Dict[str, Any] = {
'with_mutual_guilds': str(with_mutual_guilds).lower(),
'with_mutual_friends_count': str(with_mutual_friends_count).lower(),
}
if guild_id:
params['guild_id'] = guild_id
return self.request(Route('GET', '/users/{user_id}/profile', user_id=user_id), params=params)
def get_mutual_friends(self, user_id: Snowflake): # TODO: return type
return self.request(Route('GET', '/users/{user_id}/relationships', user_id=user_id))
def get_notes(self) -> Response[Dict[Snowflake, str]]:
return self.request(Route('GET', '/users/@me/notes'))
def get_note(self, user_id: Snowflake) -> Response[user.Note]:
return self.request(Route('GET', '/users/@me/notes/{user_id}', user_id=user_id))
def set_note(self, user_id: Snowflake, *, note: Optional[str] = None) -> Response[None]:
payload = {'note': note or ''}
return self.request(Route('PUT', '/users/@me/notes/{user_id}', user_id=user_id), json=payload)
def change_hypesquad_house(self, house_id: int) -> Response[None]:
payload = {'house_id': house_id}
return self.request(Route('POST', '/hypesquad/online'), json=payload)
def leave_hypesquad_house(self) -> Response[None]:
return self.request(Route('DELETE', '/hypesquad/online'))
def get_proto_settings(self, type: int) -> Response[user.ProtoSettings]:
return self.request(Route('GET', '/users/@me/settings-proto/{type}', type=type))
def edit_proto_settings(
self, type: int, settings: str, required_data_version: Optional[int] = None
) -> Response[user.ProtoSettings]:
payload: Dict[str, Snowflake] = {'settings': settings}
if required_data_version is not None:
# The required data version of the proto is set to the last known version when an offline edit is made
# so the PATCH doesn't overwrite newer edits made on a different client
payload['required_data_version'] = required_data_version
return self.request(Route('PATCH', '/users/@me/settings-proto/{type}', type=type), json=payload)
def get_settings(self): # TODO: return type
return self.request(Route('GET', '/users/@me/settings'))
def edit_settings(self, **payload): # TODO: return type, is this cheating?
return self.request(Route('PATCH', '/users/@me/settings'), json=payload)
def get_tracking(self): # TODO: return type
return self.request(Route('GET', '/users/@me/consent'))
def edit_tracking(self, payload):
return self.request(Route('POST', '/users/@me/consent'), json=payload)
def get_email_settings(self):
return self.request(Route('GET', '/users/@me/email-settings'))
def edit_email_settings(self, **payload):
return self.request(Route('PATCH', '/users/@me/email-settings'), json={'settings': payload})
def mobile_report( # Report v1
self, guild_id: Snowflake, channel_id: Snowflake, message_id: Snowflake, reason: str
): # TODO: return type
payload = {'guild_id': guild_id, 'channel_id': channel_id, 'message_id': message_id, 'reason': reason}
return self.request(Route('POST', '/report'), json=payload)
def get_application_commands(self, app_id: Snowflake):
return self.request(Route('GET', '/applications/{application_id}/commands', application_id=app_id))
def search_application_commands(
self,
channel_id: Snowflake,
type: int,
*,
limit: Optional[int] = None,
query: Optional[str] = None,
cursor: Optional[str] = None,
command_ids: Optional[List[Snowflake]] = None,
application_id: Optional[Snowflake] = None,
include_applications: Optional[bool] = None,
):
params: Dict[str, Any] = {
'type': type,
}
if include_applications is not None:
params['include_applications'] = str(include_applications).lower()
if limit is not None:
params['limit'] = limit
if query:
params['query'] = query
if cursor:
params['cursor'] = cursor
if command_ids:
params['command_ids'] = ','.join(map(str, command_ids))
if application_id:
params['application_id'] = application_id
return self.request(
Route('GET', '/channels/{channel_id}/application-commands/search', channel_id=channel_id), params=params
)
def interact(
self,
type: InteractionType,
data: dict,
channel: MessageableChannel,
message: Optional[Message] = None,
*,
nonce: Optional[str] = MISSING,
application_id: Snowflake = MISSING,
files: Optional[List[_FileBase]] = None,
) -> Response[None]:
state = getattr(message, '_state', channel._state)
payload = {
'application_id': str((message.application_id or message.author.id) if message else application_id),
'channel_id': str(channel.id),
'data': data,
'nonce': nonce if nonce is not MISSING else utils._generate_nonce(),
'session_id': state.session_id or utils._generate_session_id(),
'type': type.value,
}
if message is not None:
payload['message_flags'] = message.flags.value
payload['message_id'] = str(message.id)
if message.guild:
payload['guild_id'] = str(message.guild.id)
else:
guild = getattr(channel, 'guild', None)
if guild is not None:
payload['guild_id'] = str(guild.id)
form = []
to_upload = [file for file in files if isinstance(file, File)] if files else []
if files is not None:
form.append({'name': 'payload_json', 'value': utils._to_json(payload)})
# Legacy uploading
for index, file in enumerate(to_upload or []):
form.append(
{
'name': f'files[{index}]',
'value': file.fp,
'filename': file.filename,
'content_type': 'application/octet-stream',
}
)
payload = None
return self.request(Route('POST', '/interactions'), json=payload, form=form, files=to_upload)
def get_user_affinities(self) -> Response[user.UserAffinities]:
return self.request(Route('GET', '/users/@me/affinities/users'))
def get_guild_affinities(self) -> Response[user.GuildAffinities]:
return self.request(Route('GET', '/users/@me/affinities/guilds'))
def get_country_code(self) -> Response[subscriptions.CountryCode]:
return self.request(Route('GET', '/users/@me/billing/country-code'))
def get_library_entries(
self, country_code: Optional[str] = None, payment_source_id: Optional[Snowflake] = None
) -> Response[List[library.LibraryApplication]]:
params = {}
if country_code is not None:
params['country_code'] = country_code
if payment_source_id is not None:
params['payment_source_id'] = payment_source_id
return self.request(Route('GET', '/users/@me/library'), params=params)
def edit_library_entry(
self, app_id: Snowflake, branch_id: Snowflake, payload: dict
) -> Response[library.LibraryApplication]:
return self.request(
Route('PATCH', '/users/@me/library/{application_id}/{branch_id}', application_id=app_id, branch_id=branch_id),
json=payload,
)
def delete_library_entry(self, app_id: Snowflake, branch_id: Snowflake) -> Response[None]:
return self.request(
Route('DELETE', '/users/@me/library/{application_id}/{branch_id}', application_id=app_id, branch_id=branch_id)
)
def mark_library_entry_installed(self, app_id: Snowflake, branch_id: Snowflake) -> Response[library.LibraryApplication]:
return self.request(
Route(
'POST',
'/users/@me/library/{application_id}/{branch_id}/installed',
application_id=app_id,
branch_id=branch_id,
)
)
# Unverified Applications
def report_unverified_application(
self,
name: str,
icon_hash: str,
os: str,
*,
executable: Optional[str] = None,
publisher: Optional[str] = None,
distributor: Optional[str] = None,
sku: Optional[str] = None,
) -> Response[application.UnverifiedApplication]:
payload = {
'report_version': 3,
'name': name,
'icon': icon_hash,
'os': os,
}
if executable is not None:
payload['executable'] = executable
if publisher:
payload['publisher'] = publisher
if distributor:
payload['distributor_application'] = {
'distributor': distributor,
'sku': sku or '',
}
return self.request(Route('POST', '/unverified-applications'), json=payload)
def upload_unverified_application_icon(self, name: str, hash: str, icon: str) -> Response[None]:
payload = {
'application_name': name,
'application_hash': hash,
'icon': icon,
}
return self.request(Route('POST', '/unverified-applications/icons'), json=payload)
# Recent Mentions
def get_recent_mentions(
self,
limit: int = 25,
before: Optional[Snowflake] = None,
guild_id: Optional[Snowflake] = None,
roles: bool = True,
everyone: bool = True,
) -> Response[List[message.Message]]:
params = {
'limit': limit,
'roles': str(roles).lower(),
'everyone': str(everyone).lower(),
}
if before is not None:
params['before'] = before
if guild_id is not None:
params['guild_id'] = guild_id
return self.request(Route('GET', '/users/@me/mentions'), params=params)
def delete_recent_mention(self, message_id: Snowflake) -> Response[None]:
return self.request(Route('DELETE', '/users/@me/mentions/{message_id}', message_id=message_id))
# Tutorial
def confirm_tutorial_indicator(self, indicator: str) -> Response[None]:
return self.request(Route('PUT', '/tutorial/indicators/{indicator}', indicator=indicator))
def suppress_tutorial(self) -> Response[None]:
return self.request(Route('POST', '/tutorial/indicators/suppress'))
async def get_preferred_voice_regions(self) -> List[dict]:
async with self.__session.get('https://latency.discord.media/rtc') as resp:
if resp.status == 200:
return await resp.json()
elif resp.status == 404:
raise NotFound(resp, 'rtc regions not found')
elif resp.status == 403:
raise Forbidden(resp, 'cannot retrieve rtc regions')
else:
raise HTTPException(resp, 'failed to get rtc regions')
# Experiments
@overload
def get_experiments(
self, with_guild_experiments: Literal[True] = ...
) -> Response[experiment.ExperimentResponseWithGuild]:
...
@overload
def get_experiments(self, with_guild_experiments: Literal[False] = ...) -> Response[experiment.ExperimentResponse]:
...
@overload
def get_experiments(
self, with_guild_experiments: bool = True
) -> Response[Union[experiment.ExperimentResponse, experiment.ExperimentResponseWithGuild]]:
...
def get_experiments(
self, with_guild_experiments: bool = True
) -> Response[Union[experiment.ExperimentResponse, experiment.ExperimentResponseWithGuild]]:
params = {'with_guild_experiments': str(with_guild_experiments).lower()}
return self.request(Route('GET', '/experiments'), params=params, context_properties=ContextProperties.empty())