hikari.impl.rest
Implementation of a V8 compatible REST API for Discord.
This also includes implementations designed towards providing RESTful functionality.
View Source
# -*- coding: utf-8 -*- # cython: language_level=3 # Copyright (c) 2020 Nekokatt # Copyright (c) 2021-present davfsa # # 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. """Implementation of a V8 compatible REST API for Discord. This also includes implementations designed towards providing RESTful functionality. """ from __future__ import annotations __all__: typing.Sequence[str] = ("ClientCredentialsStrategy", "RESTApp", "RESTClientImpl") import asyncio import base64 import contextlib import copy import datetime import http import logging import math import os import platform import sys import typing import urllib.parse import aiohttp import attr from hikari import _about as about from hikari import applications from hikari import channels as channels_ from hikari import colors from hikari import commands from hikari import embeds as embeds_ from hikari import emojis from hikari import errors from hikari import files from hikari import guilds from hikari import iterators from hikari import locales from hikari import permissions as permissions_ from hikari import scheduled_events from hikari import snowflakes from hikari import traits from hikari import undefined from hikari import urls from hikari import users from hikari.api import rest as rest_api from hikari.impl import buckets as buckets_impl from hikari.impl import config as config_impl from hikari.impl import entity_factory as entity_factory_impl from hikari.impl import rate_limits from hikari.impl import special_endpoints as special_endpoints_impl from hikari.interactions import base_interactions from hikari.internal import data_binding from hikari.internal import deprecation from hikari.internal import mentions from hikari.internal import net from hikari.internal import routes from hikari.internal import time from hikari.internal import ux if typing.TYPE_CHECKING: import concurrent.futures import types from hikari import audit_logs from hikari import invites from hikari import messages as messages_ from hikari import sessions from hikari import stickers from hikari import templates from hikari import voices from hikari import webhooks from hikari.api import cache as cache_api from hikari.api import entity_factory as entity_factory_ from hikari.api import special_endpoints _LOGGER: typing.Final[logging.Logger] = logging.getLogger("hikari.rest") _APPLICATION_JSON: typing.Final[str] = "application/json" _AUTHORIZATION_HEADER: typing.Final[str] = sys.intern("Authorization") _HTTP_USER_AGENT: typing.Final[str] = ( f"DiscordBot ({about.__url__}, {about.__version__}) {about.__author__} " f"AIOHTTP/{aiohttp.__version__} " f"{platform.python_implementation()}/{platform.python_version()} {platform.system()} {platform.architecture()[0]}" ) _USER_AGENT_HEADER: typing.Final[str] = sys.intern("User-Agent") _X_AUDIT_LOG_REASON_HEADER: typing.Final[str] = sys.intern("X-Audit-Log-Reason") _X_RATELIMIT_BUCKET_HEADER: typing.Final[str] = sys.intern("X-RateLimit-Bucket") _X_RATELIMIT_LIMIT_HEADER: typing.Final[str] = sys.intern("X-RateLimit-Limit") _X_RATELIMIT_REMAINING_HEADER: typing.Final[str] = sys.intern("X-RateLimit-Remaining") _X_RATELIMIT_RESET_AFTER_HEADER: typing.Final[str] = sys.intern("X-RateLimit-Reset-After") _RETRY_ERROR_CODES: typing.Final[typing.Set[int]] = {500, 502, 503, 504} _MAX_BACKOFF_DURATION: typing.Final[int] = 16 class ClientCredentialsStrategy(rest_api.TokenStrategy): """Strategy class for handling client credential OAuth2 authorization. Parameters ---------- client: typing.Optional[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]] Object or ID of the application this client credentials strategy should authorize as. client_secret : typing.Optional[str] Client secret to use when authorizing. Other Parameters ---------------- scopes : typing.Sequence[str] The scopes to authorize for. """ __slots__: typing.Sequence[str] = ( "_client_id", "_client_secret", "_exception", "_expire_at", "_lock", "_scopes", "_token", ) def __init__( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, *, scopes: typing.Sequence[typing.Union[applications.OAuth2Scope, str]] = ( applications.OAuth2Scope.APPLICATIONS_COMMANDS_UPDATE, applications.OAuth2Scope.IDENTIFY, ), ) -> None: self._client_id = snowflakes.Snowflake(client) self._client_secret = client_secret self._exception: typing.Optional[errors.ClientHTTPResponseError] = None self._expire_at = 0.0 self._lock = asyncio.Lock() self._scopes = tuple(scopes) self._token: typing.Optional[str] = None @property def client_id(self) -> snowflakes.Snowflake: """ID of the application this token strategy authenticates with.""" return self._client_id @property def _is_expired(self) -> bool: return time.monotonic() >= self._expire_at @property def scopes(self) -> typing.Sequence[typing.Union[applications.OAuth2Scope, str]]: """Sequence of scopes this token strategy authenticates for.""" return self._scopes @property def token_type(self) -> applications.TokenType: return applications.TokenType.BEARER async def acquire(self, client: rest_api.RESTClient) -> str: if self._token and not self._is_expired: return self._token async with self._lock: if self._token and not self._is_expired: return self._token if self._exception: # If we don't copy the exception then python keeps adding onto the stack each time it's raised. raise copy.copy(self._exception) from None try: response = await client.authorize_client_credentials_token( client=self._client_id, client_secret=self._client_secret, scopes=self._scopes ) except errors.ClientHTTPResponseError as exc: if not isinstance(exc, errors.RateLimitedError): # If we don't copy the exception then python keeps adding onto the stack each time it's raised. self._exception = copy.copy(exc) raise # Expires in is lowered a bit in-order to lower the chance of a dead token being used. self._expire_at = time.monotonic() + math.floor(response.expires_in.total_seconds() * 0.99) self._token = f"{response.token_type} {response.access_token}" return self._token def invalidate(self, token: typing.Optional[str]) -> None: if not token or token == self._token: self._expire_at = 0.0 self._token = None class _RESTProvider(traits.RESTAware): __slots__: typing.Sequence[str] = ("_entity_factory", "_executor", "_rest") def __init__( self, entity_factory: typing.Callable[[], entity_factory_.EntityFactory], executor: typing.Optional[concurrent.futures.Executor], rest: typing.Callable[[], RESTClientImpl], ) -> None: self._entity_factory = entity_factory self._executor = executor self._rest = rest @property def entity_factory(self) -> entity_factory_.EntityFactory: return self._entity_factory() @property def executor(self) -> typing.Optional[concurrent.futures.Executor]: return self._executor @property def rest(self) -> rest_api.RESTClient: return self._rest() @property def http_settings(self) -> config_impl.HTTPSettings: return self._rest().http_settings @property def proxy_settings(self) -> config_impl.ProxySettings: return self._rest().proxy_settings _NONE_OR_UNDEFINED: typing.Final[typing.Tuple[None, undefined.UndefinedType]] = (None, undefined.UNDEFINED) class RESTApp(traits.ExecutorAware): """The base for a HTTP-only Discord application. This comprises of a shared TCP connector connection pool, and can have `RESTClientImpl` instances for specific credentials acquired from it. Parameters ---------- executor : typing.Optional[concurrent.futures.Executor] The executor to use for blocking file IO operations. If `None` is passed, then the default `concurrent.futures.ThreadPoolExecutor` for the `asyncio.AbstractEventLoop` will be used instead. http_settings : typing.Optional[hikari.impl.config.HTTPSettings] HTTP settings to use. Sane defaults are used if this is `None`. max_rate_limit : float Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a `hikari.errors.RateLimitedError` will be raised instead of waiting. This is provided since some endpoints may respond with non-sensible rate limits. Defaults to five minutes if unspecified. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. proxy_settings : typing.Optional[hikari.impl.config.ProxySettings] Proxy settings to use. If `None` then no proxy configuration will be used. url : typing.Optional[str] The base URL for the API. You can generally leave this as being `None` and the correct default API base URL will be generated. """ __slots__: typing.Sequence[str] = ( "_executor", "_http_settings", "_max_rate_limit", "_max_retries", "_proxy_settings", "_url", ) def __init__( self, *, executor: typing.Optional[concurrent.futures.Executor] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, url: typing.Optional[str] = None, ) -> None: self._http_settings = config_impl.HTTPSettings() if http_settings is None else http_settings self._proxy_settings = config_impl.ProxySettings() if proxy_settings is None else proxy_settings self._executor = executor self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._url = url @property def executor(self) -> typing.Optional[concurrent.futures.Executor]: return self._executor @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @typing.overload def acquire(self, token: typing.Optional[rest_api.TokenStrategy] = None) -> RESTClientImpl: ... @typing.overload def acquire( self, token: str, token_type: typing.Union[str, applications.TokenType] = applications.TokenType.BEARER, ) -> RESTClientImpl: ... def acquire( self, token: typing.Union[str, rest_api.TokenStrategy, None] = None, token_type: typing.Union[str, applications.TokenType, None] = None, ) -> RESTClientImpl: """Acquire an instance of this REST client. .. note:: The returned REST client should be started before it can be used, either by calling `RESTClientImpl.start` or by using it as an asynchronous context manager. Examples -------- ```py rest_app = RESTApp() # Using the returned client as a context manager to implicitly start # and stop it. async with rest_app.acquire("A token", "Bot") as client: user = await client.fetch_my_user() ``` Parameters ---------- token : typing.Union[str, None, hikari.api.rest.TokenStrategy] The bot or bearer token. If no token is to be used, this can be undefined. token_type : typing.Union[str, hikari.applications.TokenType, None] The type of token in use. This should only be passed when `str` is passed for `token`, can be `"Bot"` or `"Bearer"` and will be defaulted to `"Bearer"` in this situation. This should be left as `None` when either `hikari.api.rest.TokenStrategy` or `None` is passed for `token`. Returns ------- RESTClientImpl An instance of the REST client. Raises ------ ValueError If `token_type` is provided when a token strategy is passed for `token`. """ # Since we essentially mimic a fake App instance, we need to make a circular provider. # We can achieve this using a lambda. This allows the entity factory to build models that # are also REST-aware provider = _RESTProvider(lambda: entity_factory, self._executor, lambda: rest_client) entity_factory = entity_factory_impl.EntityFactoryImpl(provider) if isinstance(token, str): token = token.strip() if token_type is None: token_type = applications.TokenType.BEARER rest_client = RESTClientImpl( cache=None, entity_factory=entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=self._max_rate_limit, max_retries=self._max_retries, proxy_settings=self._proxy_settings, token=token, token_type=token_type, rest_url=self._url, ) return rest_client @attr.define() class _LiveAttributes: """Fields which are only present within `RESTClientImpl` while it's "alive". .. note:: This must be started within an active asyncio event loop. """ buckets: buckets_impl.RESTBucketManager = attr.field() client_session: aiohttp.ClientSession = attr.field() closed_event: asyncio.Event = attr.field() # We've been told in DAPI that this is per token. global_rate_limit: rate_limits.ManualRateLimiter = attr.field() tcp_connector: aiohttp.TCPConnector = attr.field() is_closing: bool = attr.field(default=False, init=False) @classmethod def build( cls, max_rate_limit: float, http_settings: config_impl.HTTPSettings, proxy_settings: config_impl.ProxySettings ) -> _LiveAttributes: """Build a live attributes object. .. warning:: This can only be called when the current thread has an active asyncio loop. """ # This asserts that this is called within an active event loop. asyncio.get_running_loop() tcp_connector = net.create_tcp_connector(http_settings) _LOGGER.log(ux.TRACE, "acquired new tcp connector") client_session = net.create_client_session( connector=tcp_connector, # No, this is correct. We manage closing the connector ourselves in this class. # This works around some other lifespan issues. connector_owner=False, http_settings=http_settings, raise_for_status=False, trust_env=proxy_settings.trust_env, ) _LOGGER.log(ux.TRACE, "acquired new aiohttp client session") return _LiveAttributes( buckets=buckets_impl.RESTBucketManager(max_rate_limit), client_session=client_session, closed_event=asyncio.Event(), global_rate_limit=rate_limits.ManualRateLimiter(), tcp_connector=tcp_connector, ) async def close(self) -> None: self.is_closing = True self.closed_event.set() self.buckets.close() self.global_rate_limit.close() await self.client_session.close() await self.tcp_connector.close() def still_alive(self) -> _LiveAttributes: """Chained method used to Check if `close` has been called before using this object's resources.""" if self.is_closing: raise errors.ComponentStateConflictError("The REST client was closed mid-request") return self # The standard exceptions are all unsloted so slotting here would be a waste of time. @attr.define(auto_exc=True, repr=False, slots=False) class _RetryRequest(RuntimeError): ... class RESTClientImpl(rest_api.RESTClient): """Implementation of the V8-compatible Discord HTTP API. This manages making HTTP/1.1 requests to the API and using the entity factory within the passed application instance to deserialize JSON responses to Pythonic data classes that are used throughout this library. Parameters ---------- entity_factory : hikari.api.entity_factory.EntityFactory The entity factory to use. executor : typing.Optional[concurrent.futures.Executor] The executor to use for blocking IO. Defaults to the `asyncio` thread pool if set to `None`. max_rate_limit : float Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a `hikari.errors.RateLimitedError` will be raised instead of waiting. This is provided since some endpoints may respond with non-sensible rate limits. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. token : typing.Union[str, None, hikari.api.rest.TokenStrategy] The bot or bearer token. If no token is to be used, this can be undefined. token_type : typing.Union[str, hikari.applications.TokenType, None] The type of token in use. This must be passed when a `str` is passed for `token` but and can be `"Bot"` or `"Bearer"`. This should be left as `None` when either `hikari.api.rest.TokenStrategy` or `None` is passed for `token`. rest_url : str The HTTP API base URL. This can contain format-string specifiers to interpolate information such as API version in use. Raises ------ ValueError * If `token_type` is provided when a token strategy is passed for `token`. * if `token_type` is left as `None` when a string is passed for `token`. * If the a value more than 5 is provided for `max_retries` """ __slots__: typing.Sequence[str] = ( "_cache", "_entity_factory", "_executor", "_http_settings", "_live_attributes", "_max_rate_limit", "_max_retries", "_proxy_settings", "_rest_url", "_token", "_token_type", ) def __init__( self, *, cache: typing.Optional[cache_api.MutableCache], entity_factory: entity_factory_.EntityFactory, executor: typing.Optional[concurrent.futures.Executor], http_settings: config_impl.HTTPSettings, max_rate_limit: float, max_retries: int = 3, proxy_settings: config_impl.ProxySettings, token: typing.Union[str, None, rest_api.TokenStrategy], token_type: typing.Union[applications.TokenType, str, None], rest_url: typing.Optional[str], ) -> None: if max_retries > 5: raise ValueError("'max_retries' must be below or equal to 5") self._cache = cache self._entity_factory = entity_factory self._executor = executor self._http_settings = http_settings self._live_attributes: typing.Optional[_LiveAttributes] = None self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._proxy_settings = proxy_settings self._token: typing.Union[str, rest_api.TokenStrategy, None] = None self._token_type: typing.Optional[str] = None if isinstance(token, str): if token_type is None: raise ValueError("Token type required when a str is passed for `token`") self._token = f"{token_type.title()} {token}" self._token_type = applications.TokenType(token_type.title()) elif isinstance(token, rest_api.TokenStrategy): if token_type is not None: raise ValueError("Token type should be handled by the token strategy") self._token = token self._token_type = token.token_type # While passing files.URL for rest_url is not officially supported, this is still # casted to string here to avoid confusing issues passing a URL here could lead to. self._rest_url = str(rest_url) if rest_url is not None else urls.REST_API_URL @property def is_alive(self) -> bool: return self._live_attributes is not None @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @property def entity_factory(self) -> entity_factory_.EntityFactory: return self._entity_factory @property def token_type(self) -> typing.Union[str, applications.TokenType, None]: return self._token_type @typing.final async def close(self) -> None: """Close the HTTP client and any open HTTP connections.""" live_attributes = self._get_live_attributes() self._live_attributes = None await live_attributes.close() @typing.final def start(self) -> None: """Start the HTTP client. .. note:: This must be called within an active event loop. Raises ------ RuntimeError If this is called in an environment without an active event loop. """ if self._live_attributes: raise errors.ComponentStateConflictError("Cannot start a REST Client which is already alive") self._live_attributes = _LiveAttributes.build(self._max_rate_limit, self._http_settings, self._proxy_settings) def _get_live_attributes(self) -> _LiveAttributes: if self._live_attributes: return self._live_attributes raise errors.ComponentStateConflictError("Cannot use an inactive REST client") async def __aenter__(self) -> RESTClientImpl: self.start() return self async def __aexit__( self, exc_type: typing.Optional[typing.Type[BaseException]], exc_val: typing.Optional[BaseException], exc_tb: typing.Optional[types.TracebackType], ) -> None: await self.close() # These are only included at runtime in-order to avoid the model being typed as a synchronous context manager. if not typing.TYPE_CHECKING: def __enter__(self) -> typing.NoReturn: # This is async only. cls = type(self) raise TypeError(f"{cls.__module__}.{cls.__qualname__} is async-only, did you mean 'async with'?") from None def __exit__( self, exc_type: typing.Optional[typing.Type[BaseException]], exc_val: typing.Optional[BaseException], exc_tb: typing.Optional[types.TracebackType], ) -> None: return None @typing.final async def _request( self, compiled_route: routes.CompiledRoute, *, query: typing.Optional[data_binding.StringMapBuilder] = None, form_builder: typing.Optional[data_binding.URLEncodedFormBuilder] = None, json: typing.Union[data_binding.JSONObjectBuilder, data_binding.JSONArray, None] = None, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, no_auth: bool = False, auth: typing.Optional[str] = None, ) -> typing.Union[None, data_binding.JSONObject, data_binding.JSONArray]: # Make a ratelimit-protected HTTP request to a JSON endpoint and expect some form # of JSON response. live_attributes = self._get_live_attributes() headers = data_binding.StringMapBuilder() headers.setdefault(_USER_AGENT_HEADER, _HTTP_USER_AGENT) re_authed = False token: typing.Optional[str] = None if auth: headers[_AUTHORIZATION_HEADER] = auth elif not no_auth: if isinstance(self._token, str): headers[_AUTHORIZATION_HEADER] = self._token elif self._token is not None: token = await self._token.acquire(self) headers[_AUTHORIZATION_HEADER] = token # As per the docs, UTF-8 characters are only supported here if it's url-encoded. headers.put(_X_AUDIT_LOG_REASON_HEADER, reason, conversion=urllib.parse.quote) url = compiled_route.create_url(self._rest_url) # This is initiated the first time we hit a 5xx error to save a little memory when nothing goes wrong backoff: typing.Optional[rate_limits.ExponentialBackOff] = None retry_count = 0 stack = contextlib.AsyncExitStack() trace_logging_enabled = _LOGGER.isEnabledFor(ux.TRACE) while True: try: uuid = time.uuid() async with stack: form = await form_builder.build(stack) if form_builder else None await stack.enter_async_context(live_attributes.still_alive().buckets.acquire(compiled_route)) # Buckets not using authentication still have a global # rate limit, but it is different from the token one. if not no_auth: await live_attributes.still_alive().global_rate_limit.acquire() if trace_logging_enabled: _LOGGER.log( ux.TRACE, "%s %s %s\n%s", uuid, compiled_route.method, url, self._stringify_http_message(headers, json), ) start = time.monotonic() # Make the request. response = await live_attributes.still_alive().client_session.request( compiled_route.method, url, headers=headers, params=query, json=json, data=form, allow_redirects=self._http_settings.max_redirects is not None, max_redirects=self._http_settings.max_redirects, proxy=self._proxy_settings.url, proxy_headers=self._proxy_settings.all_headers, ) if trace_logging_enabled: time_taken = (time.monotonic() - start) * 1_000 _LOGGER.log( ux.TRACE, "%s %s %s in %sms\n%s", uuid, response.status, response.reason, time_taken, self._stringify_http_message(response.headers, await response.read()), ) # Ensure we are not rate limited, and update rate limiting headers where appropriate. await self._parse_ratelimits(compiled_route, response, live_attributes) # Don't bother processing any further if we got NO CONTENT. There's not anything # to check. if response.status == http.HTTPStatus.NO_CONTENT: return None # Handle the response when everything went good if 200 <= response.status < 300: if response.content_type == _APPLICATION_JSON: # Only deserializing here stops Cloudflare shenanigans messing us around. return data_binding.load_json(await response.read()) real_url = str(response.real_url) raise errors.HTTPError(f"Expected JSON [{response.content_type=}, {real_url=}]") # Handling 5xx errors if response.status in _RETRY_ERROR_CODES and retry_count < self._max_retries: if backoff is None: backoff = rate_limits.ExponentialBackOff(maximum=_MAX_BACKOFF_DURATION) sleep_time = next(backoff) _LOGGER.warning( "Received status %s on request, backing off for %.2fs and retrying. Retries remaining: %s", response.status, sleep_time, self._max_retries - retry_count, ) retry_count += 1 await asyncio.sleep(sleep_time) continue # Attempt to re-auth on UNAUTHORIZED if we are using a TokenStrategy can_re_auth = response.status == 401 and not (auth or no_auth or re_authed) if can_re_auth and isinstance(self._token, rest_api.TokenStrategy): assert token is not None self._token.invalidate(token) token = await self._token.acquire(self) headers[_AUTHORIZATION_HEADER] = token re_authed = True continue await self._handle_error_response(response) except _RetryRequest: continue @staticmethod @typing.final def _stringify_http_message(headers: data_binding.Headers, body: typing.Any) -> str: string = "\n".join( f" {name}: {value}" if name != _AUTHORIZATION_HEADER else f" {name}: **REDACTED TOKEN**" for name, value in headers.items() ) if body is not None: string += "\n\n " string += body.decode("ascii") if isinstance(body, bytes) else str(body) return string @staticmethod @typing.final async def _handle_error_response(response: aiohttp.ClientResponse) -> typing.NoReturn: raise await net.generate_error_response(response) @typing.final async def _parse_ratelimits( self, compiled_route: routes.CompiledRoute, response: aiohttp.ClientResponse, live_attributes: _LiveAttributes ) -> None: # Handle rate limiting. resp_headers = response.headers limit = int(resp_headers.get(_X_RATELIMIT_LIMIT_HEADER, "1")) remaining = int(resp_headers.get(_X_RATELIMIT_REMAINING_HEADER, "1")) bucket = resp_headers.get(_X_RATELIMIT_BUCKET_HEADER) reset_after = float(resp_headers.get(_X_RATELIMIT_RESET_AFTER_HEADER, "0")) if bucket: live_attributes.still_alive().buckets.update_rate_limits( compiled_route=compiled_route, bucket_header=bucket, remaining_header=remaining, limit_header=limit, reset_after=reset_after, ) if response.status != http.HTTPStatus.TOO_MANY_REQUESTS: return # Discord have started applying ratelimits to operations on some endpoints # based on specific fields used in the JSON body. # This does not get reflected in the headers. The first we know is when we # get a 429. # The issue is that we may get the same response if Discord dynamically # adjusts the bucket ratelimits. # # We have no mechanism for handing field-based ratelimits, so if we get # to here, but notice remaining is greater than zero, we should just error. # # Seems Discord may raise this on some other undocumented cases, which # is nice of them. Apparently some dude spamming slurs in the Python # guild via a leaked webhook URL made people's clients exhibit this # behaviour. # # If we get ratelimited when running more than one bot under the same token, # or if the ratelimiting logic goes wrong, we will get a 429 and expect the # "remaining" header to be zeroed, or even negative as I don't trust that there # isn't some weird edge case here somewhere in Discord's implementation. # We can safely retry if this happens as acquiring the bucket will handle # this. if remaining <= 0: _LOGGER.warning( "rate limited on bucket %s, maybe you are running more than one bot on this token? Retrying request...", bucket, ) raise _RetryRequest if response.content_type != _APPLICATION_JSON: # We don't know exactly what this could imply. It is likely Cloudflare interfering # but I'd rather we just give up than do something resulting in multiple failed # requests repeatedly. raise errors.HTTPResponseError( str(response.real_url), http.HTTPStatus.TOO_MANY_REQUESTS, response.headers, await response.read(), f"received rate limited response with unexpected response type {response.content_type}", ) body = await response.json() body_retry_after = float(body["retry_after"]) if body.get("global", False) is True: _LOGGER.error( "rate limited on the global bucket. You should consider lowering the number of requests you make or " "contacting Discord to raise this limit. Backing off and retrying request..." ) live_attributes.still_alive().global_rate_limit.throttle(body_retry_after) raise _RetryRequest # If the values are within 20% of each other by relativistic tolerance, it is probably # safe to retry the request, as they are likely the same value just with some # measuring difference. 20% was used as a rounded figure. if math.isclose(body_retry_after, reset_after, rel_tol=0.20): _LOGGER.error("rate limited on a sub bucket on bucket %s, but it is safe to retry", bucket) raise _RetryRequest raise errors.RateLimitedError( url=str(response.real_url), route=compiled_route, headers=response.headers, raw_body=body, retry_after=body_retry_after, ) async def fetch_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.GET_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) result = self._entity_factory.deserialize_channel(response) if self._cache and isinstance(result, channels_.DMChannel): self._cache.set_dm_channel_id(result.recipient.id, result.id) return result async def edit_channel( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], /, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, region: undefined.UndefinedNoneOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, parent_category: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildCategory] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.PartialChannel: route = routes.PATCH_CHANNEL.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("position", position) body.put("topic", topic) body.put("nsfw", nsfw) body.put("bitrate", bitrate) body.put("video_quality_mode", video_quality_mode) body.put("user_limit", user_limit) body.put("rate_limit_per_user", rate_limit_per_user, conversion=time.timespan_to_int) body.put("rtc_region", region, conversion=str) body.put_snowflake("parent_id", parent_category) body.put_array( "permission_overwrites", permission_overwrites, conversion=self._entity_factory.serialize_permission_overwrite, ) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response) async def follow_channel( self, news_channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], target_channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.ChannelFollow: route = routes.POST_CHANNEL_FOLLOWERS.compile(channel=news_channel) body = data_binding.JSONObjectBuilder() body.put_snowflake("webhook_channel_id", target_channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel_follow(response) async def delete_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.DELETE_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response) async def edit_my_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, request_to_speak: typing.Union[undefined.UndefinedType, bool, datetime.datetime] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_MY_GUILD_VOICE_STATE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) if isinstance(request_to_speak, datetime.datetime): body.put("request_to_speak_timestamp", request_to_speak.isoformat()) elif request_to_speak is True: body.put("request_to_speak_timestamp", time.utc_datetime().isoformat()) elif request_to_speak is False: body.put("request_to_speak_timestamp", None) await self._request(route, json=body) async def edit_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], user: snowflakes.SnowflakeishOr[users.PartialUser], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_GUILD_VOICE_STATE.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) await self._request(route, json=body) async def edit_permission_overwrites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ snowflakes.Snowflakeish, users.PartialUser, guilds.PartialRole, channels_.PermissionOverwrite ], *, target_type: undefined.UndefinedOr[typing.Union[channels_.PermissionOverwriteType, int]] = undefined.UNDEFINED, allow: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, deny: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if target_type is undefined.UNDEFINED: if isinstance(target, users.PartialUser): target_type = channels_.PermissionOverwriteType.MEMBER elif isinstance(target, guilds.Role): target_type = channels_.PermissionOverwriteType.ROLE elif isinstance(target, channels_.PermissionOverwrite): target_type = target.type else: raise TypeError( "Cannot determine the type of the target to update. Try specifying 'target_type' manually." ) target = target.id if isinstance(target, channels_.PermissionOverwrite) else target route = routes.PUT_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) body = data_binding.JSONObjectBuilder() body.put("type", target_type) body.put("allow", allow) body.put("deny", deny) await self._request(route, json=body, reason=reason) async def delete_permission_overwrite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ channels_.PermissionOverwrite, guilds.PartialRole, users.PartialUser, snowflakes.Snowflakeish ], ) -> None: route = routes.DELETE_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) await self._request(route) async def fetch_channel_invites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel] ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_CHANNEL_INVITES.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response] async def create_invite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, max_age: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, max_uses: undefined.UndefinedOr[int] = undefined.UNDEFINED, temporary: undefined.UndefinedOr[bool] = undefined.UNDEFINED, unique: undefined.UndefinedOr[bool] = undefined.UNDEFINED, target_type: undefined.UndefinedOr[invites.TargetType] = undefined.UNDEFINED, target_user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, target_application: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[guilds.PartialApplication] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> invites.InviteWithMetadata: route = routes.POST_CHANNEL_INVITES.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("max_age", max_age, conversion=time.timespan_to_int) body.put("max_uses", max_uses) body.put("temporary", temporary) body.put("unique", unique) body.put("target_type", target_type) body.put_snowflake("target_user_id", target_user) body.put_snowflake("target_application_id", target_application) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_invite_with_metadata(response) def trigger_typing( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> special_endpoints.TypingIndicator: return special_endpoints_impl.TypingIndicator( request_call=self._request, channel=channel, rest_closed_event=self._get_live_attributes().closed_event ) async def fetch_pins( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> typing.Sequence[messages_.Message]: route = routes.GET_CHANNEL_PINS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_message(message_pl) for message_pl in response] async def pin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.PUT_CHANNEL_PINS.compile(channel=channel, message=message) await self._request(route) async def unpin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_PIN.compile(channel=channel, message=message) await self._request(route) def fetch_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, after: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, around: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[messages_.Message]: if undefined.count(before, after, around) < 2: raise TypeError("Expected no kwargs, or a maximum of one of 'before', 'after', 'around'") timestamp: undefined.UndefinedOr[str] if before is not undefined.UNDEFINED: direction = "before" if isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) elif after is not undefined.UNDEFINED: direction = "after" if isinstance(after, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(after)) else: timestamp = str(int(after)) elif around is not undefined.UNDEFINED: direction = "around" if isinstance(around, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(around)) else: timestamp = str(int(around)) else: direction = "before" timestamp = undefined.UNDEFINED return special_endpoints_impl.MessageIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, direction=direction, first_id=timestamp, ) async def fetch_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.GET_CHANNEL_MESSAGE.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) def _build_message_payload( # noqa: C901- Function too complex self, /, *, content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, edit: bool = False, ) -> typing.Tuple[data_binding.JSONObjectBuilder, typing.Optional[data_binding.URLEncodedFormBuilder]]: if not undefined.any_undefined(attachment, attachments): raise ValueError("You may only specify one of 'attachment' or 'attachments', not both") if not undefined.any_undefined(component, components): raise ValueError("You may only specify one of 'component' or 'components', not both") if not undefined.any_undefined(embed, embeds): raise ValueError("You may only specify one of 'embed' or 'embeds', not both") if attachments is not undefined.UNDEFINED and not isinstance(attachments, typing.Collection): raise TypeError( "You passed a non-collection to 'attachments', but this expects a collection. Maybe you meant to " "use 'attachment' (singular) instead?" ) if components not in _NONE_OR_UNDEFINED and not isinstance(components, typing.Collection): raise TypeError( "You passed a non-collection to 'components', but this expects a collection. Maybe you meant to " "use 'component' (singular) instead?" ) if embeds not in _NONE_OR_UNDEFINED and not isinstance(embeds, typing.Collection): raise TypeError( "You passed a non-collection to 'embeds', but this expects a collection. Maybe you meant to " "use 'embed' (singular) instead?" ) if undefined.all_undefined(embed, embeds) and isinstance(content, embeds_.Embed): # Syntactic sugar, common mistake to accidentally send an embed # as the content, so let's detect this and fix it for the user. embed = content content = undefined.UNDEFINED elif undefined.all_undefined(attachment, attachments) and isinstance( content, (files.Resource, files.RAWISH_TYPES, os.PathLike) ): # Syntactic sugar, common mistake to accidentally send an attachment # as the content, so let's detect this and fix it for the user. This # will still then work with normal implicit embed attachments as # we work this out later. attachment = content content = undefined.UNDEFINED final_attachments: typing.List[files.Resource[files.AsyncReader]] = [] if attachment is not undefined.UNDEFINED: final_attachments.append(files.ensure_resource(attachment)) elif attachments is not undefined.UNDEFINED: final_attachments.extend([files.ensure_resource(a) for a in attachments]) serialized_components: undefined.UndefinedOr[typing.List[data_binding.JSONObject]] = undefined.UNDEFINED if component is not undefined.UNDEFINED: if component is not None: serialized_components = [component.build()] else: serialized_components = [] elif components is not undefined.UNDEFINED: if components is not None: serialized_components = [component.build() for component in components] else: serialized_components = [] serialized_embeds: undefined.UndefinedOr[data_binding.JSONArray] = undefined.UNDEFINED if embed is not undefined.UNDEFINED: if embed is not None: embed_payload, embed_attachments = self._entity_factory.serialize_embed(embed) final_attachments.extend(embed_attachments) serialized_embeds = [embed_payload] else: serialized_embeds = [] elif embeds is not undefined.UNDEFINED: serialized_embeds = [] if embeds is not None: for e in embeds: embed_payload, embed_attachments = self._entity_factory.serialize_embed(e) final_attachments.extend(embed_attachments) serialized_embeds.append(embed_payload) body = data_binding.JSONObjectBuilder() body.put("content", content, conversion=lambda v: v if v is None else str(v)) body.put("tts", tts) body.put("flags", flags) body.put("embeds", serialized_embeds) body.put("components", serialized_components) if replace_attachments: body.put("attachments", None) if not edit or not undefined.all_undefined(mentions_everyone, mentions_reply, user_mentions, role_mentions): body.put( "allowed_mentions", mentions.generate_allowed_mentions(mentions_everyone, mentions_reply, user_mentions, role_mentions), ) if final_attachments: form_builder = data_binding.URLEncodedFormBuilder(executor=self._executor) for i, attachment in enumerate(final_attachments): form_builder.add_resource(f"file{i}", attachment) return body, form_builder return body, None async def create_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reply: undefined.UndefinedOr[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.POST_CHANNEL_MESSAGES.compile(channel=channel) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("message_reference", reply, conversion=lambda m: {"message_id": str(int(m))}) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def crosspost_message( self, channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.POST_CHANNEL_CROSSPOST.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def edit_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_CHANNEL_MESSAGE.compile(channel=channel, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, flags=flags, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_MESSAGE.compile(channel=channel, message=message) await self._request(route) async def delete_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], messages: typing.Union[ snowflakes.SnowflakeishOr[messages_.PartialMessage], snowflakes.SnowflakeishIterable[messages_.PartialMessage], ], /, *other_messages: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.POST_DELETE_CHANNEL_MESSAGES_BULK.compile(channel=channel) pending: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] deleted: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] if isinstance(messages, typing.Iterable): # Syntactic sugar. Allows to use iterables pending.extend(messages) else: pending.append(messages) # This maintains the order in-order to keep a predictable deletion order. pending.extend(other_messages) while pending: # Discord only allows 2-100 messages in the BULK_DELETE endpoint. Because of that, # if the user wants 101 messages deleted, we will post 100 messages in bulk delete # and then the last message in a normal delete. # Along with this, the bucket size for v6 and v7 seems to be a bit restrictive. As of # 30th July 2020, this endpoint returned the following headers when being ratelimited: # x-ratelimit-bucket b05c0d8c2ab83895085006a8eae073a3 # x-ratelimit-limit 1 # x-ratelimit-remaining 0 # x-ratelimit-reset 1596033974.096 # x-ratelimit-reset-after 3.000 # This kind of defeats the point of asynchronously gathering any of these # in the first place really. To save clogging up the event loop # (albeit at a cost of maybe a couple-dozen milliseconds per call), # I am just gonna invoke these sequentially instead. try: if len(pending) == 1: message = pending[0] try: await self.delete_message(channel, message) except errors.NotFoundError as exc: # If the message is not found then this error should be suppressed # to keep consistency with how the bulk delete endpoint functions. if exc.code != 10008: # Unknown Message raise deleted.append(message) else: body = data_binding.JSONObjectBuilder() chunk = pending[:100] body.put_snowflake_array("messages", chunk) await self._request(route, json=body) deleted += chunk pending = pending[100:] except Exception as ex: raise errors.BulkDeleteError(deleted, pending) from ex @staticmethod def _transform_emoji_to_url_format( emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]], /, ) -> str: if isinstance(emoji, emojis.Emoji): if emoji_id is not undefined.UNDEFINED: raise ValueError("emoji_id shouldn't be passed when an Emoji object is passed for emoji") return emoji.url_name if emoji_id is not undefined.UNDEFINED: return f"{emoji}:{snowflakes.Snowflake(emoji_id)}" return emoji async def add_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.PUT_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_my_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_all_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_EMOJI.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], user: snowflakes.SnowflakeishOr[users.PartialUser], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_USER.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, user=user, ) await self._request(route) async def delete_all_reactions( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_ALL_REACTIONS.compile(channel=channel, message=message) await self._request(route) def fetch_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[users.User]: return special_endpoints_impl.ReactorIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, message=message, emoji=self._transform_emoji_to_url_format(emoji, emoji_id), ) async def create_webhook( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], name: str, *, avatar: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.IncomingWebhook: route = routes.POST_CHANNEL_WEBHOOKS.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) if avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_incoming_webhook(response) async def fetch_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.GET_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.GET_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True response = await self._request(route, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response) async def fetch_channel_webhooks( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_CHANNEL_WEBHOOKS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_pl) for webhook_pl in response] async def fetch_guild_webhooks( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_GUILD_WEBHOOKS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_payload) for webhook_payload in response] async def edit_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.WebhookChannelT]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.PATCH_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.PATCH_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake("channel", channel) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response) async def delete_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if token is undefined.UNDEFINED: route = routes.DELETE_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.DELETE_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True await self._request(route, no_auth=no_auth) async def execute_webhook( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar_url: typing.Union[undefined.UndefinedType, str, files.URL] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.POST_WEBHOOK_WITH_TOKEN.compile(webhook=webhook_id, token=token) query = data_binding.StringMapBuilder() query.put("wait", True) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("username", username) body.put("avatar_url", avatar_url, conversion=str) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, query=query, no_auth=True) else: response = await self._request(route, json=body, query=query, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def fetch_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.GET_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def edit_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.PATCH_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], ) -> None: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.DELETE_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) await self._request(route, no_auth=True) async def fetch_gateway_url(self) -> str: route = routes.GET_GATEWAY.compile() # This doesn't need authorization. response = await self._request(route, no_auth=True) assert isinstance(response, dict) url = response["url"] assert isinstance(url, str) return url async def fetch_gateway_bot_info(self) -> sessions.GatewayBotInfo: route = routes.GET_GATEWAY_BOT.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_gateway_bot_info(response) async def fetch_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.GET_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) query = data_binding.StringMapBuilder() query.put("with_counts", True) query.put("with_expiration", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response) async def delete_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.DELETE_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response) async def fetch_my_user(self) -> users.OwnUser: route = routes.GET_MY_USER.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response) async def edit_my_user( self, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, ) -> users.OwnUser: route = routes.PATCH_MY_USER.compile() body = data_binding.JSONObjectBuilder() body.put("username", username) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response) async def fetch_my_connections(self) -> typing.Sequence[applications.OwnConnection]: route = routes.GET_MY_CONNECTIONS.compile() response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_own_connection(connection_payload) for connection_payload in response] def fetch_my_guilds( self, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[applications.OwnGuild]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.OwnGuildIterator( entity_factory=self._entity_factory, request_call=self._request, newest_first=newest_first, first_id=str(start_at), ) async def leave_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], /) -> None: route = routes.DELETE_MY_GUILD.compile(guild=guild) await self._request(route) async def create_dm_channel(self, user: snowflakes.SnowflakeishOr[users.PartialUser], /) -> channels_.DMChannel: route = routes.POST_MY_CHANNELS.compile() body = data_binding.JSONObjectBuilder() body.put_snowflake("recipient_id", user) response = await self._request(route, json=body) assert isinstance(response, dict) channel = self._entity_factory.deserialize_dm(response) if self._cache: self._cache.set_dm_channel_id(user, channel.id) return channel async def fetch_application(self) -> applications.Application: route = routes.GET_MY_APPLICATION.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_application(response) async def fetch_authorization(self) -> applications.AuthorizationInformation: route = routes.GET_MY_AUTHORIZATION.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_information(response) @staticmethod def _gen_oauth2_token(client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str) -> str: token = base64.b64encode(f"{int(client)}:{client_secret}".encode()).decode("utf-8") return f"{applications.TokenType.BASIC} {token}" async def authorize_client_credentials_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, scopes: typing.Sequence[typing.Union[applications.OAuth2Scope, str]], ) -> applications.PartialOAuth2Token: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "client_credentials") form_builder.add_field("scope", " ".join(scopes)) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_partial_token(response) async def authorize_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, code: str, redirect_uri: str, ) -> applications.OAuth2AuthorizationToken: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "authorization_code") form_builder.add_field("code", code) form_builder.add_field("redirect_uri", redirect_uri) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_token(response) async def refresh_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, refresh_token: str, *, scopes: undefined.UndefinedOr[ typing.Sequence[typing.Union[applications.OAuth2Scope, str]] ] = undefined.UNDEFINED, ) -> applications.OAuth2AuthorizationToken: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "refresh_token") form_builder.add_field("refresh_token", refresh_token) if scopes is not undefined.UNDEFINED: form_builder.add_field("scope", " ".join(scopes)) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_token(response) async def revoke_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, token: typing.Union[str, applications.PartialOAuth2Token], ) -> None: route = routes.POST_TOKEN_REVOKE.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("token", str(token)) await self._request(route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret)) async def add_user_to_guild( self, access_token: typing.Union[str, applications.PartialOAuth2Token], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> typing.Optional[guilds.Member]: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PUT_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("access_token", str(access_token)) body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if (response := await self._request(route, json=body)) is not None: assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) else: # User already is in the guild. return None async def fetch_voice_regions(self) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_VOICE_REGIONS.compile() response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ] async def fetch_user(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> users.User: route = routes.GET_USER.compile(user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_user(response) def fetch_audit_log( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, event_type: undefined.UndefinedOr[typing.Union[audit_logs.AuditLogEventType, int]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[audit_logs.AuditLog]: timestamp: undefined.UndefinedOr[str] if before is undefined.UNDEFINED: timestamp = undefined.UNDEFINED elif isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) return special_endpoints_impl.AuditLogIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild, before=timestamp, user=user, action_type=event_type, ) async def fetch_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], ) -> emojis.KnownCustomEmoji: route = routes.GET_GUILD_EMOJI.compile(guild=guild, emoji=emoji) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def fetch_guild_emojis( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[emojis.KnownCustomEmoji]: route = routes.GET_GUILD_EMOJIS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_known_custom_emoji(emoji_payload, guild_id=guild_id) for emoji_payload in response ] async def create_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, image: files.Resourceish, *, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.POST_GUILD_EMOJIS.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) image_resource = files.ensure_resource(image) async with image_resource.stream(executor=self._executor) as stream: body.put("image", await stream.data_uri()) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def edit_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.PATCH_GUILD_EMOJI.compile(guild=guild, emoji=emoji) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def delete_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_EMOJI.compile(guild=guild, emoji=emoji) await self._request(route, reason=reason) async def fetch_available_sticker_packs(self) -> typing.Sequence[stickers.StickerPack]: route = routes.GET_STICKER_PACKS.compile() response = await self._request(route, no_auth=True) assert isinstance(response, dict) return [ self._entity_factory.deserialize_sticker_pack(sticker_pack_payload) for sticker_pack_payload in response["sticker_packs"] ] async def fetch_sticker( self, sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> typing.Union[stickers.StandardSticker, stickers.GuildSticker]: route = routes.GET_STICKER.compile(sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return ( self._entity_factory.deserialize_guild_sticker(response) if "guild_id" in response else self._entity_factory.deserialize_standard_sticker(response) ) async def fetch_guild_stickers( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[stickers.GuildSticker]: route = routes.GET_GUILD_STICKERS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_guild_sticker(guild_sticker_payload) for guild_sticker_payload in response ] async def fetch_guild_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> stickers.GuildSticker: route = routes.GET_GUILD_STICKER.compile(guild=guild, sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def create_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, tag: str, image: files.Resourceish, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.POST_GUILD_STICKERS.compile(guild=guild) form = data_binding.URLEncodedFormBuilder(executor=self._executor) form.add_field("name", name) form.add_field("tags", tag) form.add_field("description", description or "") form.add_resource("file", files.ensure_resource(image)) response = await self._request(route, form_builder=form, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def edit_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, tag: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.PATCH_GUILD_STICKER.compile(guild=guild, sticker=sticker) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("tags", tag) body.put("description", description) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def delete_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_STICKER.compile(guild=guild, sticker=sticker) await self._request(route, reason=reason) def guild_builder(self, name: str, /) -> special_endpoints.GuildBuilder: return special_endpoints_impl.GuildBuilder( entity_factory=self._entity_factory, executor=self._executor, request_call=self._request, name=name ) async def fetch_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.RESTGuild: route = routes.GET_GUILD.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_counts", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def fetch_guild_preview(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildPreview: route = routes.GET_GUILD_PREVIEW.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_preview(response) async def edit_guild( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, verification_level: undefined.UndefinedOr[guilds.GuildVerificationLevel] = undefined.UNDEFINED, default_message_notifications: undefined.UndefinedOr[ guilds.GuildMessageNotificationsLevel ] = undefined.UNDEFINED, explicit_content_filter_level: undefined.UndefinedOr[ guilds.GuildExplicitContentFilterLevel ] = undefined.UNDEFINED, afk_channel: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, afk_timeout: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, splash: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, banner: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, system_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, rules_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, public_updates_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, preferred_locale: undefined.UndefinedOr[typing.Union[str, locales.Locale]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.RESTGuild: route = routes.PATCH_GUILD.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("verification_level", verification_level) body.put("default_message_notifications", default_message_notifications) body.put("explicit_content_filter", explicit_content_filter_level) body.put("afk_timeout", afk_timeout, conversion=time.timespan_to_int) body.put("preferred_locale", preferred_locale, conversion=str) body.put_snowflake("afk_channel_id", afk_channel) body.put_snowflake("owner_id", owner) body.put_snowflake("system_channel_id", system_channel) body.put_snowflake("rules_channel_id", rules_channel) body.put_snowflake("public_updates_channel_id", public_updates_channel) tasks: typing.List[asyncio.Task[str]] = [] if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("icon", future.result())) tasks.append(task) if splash is None: body.put("splash", None) elif splash is not undefined.UNDEFINED: splash_resource = files.ensure_resource(splash) async with splash_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("splash", future.result())) tasks.append(task) if banner is None: body.put("banner", None) elif banner is not undefined.UNDEFINED: banner_resource = files.ensure_resource(banner) async with banner_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("banner", future.result())) tasks.append(task) await asyncio.gather(*tasks) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def delete_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> None: route = routes.DELETE_GUILD.compile(guild=guild) await self._request(route) async def fetch_guild_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[channels_.GuildChannel]: route = routes.GET_GUILD_CHANNELS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) channel_sequence = [self._entity_factory.deserialize_channel(channel_payload) for channel_payload in response] # Will always be guild channels unless Discord messes up severely on something! return typing.cast("typing.Sequence[channels_.GuildChannel]", channel_sequence) async def create_guild_text_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildTextChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_TEXT, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_text_channel(response) async def create_guild_news_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildNewsChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_NEWS, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_news_channel(response) async def create_guild_voice_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildVoiceChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_VOICE, position=position, user_limit=user_limit, bitrate=bitrate, video_quality_mode=video_quality_mode, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_voice_channel(response) async def create_guild_stage_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildStageChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_STAGE, position=position, user_limit=user_limit, bitrate=bitrate, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_stage_channel(response) async def create_guild_category( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildCategory: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_CATEGORY, position=position, permission_overwrites=permission_overwrites, reason=reason, ) return self._entity_factory.deserialize_guild_category(response) async def _create_guild_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, type_: channels_.ChannelType, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> data_binding.JSONObject: route = routes.POST_GUILD_CHANNELS.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("type", type_) body.put("name", name) body.put("position", position) body.put("topic", topic) body.put("nsfw", nsfw) body.put("bitrate", bitrate) body.put("video_quality_mode", video_quality_mode) body.put("user_limit", user_limit) body.put("rate_limit_per_user", rate_limit_per_user, conversion=time.timespan_to_int) body.put("rtc_region", region, conversion=str) body.put_snowflake("parent_id", category) body.put_array( "permission_overwrites", permission_overwrites, conversion=self._entity_factory.serialize_permission_overwrite, ) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return response async def reposition_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[channels_.GuildChannel]], ) -> None: route = routes.POST_GUILD_CHANNELS.compile(guild=guild) body = [{"id": str(int(channel)), "position": pos} for pos, channel in positions.items()] await self._request(route, json=body) async def fetch_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.Member: route = routes.GET_GUILD_MEMBER.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) def fetch_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> iterators.LazyIterator[guilds.Member]: return special_endpoints_impl.MemberIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild ) async def fetch_my_member(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.Member: route = routes.GET_MY_GUILD_MEMBER.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) async def search_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, ) -> typing.Sequence[guilds.Member]: route = routes.GET_GUILD_MEMBERS_SEARCH.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("query", name) query.put("limit", 1000) response = await self._request(route, query=query) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_member(member_payload, guild_id=guild_id) for member_payload in response ] async def edit_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, voice_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PATCH_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if voice_channel is None: body.put("channel_id", None) else: body.put_snowflake("channel_id", voice_channel) if isinstance(communication_disabled_until, datetime.datetime): body.put("communication_disabled_until", communication_disabled_until.isoformat()) else: body.put("communication_disabled_until", communication_disabled_until) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) async def edit_my_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: route = routes.PATCH_MY_GUILD_MEMBER.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) @deprecation.deprecated("2.0.0.dev104", "2.0.0.dev110", "Use `edit_my_member`'s `nick` argument instead.") async def edit_my_nick( self, guild: snowflakes.SnowflakeishOr[guilds.Guild], nick: typing.Optional[str], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: await self.edit_my_member(guild, nickname=nick, reason=reason) async def add_role_to_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.PUT_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason) async def remove_role_from_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason) async def kick_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER.compile(guild=guild, user=user) await self._request(route, reason=reason) def kick_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.kick_user(guild, user, reason=reason) async def ban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: body = data_binding.JSONObjectBuilder() body.put("delete_message_days", delete_message_days) route = routes.PUT_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, json=body, reason=reason) def ban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.ban_user(guild, user, delete_message_days=delete_message_days, reason=reason) async def unban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, reason=reason) def unban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.unban_user(guild, user, reason=reason) async def fetch_ban( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.GuildBan: route = routes.GET_GUILD_BAN.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_member_ban(response) async def fetch_bans( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[guilds.GuildBan]: route = routes.GET_GUILD_BANS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_member_ban(ban_payload) for ban_payload in response] async def fetch_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Role]: route = routes.GET_GUILD_ROLES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [self._entity_factory.deserialize_role(role_payload, guild_id=guild_id) for role_payload in response] async def create_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = permissions_.Permissions.NONE, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.POST_GUILD_ROLES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild)) async def reposition_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[guilds.PartialRole]], ) -> None: route = routes.PATCH_GUILD_ROLES.compile(guild=guild) body = [{"id": str(int(role)), "position": pos} for pos, role in positions.items()] await self._request(route, json=body) async def edit_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.PATCH_GUILD_ROLE.compile(guild=guild, role=role) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild)) async def delete_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], ) -> None: route = routes.DELETE_GUILD_ROLE.compile(guild=guild, role=role) await self._request(route) async def estimate_guild_prune_count( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, ) -> int: route = routes.GET_GUILD_PRUNE.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("days", days) if include_roles is not undefined.UNDEFINED: roles = ",".join(str(int(role)) for role in include_roles) query.put("include_roles", roles) response = await self._request(route, query=query) assert isinstance(response, dict) return int(response["pruned"]) async def begin_guild_prune( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, compute_prune_count: undefined.UndefinedOr[bool] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Optional[int]: route = routes.POST_GUILD_PRUNE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("days", days) body.put("compute_prune_count", compute_prune_count) body.put_snowflake_array("include_roles", include_roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) pruned = response.get("pruned") return int(pruned) if pruned is not None else None async def fetch_guild_voice_regions( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_GUILD_VOICE_REGIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ] async def fetch_guild_invites( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_GUILD_INVITES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response] async def fetch_integrations( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Integration]: route = routes.GET_GUILD_INTEGRATIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_integration(integration_payload, guild_id=guild_id) for integration_payload in response ] async def fetch_widget(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildWidget: route = routes.GET_GUILD_WIDGET.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response) async def edit_widget( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildChannel]] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.GuildWidget: route = routes.PATCH_GUILD_WIDGET.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("enabled", enabled) if channel is None: body.put("channel", None) elif channel is not undefined.UNDEFINED: body.put_snowflake("channel", channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response) async def fetch_welcome_screen(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.WelcomeScreen: route = routes.GET_GUILD_WELCOME_SCREEN.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response) async def edit_welcome_screen( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, channels: undefined.UndefinedNoneOr[typing.Sequence[guilds.WelcomeChannel]] = undefined.UNDEFINED, ) -> guilds.WelcomeScreen: route = routes.PATCH_GUILD_WELCOME_SCREEN.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("description", description) body.put("enabled", enabled) if channels is not None: body.put_array("welcome_channels", channels, conversion=self._entity_factory.serialize_welcome_channel) else: body.put("welcome_channels", None) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response) async def fetch_vanity_url(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> invites.VanityURL: route = routes.GET_GUILD_VANITY_URL.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_vanity_url(response) async def fetch_template(self, template: typing.Union[templates.Template, str]) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.GET_TEMPLATE.compile(template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def fetch_guild_templates( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[templates.Template]: route = routes.GET_GUILD_TEMPLATES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_template(template_payload) for template_payload in response] async def sync_guild_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[templates.Template, str], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PUT_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def create_guild_from_template( self, template: typing.Union[str, templates.Template], name: str, *, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, ) -> guilds.RESTGuild: template = template if isinstance(template, str) else template.code route = routes.POST_TEMPLATE.compile(template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def create_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: route = routes.POST_GUILD_TEMPLATES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def edit_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PATCH_GUILD_TEMPLATE.compile(guild=guild, template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def delete_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.DELETE_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) @deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `slash_command_builder` instead.") def command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return self.slash_command_builder(name, description) def slash_command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return special_endpoints_impl.SlashCommandBuilder(name, description) def context_menu_command_builder( self, type: typing.Union[commands.CommandType, int], name: str, ) -> special_endpoints.ContextMenuCommandBuilder: return special_endpoints_impl.ContextMenuCommandBuilder(commands.CommandType(type), name) async def fetch_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.GET_APPLICATION_GUILD_COMMAND.compile(application=application, guild=guild, command=command) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def fetch_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMANDS.compile(application=application) else: route = routes.GET_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(command, guild_id=guild_id) for command in response] async def _create_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], type: typing.Union[commands.CommandType, int], name: str, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> data_binding.JSONObject: if guild is undefined.UNDEFINED: route = routes.POST_APPLICATION_COMMAND.compile(application=application) else: route = routes.POST_APPLICATION_GUILD_COMMAND.compile(application=application, guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) body.put("type", type) body.put_array("options", options, conversion=self._entity_factory.serialize_command_option) body.put("default_permission", default_permission) response = await self._request(route, json=body) assert isinstance(response, dict) return response @deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `create_slash_command` instead.") async def create_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: return await self.create_slash_command( application=application, name=name, description=description, guild=guild, options=options, default_permission=default_permission, ) async def create_slash_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: response = await self._create_application_command( application=application, type=commands.CommandType.SLASH, name=name, description=description, guild=guild, options=options, default_permission=default_permission, ) return self._entity_factory.deserialize_slash_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def create_context_menu_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], type: typing.Union[commands.CommandType, int], name: str, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.ContextMenuCommand: response = await self._create_application_command( application=application, type=type, name=name, guild=guild, default_permission=default_permission, ) return self._entity_factory.deserialize_context_menu_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def set_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], commands: typing.Sequence[special_endpoints.CommandBuilder], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.PUT_APPLICATION_COMMANDS.compile(application=application) else: route = routes.PUT_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route, json=[command.build(self._entity_factory) for command in commands]) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(payload, guild_id=guild_id) for payload in response] async def edit_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.PATCH_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.PATCH_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) body.put_array("options", options, conversion=self._entity_factory.serialize_command_option) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def delete_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> None: if guild is undefined.UNDEFINED: route = routes.DELETE_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.DELETE_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) await self._request(route) async def fetch_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.GET_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response] async def fetch_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], ) -> commands.GuildCommandPermissions: route = routes.GET_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response) async def set_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], permissions: typing.Mapping[ snowflakes.SnowflakeishOr[commands.PartialCommand], typing.Sequence[commands.CommandPermission] ], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.PUT_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) body = [ { "id": str(snowflakes.Snowflake(command)), "permissions": [self._entity_factory.serialize_command_permission(permission) for permission in perms], } for command, perms in permissions.items() ] response = await self._request(route, json=body) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response] async def set_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], permissions: typing.Sequence[commands.CommandPermission], ) -> commands.GuildCommandPermissions: route = routes.PUT_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) body = data_binding.JSONObjectBuilder() body.put_array("permissions", permissions, conversion=self._entity_factory.serialize_command_permission) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response) def interaction_deferred_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionDeferredBuilder: return special_endpoints_impl.InteractionDeferredBuilder(type=type_) def interaction_autocomplete_builder( self, choices: typing.Sequence[commands.CommandChoice] ) -> special_endpoints.InteractionAutocompleteBuilder: return special_endpoints_impl.InteractionAutocompleteBuilder(choices) def interaction_message_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionMessageBuilder: return special_endpoints_impl.InteractionMessageBuilder(type=type_) async def fetch_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> messages_.Message: route = routes.GET_INTERACTION_RESPONSE.compile(webhook=application, token=token) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def create_interaction_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, response_type: typing.Union[int, base_interactions.ResponseType], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, flags: typing.Union[int, messages_.MessageFlag, undefined.UndefinedType] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) data, form = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body = data_binding.JSONObjectBuilder() body.put("type", response_type) body.put("data", data) if form is not None: form.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) await self._request(route, form_builder=form, no_auth=True) else: await self._request(route, json=body, no_auth=True) async def edit_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str, content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_INTERACTION_RESPONSE.compile(webhook=application, token=token) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> None: route = routes.DELETE_INTERACTION_RESPONSE.compile(webhook=application, token=token) await self._request(route, no_auth=True) async def create_autocomplete_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, choices: typing.Sequence[commands.CommandChoice], ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) body = data_binding.JSONObjectBuilder() body.put("type", base_interactions.ResponseType.AUTOCOMPLETE) data = data_binding.JSONObjectBuilder() data.put("choices", [{"name": choice.name, "value": choice.value} for choice in choices]) body.put("data", data) await self._request(route, json=body, no_auth=True) def build_action_row(self) -> special_endpoints.ActionRowBuilder: return special_endpoints_impl.ActionRowBuilder() async def fetch_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> scheduled_events.ScheduledEvent: route = routes.GET_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_scheduled_event(response) async def fetch_scheduled_events( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], / ) -> typing.Sequence[scheduled_events.ScheduledEvent]: route = routes.GET_GUILD_SCHEDULED_EVENTS.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, list) return [self._entity_factory.deserialize_scheduled_event(event) for event in response] async def _create_or_edit_scheduled_stage( self, route: routes.CompiledRoute, entity_type: undefined.UndefinedNoneOr[typing.Union[int, scheduled_events.ScheduledEventType]], name: undefined.UndefinedOr[str], *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.PartialChannel]] = undefined.UNDEFINED, location: undefined.UndefinedOr[str] = undefined.UNDEFINED, start_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: undefined.UndefinedOr[ typing.Union[int, scheduled_events.EventPrivacyLevel] ] = undefined.UNDEFINED, status: undefined.UndefinedOr[typing.Union[int, scheduled_events.ScheduledEventStatus]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> data_binding.JSONObject: body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("name", name) body.put("privacy_level", privacy_level) body.put("scheduled_start_time", start_time, conversion=datetime.datetime.isoformat) body.put("scheduled_end_time", end_time, conversion=datetime.datetime.isoformat) body.put("description", description) body.put("entity_type", entity_type) body.put("status", status) if image is not undefined.UNDEFINED: image_resource = files.ensure_resource(image) async with image_resource.stream(executor=self._executor) as stream: body.put("image", await stream.data_uri()) if location is not undefined.UNDEFINED: body["entity_metadata"] = {"location": location} response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return response async def create_external_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, /, location: str, start_time: datetime.datetime, end_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledExternalEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.EXTERNAL, name, location=location, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_external_event(response) async def create_stage_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledStageEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.STAGE_INSTANCE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_stage_event(response) async def create_voice_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledVoiceEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.VOICE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_voice_event(response) async def edit_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.PartialChannel]] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, entity_type: undefined.UndefinedOr[ typing.Union[int, scheduled_events.ScheduledEventType] ] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, location: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, privacy_level: undefined.UndefinedOr[ typing.Union[int, scheduled_events.EventPrivacyLevel] ] = undefined.UNDEFINED, start_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, end_time: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, status: undefined.UndefinedOr[typing.Union[int, scheduled_events.ScheduledEventStatus]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledEvent: route = routes.PATCH_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) if entity_type is not undefined.UNDEFINED: entity_type = scheduled_events.ScheduledEventType(entity_type) # Yes this does have to be explicitly set to None when changing to EXTERNAL if entity_type is scheduled_events.ScheduledEventType.EXTERNAL and channel is undefined.UNDEFINED: channel = None response = await self._create_or_edit_scheduled_stage( route, entity_type, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, location=location, privacy_level=privacy_level, status=status, reason=reason, ) return self._entity_factory.deserialize_scheduled_event(response) async def delete_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> None: route = routes.DELETE_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) await self._request(route) def fetch_scheduled_event_users( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[scheduled_events.ScheduledEventUser]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.ScheduledEventUserIterator( self._entity_factory, self._request, newest_first, str(start_at), guild, event )
View Source
class ClientCredentialsStrategy(rest_api.TokenStrategy): """Strategy class for handling client credential OAuth2 authorization. Parameters ---------- client: typing.Optional[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]] Object or ID of the application this client credentials strategy should authorize as. client_secret : typing.Optional[str] Client secret to use when authorizing. Other Parameters ---------------- scopes : typing.Sequence[str] The scopes to authorize for. """ __slots__: typing.Sequence[str] = ( "_client_id", "_client_secret", "_exception", "_expire_at", "_lock", "_scopes", "_token", ) def __init__( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, *, scopes: typing.Sequence[typing.Union[applications.OAuth2Scope, str]] = ( applications.OAuth2Scope.APPLICATIONS_COMMANDS_UPDATE, applications.OAuth2Scope.IDENTIFY, ), ) -> None: self._client_id = snowflakes.Snowflake(client) self._client_secret = client_secret self._exception: typing.Optional[errors.ClientHTTPResponseError] = None self._expire_at = 0.0 self._lock = asyncio.Lock() self._scopes = tuple(scopes) self._token: typing.Optional[str] = None @property def client_id(self) -> snowflakes.Snowflake: """ID of the application this token strategy authenticates with.""" return self._client_id @property def _is_expired(self) -> bool: return time.monotonic() >= self._expire_at @property def scopes(self) -> typing.Sequence[typing.Union[applications.OAuth2Scope, str]]: """Sequence of scopes this token strategy authenticates for.""" return self._scopes @property def token_type(self) -> applications.TokenType: return applications.TokenType.BEARER async def acquire(self, client: rest_api.RESTClient) -> str: if self._token and not self._is_expired: return self._token async with self._lock: if self._token and not self._is_expired: return self._token if self._exception: # If we don't copy the exception then python keeps adding onto the stack each time it's raised. raise copy.copy(self._exception) from None try: response = await client.authorize_client_credentials_token( client=self._client_id, client_secret=self._client_secret, scopes=self._scopes ) except errors.ClientHTTPResponseError as exc: if not isinstance(exc, errors.RateLimitedError): # If we don't copy the exception then python keeps adding onto the stack each time it's raised. self._exception = copy.copy(exc) raise # Expires in is lowered a bit in-order to lower the chance of a dead token being used. self._expire_at = time.monotonic() + math.floor(response.expires_in.total_seconds() * 0.99) self._token = f"{response.token_type} {response.access_token}" return self._token def invalidate(self, token: typing.Optional[str]) -> None: if not token or token == self._token: self._expire_at = 0.0 self._token = None
Strategy class for handling client credential OAuth2 authorization.
Parameters
- client (typing.Optional[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]]): Object or ID of the application this client credentials strategy should authorize as.
- client_secret (typing.Optional[str]): Client secret to use when authorizing.
Other Parameters
- scopes (typing.Sequence[str]): The scopes to authorize for.
Variables and properties
ID of the application this token strategy authenticates with.
Sequence of scopes this token strategy authenticates for.
Type of token this strategy returns.
Methods
self,
client: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
client_secret: str,
*,
scopes: Sequence[Union[hikari.applications.OAuth2Scope, str]] = (<OAuth2Scope.APPLICATIONS_COMMANDS_UPDATE: 'applications.commands.update'>, <OAuth2Scope.IDENTIFY: 'identify'>)
):
View Source
def __init__( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, *, scopes: typing.Sequence[typing.Union[applications.OAuth2Scope, str]] = ( applications.OAuth2Scope.APPLICATIONS_COMMANDS_UPDATE, applications.OAuth2Scope.IDENTIFY, ), ) -> None: self._client_id = snowflakes.Snowflake(client) self._client_secret = client_secret self._exception: typing.Optional[errors.ClientHTTPResponseError] = None self._expire_at = 0.0 self._lock = asyncio.Lock() self._scopes = tuple(scopes) self._token: typing.Optional[str] = None
View Source
async def acquire(self, client: rest_api.RESTClient) -> str: if self._token and not self._is_expired: return self._token async with self._lock: if self._token and not self._is_expired: return self._token if self._exception: # If we don't copy the exception then python keeps adding onto the stack each time it's raised. raise copy.copy(self._exception) from None try: response = await client.authorize_client_credentials_token( client=self._client_id, client_secret=self._client_secret, scopes=self._scopes ) except errors.ClientHTTPResponseError as exc: if not isinstance(exc, errors.RateLimitedError): # If we don't copy the exception then python keeps adding onto the stack each time it's raised. self._exception = copy.copy(exc) raise # Expires in is lowered a bit in-order to lower the chance of a dead token being used. self._expire_at = time.monotonic() + math.floor(response.expires_in.total_seconds() * 0.99) self._token = f"{response.token_type} {response.access_token}" return self._token
Acquire an authorization token (including the prefix).
Returns
- str: The current authorization token to use for this client and it's prefix.
View Source
def invalidate(self, token: typing.Optional[str]) -> None: if not token or token == self._token: self._expire_at = 0.0 self._token = None
Invalidate the cached token in this handler.
Note: token
may be provided in-order to avoid newly generated tokens from being invalidated due to multiple calls being made by separate subroutines which are handling the same token.
Parameters
- token (typing.Optional[str]): The token to specifically invalidate. If provided then this will only invalidate the cached token if it matches this, otherwise it'll be invalidated regardless.
View Source
class RESTApp(traits.ExecutorAware): """The base for a HTTP-only Discord application. This comprises of a shared TCP connector connection pool, and can have `RESTClientImpl` instances for specific credentials acquired from it. Parameters ---------- executor : typing.Optional[concurrent.futures.Executor] The executor to use for blocking file IO operations. If `None` is passed, then the default `concurrent.futures.ThreadPoolExecutor` for the `asyncio.AbstractEventLoop` will be used instead. http_settings : typing.Optional[hikari.impl.config.HTTPSettings] HTTP settings to use. Sane defaults are used if this is `None`. max_rate_limit : float Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a `hikari.errors.RateLimitedError` will be raised instead of waiting. This is provided since some endpoints may respond with non-sensible rate limits. Defaults to five minutes if unspecified. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. proxy_settings : typing.Optional[hikari.impl.config.ProxySettings] Proxy settings to use. If `None` then no proxy configuration will be used. url : typing.Optional[str] The base URL for the API. You can generally leave this as being `None` and the correct default API base URL will be generated. """ __slots__: typing.Sequence[str] = ( "_executor", "_http_settings", "_max_rate_limit", "_max_retries", "_proxy_settings", "_url", ) def __init__( self, *, executor: typing.Optional[concurrent.futures.Executor] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, url: typing.Optional[str] = None, ) -> None: self._http_settings = config_impl.HTTPSettings() if http_settings is None else http_settings self._proxy_settings = config_impl.ProxySettings() if proxy_settings is None else proxy_settings self._executor = executor self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._url = url @property def executor(self) -> typing.Optional[concurrent.futures.Executor]: return self._executor @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @typing.overload def acquire(self, token: typing.Optional[rest_api.TokenStrategy] = None) -> RESTClientImpl: ... @typing.overload def acquire( self, token: str, token_type: typing.Union[str, applications.TokenType] = applications.TokenType.BEARER, ) -> RESTClientImpl: ... def acquire( self, token: typing.Union[str, rest_api.TokenStrategy, None] = None, token_type: typing.Union[str, applications.TokenType, None] = None, ) -> RESTClientImpl: """Acquire an instance of this REST client. .. note:: The returned REST client should be started before it can be used, either by calling `RESTClientImpl.start` or by using it as an asynchronous context manager. Examples -------- ```py rest_app = RESTApp() # Using the returned client as a context manager to implicitly start # and stop it. async with rest_app.acquire("A token", "Bot") as client: user = await client.fetch_my_user() ``` Parameters ---------- token : typing.Union[str, None, hikari.api.rest.TokenStrategy] The bot or bearer token. If no token is to be used, this can be undefined. token_type : typing.Union[str, hikari.applications.TokenType, None] The type of token in use. This should only be passed when `str` is passed for `token`, can be `"Bot"` or `"Bearer"` and will be defaulted to `"Bearer"` in this situation. This should be left as `None` when either `hikari.api.rest.TokenStrategy` or `None` is passed for `token`. Returns ------- RESTClientImpl An instance of the REST client. Raises ------ ValueError If `token_type` is provided when a token strategy is passed for `token`. """ # Since we essentially mimic a fake App instance, we need to make a circular provider. # We can achieve this using a lambda. This allows the entity factory to build models that # are also REST-aware provider = _RESTProvider(lambda: entity_factory, self._executor, lambda: rest_client) entity_factory = entity_factory_impl.EntityFactoryImpl(provider) if isinstance(token, str): token = token.strip() if token_type is None: token_type = applications.TokenType.BEARER rest_client = RESTClientImpl( cache=None, entity_factory=entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=self._max_rate_limit, max_retries=self._max_retries, proxy_settings=self._proxy_settings, token=token, token_type=token_type, rest_url=self._url, ) return rest_client
The base for a HTTP-only Discord application.
This comprises of a shared TCP connector connection pool, and can have RESTClientImpl
instances for specific credentials acquired from it.
Parameters
- executor (typing.Optional[concurrent.futures.Executor]): The executor to use for blocking file IO operations. If
None
is passed, then the defaultconcurrent.futures.ThreadPoolExecutor
for theasyncio.AbstractEventLoop
will be used instead. - http_settings (typing.Optional[hikari.impl.config.HTTPSettings]): HTTP settings to use. Sane defaults are used if this is
None
. max_rate_limit (float): Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a
hikari.errors.RateLimitedError
will be raised instead of waiting.This is provided since some endpoints may respond with non-sensible rate limits.
Defaults to five minutes if unspecified.
- max_retries (typing.Optional[int]): Maximum number of times a request will be retried if it fails with a
5xx
status. Defaults to 3 if set toNone
. - proxy_settings (typing.Optional[hikari.impl.config.ProxySettings]): Proxy settings to use. If
None
then no proxy configuration will be used. - url (typing.Optional[str]): The base URL for the API. You can generally leave this as being
None
and the correct default API base URL will be generated.
Variables and properties
Executor to use for blocking operations.
This may return None
if the default asyncio
thread pool should be used instead.
Methods
self,
*,
executor: Optional[concurrent.futures._base.Executor] = None,
http_settings: Optional[hikari.impl.config.HTTPSettings] = None,
max_rate_limit: float = 300,
max_retries: int = 3,
proxy_settings: Optional[hikari.impl.config.ProxySettings] = None,
url: Optional[str] = None
):
View Source
def __init__( self, *, executor: typing.Optional[concurrent.futures.Executor] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, url: typing.Optional[str] = None, ) -> None: self._http_settings = config_impl.HTTPSettings() if http_settings is None else http_settings self._proxy_settings = config_impl.ProxySettings() if proxy_settings is None else proxy_settings self._executor = executor self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._url = url
self,
token: Union[str, hikari.api.rest.TokenStrategy, NoneType] = None,
token_type: Union[str, hikari.applications.TokenType, NoneType] = None
) -> hikari.impl.rest.RESTClientImpl:
View Source
def acquire( self, token: typing.Union[str, rest_api.TokenStrategy, None] = None, token_type: typing.Union[str, applications.TokenType, None] = None, ) -> RESTClientImpl: """Acquire an instance of this REST client. .. note:: The returned REST client should be started before it can be used, either by calling `RESTClientImpl.start` or by using it as an asynchronous context manager. Examples -------- ```py rest_app = RESTApp() # Using the returned client as a context manager to implicitly start # and stop it. async with rest_app.acquire("A token", "Bot") as client: user = await client.fetch_my_user() ``` Parameters ---------- token : typing.Union[str, None, hikari.api.rest.TokenStrategy] The bot or bearer token. If no token is to be used, this can be undefined. token_type : typing.Union[str, hikari.applications.TokenType, None] The type of token in use. This should only be passed when `str` is passed for `token`, can be `"Bot"` or `"Bearer"` and will be defaulted to `"Bearer"` in this situation. This should be left as `None` when either `hikari.api.rest.TokenStrategy` or `None` is passed for `token`. Returns ------- RESTClientImpl An instance of the REST client. Raises ------ ValueError If `token_type` is provided when a token strategy is passed for `token`. """ # Since we essentially mimic a fake App instance, we need to make a circular provider. # We can achieve this using a lambda. This allows the entity factory to build models that # are also REST-aware provider = _RESTProvider(lambda: entity_factory, self._executor, lambda: rest_client) entity_factory = entity_factory_impl.EntityFactoryImpl(provider) if isinstance(token, str): token = token.strip() if token_type is None: token_type = applications.TokenType.BEARER rest_client = RESTClientImpl( cache=None, entity_factory=entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=self._max_rate_limit, max_retries=self._max_retries, proxy_settings=self._proxy_settings, token=token, token_type=token_type, rest_url=self._url, ) return rest_client
Acquire an instance of this REST client.
Note: The returned REST client should be started before it can be used, either by calling RESTClientImpl.start
or by using it as an asynchronous context manager.
Examples
rest_app = RESTApp()
# Using the returned client as a context manager to implicitly start
# and stop it.
async with rest_app.acquire("A token", "Bot") as client:
user = await client.fetch_my_user()
Parameters
- token (typing.Union[str, None, hikari.api.rest.TokenStrategy]): The bot or bearer token. If no token is to be used, this can be undefined.
token_type (typing.Union[str, hikari.applications.TokenType, None]): The type of token in use. This should only be passed when
str
is passed fortoken
, can be"Bot"
or"Bearer"
and will be defaulted to"Bearer"
in this situation.This should be left as
None
when eitherhikari.api.rest.TokenStrategy
orNone
is passed fortoken
.
Returns
- RESTClientImpl: An instance of the REST client.
Raises
- ValueError: If
token_type
is provided when a token strategy is passed fortoken
.
View Source
class RESTClientImpl(rest_api.RESTClient): """Implementation of the V8-compatible Discord HTTP API. This manages making HTTP/1.1 requests to the API and using the entity factory within the passed application instance to deserialize JSON responses to Pythonic data classes that are used throughout this library. Parameters ---------- entity_factory : hikari.api.entity_factory.EntityFactory The entity factory to use. executor : typing.Optional[concurrent.futures.Executor] The executor to use for blocking IO. Defaults to the `asyncio` thread pool if set to `None`. max_rate_limit : float Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a `hikari.errors.RateLimitedError` will be raised instead of waiting. This is provided since some endpoints may respond with non-sensible rate limits. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. token : typing.Union[str, None, hikari.api.rest.TokenStrategy] The bot or bearer token. If no token is to be used, this can be undefined. token_type : typing.Union[str, hikari.applications.TokenType, None] The type of token in use. This must be passed when a `str` is passed for `token` but and can be `"Bot"` or `"Bearer"`. This should be left as `None` when either `hikari.api.rest.TokenStrategy` or `None` is passed for `token`. rest_url : str The HTTP API base URL. This can contain format-string specifiers to interpolate information such as API version in use. Raises ------ ValueError * If `token_type` is provided when a token strategy is passed for `token`. * if `token_type` is left as `None` when a string is passed for `token`. * If the a value more than 5 is provided for `max_retries` """ __slots__: typing.Sequence[str] = ( "_cache", "_entity_factory", "_executor", "_http_settings", "_live_attributes", "_max_rate_limit", "_max_retries", "_proxy_settings", "_rest_url", "_token", "_token_type", ) def __init__( self, *, cache: typing.Optional[cache_api.MutableCache], entity_factory: entity_factory_.EntityFactory, executor: typing.Optional[concurrent.futures.Executor], http_settings: config_impl.HTTPSettings, max_rate_limit: float, max_retries: int = 3, proxy_settings: config_impl.ProxySettings, token: typing.Union[str, None, rest_api.TokenStrategy], token_type: typing.Union[applications.TokenType, str, None], rest_url: typing.Optional[str], ) -> None: if max_retries > 5: raise ValueError("'max_retries' must be below or equal to 5") self._cache = cache self._entity_factory = entity_factory self._executor = executor self._http_settings = http_settings self._live_attributes: typing.Optional[_LiveAttributes] = None self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._proxy_settings = proxy_settings self._token: typing.Union[str, rest_api.TokenStrategy, None] = None self._token_type: typing.Optional[str] = None if isinstance(token, str): if token_type is None: raise ValueError("Token type required when a str is passed for `token`") self._token = f"{token_type.title()} {token}" self._token_type = applications.TokenType(token_type.title()) elif isinstance(token, rest_api.TokenStrategy): if token_type is not None: raise ValueError("Token type should be handled by the token strategy") self._token = token self._token_type = token.token_type # While passing files.URL for rest_url is not officially supported, this is still # casted to string here to avoid confusing issues passing a URL here could lead to. self._rest_url = str(rest_url) if rest_url is not None else urls.REST_API_URL @property def is_alive(self) -> bool: return self._live_attributes is not None @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @property def entity_factory(self) -> entity_factory_.EntityFactory: return self._entity_factory @property def token_type(self) -> typing.Union[str, applications.TokenType, None]: return self._token_type @typing.final async def close(self) -> None: """Close the HTTP client and any open HTTP connections.""" live_attributes = self._get_live_attributes() self._live_attributes = None await live_attributes.close() @typing.final def start(self) -> None: """Start the HTTP client. .. note:: This must be called within an active event loop. Raises ------ RuntimeError If this is called in an environment without an active event loop. """ if self._live_attributes: raise errors.ComponentStateConflictError("Cannot start a REST Client which is already alive") self._live_attributes = _LiveAttributes.build(self._max_rate_limit, self._http_settings, self._proxy_settings) def _get_live_attributes(self) -> _LiveAttributes: if self._live_attributes: return self._live_attributes raise errors.ComponentStateConflictError("Cannot use an inactive REST client") async def __aenter__(self) -> RESTClientImpl: self.start() return self async def __aexit__( self, exc_type: typing.Optional[typing.Type[BaseException]], exc_val: typing.Optional[BaseException], exc_tb: typing.Optional[types.TracebackType], ) -> None: await self.close() # These are only included at runtime in-order to avoid the model being typed as a synchronous context manager. if not typing.TYPE_CHECKING: def __enter__(self) -> typing.NoReturn: # This is async only. cls = type(self) raise TypeError(f"{cls.__module__}.{cls.__qualname__} is async-only, did you mean 'async with'?") from None def __exit__( self, exc_type: typing.Optional[typing.Type[BaseException]], exc_val: typing.Optional[BaseException], exc_tb: typing.Optional[types.TracebackType], ) -> None: return None @typing.final async def _request( self, compiled_route: routes.CompiledRoute, *, query: typing.Optional[data_binding.StringMapBuilder] = None, form_builder: typing.Optional[data_binding.URLEncodedFormBuilder] = None, json: typing.Union[data_binding.JSONObjectBuilder, data_binding.JSONArray, None] = None, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, no_auth: bool = False, auth: typing.Optional[str] = None, ) -> typing.Union[None, data_binding.JSONObject, data_binding.JSONArray]: # Make a ratelimit-protected HTTP request to a JSON endpoint and expect some form # of JSON response. live_attributes = self._get_live_attributes() headers = data_binding.StringMapBuilder() headers.setdefault(_USER_AGENT_HEADER, _HTTP_USER_AGENT) re_authed = False token: typing.Optional[str] = None if auth: headers[_AUTHORIZATION_HEADER] = auth elif not no_auth: if isinstance(self._token, str): headers[_AUTHORIZATION_HEADER] = self._token elif self._token is not None: token = await self._token.acquire(self) headers[_AUTHORIZATION_HEADER] = token # As per the docs, UTF-8 characters are only supported here if it's url-encoded. headers.put(_X_AUDIT_LOG_REASON_HEADER, reason, conversion=urllib.parse.quote) url = compiled_route.create_url(self._rest_url) # This is initiated the first time we hit a 5xx error to save a little memory when nothing goes wrong backoff: typing.Optional[rate_limits.ExponentialBackOff] = None retry_count = 0 stack = contextlib.AsyncExitStack() trace_logging_enabled = _LOGGER.isEnabledFor(ux.TRACE) while True: try: uuid = time.uuid() async with stack: form = await form_builder.build(stack) if form_builder else None await stack.enter_async_context(live_attributes.still_alive().buckets.acquire(compiled_route)) # Buckets not using authentication still have a global # rate limit, but it is different from the token one. if not no_auth: await live_attributes.still_alive().global_rate_limit.acquire() if trace_logging_enabled: _LOGGER.log( ux.TRACE, "%s %s %s\n%s", uuid, compiled_route.method, url, self._stringify_http_message(headers, json), ) start = time.monotonic() # Make the request. response = await live_attributes.still_alive().client_session.request( compiled_route.method, url, headers=headers, params=query, json=json, data=form, allow_redirects=self._http_settings.max_redirects is not None, max_redirects=self._http_settings.max_redirects, proxy=self._proxy_settings.url, proxy_headers=self._proxy_settings.all_headers, ) if trace_logging_enabled: time_taken = (time.monotonic() - start) * 1_000 _LOGGER.log( ux.TRACE, "%s %s %s in %sms\n%s", uuid, response.status, response.reason, time_taken, self._stringify_http_message(response.headers, await response.read()), ) # Ensure we are not rate limited, and update rate limiting headers where appropriate. await self._parse_ratelimits(compiled_route, response, live_attributes) # Don't bother processing any further if we got NO CONTENT. There's not anything # to check. if response.status == http.HTTPStatus.NO_CONTENT: return None # Handle the response when everything went good if 200 <= response.status < 300: if response.content_type == _APPLICATION_JSON: # Only deserializing here stops Cloudflare shenanigans messing us around. return data_binding.load_json(await response.read()) real_url = str(response.real_url) raise errors.HTTPError(f"Expected JSON [{response.content_type=}, {real_url=}]") # Handling 5xx errors if response.status in _RETRY_ERROR_CODES and retry_count < self._max_retries: if backoff is None: backoff = rate_limits.ExponentialBackOff(maximum=_MAX_BACKOFF_DURATION) sleep_time = next(backoff) _LOGGER.warning( "Received status %s on request, backing off for %.2fs and retrying. Retries remaining: %s", response.status, sleep_time, self._max_retries - retry_count, ) retry_count += 1 await asyncio.sleep(sleep_time) continue # Attempt to re-auth on UNAUTHORIZED if we are using a TokenStrategy can_re_auth = response.status == 401 and not (auth or no_auth or re_authed) if can_re_auth and isinstance(self._token, rest_api.TokenStrategy): assert token is not None self._token.invalidate(token) token = await self._token.acquire(self) headers[_AUTHORIZATION_HEADER] = token re_authed = True continue await self._handle_error_response(response) except _RetryRequest: continue @staticmethod @typing.final def _stringify_http_message(headers: data_binding.Headers, body: typing.Any) -> str: string = "\n".join( f" {name}: {value}" if name != _AUTHORIZATION_HEADER else f" {name}: **REDACTED TOKEN**" for name, value in headers.items() ) if body is not None: string += "\n\n " string += body.decode("ascii") if isinstance(body, bytes) else str(body) return string @staticmethod @typing.final async def _handle_error_response(response: aiohttp.ClientResponse) -> typing.NoReturn: raise await net.generate_error_response(response) @typing.final async def _parse_ratelimits( self, compiled_route: routes.CompiledRoute, response: aiohttp.ClientResponse, live_attributes: _LiveAttributes ) -> None: # Handle rate limiting. resp_headers = response.headers limit = int(resp_headers.get(_X_RATELIMIT_LIMIT_HEADER, "1")) remaining = int(resp_headers.get(_X_RATELIMIT_REMAINING_HEADER, "1")) bucket = resp_headers.get(_X_RATELIMIT_BUCKET_HEADER) reset_after = float(resp_headers.get(_X_RATELIMIT_RESET_AFTER_HEADER, "0")) if bucket: live_attributes.still_alive().buckets.update_rate_limits( compiled_route=compiled_route, bucket_header=bucket, remaining_header=remaining, limit_header=limit, reset_after=reset_after, ) if response.status != http.HTTPStatus.TOO_MANY_REQUESTS: return # Discord have started applying ratelimits to operations on some endpoints # based on specific fields used in the JSON body. # This does not get reflected in the headers. The first we know is when we # get a 429. # The issue is that we may get the same response if Discord dynamically # adjusts the bucket ratelimits. # # We have no mechanism for handing field-based ratelimits, so if we get # to here, but notice remaining is greater than zero, we should just error. # # Seems Discord may raise this on some other undocumented cases, which # is nice of them. Apparently some dude spamming slurs in the Python # guild via a leaked webhook URL made people's clients exhibit this # behaviour. # # If we get ratelimited when running more than one bot under the same token, # or if the ratelimiting logic goes wrong, we will get a 429 and expect the # "remaining" header to be zeroed, or even negative as I don't trust that there # isn't some weird edge case here somewhere in Discord's implementation. # We can safely retry if this happens as acquiring the bucket will handle # this. if remaining <= 0: _LOGGER.warning( "rate limited on bucket %s, maybe you are running more than one bot on this token? Retrying request...", bucket, ) raise _RetryRequest if response.content_type != _APPLICATION_JSON: # We don't know exactly what this could imply. It is likely Cloudflare interfering # but I'd rather we just give up than do something resulting in multiple failed # requests repeatedly. raise errors.HTTPResponseError( str(response.real_url), http.HTTPStatus.TOO_MANY_REQUESTS, response.headers, await response.read(), f"received rate limited response with unexpected response type {response.content_type}", ) body = await response.json() body_retry_after = float(body["retry_after"]) if body.get("global", False) is True: _LOGGER.error( "rate limited on the global bucket. You should consider lowering the number of requests you make or " "contacting Discord to raise this limit. Backing off and retrying request..." ) live_attributes.still_alive().global_rate_limit.throttle(body_retry_after) raise _RetryRequest # If the values are within 20% of each other by relativistic tolerance, it is probably # safe to retry the request, as they are likely the same value just with some # measuring difference. 20% was used as a rounded figure. if math.isclose(body_retry_after, reset_after, rel_tol=0.20): _LOGGER.error("rate limited on a sub bucket on bucket %s, but it is safe to retry", bucket) raise _RetryRequest raise errors.RateLimitedError( url=str(response.real_url), route=compiled_route, headers=response.headers, raw_body=body, retry_after=body_retry_after, ) async def fetch_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.GET_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) result = self._entity_factory.deserialize_channel(response) if self._cache and isinstance(result, channels_.DMChannel): self._cache.set_dm_channel_id(result.recipient.id, result.id) return result async def edit_channel( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], /, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, region: undefined.UndefinedNoneOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, parent_category: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildCategory] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.PartialChannel: route = routes.PATCH_CHANNEL.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("position", position) body.put("topic", topic) body.put("nsfw", nsfw) body.put("bitrate", bitrate) body.put("video_quality_mode", video_quality_mode) body.put("user_limit", user_limit) body.put("rate_limit_per_user", rate_limit_per_user, conversion=time.timespan_to_int) body.put("rtc_region", region, conversion=str) body.put_snowflake("parent_id", parent_category) body.put_array( "permission_overwrites", permission_overwrites, conversion=self._entity_factory.serialize_permission_overwrite, ) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response) async def follow_channel( self, news_channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], target_channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.ChannelFollow: route = routes.POST_CHANNEL_FOLLOWERS.compile(channel=news_channel) body = data_binding.JSONObjectBuilder() body.put_snowflake("webhook_channel_id", target_channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel_follow(response) async def delete_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.DELETE_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response) async def edit_my_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, request_to_speak: typing.Union[undefined.UndefinedType, bool, datetime.datetime] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_MY_GUILD_VOICE_STATE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) if isinstance(request_to_speak, datetime.datetime): body.put("request_to_speak_timestamp", request_to_speak.isoformat()) elif request_to_speak is True: body.put("request_to_speak_timestamp", time.utc_datetime().isoformat()) elif request_to_speak is False: body.put("request_to_speak_timestamp", None) await self._request(route, json=body) async def edit_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], user: snowflakes.SnowflakeishOr[users.PartialUser], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_GUILD_VOICE_STATE.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) await self._request(route, json=body) async def edit_permission_overwrites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ snowflakes.Snowflakeish, users.PartialUser, guilds.PartialRole, channels_.PermissionOverwrite ], *, target_type: undefined.UndefinedOr[typing.Union[channels_.PermissionOverwriteType, int]] = undefined.UNDEFINED, allow: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, deny: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if target_type is undefined.UNDEFINED: if isinstance(target, users.PartialUser): target_type = channels_.PermissionOverwriteType.MEMBER elif isinstance(target, guilds.Role): target_type = channels_.PermissionOverwriteType.ROLE elif isinstance(target, channels_.PermissionOverwrite): target_type = target.type else: raise TypeError( "Cannot determine the type of the target to update. Try specifying 'target_type' manually." ) target = target.id if isinstance(target, channels_.PermissionOverwrite) else target route = routes.PUT_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) body = data_binding.JSONObjectBuilder() body.put("type", target_type) body.put("allow", allow) body.put("deny", deny) await self._request(route, json=body, reason=reason) async def delete_permission_overwrite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ channels_.PermissionOverwrite, guilds.PartialRole, users.PartialUser, snowflakes.Snowflakeish ], ) -> None: route = routes.DELETE_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) await self._request(route) async def fetch_channel_invites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel] ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_CHANNEL_INVITES.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response] async def create_invite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, max_age: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, max_uses: undefined.UndefinedOr[int] = undefined.UNDEFINED, temporary: undefined.UndefinedOr[bool] = undefined.UNDEFINED, unique: undefined.UndefinedOr[bool] = undefined.UNDEFINED, target_type: undefined.UndefinedOr[invites.TargetType] = undefined.UNDEFINED, target_user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, target_application: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[guilds.PartialApplication] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> invites.InviteWithMetadata: route = routes.POST_CHANNEL_INVITES.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("max_age", max_age, conversion=time.timespan_to_int) body.put("max_uses", max_uses) body.put("temporary", temporary) body.put("unique", unique) body.put("target_type", target_type) body.put_snowflake("target_user_id", target_user) body.put_snowflake("target_application_id", target_application) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_invite_with_metadata(response) def trigger_typing( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> special_endpoints.TypingIndicator: return special_endpoints_impl.TypingIndicator( request_call=self._request, channel=channel, rest_closed_event=self._get_live_attributes().closed_event ) async def fetch_pins( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> typing.Sequence[messages_.Message]: route = routes.GET_CHANNEL_PINS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_message(message_pl) for message_pl in response] async def pin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.PUT_CHANNEL_PINS.compile(channel=channel, message=message) await self._request(route) async def unpin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_PIN.compile(channel=channel, message=message) await self._request(route) def fetch_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, after: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, around: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[messages_.Message]: if undefined.count(before, after, around) < 2: raise TypeError("Expected no kwargs, or a maximum of one of 'before', 'after', 'around'") timestamp: undefined.UndefinedOr[str] if before is not undefined.UNDEFINED: direction = "before" if isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) elif after is not undefined.UNDEFINED: direction = "after" if isinstance(after, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(after)) else: timestamp = str(int(after)) elif around is not undefined.UNDEFINED: direction = "around" if isinstance(around, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(around)) else: timestamp = str(int(around)) else: direction = "before" timestamp = undefined.UNDEFINED return special_endpoints_impl.MessageIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, direction=direction, first_id=timestamp, ) async def fetch_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.GET_CHANNEL_MESSAGE.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) def _build_message_payload( # noqa: C901- Function too complex self, /, *, content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, edit: bool = False, ) -> typing.Tuple[data_binding.JSONObjectBuilder, typing.Optional[data_binding.URLEncodedFormBuilder]]: if not undefined.any_undefined(attachment, attachments): raise ValueError("You may only specify one of 'attachment' or 'attachments', not both") if not undefined.any_undefined(component, components): raise ValueError("You may only specify one of 'component' or 'components', not both") if not undefined.any_undefined(embed, embeds): raise ValueError("You may only specify one of 'embed' or 'embeds', not both") if attachments is not undefined.UNDEFINED and not isinstance(attachments, typing.Collection): raise TypeError( "You passed a non-collection to 'attachments', but this expects a collection. Maybe you meant to " "use 'attachment' (singular) instead?" ) if components not in _NONE_OR_UNDEFINED and not isinstance(components, typing.Collection): raise TypeError( "You passed a non-collection to 'components', but this expects a collection. Maybe you meant to " "use 'component' (singular) instead?" ) if embeds not in _NONE_OR_UNDEFINED and not isinstance(embeds, typing.Collection): raise TypeError( "You passed a non-collection to 'embeds', but this expects a collection. Maybe you meant to " "use 'embed' (singular) instead?" ) if undefined.all_undefined(embed, embeds) and isinstance(content, embeds_.Embed): # Syntactic sugar, common mistake to accidentally send an embed # as the content, so let's detect this and fix it for the user. embed = content content = undefined.UNDEFINED elif undefined.all_undefined(attachment, attachments) and isinstance( content, (files.Resource, files.RAWISH_TYPES, os.PathLike) ): # Syntactic sugar, common mistake to accidentally send an attachment # as the content, so let's detect this and fix it for the user. This # will still then work with normal implicit embed attachments as # we work this out later. attachment = content content = undefined.UNDEFINED final_attachments: typing.List[files.Resource[files.AsyncReader]] = [] if attachment is not undefined.UNDEFINED: final_attachments.append(files.ensure_resource(attachment)) elif attachments is not undefined.UNDEFINED: final_attachments.extend([files.ensure_resource(a) for a in attachments]) serialized_components: undefined.UndefinedOr[typing.List[data_binding.JSONObject]] = undefined.UNDEFINED if component is not undefined.UNDEFINED: if component is not None: serialized_components = [component.build()] else: serialized_components = [] elif components is not undefined.UNDEFINED: if components is not None: serialized_components = [component.build() for component in components] else: serialized_components = [] serialized_embeds: undefined.UndefinedOr[data_binding.JSONArray] = undefined.UNDEFINED if embed is not undefined.UNDEFINED: if embed is not None: embed_payload, embed_attachments = self._entity_factory.serialize_embed(embed) final_attachments.extend(embed_attachments) serialized_embeds = [embed_payload] else: serialized_embeds = [] elif embeds is not undefined.UNDEFINED: serialized_embeds = [] if embeds is not None: for e in embeds: embed_payload, embed_attachments = self._entity_factory.serialize_embed(e) final_attachments.extend(embed_attachments) serialized_embeds.append(embed_payload) body = data_binding.JSONObjectBuilder() body.put("content", content, conversion=lambda v: v if v is None else str(v)) body.put("tts", tts) body.put("flags", flags) body.put("embeds", serialized_embeds) body.put("components", serialized_components) if replace_attachments: body.put("attachments", None) if not edit or not undefined.all_undefined(mentions_everyone, mentions_reply, user_mentions, role_mentions): body.put( "allowed_mentions", mentions.generate_allowed_mentions(mentions_everyone, mentions_reply, user_mentions, role_mentions), ) if final_attachments: form_builder = data_binding.URLEncodedFormBuilder(executor=self._executor) for i, attachment in enumerate(final_attachments): form_builder.add_resource(f"file{i}", attachment) return body, form_builder return body, None async def create_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reply: undefined.UndefinedOr[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.POST_CHANNEL_MESSAGES.compile(channel=channel) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("message_reference", reply, conversion=lambda m: {"message_id": str(int(m))}) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def crosspost_message( self, channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.POST_CHANNEL_CROSSPOST.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def edit_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_CHANNEL_MESSAGE.compile(channel=channel, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, flags=flags, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_MESSAGE.compile(channel=channel, message=message) await self._request(route) async def delete_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], messages: typing.Union[ snowflakes.SnowflakeishOr[messages_.PartialMessage], snowflakes.SnowflakeishIterable[messages_.PartialMessage], ], /, *other_messages: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.POST_DELETE_CHANNEL_MESSAGES_BULK.compile(channel=channel) pending: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] deleted: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] if isinstance(messages, typing.Iterable): # Syntactic sugar. Allows to use iterables pending.extend(messages) else: pending.append(messages) # This maintains the order in-order to keep a predictable deletion order. pending.extend(other_messages) while pending: # Discord only allows 2-100 messages in the BULK_DELETE endpoint. Because of that, # if the user wants 101 messages deleted, we will post 100 messages in bulk delete # and then the last message in a normal delete. # Along with this, the bucket size for v6 and v7 seems to be a bit restrictive. As of # 30th July 2020, this endpoint returned the following headers when being ratelimited: # x-ratelimit-bucket b05c0d8c2ab83895085006a8eae073a3 # x-ratelimit-limit 1 # x-ratelimit-remaining 0 # x-ratelimit-reset 1596033974.096 # x-ratelimit-reset-after 3.000 # This kind of defeats the point of asynchronously gathering any of these # in the first place really. To save clogging up the event loop # (albeit at a cost of maybe a couple-dozen milliseconds per call), # I am just gonna invoke these sequentially instead. try: if len(pending) == 1: message = pending[0] try: await self.delete_message(channel, message) except errors.NotFoundError as exc: # If the message is not found then this error should be suppressed # to keep consistency with how the bulk delete endpoint functions. if exc.code != 10008: # Unknown Message raise deleted.append(message) else: body = data_binding.JSONObjectBuilder() chunk = pending[:100] body.put_snowflake_array("messages", chunk) await self._request(route, json=body) deleted += chunk pending = pending[100:] except Exception as ex: raise errors.BulkDeleteError(deleted, pending) from ex @staticmethod def _transform_emoji_to_url_format( emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]], /, ) -> str: if isinstance(emoji, emojis.Emoji): if emoji_id is not undefined.UNDEFINED: raise ValueError("emoji_id shouldn't be passed when an Emoji object is passed for emoji") return emoji.url_name if emoji_id is not undefined.UNDEFINED: return f"{emoji}:{snowflakes.Snowflake(emoji_id)}" return emoji async def add_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.PUT_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_my_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_all_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_EMOJI.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route) async def delete_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], user: snowflakes.SnowflakeishOr[users.PartialUser], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_USER.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, user=user, ) await self._request(route) async def delete_all_reactions( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_ALL_REACTIONS.compile(channel=channel, message=message) await self._request(route) def fetch_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[users.User]: return special_endpoints_impl.ReactorIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, message=message, emoji=self._transform_emoji_to_url_format(emoji, emoji_id), ) async def create_webhook( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], name: str, *, avatar: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.IncomingWebhook: route = routes.POST_CHANNEL_WEBHOOKS.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) if avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_incoming_webhook(response) async def fetch_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.GET_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.GET_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True response = await self._request(route, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response) async def fetch_channel_webhooks( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_CHANNEL_WEBHOOKS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_pl) for webhook_pl in response] async def fetch_guild_webhooks( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_GUILD_WEBHOOKS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_payload) for webhook_payload in response] async def edit_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.WebhookChannelT]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.PATCH_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.PATCH_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake("channel", channel) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response) async def delete_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if token is undefined.UNDEFINED: route = routes.DELETE_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.DELETE_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True await self._request(route, no_auth=no_auth) async def execute_webhook( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar_url: typing.Union[undefined.UndefinedType, str, files.URL] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.POST_WEBHOOK_WITH_TOKEN.compile(webhook=webhook_id, token=token) query = data_binding.StringMapBuilder() query.put("wait", True) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("username", username) body.put("avatar_url", avatar_url, conversion=str) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, query=query, no_auth=True) else: response = await self._request(route, json=body, query=query, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def fetch_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.GET_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def edit_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.PATCH_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], ) -> None: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.DELETE_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) await self._request(route, no_auth=True) async def fetch_gateway_url(self) -> str: route = routes.GET_GATEWAY.compile() # This doesn't need authorization. response = await self._request(route, no_auth=True) assert isinstance(response, dict) url = response["url"] assert isinstance(url, str) return url async def fetch_gateway_bot_info(self) -> sessions.GatewayBotInfo: route = routes.GET_GATEWAY_BOT.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_gateway_bot_info(response) async def fetch_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.GET_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) query = data_binding.StringMapBuilder() query.put("with_counts", True) query.put("with_expiration", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response) async def delete_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.DELETE_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response) async def fetch_my_user(self) -> users.OwnUser: route = routes.GET_MY_USER.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response) async def edit_my_user( self, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, ) -> users.OwnUser: route = routes.PATCH_MY_USER.compile() body = data_binding.JSONObjectBuilder() body.put("username", username) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response) async def fetch_my_connections(self) -> typing.Sequence[applications.OwnConnection]: route = routes.GET_MY_CONNECTIONS.compile() response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_own_connection(connection_payload) for connection_payload in response] def fetch_my_guilds( self, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[applications.OwnGuild]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.OwnGuildIterator( entity_factory=self._entity_factory, request_call=self._request, newest_first=newest_first, first_id=str(start_at), ) async def leave_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], /) -> None: route = routes.DELETE_MY_GUILD.compile(guild=guild) await self._request(route) async def create_dm_channel(self, user: snowflakes.SnowflakeishOr[users.PartialUser], /) -> channels_.DMChannel: route = routes.POST_MY_CHANNELS.compile() body = data_binding.JSONObjectBuilder() body.put_snowflake("recipient_id", user) response = await self._request(route, json=body) assert isinstance(response, dict) channel = self._entity_factory.deserialize_dm(response) if self._cache: self._cache.set_dm_channel_id(user, channel.id) return channel async def fetch_application(self) -> applications.Application: route = routes.GET_MY_APPLICATION.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_application(response) async def fetch_authorization(self) -> applications.AuthorizationInformation: route = routes.GET_MY_AUTHORIZATION.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_information(response) @staticmethod def _gen_oauth2_token(client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str) -> str: token = base64.b64encode(f"{int(client)}:{client_secret}".encode()).decode("utf-8") return f"{applications.TokenType.BASIC} {token}" async def authorize_client_credentials_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, scopes: typing.Sequence[typing.Union[applications.OAuth2Scope, str]], ) -> applications.PartialOAuth2Token: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "client_credentials") form_builder.add_field("scope", " ".join(scopes)) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_partial_token(response) async def authorize_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, code: str, redirect_uri: str, ) -> applications.OAuth2AuthorizationToken: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "authorization_code") form_builder.add_field("code", code) form_builder.add_field("redirect_uri", redirect_uri) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_token(response) async def refresh_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, refresh_token: str, *, scopes: undefined.UndefinedOr[ typing.Sequence[typing.Union[applications.OAuth2Scope, str]] ] = undefined.UNDEFINED, ) -> applications.OAuth2AuthorizationToken: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "refresh_token") form_builder.add_field("refresh_token", refresh_token) if scopes is not undefined.UNDEFINED: form_builder.add_field("scope", " ".join(scopes)) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_token(response) async def revoke_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, token: typing.Union[str, applications.PartialOAuth2Token], ) -> None: route = routes.POST_TOKEN_REVOKE.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("token", str(token)) await self._request(route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret)) async def add_user_to_guild( self, access_token: typing.Union[str, applications.PartialOAuth2Token], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> typing.Optional[guilds.Member]: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PUT_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("access_token", str(access_token)) body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if (response := await self._request(route, json=body)) is not None: assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) else: # User already is in the guild. return None async def fetch_voice_regions(self) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_VOICE_REGIONS.compile() response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ] async def fetch_user(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> users.User: route = routes.GET_USER.compile(user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_user(response) def fetch_audit_log( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, event_type: undefined.UndefinedOr[typing.Union[audit_logs.AuditLogEventType, int]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[audit_logs.AuditLog]: timestamp: undefined.UndefinedOr[str] if before is undefined.UNDEFINED: timestamp = undefined.UNDEFINED elif isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) return special_endpoints_impl.AuditLogIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild, before=timestamp, user=user, action_type=event_type, ) async def fetch_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], ) -> emojis.KnownCustomEmoji: route = routes.GET_GUILD_EMOJI.compile(guild=guild, emoji=emoji) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def fetch_guild_emojis( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[emojis.KnownCustomEmoji]: route = routes.GET_GUILD_EMOJIS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_known_custom_emoji(emoji_payload, guild_id=guild_id) for emoji_payload in response ] async def create_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, image: files.Resourceish, *, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.POST_GUILD_EMOJIS.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) image_resource = files.ensure_resource(image) async with image_resource.stream(executor=self._executor) as stream: body.put("image", await stream.data_uri()) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def edit_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.PATCH_GUILD_EMOJI.compile(guild=guild, emoji=emoji) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild)) async def delete_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_EMOJI.compile(guild=guild, emoji=emoji) await self._request(route, reason=reason) async def fetch_available_sticker_packs(self) -> typing.Sequence[stickers.StickerPack]: route = routes.GET_STICKER_PACKS.compile() response = await self._request(route, no_auth=True) assert isinstance(response, dict) return [ self._entity_factory.deserialize_sticker_pack(sticker_pack_payload) for sticker_pack_payload in response["sticker_packs"] ] async def fetch_sticker( self, sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> typing.Union[stickers.StandardSticker, stickers.GuildSticker]: route = routes.GET_STICKER.compile(sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return ( self._entity_factory.deserialize_guild_sticker(response) if "guild_id" in response else self._entity_factory.deserialize_standard_sticker(response) ) async def fetch_guild_stickers( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[stickers.GuildSticker]: route = routes.GET_GUILD_STICKERS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_guild_sticker(guild_sticker_payload) for guild_sticker_payload in response ] async def fetch_guild_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> stickers.GuildSticker: route = routes.GET_GUILD_STICKER.compile(guild=guild, sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def create_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, tag: str, image: files.Resourceish, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.POST_GUILD_STICKERS.compile(guild=guild) form = data_binding.URLEncodedFormBuilder(executor=self._executor) form.add_field("name", name) form.add_field("tags", tag) form.add_field("description", description or "") form.add_resource("file", files.ensure_resource(image)) response = await self._request(route, form_builder=form, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def edit_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, tag: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.PATCH_GUILD_STICKER.compile(guild=guild, sticker=sticker) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("tags", tag) body.put("description", description) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response) async def delete_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_STICKER.compile(guild=guild, sticker=sticker) await self._request(route, reason=reason) def guild_builder(self, name: str, /) -> special_endpoints.GuildBuilder: return special_endpoints_impl.GuildBuilder( entity_factory=self._entity_factory, executor=self._executor, request_call=self._request, name=name ) async def fetch_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.RESTGuild: route = routes.GET_GUILD.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_counts", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def fetch_guild_preview(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildPreview: route = routes.GET_GUILD_PREVIEW.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_preview(response) async def edit_guild( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, verification_level: undefined.UndefinedOr[guilds.GuildVerificationLevel] = undefined.UNDEFINED, default_message_notifications: undefined.UndefinedOr[ guilds.GuildMessageNotificationsLevel ] = undefined.UNDEFINED, explicit_content_filter_level: undefined.UndefinedOr[ guilds.GuildExplicitContentFilterLevel ] = undefined.UNDEFINED, afk_channel: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, afk_timeout: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, splash: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, banner: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, system_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, rules_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, public_updates_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, preferred_locale: undefined.UndefinedOr[typing.Union[str, locales.Locale]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.RESTGuild: route = routes.PATCH_GUILD.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("verification_level", verification_level) body.put("default_message_notifications", default_message_notifications) body.put("explicit_content_filter", explicit_content_filter_level) body.put("afk_timeout", afk_timeout, conversion=time.timespan_to_int) body.put("preferred_locale", preferred_locale, conversion=str) body.put_snowflake("afk_channel_id", afk_channel) body.put_snowflake("owner_id", owner) body.put_snowflake("system_channel_id", system_channel) body.put_snowflake("rules_channel_id", rules_channel) body.put_snowflake("public_updates_channel_id", public_updates_channel) tasks: typing.List[asyncio.Task[str]] = [] if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("icon", future.result())) tasks.append(task) if splash is None: body.put("splash", None) elif splash is not undefined.UNDEFINED: splash_resource = files.ensure_resource(splash) async with splash_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("splash", future.result())) tasks.append(task) if banner is None: body.put("banner", None) elif banner is not undefined.UNDEFINED: banner_resource = files.ensure_resource(banner) async with banner_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("banner", future.result())) tasks.append(task) await asyncio.gather(*tasks) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def delete_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> None: route = routes.DELETE_GUILD.compile(guild=guild) await self._request(route) async def fetch_guild_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[channels_.GuildChannel]: route = routes.GET_GUILD_CHANNELS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) channel_sequence = [self._entity_factory.deserialize_channel(channel_payload) for channel_payload in response] # Will always be guild channels unless Discord messes up severely on something! return typing.cast("typing.Sequence[channels_.GuildChannel]", channel_sequence) async def create_guild_text_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildTextChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_TEXT, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_text_channel(response) async def create_guild_news_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildNewsChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_NEWS, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_news_channel(response) async def create_guild_voice_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildVoiceChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_VOICE, position=position, user_limit=user_limit, bitrate=bitrate, video_quality_mode=video_quality_mode, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_voice_channel(response) async def create_guild_stage_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildStageChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_STAGE, position=position, user_limit=user_limit, bitrate=bitrate, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_stage_channel(response) async def create_guild_category( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildCategory: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_CATEGORY, position=position, permission_overwrites=permission_overwrites, reason=reason, ) return self._entity_factory.deserialize_guild_category(response) async def _create_guild_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, type_: channels_.ChannelType, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> data_binding.JSONObject: route = routes.POST_GUILD_CHANNELS.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("type", type_) body.put("name", name) body.put("position", position) body.put("topic", topic) body.put("nsfw", nsfw) body.put("bitrate", bitrate) body.put("video_quality_mode", video_quality_mode) body.put("user_limit", user_limit) body.put("rate_limit_per_user", rate_limit_per_user, conversion=time.timespan_to_int) body.put("rtc_region", region, conversion=str) body.put_snowflake("parent_id", category) body.put_array( "permission_overwrites", permission_overwrites, conversion=self._entity_factory.serialize_permission_overwrite, ) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return response async def reposition_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[channels_.GuildChannel]], ) -> None: route = routes.POST_GUILD_CHANNELS.compile(guild=guild) body = [{"id": str(int(channel)), "position": pos} for pos, channel in positions.items()] await self._request(route, json=body) async def fetch_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.Member: route = routes.GET_GUILD_MEMBER.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) def fetch_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> iterators.LazyIterator[guilds.Member]: return special_endpoints_impl.MemberIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild ) async def fetch_my_member(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.Member: route = routes.GET_MY_GUILD_MEMBER.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) async def search_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, ) -> typing.Sequence[guilds.Member]: route = routes.GET_GUILD_MEMBERS_SEARCH.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("query", name) query.put("limit", 1000) response = await self._request(route, query=query) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_member(member_payload, guild_id=guild_id) for member_payload in response ] async def edit_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, voice_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PATCH_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if voice_channel is None: body.put("channel_id", None) else: body.put_snowflake("channel_id", voice_channel) if isinstance(communication_disabled_until, datetime.datetime): body.put("communication_disabled_until", communication_disabled_until.isoformat()) else: body.put("communication_disabled_until", communication_disabled_until) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) async def edit_my_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: route = routes.PATCH_MY_GUILD_MEMBER.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) @deprecation.deprecated("2.0.0.dev104", "2.0.0.dev110", "Use `edit_my_member`'s `nick` argument instead.") async def edit_my_nick( self, guild: snowflakes.SnowflakeishOr[guilds.Guild], nick: typing.Optional[str], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: await self.edit_my_member(guild, nickname=nick, reason=reason) async def add_role_to_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.PUT_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason) async def remove_role_from_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason) async def kick_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER.compile(guild=guild, user=user) await self._request(route, reason=reason) def kick_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.kick_user(guild, user, reason=reason) async def ban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: body = data_binding.JSONObjectBuilder() body.put("delete_message_days", delete_message_days) route = routes.PUT_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, json=body, reason=reason) def ban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.ban_user(guild, user, delete_message_days=delete_message_days, reason=reason) async def unban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, reason=reason) def unban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.unban_user(guild, user, reason=reason) async def fetch_ban( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.GuildBan: route = routes.GET_GUILD_BAN.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_member_ban(response) async def fetch_bans( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[guilds.GuildBan]: route = routes.GET_GUILD_BANS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_member_ban(ban_payload) for ban_payload in response] async def fetch_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Role]: route = routes.GET_GUILD_ROLES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [self._entity_factory.deserialize_role(role_payload, guild_id=guild_id) for role_payload in response] async def create_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = permissions_.Permissions.NONE, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.POST_GUILD_ROLES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild)) async def reposition_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[guilds.PartialRole]], ) -> None: route = routes.PATCH_GUILD_ROLES.compile(guild=guild) body = [{"id": str(int(role)), "position": pos} for pos, role in positions.items()] await self._request(route, json=body) async def edit_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.PATCH_GUILD_ROLE.compile(guild=guild, role=role) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild)) async def delete_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], ) -> None: route = routes.DELETE_GUILD_ROLE.compile(guild=guild, role=role) await self._request(route) async def estimate_guild_prune_count( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, ) -> int: route = routes.GET_GUILD_PRUNE.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("days", days) if include_roles is not undefined.UNDEFINED: roles = ",".join(str(int(role)) for role in include_roles) query.put("include_roles", roles) response = await self._request(route, query=query) assert isinstance(response, dict) return int(response["pruned"]) async def begin_guild_prune( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, compute_prune_count: undefined.UndefinedOr[bool] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Optional[int]: route = routes.POST_GUILD_PRUNE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("days", days) body.put("compute_prune_count", compute_prune_count) body.put_snowflake_array("include_roles", include_roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) pruned = response.get("pruned") return int(pruned) if pruned is not None else None async def fetch_guild_voice_regions( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_GUILD_VOICE_REGIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ] async def fetch_guild_invites( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_GUILD_INVITES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response] async def fetch_integrations( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Integration]: route = routes.GET_GUILD_INTEGRATIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_integration(integration_payload, guild_id=guild_id) for integration_payload in response ] async def fetch_widget(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildWidget: route = routes.GET_GUILD_WIDGET.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response) async def edit_widget( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildChannel]] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.GuildWidget: route = routes.PATCH_GUILD_WIDGET.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("enabled", enabled) if channel is None: body.put("channel", None) elif channel is not undefined.UNDEFINED: body.put_snowflake("channel", channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response) async def fetch_welcome_screen(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.WelcomeScreen: route = routes.GET_GUILD_WELCOME_SCREEN.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response) async def edit_welcome_screen( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, channels: undefined.UndefinedNoneOr[typing.Sequence[guilds.WelcomeChannel]] = undefined.UNDEFINED, ) -> guilds.WelcomeScreen: route = routes.PATCH_GUILD_WELCOME_SCREEN.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("description", description) body.put("enabled", enabled) if channels is not None: body.put_array("welcome_channels", channels, conversion=self._entity_factory.serialize_welcome_channel) else: body.put("welcome_channels", None) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response) async def fetch_vanity_url(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> invites.VanityURL: route = routes.GET_GUILD_VANITY_URL.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_vanity_url(response) async def fetch_template(self, template: typing.Union[templates.Template, str]) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.GET_TEMPLATE.compile(template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def fetch_guild_templates( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[templates.Template]: route = routes.GET_GUILD_TEMPLATES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_template(template_payload) for template_payload in response] async def sync_guild_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[templates.Template, str], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PUT_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def create_guild_from_template( self, template: typing.Union[str, templates.Template], name: str, *, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, ) -> guilds.RESTGuild: template = template if isinstance(template, str) else template.code route = routes.POST_TEMPLATE.compile(template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response) async def create_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: route = routes.POST_GUILD_TEMPLATES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def edit_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PATCH_GUILD_TEMPLATE.compile(guild=guild, template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) async def delete_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.DELETE_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response) @deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `slash_command_builder` instead.") def command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return self.slash_command_builder(name, description) def slash_command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return special_endpoints_impl.SlashCommandBuilder(name, description) def context_menu_command_builder( self, type: typing.Union[commands.CommandType, int], name: str, ) -> special_endpoints.ContextMenuCommandBuilder: return special_endpoints_impl.ContextMenuCommandBuilder(commands.CommandType(type), name) async def fetch_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.GET_APPLICATION_GUILD_COMMAND.compile(application=application, guild=guild, command=command) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def fetch_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMANDS.compile(application=application) else: route = routes.GET_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(command, guild_id=guild_id) for command in response] async def _create_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], type: typing.Union[commands.CommandType, int], name: str, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> data_binding.JSONObject: if guild is undefined.UNDEFINED: route = routes.POST_APPLICATION_COMMAND.compile(application=application) else: route = routes.POST_APPLICATION_GUILD_COMMAND.compile(application=application, guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) body.put("type", type) body.put_array("options", options, conversion=self._entity_factory.serialize_command_option) body.put("default_permission", default_permission) response = await self._request(route, json=body) assert isinstance(response, dict) return response @deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `create_slash_command` instead.") async def create_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: return await self.create_slash_command( application=application, name=name, description=description, guild=guild, options=options, default_permission=default_permission, ) async def create_slash_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: response = await self._create_application_command( application=application, type=commands.CommandType.SLASH, name=name, description=description, guild=guild, options=options, default_permission=default_permission, ) return self._entity_factory.deserialize_slash_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def create_context_menu_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], type: typing.Union[commands.CommandType, int], name: str, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.ContextMenuCommand: response = await self._create_application_command( application=application, type=type, name=name, guild=guild, default_permission=default_permission, ) return self._entity_factory.deserialize_context_menu_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def set_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], commands: typing.Sequence[special_endpoints.CommandBuilder], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.PUT_APPLICATION_COMMANDS.compile(application=application) else: route = routes.PUT_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route, json=[command.build(self._entity_factory) for command in commands]) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(payload, guild_id=guild_id) for payload in response] async def edit_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.PATCH_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.PATCH_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) body.put_array("options", options, conversion=self._entity_factory.serialize_command_option) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None ) async def delete_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> None: if guild is undefined.UNDEFINED: route = routes.DELETE_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.DELETE_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) await self._request(route) async def fetch_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.GET_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response] async def fetch_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], ) -> commands.GuildCommandPermissions: route = routes.GET_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response) async def set_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], permissions: typing.Mapping[ snowflakes.SnowflakeishOr[commands.PartialCommand], typing.Sequence[commands.CommandPermission] ], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.PUT_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) body = [ { "id": str(snowflakes.Snowflake(command)), "permissions": [self._entity_factory.serialize_command_permission(permission) for permission in perms], } for command, perms in permissions.items() ] response = await self._request(route, json=body) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response] async def set_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], permissions: typing.Sequence[commands.CommandPermission], ) -> commands.GuildCommandPermissions: route = routes.PUT_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) body = data_binding.JSONObjectBuilder() body.put_array("permissions", permissions, conversion=self._entity_factory.serialize_command_permission) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response) def interaction_deferred_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionDeferredBuilder: return special_endpoints_impl.InteractionDeferredBuilder(type=type_) def interaction_autocomplete_builder( self, choices: typing.Sequence[commands.CommandChoice] ) -> special_endpoints.InteractionAutocompleteBuilder: return special_endpoints_impl.InteractionAutocompleteBuilder(choices) def interaction_message_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionMessageBuilder: return special_endpoints_impl.InteractionMessageBuilder(type=type_) async def fetch_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> messages_.Message: route = routes.GET_INTERACTION_RESPONSE.compile(webhook=application, token=token) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def create_interaction_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, response_type: typing.Union[int, base_interactions.ResponseType], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, flags: typing.Union[int, messages_.MessageFlag, undefined.UndefinedType] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) data, form = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body = data_binding.JSONObjectBuilder() body.put("type", response_type) body.put("data", data) if form is not None: form.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) await self._request(route, form_builder=form, no_auth=True) else: await self._request(route, json=body, no_auth=True) async def edit_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str, content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_INTERACTION_RESPONSE.compile(webhook=application, token=token) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response) async def delete_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> None: route = routes.DELETE_INTERACTION_RESPONSE.compile(webhook=application, token=token) await self._request(route, no_auth=True) async def create_autocomplete_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, choices: typing.Sequence[commands.CommandChoice], ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) body = data_binding.JSONObjectBuilder() body.put("type", base_interactions.ResponseType.AUTOCOMPLETE) data = data_binding.JSONObjectBuilder() data.put("choices", [{"name": choice.name, "value": choice.value} for choice in choices]) body.put("data", data) await self._request(route, json=body, no_auth=True) def build_action_row(self) -> special_endpoints.ActionRowBuilder: return special_endpoints_impl.ActionRowBuilder() async def fetch_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> scheduled_events.ScheduledEvent: route = routes.GET_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_scheduled_event(response) async def fetch_scheduled_events( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], / ) -> typing.Sequence[scheduled_events.ScheduledEvent]: route = routes.GET_GUILD_SCHEDULED_EVENTS.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, list) return [self._entity_factory.deserialize_scheduled_event(event) for event in response] async def _create_or_edit_scheduled_stage( self, route: routes.CompiledRoute, entity_type: undefined.UndefinedNoneOr[typing.Union[int, scheduled_events.ScheduledEventType]], name: undefined.UndefinedOr[str], *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.PartialChannel]] = undefined.UNDEFINED, location: undefined.UndefinedOr[str] = undefined.UNDEFINED, start_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: undefined.UndefinedOr[ typing.Union[int, scheduled_events.EventPrivacyLevel] ] = undefined.UNDEFINED, status: undefined.UndefinedOr[typing.Union[int, scheduled_events.ScheduledEventStatus]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> data_binding.JSONObject: body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("name", name) body.put("privacy_level", privacy_level) body.put("scheduled_start_time", start_time, conversion=datetime.datetime.isoformat) body.put("scheduled_end_time", end_time, conversion=datetime.datetime.isoformat) body.put("description", description) body.put("entity_type", entity_type) body.put("status", status) if image is not undefined.UNDEFINED: image_resource = files.ensure_resource(image) async with image_resource.stream(executor=self._executor) as stream: body.put("image", await stream.data_uri()) if location is not undefined.UNDEFINED: body["entity_metadata"] = {"location": location} response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return response async def create_external_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, /, location: str, start_time: datetime.datetime, end_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledExternalEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.EXTERNAL, name, location=location, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_external_event(response) async def create_stage_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledStageEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.STAGE_INSTANCE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_stage_event(response) async def create_voice_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledVoiceEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.VOICE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_voice_event(response) async def edit_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.PartialChannel]] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, entity_type: undefined.UndefinedOr[ typing.Union[int, scheduled_events.ScheduledEventType] ] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, location: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, privacy_level: undefined.UndefinedOr[ typing.Union[int, scheduled_events.EventPrivacyLevel] ] = undefined.UNDEFINED, start_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, end_time: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, status: undefined.UndefinedOr[typing.Union[int, scheduled_events.ScheduledEventStatus]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledEvent: route = routes.PATCH_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) if entity_type is not undefined.UNDEFINED: entity_type = scheduled_events.ScheduledEventType(entity_type) # Yes this does have to be explicitly set to None when changing to EXTERNAL if entity_type is scheduled_events.ScheduledEventType.EXTERNAL and channel is undefined.UNDEFINED: channel = None response = await self._create_or_edit_scheduled_stage( route, entity_type, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, location=location, privacy_level=privacy_level, status=status, reason=reason, ) return self._entity_factory.deserialize_scheduled_event(response) async def delete_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> None: route = routes.DELETE_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) await self._request(route) def fetch_scheduled_event_users( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[scheduled_events.ScheduledEventUser]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.ScheduledEventUserIterator( self._entity_factory, self._request, newest_first, str(start_at), guild, event )
Implementation of the V8-compatible Discord HTTP API.
This manages making HTTP/1.1 requests to the API and using the entity factory within the passed application instance to deserialize JSON responses to Pythonic data classes that are used throughout this library.
Parameters
- entity_factory (hikari.api.entity_factory.EntityFactory): The entity factory to use.
- executor (typing.Optional[concurrent.futures.Executor]): The executor to use for blocking IO. Defaults to the
asyncio
thread pool if set toNone
. max_rate_limit (float): Maximum number of seconds to sleep for when rate limited. If a rate limit occurs that is longer than this value, then a
hikari.errors.RateLimitedError
will be raised instead of waiting.This is provided since some endpoints may respond with non-sensible rate limits.
- max_retries (typing.Optional[int]): Maximum number of times a request will be retried if it fails with a
5xx
status. Defaults to 3 if set toNone
. - token (typing.Union[str, None, hikari.api.rest.TokenStrategy]): The bot or bearer token. If no token is to be used, this can be undefined.
token_type (typing.Union[str, hikari.applications.TokenType, None]): The type of token in use. This must be passed when a
str
is passed fortoken
but and can be"Bot"
or"Bearer"
.This should be left as
None
when eitherhikari.api.rest.TokenStrategy
orNone
is passed fortoken
.- rest_url (str): The HTTP API base URL. This can contain format-string specifiers to interpolate information such as API version in use.
Raises
- ValueError: * If
token_type
is provided when a token strategy is passed fortoken
.- if
token_type
is left asNone
when a string is passed fortoken
. - If the a value more than 5 is provided for
max_retries
- if
Variables and properties
Entity factory used by this REST client.
HTTP settings in use by this component.
Whether this component is alive.
Proxy settings in use by this component.
Type of token this client is using for most requests.
If this is None
then this client will likely only work for some endpoints such as public and webhook ones.
Methods
self,
*,
cache: Optional[hikari.api.cache.MutableCache],
entity_factory: hikari.api.entity_factory.EntityFactory,
executor: Optional[concurrent.futures._base.Executor],
http_settings: hikari.impl.config.HTTPSettings,
max_rate_limit: float,
max_retries: int = 3,
proxy_settings: hikari.impl.config.ProxySettings,
token: Union[str, NoneType, hikari.api.rest.TokenStrategy],
token_type: Union[hikari.applications.TokenType, str, NoneType],
rest_url: Optional[str]
):
View Source
def __init__( self, *, cache: typing.Optional[cache_api.MutableCache], entity_factory: entity_factory_.EntityFactory, executor: typing.Optional[concurrent.futures.Executor], http_settings: config_impl.HTTPSettings, max_rate_limit: float, max_retries: int = 3, proxy_settings: config_impl.ProxySettings, token: typing.Union[str, None, rest_api.TokenStrategy], token_type: typing.Union[applications.TokenType, str, None], rest_url: typing.Optional[str], ) -> None: if max_retries > 5: raise ValueError("'max_retries' must be below or equal to 5") self._cache = cache self._entity_factory = entity_factory self._executor = executor self._http_settings = http_settings self._live_attributes: typing.Optional[_LiveAttributes] = None self._max_rate_limit = max_rate_limit self._max_retries = max_retries self._proxy_settings = proxy_settings self._token: typing.Union[str, rest_api.TokenStrategy, None] = None self._token_type: typing.Optional[str] = None if isinstance(token, str): if token_type is None: raise ValueError("Token type required when a str is passed for `token`") self._token = f"{token_type.title()} {token}" self._token_type = applications.TokenType(token_type.title()) elif isinstance(token, rest_api.TokenStrategy): if token_type is not None: raise ValueError("Token type should be handled by the token strategy") self._token = token self._token_type = token.token_type # While passing files.URL for rest_url is not officially supported, this is still # casted to string here to avoid confusing issues passing a URL here could lead to. self._rest_url = str(rest_url) if rest_url is not None else urls.REST_API_URL
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
emoji: Union[str, hikari.emojis.Emoji],
emoji_id: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def add_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.PUT_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route)
Add a reaction emoji to a message in a given channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to add the reaction to is. This may be a
hikari.channels.TextableChannel
or the ID of an existing channel. - message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to add a reaction to. This may be the object or the ID of an existing message.
- emoji (typing.Union[str, hikari.emojis.Emoji]): Object or name of the emoji to react with.
Other Parameters
- emoji_id (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]]): ID of the custom emoji to react with. This should only be provided when a custom emoji's name is passed for
emoji
.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
ADD_REACTIONS
(this is only necessary if you are the first person to add the reaction). - hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
role: Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def add_role_to_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.PUT_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason)
Add a role to a member.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild where the member is in. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to add the role to. This may be the object or the ID of an existing user.
- role (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]): The role to add. This may be the object or the ID of an existing role.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild, user or role are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
access_token: Union[str, hikari.applications.PartialOAuth2Token],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
nickname: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
nick: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
mute: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
deaf: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> Optional[hikari.guilds.Member]:
View Source
async def add_user_to_guild( self, access_token: typing.Union[str, applications.PartialOAuth2Token], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> typing.Optional[guilds.Member]: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PUT_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("access_token", str(access_token)) body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if (response := await self._request(route, json=body)) is not None: assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild)) else: # User already is in the guild. return None
Add a user to a guild.
Note: This requires the access_token
to have the hikari.applications.OAuth2Scope.GUILDS_JOIN
scope enabled along with the authorization of a Bot which has MANAGE_INVITES
permission within the target guild.
Parameters
- access_token (typing.Union[str, hikari.applications.PartialOAuth2Token]): Object or string of the access token to use for this request.
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to add the user to. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to add to the guild. This may be the object or the ID of an existing user.
Other Parameters
nickname (hikari.undefined.UndefinedOr[str]): If provided, the nick to add to the user when he joins the guild.
Requires the
MANAGE_NICKNAMES
permission on the guild.- nick (hikari.undefined.UndefinedOr[str]): Deprecated alias for
nickname
. roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]): If provided, the roles to add to the user when he joins the guild. This may be a collection objects or IDs of existing roles.
Requires the
MANAGE_ROLES
permission on the guild.mute (hikari.undefined.UndefinedOr[bool]): If provided, the mute state to add the user when he joins the guild.
Requires the
MUTE_MEMBERS
permission on the guild.deaf (hikari.undefined.UndefinedOr[bool]): If provided, the deaf state to add the user when he joins the guild.
Requires the
DEAFEN_MEMBERS
permission on the guild.
Returns
- typing.Optional[hikari.guilds.Member]:
None
if the user was already part of the guild, elsehikari.guilds.Member
.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are not part of the guild you want to add the user to, if you are missing permissions to do one of the things you specified, if you are using an access token for another user, if the token is bound to another bot or if the access token doesn't have the
hikari.applications.OAuth2Scope.GUILDS_JOIN
scope enabled. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If you own the guild or the user is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
delete_message_days: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> Coroutine[Any, Any, NoneType]:
View Source
def ban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.ban_user(guild, user, delete_message_days=delete_message_days, reason=reason)
Alias of ban_user
.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
delete_message_days: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def ban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: body = data_binding.JSONObjectBuilder() body.put("delete_message_days", delete_message_days) route = routes.PUT_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, json=body, reason=reason)
Ban a member from a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to ban the member from. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to kick. This may be the object or the ID of an existing user.
Other Parameters
- delete_message_days (hikari.undefined.UndefinedNoneOr[int]): If provided, the number of days to delete messages for. This must be between 0 and 7.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
BAN_MEMBERS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or user are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
days: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
compute_prune_count: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
include_roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> Optional[int]:
View Source
async def begin_guild_prune( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, compute_prune_count: undefined.UndefinedOr[bool] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Optional[int]: route = routes.POST_GUILD_PRUNE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("days", days) body.put("compute_prune_count", compute_prune_count) body.put_snowflake_array("include_roles", include_roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) pruned = response.get("pruned") return int(pruned) if pruned is not None else None
Begin the guild prune.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to begin the guild prune in. This may be the object or the ID of an existing guild.
Other Parameters
- days (hikari.undefined.UndefinedOr[int]): If provided, number of days to count prune for.
- compute_prune_count (hikari.snowflakes.SnowflakeishOr[bool]): If provided, whether to return the prune count. This is discouraged for large guilds.
- include_roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]): If provided, the role(s) to include. By default, this endpoint will not count users with roles. Providing roles using this attribute will make members with the specified roles also get included into the count.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- typing.Optional[int]: If
compute_prune_count
is not provided orTrue
, the number of members pruned. ElseNone
.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
KICK_MEMBERS
permission. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
def build_action_row(self) -> special_endpoints.ActionRowBuilder: return special_endpoints_impl.ActionRowBuilder()
Build an action row message component for use in message create and REST calls.
Returns
- hikari.api.special_endpoints.ActionRowBuilder: The initialised action row builder.
View Source
@typing.final async def close(self) -> None: """Close the HTTP client and any open HTTP connections.""" live_attributes = self._get_live_attributes() self._live_attributes = None await live_attributes.close()
Close the HTTP client and any open HTTP connections.
self,
name: str,
description: str
) -> hikari.api.special_endpoints.SlashCommandBuilder:
View Source
@deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `slash_command_builder` instead.") def command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return self.slash_command_builder(name, description)
Create a slash command builder for use in RESTClient.set_application_commands
.
Deprecated since version 2.0.0.dev106: Will be removed in 2.0.0.dev110. Use slash_command_builder
instead.
Parameters
- name (str): The command's name. This should match the regex
^[\w-]{1,32}$
in Unicode mode and be lowercase. - description (str): The description to set for the command. This should be inclusively between 1-100 characters in length.
Returns
- hikari.api.special_endpoints.SlashCommandBuilder: The created command builder object.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
name: str,
description: str,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
*,
options: Union[Sequence[hikari.commands.CommandOption], hikari.undefined.UndefinedType] = UNDEFINED,
default_permission: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.commands.SlashCommand:
View Source
@deprecation.deprecated("2.0.0.dev106", "2.0.0.dev110", "Use `create_slash_command` instead.") async def create_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: return await self.create_slash_command( application=application, name=name, description=description, guild=guild, options=options, default_permission=default_permission, )
Create an application slash command.
Deprecated since version 2.0.0.dev106: Will be removed in 2.0.0.dev110. Use create_slash_command
instead.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to create a command for.
- name (str): The command's name. This should match the regex
^[\w-]{1,32}$
in Unicode mode and be lowercase. - description (str): The description to set for the command. This should be inclusively between 1-100 characters in length.
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the specific guild this should be made for. If left as
hikari.undefined.UNDEFINED
then this call will create a global command rather than a guild specific one.
Other Parameters
- options (hikari.undefined.UndefinedOr[typing.Sequence[hikari.commands.CommandOption]]): A sequence of up to 10 options for this command.
default_permission (hikari.undefined.UndefinedOr[bool]): Whether this command should be enabled by default (without any permissions) when added to a guild.
Defaults to
True
.
Returns
- hikari.commands.SlashCommand: Object of the created command.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands.
- hikari.errors.NotFoundError: If the provided application isn't found.
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
interaction: Union[hikari.interactions.base_interactions.PartialInteraction, hikari.snowflakes.Snowflake, int],
token: str,
choices: Sequence[hikari.commands.CommandChoice]
) -> None:
View Source
async def create_autocomplete_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, choices: typing.Sequence[commands.CommandChoice], ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) body = data_binding.JSONObjectBuilder() body.put("type", base_interactions.ResponseType.AUTOCOMPLETE) data = data_binding.JSONObjectBuilder() data.put("choices", [{"name": choice.name, "value": choice.value} for choice in choices]) body.put("data", data) await self._request(route, json=body, no_auth=True)
Create the initial response for an autocomplete interaction.
Parameters
- interaction (hikari.snowflakes.SnowflakeishOr[hikari.interactions.base_interactions.PartialInteraction]): Object or ID of the interaction this response is for.
- token (str): The command interaction's token.
Other Parameters
- choices (typing.Sequence[commands.CommandChoice]): The autocomplete choices themselves.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the interaction is not found or if the interaction's initial response has already been created.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
/
) -> hikari.channels.DMChannel:
View Source
async def create_dm_channel(self, user: snowflakes.SnowflakeishOr[users.PartialUser], /) -> channels_.DMChannel: route = routes.POST_MY_CHANNELS.compile() body = data_binding.JSONObjectBuilder() body.put_snowflake("recipient_id", user) response = await self._request(route, json=body) assert isinstance(response, dict) channel = self._entity_factory.deserialize_dm(response) if self._cache: self._cache.set_dm_channel_id(user, channel.id) return channel
Create a DM channel with a user.
Parameters
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to create the DM channel with. This may be the object or the ID of an existing user.
Returns
- hikari.channels.DMChannel: The created DM channel.
Raises
- hikari.errors.BadRequestError: If the user is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO],
*,
roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.emojis.KnownCustomEmoji:
View Source
async def create_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, image: files.Resourceish, *, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.POST_GUILD_EMOJIS.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) image_resource = files.ensure_resource(image) async with image_resource.stream(executor=self._executor) as stream: body.put("image", await stream.data_uri()) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild))
Create an emoji in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the emoji on. This can be a guild object or the ID of an existing guild.
- name (str): The name for the emoji.
- image (hikari.files.Resourceish): The 128x128 image for the emoji. Maximum upload size is 256kb. This can be a still or an animated image.
Other Parameters
- roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]): If provided, a collection of the roles that will be able to use this emoji. This can be a
hikari.guilds.PartialRole
or the ID of an existing role. - reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.emojis.KnownCustomEmoji: The created emoji.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value or if there are no more spaces for the type of emoji in the guild.
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
/,
location: str,
start_time: datetime.datetime,
end_time: datetime.datetime,
*,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
privacy_level: Union[int, hikari.scheduled_events.EventPrivacyLevel] = <EventPrivacyLevel.GUILD_ONLY: 2>,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.scheduled_events.ScheduledExternalEvent:
View Source
async def create_external_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, /, location: str, start_time: datetime.datetime, end_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledExternalEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.EXTERNAL, name, location=location, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_external_event(response)
Create a scheduled external event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the event in.
- name (str): The name of the event.
- location (str): The location the event.
- start_time (datetime.datetime): When the event is scheduled to start.
- end_time (datetime.datetime): When the event is scheduled to end.
Other Parameters
- description (hikari.undefined.UndefinedOr[str]): The event's description.
- image (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): The event's display image.
privacy_level (hikari.undefined.UndefinedOr[hikari.scheduled_events.EventPrivacyLevel]): The event's privacy level.
This effects who can view and subscribe to the event.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.scheduled_events.ScheduledExternalEvent: The created scheduled external event.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_EVENTS
permission. - hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.GuildCategory:
View Source
async def create_guild_category( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildCategory: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_CATEGORY, position=position, permission_overwrites=permission_overwrites, reason=reason, ) return self._entity_factory.deserialize_guild_category(response)
Create a category in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the channel in. This may be the object or the ID of an existing guild.
- name (str): The channels name. Must be between 2 and 1000 characters.
Other Parameters
- position (hikari.undefined.UndefinedOr[int]): If provided, the position of the category.
- permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the permission overwrites for the category.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.GuildCategory: The created category.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
template: Union[str, hikari.templates.Template],
name: str,
*,
icon: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.RESTGuild:
View Source
async def create_guild_from_template( self, template: typing.Union[str, templates.Template], name: str, *, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, ) -> guilds.RESTGuild: template = template if isinstance(template, str) else template.code route = routes.POST_TEMPLATE.compile(template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response)
Make a guild from a template.
Note: This endpoint can only be used by bots in less than 10 guilds.
Parameters
- template (typing.Union[str, hikari.templates.Template]): The object or string code of the template to create a guild based on.
- name (str): The new guilds name.
Other Parameters
- icon (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the guild icon to set. Must be a 1024x1024 image or can be an animated gif when the guild has the
ANIMATED_ICON
feature.
Returns
- hikari.guilds.RESTGuild: Object of the created guild.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value or if you call this as a bot that's in more than 10 guilds.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
topic: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
nsfw: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
rate_limit_per_user: Union[int, float, datetime.timedelta, hikari.undefined.UndefinedType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
category: Union[hikari.channels.GuildCategory, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.GuildNewsChannel:
View Source
async def create_guild_news_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildNewsChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_NEWS, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_news_channel(response)
Create a news channel in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the channel in. This may be the object or the ID of an existing guild.
- name (str): The channels name. Must be between 2 and 1000 characters.
Other Parameters
- position (hikari.undefined.UndefinedOr[int]): If provided, the position of the channel (relative to the category, if any).
- topic (hikari.undefined.UndefinedOr[str]): If provided, the channels topic. Maximum 1024 characters.
- nsfw (hikari.undefined.UndefinedOr[bool]): If provided, whether to mark the channel as NSFW.
- rate_limit_per_user (hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]): If provided, the amount of seconds a user has to wait before being able to send another message in the channel. Maximum 21600 seconds.
- permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the permission overwrites for the channel.
- category (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]): The category to create the channel under. This may be the object or the ID of an existing category.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.GuildNewsChannel: The created channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
user_limit: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
bitrate: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
region: Union[hikari.voices.VoiceRegion, str, hikari.undefined.UndefinedType] = UNDEFINED,
category: Union[hikari.channels.GuildCategory, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.GuildStageChannel:
View Source
async def create_guild_stage_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildStageChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_STAGE, position=position, user_limit=user_limit, bitrate=bitrate, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_stage_channel(response)
Create a stage channel in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the channel in. This may be the object or the ID of an existing guild.
- name (str): The channel's name. Must be between 2 and 1000 characters.
Other Parameters
- position (hikari.undefined.UndefinedOr[int]): If provided, the position of the channel (relative to the category, if any).
- user_limit (hikari.undefined.UndefinedOr[int]): If provided, the maximum users in the channel at once. Must be between 0 and 99 with 0 meaning no limit.
- bitrate (hikari.undefined.UndefinedOr[int]): If provided, the bitrate for the channel. Must be between 8000 and 96000 or 8000 and 128000 for VIP servers.
- permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the permission overwrites for the channel.
- region (hikari.undefined.UndefinedOr[typing.Union[hikari.voices.VoiceRegion, str]]): If provided, the voice region to for this channel. Passing
None
here will set it to "auto" mode where the used region will be decided based on the first person who connects to it when it's empty. - category (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]): The category to create the channel under. This may be the object or the ID of an existing category.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.GuildStageChannel: The created channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
topic: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
nsfw: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
rate_limit_per_user: Union[int, float, datetime.timedelta, hikari.undefined.UndefinedType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
category: Union[hikari.channels.GuildCategory, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.GuildTextChannel:
View Source
async def create_guild_text_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildTextChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_TEXT, position=position, topic=topic, nsfw=nsfw, rate_limit_per_user=rate_limit_per_user, permission_overwrites=permission_overwrites, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_text_channel(response)
Create a text channel in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the channel in. This may be the object or the ID of an existing guild.
- name (str): The channels name. Must be between 2 and 1000 characters.
Other Parameters
- position (hikari.undefined.UndefinedOr[int]): If provided, the position of the channel (relative to the category, if any).
- topic (hikari.undefined.UndefinedOr[str]): If provided, the channels topic. Maximum 1024 characters.
- nsfw (hikari.undefined.UndefinedOr[bool]): If provided, whether to mark the channel as NSFW.
- rate_limit_per_user (hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]): If provided, the amount of seconds a user has to wait before being able to send another message in the channel. Maximum 21600 seconds.
- permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the permission overwrites for the channel.
- category (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]): The category to create the channel under. This may be the object or the ID of an existing category.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.GuildTextChannel: The created channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
user_limit: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
bitrate: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
video_quality_mode: Union[hikari.channels.VideoQualityMode, int, hikari.undefined.UndefinedType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
region: Union[hikari.voices.VoiceRegion, str, hikari.undefined.UndefinedType] = UNDEFINED,
category: Union[hikari.channels.GuildCategory, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.GuildVoiceChannel:
View Source
async def create_guild_voice_channel( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, region: undefined.UndefinedOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.GuildVoiceChannel: response = await self._create_guild_channel( guild, name, channels_.ChannelType.GUILD_VOICE, position=position, user_limit=user_limit, bitrate=bitrate, video_quality_mode=video_quality_mode, permission_overwrites=permission_overwrites, region=region, category=category, reason=reason, ) return self._entity_factory.deserialize_guild_voice_channel(response)
Create a voice channel in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the channel in. This may be the object or the ID of an existing guild.
- name (str): The channels name. Must be between 2 and 1000 characters.
Other Parameters
- position (hikari.undefined.UndefinedOr[int]): If provided, the position of the channel (relative to the category, if any).
- user_limit (hikari.undefined.UndefinedOr[int]): If provided, the maximum users in the channel at once. Must be between 0 and 99 with 0 meaning no limit.
- bitrate (hikari.undefined.UndefinedOr[int]): If provided, the bitrate for the channel. Must be between 8000 and 96000 or 8000 and 128000 for VIP servers.
- video_quality_mode (hikari.undefined.UndefinedOr[typing.Union[hikari.channels.VideoQualityMode, int]]): If provided, the new video quality mode for the channel.
- permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the permission overwrites for the channel.
- region (hikari.undefined.UndefinedOr[typing.Union[hikari.voices.VoiceRegion, str]]): If provided, the voice region to for this channel. Passing
None
here will set it to "auto" mode where the used region will be decided based on the first person who connects to it when it's empty. - category (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]): The category to create the channel under. This may be the object or the ID of an existing category.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.GuildVoiceChannel: The created channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
interaction: Union[hikari.interactions.base_interactions.PartialInteraction, hikari.snowflakes.Snowflake, int],
token: str,
response_type: Union[int, hikari.interactions.base_interactions.ResponseType],
content: Union[Any, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
*,
flags: Union[int, hikari.messages.MessageFlag, hikari.undefined.UndefinedType] = UNDEFINED,
tts: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType] = UNDEFINED,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def create_interaction_response( self, interaction: snowflakes.SnowflakeishOr[base_interactions.PartialInteraction], token: str, response_type: typing.Union[int, base_interactions.ResponseType], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, flags: typing.Union[int, messages_.MessageFlag, undefined.UndefinedType] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> None: route = routes.POST_INTERACTION_RESPONSE.compile(interaction=interaction, token=token) data, form = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body = data_binding.JSONObjectBuilder() body.put("type", response_type) body.put("data", data) if form is not None: form.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) await self._request(route, form_builder=form, no_auth=True) else: await self._request(route, json=body, no_auth=True)
Create the initial response for a interaction.
Warning: Calling this with an interaction which already has an initial response will result in this raising a hikari.errors.NotFoundError
. This includes if the REST interaction server has already responded to the request.
Parameters
- interaction (hikari.snowflakes.SnowflakeishOr[hikari.interactions.base_interactions.PartialInteraction]): Object or ID of the interaction this response is for.
- token (str): The command interaction's token.
- response_type (typing.Union[int, hikari.interactions.base_interactions.ResponseType]): The type of interaction response this is.
Other Parameters
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message contents. If
hikari.undefined.UNDEFINED
, then nothing will be sent in the content. Any other value here will be cast to astr
.If this is a
hikari.embeds.Embed
and noembed
nor noembeds
kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.- attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish],): If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.
- attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]],): If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.
- component (hikari.undefined.UndefinedOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to include in this message.
- components (hikari.undefined.UndefinedOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects to include in this message.
- embed (hikari.undefined.UndefinedOr[hikari.embeds.Embed]): If provided, the message embed.
- embeds (hikari.undefined.UndefinedOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the message embeds.
flags (typing.Union[int, hikari.messages.MessageFlag, hikari.undefined.UndefinedType]): If provided, the message flags this response should have.
As of writing the only message flag which can be set here is
hikari.messages.MessageFlag.EPHEMERAL
.- tts (hikari.undefined.UndefinedOr[bool]): If provided, whether the message will be read out by a screen reader using Discord's TTS (text-to-speech) system.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, whether the message should parse @everyone/@here mentions.
- user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, and
True
, all user mentions will be detected. If provided, andFalse
, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.users.PartialUser
derivatives to enforce mentioning specific users. - role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, and
True
, all role mentions will be detected. If provided, andFalse
, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.guilds.PartialRole
derivatives to enforce mentioning specific roles.
Raises
- ValueError: If more than 100 unique objects/entities are passed for
role_mentions
oruser_mentions
. - TypeError: If both
embed
andembeds
are specified. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits invalid image URLs in embeds.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the interaction is not found or if the interaction's initial response has already been created.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int],
*,
max_age: Union[int, float, datetime.timedelta, hikari.undefined.UndefinedType] = UNDEFINED,
max_uses: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
temporary: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
unique: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
target_type: Union[hikari.invites.TargetType, hikari.undefined.UndefinedType] = UNDEFINED,
target_user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
target_application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.invites.InviteWithMetadata:
View Source
async def create_invite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, max_age: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, max_uses: undefined.UndefinedOr[int] = undefined.UNDEFINED, temporary: undefined.UndefinedOr[bool] = undefined.UNDEFINED, unique: undefined.UndefinedOr[bool] = undefined.UNDEFINED, target_type: undefined.UndefinedOr[invites.TargetType] = undefined.UNDEFINED, target_user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, target_application: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[guilds.PartialApplication] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> invites.InviteWithMetadata: route = routes.POST_CHANNEL_INVITES.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("max_age", max_age, conversion=time.timespan_to_int) body.put("max_uses", max_uses) body.put("temporary", temporary) body.put("unique", unique) body.put("target_type", target_type) body.put_snowflake("target_user_id", target_user) body.put_snowflake("target_application_id", target_application) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_invite_with_metadata(response)
Create an invite to the given guild channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The channel to create a invite for. This may be the object or the ID of an existing channel.
Other Parameters
- max_age (hikari.undefined.UndefinedOr[typing.Union[datetime.timedelta, float, int]]): If provided, the duration of the invite before expiry.
- max_uses (hikari.undefined.UndefinedOr[int]): If provided, the max uses the invite can have.
- temporary (hikari.undefined.UndefinedOr[bool]): If provided, whether the invite only grants temporary membership.
- unique (hikari.undefined.UndefinedOr[bool]): If provided, whether the invite should be unique.
- target_type (hikari.undefined.UndefinedOr[hikari.invites.TargetType]): If provided, the target type of this invite.
target_user (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]]): If provided, the target user id for this invite. This may be the object or the ID of an existing user.
Note: This is required if
target_type
isSTREAM
and the targeted user must be streaming into the channel.target_application (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]]): If provided, the target application id for this invite. This may be the object or the ID of an existing application.
Note: This is required if
target_type
isEMBEDDED_APPLICATION
and the targeted application must have theEMBEDDED
flag.- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.invites.InviteWithMetadata: The invite to the given guild channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNELS
permission. - hikari.errors.NotFoundError: If the channel is not found, or if the target user does not exist, if provided.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
content: Union[Any, hikari.undefined.UndefinedType] = UNDEFINED,
*,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType] = UNDEFINED,
tts: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
reply: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
mentions_reply: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.messages.Message:
View Source
async def create_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reply: undefined.UndefinedOr[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.POST_CHANNEL_MESSAGES.compile(channel=channel) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("message_reference", reply, conversion=lambda m: {"message_id": str(int(m))}) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Create a message in the given channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to create the message in.
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message contents. If
hikari.undefined.UNDEFINED
, then nothing will be sent in the content. Any other value here will be cast to astr
.If this is a
hikari.embeds.Embed
and noembed
norembeds
kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.Likewise, if this is a
hikari.files.Resource
, then the content is instead treated as an attachment if noattachment
and noattachments
kwargs are provided.
Other Parameters
attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish],): If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.
Attachments can be passed as many different things, to aid in convenience.
- If a
pathlib.PurePath
orstr
to a valid URL, the resource at the given URL will be streamed to Discord when sending the message. Subclasses ofhikari.files.WebResource
such ashikari.files.URL
,hikari.messages.Attachment
,hikari.emojis.Emoji
,EmbedResource
, etc will also be uploaded this way. This will use bit-inception, so only a small percentage of the resource will remain in memory at any one time, thus aiding in scalability. - If a
hikari.files.Bytes
is passed, or astr
that contains a valid data URI is passed, then this is uploaded with a randomized file name if not provided. - If a
hikari.files.File
,pathlib.PurePath
orstr
that is an absolute or relative path to a file on your file system is passed, then this resource is uploaded as an attachment using non-blocking code internally and streamed using bit-inception where possible. This depends on the type ofconcurrent.futures.Executor
that is being used for the application (default is a thread pool which supports this behaviour).
- If a
- attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]],): If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.
- component (hikari.undefined.UndefinedOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to include in this message.
- components (hikari.undefined.UndefinedOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects to include in this message.
- embed (hikari.undefined.UndefinedOr[hikari.embeds.Embed]): If provided, the message embed.
- embeds (hikari.undefined.UndefinedOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the message embeds.
- tts (hikari.undefined.UndefinedOr[bool]): If provided, whether the message will be read out by a screen reader using Discord's TTS (text-to-speech) system.
- reply (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]]): If provided, the message to reply to.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, whether the message should parse @everyone/@here mentions.
mentions_reply (hikari.undefined.UndefinedOr[bool]): If provided, whether to mention the author of the message that is being replied to.
This will not do anything if not being used with
reply
.- user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, and
True
, all user mentions will be detected. If provided, andFalse
, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.users.PartialUser
derivatives to enforce mentioning specific users. - role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, and
True
, all role mentions will be detected. If provided, andFalse
, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.guilds.PartialRole
derivatives to enforce mentioning specific roles.
Returns
- hikari.messages.Message: The created message.
Raises
- ValueError: If more than 100 unique objects/entities are passed for
role_mentions
oruser_mentions
or if bothattachment
andattachments
,component
andcomponents
orembed
andembeds
are specified. - TypeError: If
attachments
,components
orembeds
is passed but is not a sequence. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; if
reply
is not found or not in the same channel aschannel
; too many components. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
SEND_MESSAGES
in the channel or the person you are trying to message has the DM's disabled. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
permissions: Union[hikari.permissions.Permissions, hikari.undefined.UndefinedType] = <Permissions.NONE: 0>,
color: Union[hikari.colors.Color, SupportsInt, Tuple[SupportsInt, SupportsInt, SupportsInt], Tuple[SupportsFloat, SupportsFloat, SupportsFloat], Sequence[SupportsInt], Sequence[SupportsFloat], str, hikari.undefined.UndefinedType] = UNDEFINED,
colour: Union[hikari.colors.Color, SupportsInt, Tuple[SupportsInt, SupportsInt, SupportsInt], Tuple[SupportsFloat, SupportsFloat, SupportsFloat], Sequence[SupportsInt], Sequence[SupportsFloat], str, hikari.undefined.UndefinedType] = UNDEFINED,
hoist: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
icon: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
unicode_emoji: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
mentionable: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.Role:
View Source
async def create_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = permissions_.Permissions.NONE, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.POST_GUILD_ROLES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild))
Create a role.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the role in. This may be the object or the ID of an existing guild.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): If provided, the name for the role.
- permissions (hikari.undefined.UndefinedOr[hikari.permissions.Permissions]): The permissions to give the role. This will default to setting NO roles if left to the default value. This is in contrast to default behaviour on Discord where some random permissions will be set by default.
- color (hikari.undefined.UndefinedOr[hikari.colors.Colorish]): If provided, the role's color.
- colour (hikari.undefined.UndefinedOr[hikari.colors.Colorish]): An alias for
color
. - hoist (hikari.undefined.UndefinedOr[bool]): If provided, whether to hoist the role.
- icon (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the role icon. Must be a 64x64 image under 256kb.
- unicode_emoji (hikari.undefined.UndefinedOr[str]): If provided, the standard emoji to set as the role icon.
- mentionable (hikari.undefined.UndefinedOr[bool]): If provided, whether to make the role mentionable.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.Role: The created role.
Raises
- TypeError: If both
color
andcolour
are specified or if bothicon
andunicode_emoji
are specified. - hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
name: str,
description: str,
*,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
options: Union[Sequence[hikari.commands.CommandOption], hikari.undefined.UndefinedType] = UNDEFINED,
default_permission: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.commands.SlashCommand:
View Source
async def create_slash_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], name: str, description: str, *, guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, default_permission: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> commands.SlashCommand: response = await self._create_application_command( application=application, type=commands.CommandType.SLASH, name=name, description=description, guild=guild, options=options, default_permission=default_permission, ) return self._entity_factory.deserialize_slash_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None )
Create an application command.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to create a command for.
- name (str): The command's name. This should match the regex
^[\w-]{1,32}$
in Unicode mode and be lowercase. - description (str): The description to set for the command. This should be inclusively between 1-100 characters in length.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the specific guild this should be made for. If left as
hikari.undefined.UNDEFINED
then this call will create a global command rather than a guild specific one. - options (hikari.undefined.UndefinedOr[typing.Sequence[hikari.commands.CommandOption]]): A sequence of up to 10 options for this command.
default_permission (hikari.undefined.UndefinedOr[bool]): Whether this command should be enabled by default (without any permissions) when added to a guild.
Defaults to
True
.
Returns
- hikari.commands.SlashCommand: Object of the created command.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands.
- hikari.errors.NotFoundError: If the provided application isn't found.
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.PartialChannel, hikari.snowflakes.Snowflake, int],
name: str,
/,
start_time: datetime.datetime,
*,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
end_time: Union[datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
privacy_level: Union[int, hikari.scheduled_events.EventPrivacyLevel] = <EventPrivacyLevel.GUILD_ONLY: 2>,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.scheduled_events.ScheduledStageEvent:
View Source
async def create_stage_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledStageEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.STAGE_INSTANCE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_stage_event(response)
Create a scheduled stage event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the event in.
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]): The stage channel to create the event in.
- name (str): The name of the event.
- start_time (datetime.datetime): When the event is scheduled to start.
Other Parameters
- description (hikari.undefined.UndefinedOr[str]): The event's description.
- end_time (hikari.undefined.UndefinedOr[datetime.datetime]): When the event should be scheduled to end.
- image (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): The event's display image.
privacy_level (hikari.undefined.UndefinedOr[hikari.scheduled_events.EventPrivacyLevel]): The event's privacy level.
This effects who can view and subscribe to the event.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.scheduled_events.ScheduledStageEvent: The created scheduled stage event.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing permissions to create the scheduled event.
You need the following permissions in the target stage channel: MANAGE_EVENTS
, VIEW_CHANNEL
and CONNECT
.
- hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
tag: str,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO],
*,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.stickers.GuildSticker:
View Source
async def create_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, tag: str, image: files.Resourceish, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.POST_GUILD_STICKERS.compile(guild=guild) form = data_binding.URLEncodedFormBuilder(executor=self._executor) form.add_field("name", name) form.add_field("tags", tag) form.add_field("description", description or "") form.add_resource("file", files.ensure_resource(image)) response = await self._request(route, form_builder=form, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response)
Create a sticker in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the sticker on. This can be a guild object or the ID of an existing guild.
- name (str): The name for the sticker.
- tag (str): The tag for the sticker.
image (hikari.files.Resourceish): The 320x320 image for the sticker. Maximum upload size is 500kb. This can be a still or an animated PNG or a Lottie.
Note: Lottie support is only available for verified and partnered servers.
Other Parameters
- description (hikari.undefined.UndefinedOr[str]): If provided, the description of the sticker.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.stickers.GuildSticker: The created sticker.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value or if there are no more spaces for the sticker in the guild.
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str,
*,
description: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED
) -> hikari.templates.Template:
View Source
async def create_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: route = routes.POST_GUILD_TEMPLATES.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response)
Create a guild template.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create a template from.
- name (str): The name to use for the created template.
Other Parameters
- description (hikari.undefined.UndefinedNoneOr[str]): The description to set for the template.
Returns
- hikari.templates.Template: The object of the created template.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found or you are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.PartialChannel, hikari.snowflakes.Snowflake, int],
name: str,
/,
start_time: datetime.datetime,
*,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
end_time: Union[datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
privacy_level: Union[int, hikari.scheduled_events.EventPrivacyLevel] = <EventPrivacyLevel.GUILD_ONLY: 2>,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.scheduled_events.ScheduledVoiceEvent:
View Source
async def create_voice_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.PartialChannel], name: str, /, start_time: datetime.datetime, *, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, end_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, privacy_level: typing.Union[ int, scheduled_events.EventPrivacyLevel ] = scheduled_events.EventPrivacyLevel.GUILD_ONLY, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledVoiceEvent: route = routes.POST_GUILD_SCHEDULED_EVENT.compile(guild=guild) response = await self._create_or_edit_scheduled_stage( route, scheduled_events.ScheduledEventType.VOICE, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, privacy_level=privacy_level, reason=reason, ) return self._entity_factory.deserialize_scheduled_voice_event(response)
Create a scheduled voice event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to create the event in.
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]): The voice channel to create the event in.
- name (str): The name of the event.
- start_time (datetime.datetime): When the event is scheduled to start.
Other Parameters
- description (hikari.undefined.UndefinedOr[str]): The event's description.
- end_time (hikari.undefined.UndefinedOr[datetime.datetime]): When the event should be scheduled to end.
- image (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): The event's display image.
privacy_level (hikari.undefined.UndefinedOr[hikari.scheduled_events.EventPrivacyLevel]): The event's privacy level.
This effects who can view and subscribe to the event.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.scheduled_events.ScheduledVoiceEvent: The created scheduled voice event.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing permissions to create the scheduled event.
You need the following permissions in the target voice channel: MANAGE_EVENTS
, VIEW_CHANNEL
and CONNECT
.
- hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildTextChannel, hikari.channels.GuildNewsChannel, hikari.snowflakes.Snowflake, int],
name: str,
*,
avatar: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.webhooks.IncomingWebhook:
View Source
async def create_webhook( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], name: str, *, avatar: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.IncomingWebhook: route = routes.POST_CHANNEL_WEBHOOKS.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) if avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_incoming_webhook(response)
Create webhook in a channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.WebhookChannelT]): The channel where the webhook will be created. This may be the object or the ID of an existing channel.
- name (str): The name for the webhook. This cannot be
clyde
.
Other Parameters
- avatar (typing.Optional[hikari.files.Resourceish]): If provided, the avatar for the webhook.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.webhooks.IncomingWebhook: The created webhook.
Raises
- hikari.errors.BadRequestError: If
name
doesn't follow the restrictions enforced by discord. - hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildNewsChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> hikari.messages.Message:
View Source
async def crosspost_message( self, channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.POST_CHANNEL_CROSSPOST.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Broadcast an announcement message.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildNewsChannel]): The object or ID of the news channel to crosspost a message in.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The object or ID of the message to crosspost.
Returns
- hikari.messages.Message: The message object that was crossposted.
Raises
- hikari.errors.BadRequestError: If you tried to crosspost a message that has already been broadcast.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you try to crosspost a message by the current user without the
SEND_MESSAGES
permission for the target news channel or try to crosspost a message by another user without both theSEND_MESSAGES
andMANAGE_MESSAGES
permissions for the target channel. - hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_all_reactions( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_ALL_REACTIONS.compile(channel=channel, message=message) await self._request(route)
Delete all reactions from a message.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to delete all reactions from is. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete all reaction from. This may be the object or the ID of an existing message.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
emoji: Union[str, hikari.emojis.Emoji],
emoji_id: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_all_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_EMOJI.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route)
Delete all reactions for a single emoji on a given message.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to delete the reactions from is. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete a reactions from. This may be the object or the ID of an existing message.
- emoji (typing.Union[str, hikari.emojis.Emoji]): Object or name of the emoji to remove all the reactions for.
Other Parameters
- emoji_id (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]]): ID of the custom emoji to remove all the reactions for. This should only be provided when a custom emoji's name is passed for
emoji
.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
command: Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> None: if guild is undefined.UNDEFINED: route = routes.DELETE_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.DELETE_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) await self._request(route)
Delete a registered application command.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to delete a command for.
- command (hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand]): Object or ID of the command to delete.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to delete a command for if this is a guild specific command. Leave this as
hikari.undefined.UNDEFINED
to delete a global command.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands.
- hikari.errors.NotFoundError: If the provided application or command isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.PartialChannel, hikari.snowflakes.Snowflake, int]
) -> hikari.channels.PartialChannel:
View Source
async def delete_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.DELETE_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response)
Delete a channel in a guild, or close a DM.
Note: For Public servers, the set 'Rules' or 'Guidelines' channels and the 'Public Server Updates' channel cannot be deleted.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]): The channel to delete. This may be the object or the ID of an existing channel.
Returns
- hikari.channels.PartialChannel: Object of the channel that was deleted.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission in the channel. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
emoji: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_EMOJI.compile(guild=guild, emoji=emoji) await self._request(route, reason=reason)
Delete an emoji in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete the emoji on. This can be a guild object or the ID of an existing guild.
- emoji (hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]): The emoji to delete. This can be a
hikari.emojis.CustomEmoji
or the ID of an existing emoji.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild or the emoji are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> None: route = routes.DELETE_GUILD.compile(guild=guild) await self._request(route)
Delete a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete. This may be the object or the ID of an existing guild.
Raises
- hikari.errors.ForbiddenError: If you are not the owner of the guild.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If you own the guild or if you are not in it.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
token: str
) -> None:
View Source
async def delete_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> None: route = routes.DELETE_INTERACTION_RESPONSE.compile(webhook=application, token=token) await self._request(route, no_auth=True)
Delete the initial response of an interaction.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to delete a command response for.
- token (str): The interaction's token.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the interaction or response is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
invite: Union[hikari.invites.InviteCode, str]
) -> hikari.invites.Invite:
View Source
async def delete_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.DELETE_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response)
Delete an existing invite.
Parameters
- invite (typing.Union[hikari.invites.InviteCode, str]): The invite to delete. This may be an invite object or the code of an existing invite.
Returns
- hikari.invites.Invite: Object of the invite that was deleted.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission in the guild the invite is from or if you are missing theMANAGE_CHANNELS
permission in the channel the invite is from. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the invite is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_MESSAGE.compile(channel=channel, message=message) await self._request(route)
Delete a given message in a given channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to delete the message in. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete. This may be the object or the ID of an existing message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
, and the message is not sent by you. - hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
messages: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int, Iterable[Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]]],
/,
*other_messages: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], messages: typing.Union[ snowflakes.SnowflakeishOr[messages_.PartialMessage], snowflakes.SnowflakeishIterable[messages_.PartialMessage], ], /, *other_messages: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.POST_DELETE_CHANNEL_MESSAGES_BULK.compile(channel=channel) pending: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] deleted: typing.List[snowflakes.SnowflakeishOr[messages_.PartialMessage]] = [] if isinstance(messages, typing.Iterable): # Syntactic sugar. Allows to use iterables pending.extend(messages) else: pending.append(messages) # This maintains the order in-order to keep a predictable deletion order. pending.extend(other_messages) while pending: # Discord only allows 2-100 messages in the BULK_DELETE endpoint. Because of that, # if the user wants 101 messages deleted, we will post 100 messages in bulk delete # and then the last message in a normal delete. # Along with this, the bucket size for v6 and v7 seems to be a bit restrictive. As of # 30th July 2020, this endpoint returned the following headers when being ratelimited: # x-ratelimit-bucket b05c0d8c2ab83895085006a8eae073a3 # x-ratelimit-limit 1 # x-ratelimit-remaining 0 # x-ratelimit-reset 1596033974.096 # x-ratelimit-reset-after 3.000 # This kind of defeats the point of asynchronously gathering any of these # in the first place really. To save clogging up the event loop # (albeit at a cost of maybe a couple-dozen milliseconds per call), # I am just gonna invoke these sequentially instead. try: if len(pending) == 1: message = pending[0] try: await self.delete_message(channel, message) except errors.NotFoundError as exc: # If the message is not found then this error should be suppressed # to keep consistency with how the bulk delete endpoint functions. if exc.code != 10008: # Unknown Message raise deleted.append(message) else: body = data_binding.JSONObjectBuilder() chunk = pending[:100] body.put_snowflake_array("messages", chunk) await self._request(route, json=body) deleted += chunk pending = pending[100:] except Exception as ex: raise errors.BulkDeleteError(deleted, pending) from ex
Bulk-delete messages from the channel.
Note: This API endpoint will only be able to delete 100 messages at a time. For anything more than this, multiple requests will be executed one-after-the-other, since the rate limits for this endpoint do not favour more than one request per bucket.
If one message is left over from chunking per 100 messages, or only one message is passed to this coroutine function, then the logic is expected to defer to delete_message
. The implication of this is that the delete_message
endpoint is rate limited by a different bucket with different usage rates.
Warning: This endpoint is not atomic. If an error occurs midway through a bulk delete, you will not be able to revert any changes made up to this point.
Warning: Specifying any messages more than 14 days old will cause the call to fail, potentially with partial completion.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to bulk delete the messages in. This may be the object or the ID of an existing channel.
- messages (typing.Union[hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage], hikari.snowflakes.SnowflakeishIterable[hikari.messages.PartialMessage]]): Either the object/ID of an existing message to delete or an iterable of the objects and/or IDs of existing messages to delete.
Other Parameters
- *other_messages (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The objects and/or IDs of other existing messages to delete.
Raises
- hikari.errors.BulkDeleteError: An error containing the messages successfully deleted, and the messages that were not removed. The
BaseException.__cause__
of the exception will be the original error that terminated this process.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
emoji: Union[str, hikari.emojis.Emoji],
emoji_id: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_my_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_MY_REACTION.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, ) await self._request(route)
Delete a reaction that your application user created.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to delete the reaction from is. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete a reaction from. This may be the object or the ID of an existing message.
- emoji (typing.Union[str, hikari.emojis.Emoji]): Object or name of the emoji to remove your reaction for.
Other Parameters
- emoji_id (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]]): ID of the custom emoji to remove your reaction for. This should only be provided when a custom emoji's name is passed for
emoji
.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int],
target: Union[hikari.channels.PermissionOverwrite, hikari.guilds.PartialRole, hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_permission_overwrite( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ channels_.PermissionOverwrite, guilds.PartialRole, users.PartialUser, snowflakes.Snowflakeish ], ) -> None: route = routes.DELETE_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) await self._request(route)
Delete a custom permission for an entity in a given guild channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The channel to delete a permission overwrite in. This may be the object, or the ID of an existing channel.
- target (typing.Union[hikari.users.PartialUser, hikari.guilds.PartialRole, hikari.channels.PermissionOverwrite, hikari.snowflakes.Snowflakeish]): The channel overwrite to delete.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_PERMISSIONS
permission in the channel. - hikari.errors.NotFoundError: If the channel is not found or the target is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
emoji: Union[str, hikari.emojis.Emoji],
emoji_id: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_reaction( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], user: snowflakes.SnowflakeishOr[users.PartialUser], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_REACTION_USER.compile( emoji=self._transform_emoji_to_url_format(emoji, emoji_id), channel=channel, message=message, user=user, ) await self._request(route)
Delete a reaction from a message.
If you are looking to delete your own applications reaction, use delete_my_reaction
.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to delete the reaction from is. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete a reaction from. This may be the object or the ID of an existing message.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): Object or ID of the user to remove the reaction of.
- emoji (typing.Union[str, hikari.emojis.Emoji]): Object or name of the emoji to react with.
Other Parameters
- emoji_id (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]]): ID of the custom emoji to react with. This should only be provided when a custom emoji's name is passed for
emoji
.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
role: Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], ) -> None: route = routes.DELETE_GUILD_ROLE.compile(guild=guild, role=role) await self._request(route)
Delete a role.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete the role in. This may be the object or the ID of an existing guild.
- role (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]): The role to delete. This may be the object or the ID of an existing role.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or role are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
event: Union[hikari.scheduled_events.ScheduledEvent, hikari.snowflakes.Snowflake, int],
/
) -> None:
View Source
async def delete_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> None: route = routes.DELETE_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) await self._request(route)
Delete a scheduled event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete the event from.
- event (hikari.snowflakes.SnowflakeishOr[hikari.scheduled_events.ScheduledEvent]): The scheduled event to delete.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_EVENTS
permission. - hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
sticker: Union[hikari.stickers.PartialSticker, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_STICKER.compile(guild=guild, sticker=sticker) await self._request(route, reason=reason)
Delete a sticker in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete the sticker on. This can be a guild object or the ID of an existing guild.
- sticker (hikari.snowflakes.SnowflakeishOr[hikari.stickers.PartialSticker]): The sticker to delete. This can be a sticker object or the ID of an existing sticker.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild or the sticker are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
template: Union[str, hikari.templates.Template]
) -> hikari.templates.Template:
View Source
async def delete_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.DELETE_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response)
Delete a guild template.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to delete a template in.
- template (typing.Union[str, hikari.templates.Template]): Object or string code of the template to delete.
Returns
- hikari.templates.Template: The deleted template's object.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found or you are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.PartialWebhook, hikari.snowflakes.Snowflake, int],
*,
token: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def delete_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if token is undefined.UNDEFINED: route = routes.DELETE_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.DELETE_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True await self._request(route, no_auth=no_auth)
Delete a webhook.
Parameters
- webhook (hikari.snowflakes.SnowflakeishOr[hikari.webhooks.PartialWebhook]): The webhook to delete. This may be the object or the ID of an existing webhook.
Other Parameters
- token (hikari.undefined.UndefinedOr[str]): If provided, the webhook token that will be used to delete the webhook instead of the token the client was initialized with.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission when not using a token. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.ExecutableWebhook, hikari.snowflakes.Snowflake, int],
token: str,
message: Union[hikari.messages.Message, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def delete_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], ) -> None: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.DELETE_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) await self._request(route, no_auth=True)
Delete a given message in a given channel.
Parameters
- webhook (typing.Union[hikari.snowflakes.Snowflakeish, hikari.webhooks.ExecutableWebhook]): The webhook to execute. This may be the object or the ID of an existing webhook.
- token (str): The webhook token.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete. This may be the object or the ID of an existing message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook or the message are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
command: Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
options: Union[Sequence[hikari.commands.CommandOption], hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.commands.PartialCommand:
View Source
async def edit_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, options: undefined.UndefinedOr[typing.Sequence[commands.CommandOption]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.PATCH_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.PATCH_APPLICATION_GUILD_COMMAND.compile( application=application, command=command, guild=guild ) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) body.put_array("options", options, conversion=self._entity_factory.serialize_command_option) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None )
Edit a registered application command.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to edit a command for.
- command (hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand]): Object or ID of the command to modify.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to edit a command for if this is a guild specific command. Leave this as
hikari.undefined.UNDEFINED
to delete a global command. - name (hikari.undefined.UndefinedOr[str]): The name to set for the command. Leave as
hikari.undefined.UNDEFINED
to not change. - description (hikari.undefined.UndefinedOr[str]): The description to set for the command. Leave as
hikari.undefined.UNDEFINED
to not change. - options (hikari.undefined.UndefinedOr[typing.Sequence[hikari.commands.CommandOption]]): A sequence of up to 10 options to set for this command. Leave this as
hikari.undefined.UNDEFINED
to not change.
Returns
- hikari.commands.PartialCommand: The edited command object.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands.
- hikari.errors.NotFoundError: If the provided application or command isn't found.
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int],
/,
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
position: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
topic: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
nsfw: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
bitrate: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
video_quality_mode: Union[hikari.channels.VideoQualityMode, int, hikari.undefined.UndefinedType] = UNDEFINED,
user_limit: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
rate_limit_per_user: Union[int, float, datetime.timedelta, hikari.undefined.UndefinedType] = UNDEFINED,
region: Union[hikari.voices.VoiceRegion, str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
permission_overwrites: Union[Sequence[hikari.channels.PermissionOverwrite], hikari.undefined.UndefinedType] = UNDEFINED,
parent_category: Union[hikari.channels.GuildCategory, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.PartialChannel:
View Source
async def edit_channel( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], /, *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, position: undefined.UndefinedOr[int] = undefined.UNDEFINED, topic: undefined.UndefinedOr[str] = undefined.UNDEFINED, nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED, bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED, video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED, user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED, rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, region: undefined.UndefinedNoneOr[typing.Union[voices.VoiceRegion, str]] = undefined.UNDEFINED, permission_overwrites: undefined.UndefinedOr[ typing.Sequence[channels_.PermissionOverwrite] ] = undefined.UNDEFINED, parent_category: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildCategory] ] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.PartialChannel: route = routes.PATCH_CHANNEL.compile(channel=channel) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("position", position) body.put("topic", topic) body.put("nsfw", nsfw) body.put("bitrate", bitrate) body.put("video_quality_mode", video_quality_mode) body.put("user_limit", user_limit) body.put("rate_limit_per_user", rate_limit_per_user, conversion=time.timespan_to_int) body.put("rtc_region", region, conversion=str) body.put_snowflake("parent_id", parent_category) body.put_array( "permission_overwrites", permission_overwrites, conversion=self._entity_factory.serialize_permission_overwrite, ) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel(response)
Edit a channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The channel to edit. This may be the object or the ID of an existing channel.
Other Parameters
- name (hikari.undefined.UndefinedOr[[str]): If provided, the new name for the channel.
- position (hikari.undefined.UndefinedOr[[int]): If provided, the new position for the channel.
- topic (hikari.undefined.UndefinedOr[str]): If provided, the new topic for the channel.
- nsfw (hikari.undefined.UndefinedOr[bool]): If provided, whether the channel should be marked as NSFW or not.
- bitrate (hikari.undefined.UndefinedOr[int]): If provided, the new bitrate for the channel.
- video_quality_mode (hikari.undefined.UndefinedOr[typing.Union[hikari.channels.VideoQualityMode, int]]): If provided, the new video quality mode for the channel.
- user_limit (hikari.undefined.UndefinedOr[int]): If provided, the new user limit in the channel.
- rate_limit_per_user (hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]): If provided, the new rate limit per user in the channel.
- region (hikari.undefined.UndefinedOr[typing.Union[str, hikari.voices.VoiceRegion]]): If provided, the voice region to set for this channel. Passing
None
here will set it to "auto" mode where the used region will be decided based on the first person who connects to it when it's empty. - permission_overwrites (hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]): If provided, the new permission overwrites for the channel.
- parent_category (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]): If provided, the new guild category for the channel.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.channels.PartialChannel: The edited channel.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing permissions to edit the channel.
- hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
emoji: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.emojis.KnownCustomEmoji:
View Source
async def edit_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> emojis.KnownCustomEmoji: route = routes.PATCH_GUILD_EMOJI.compile(guild=guild, emoji=emoji) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake_array("roles", roles) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild))
Edit an emoji in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the emoji on. This can be a guild object or the ID of an existing guild.
- emoji (hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]): The emoji to edit. This can be a
hikari.emojis.CustomEmoji
or the ID of an existing emoji.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): If provided, the new name for the emoji.
- roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]): If provided, the new collection of roles that will be able to use this emoji. This can be a
hikari.guilds.PartialRole
or the ID of an existing role. - reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.emojis.KnownCustomEmoji: The edited emoji.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild or the emoji are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
verification_level: Union[hikari.guilds.GuildVerificationLevel, hikari.undefined.UndefinedType] = UNDEFINED,
default_message_notifications: Union[hikari.guilds.GuildMessageNotificationsLevel, hikari.undefined.UndefinedType] = UNDEFINED,
explicit_content_filter_level: Union[hikari.guilds.GuildExplicitContentFilterLevel, hikari.undefined.UndefinedType] = UNDEFINED,
afk_channel: Union[hikari.channels.GuildVoiceChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
afk_timeout: Union[int, float, datetime.timedelta, hikari.undefined.UndefinedType] = UNDEFINED,
icon: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
owner: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
splash: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
banner: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
system_channel: Union[hikari.channels.GuildTextChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
rules_channel: Union[hikari.channels.GuildTextChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
public_updates_channel: Union[hikari.channels.GuildTextChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
preferred_locale: Union[str, hikari.locales.Locale, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.RESTGuild:
View Source
async def edit_guild( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, verification_level: undefined.UndefinedOr[guilds.GuildVerificationLevel] = undefined.UNDEFINED, default_message_notifications: undefined.UndefinedOr[ guilds.GuildMessageNotificationsLevel ] = undefined.UNDEFINED, explicit_content_filter_level: undefined.UndefinedOr[ guilds.GuildExplicitContentFilterLevel ] = undefined.UNDEFINED, afk_channel: undefined.UndefinedOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, afk_timeout: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, splash: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, banner: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, system_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, rules_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, public_updates_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildTextChannel] ] = undefined.UNDEFINED, preferred_locale: undefined.UndefinedOr[typing.Union[str, locales.Locale]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.RESTGuild: route = routes.PATCH_GUILD.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("verification_level", verification_level) body.put("default_message_notifications", default_message_notifications) body.put("explicit_content_filter", explicit_content_filter_level) body.put("afk_timeout", afk_timeout, conversion=time.timespan_to_int) body.put("preferred_locale", preferred_locale, conversion=str) body.put_snowflake("afk_channel_id", afk_channel) body.put_snowflake("owner_id", owner) body.put_snowflake("system_channel_id", system_channel) body.put_snowflake("rules_channel_id", rules_channel) body.put_snowflake("public_updates_channel_id", public_updates_channel) tasks: typing.List[asyncio.Task[str]] = [] if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("icon", future.result())) tasks.append(task) if splash is None: body.put("splash", None) elif splash is not undefined.UNDEFINED: splash_resource = files.ensure_resource(splash) async with splash_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("splash", future.result())) tasks.append(task) if banner is None: body.put("banner", None) elif banner is not undefined.UNDEFINED: banner_resource = files.ensure_resource(banner) async with banner_resource.stream(executor=self._executor) as stream: task = asyncio.create_task(stream.data_uri()) task.add_done_callback(lambda future: body.put("banner", future.result())) tasks.append(task) await asyncio.gather(*tasks) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response)
Edit a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit. This may be the object or the ID of an existing guild.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): If provided, the new name for the guild.
- verification_level (hikari.undefined.UndefinedOr[hikari.guilds.GuildVerificationLevel]): If provided, the new verification level.
- default_message_notifications (hikari.undefined.UndefinedOr[hikari.guilds.GuildMessageNotificationsLevel]): If provided, the new default message notifications level.
- explicit_content_filter_level (hikari.undefined.UndefinedOr[hikari.guilds.GuildExplicitContentFilterLevel]): If provided, the new explicit content filter level.
- afk_channel (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]): If provided, the new afk channel. Requires
afk_timeout
to be set to work. - afk_timeout (hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]): If provided, the new afk timeout.
- icon (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the new guild icon. Must be a 1024x1024 image or can be an animated gif when the guild has the
ANIMATED_ICON
feature. owner (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]]]): If provided, the new guild owner.
Warning: You need to be the owner of the server to use this.
- splash (hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]): If provided, the new guild splash. Must be a 16:9 image and the guild must have the
INVITE_SPLASH
feature. - banner (hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]): If provided, the new guild banner. Must be a 16:9 image and the guild must have the
BANNER
feature. - system_channel (hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]): If provided, the new system channel.
- rules_channel (hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]): If provided, the new rules channel.
- public_updates_channel (hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]): If provided, the new public updates channel.
- preferred_locale (hikari.undefined.UndefinedNoneOr[str]): If provided, the new preferred locale.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.RESTGuild: The edited guild.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value. Or you are missing the
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission or if you tried to pass ownership without being the server owner. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
token: str,
content: Union[Any, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
*,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
replace_attachments: bool = False,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.messages.Message:
View Source
async def edit_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str, content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_INTERACTION_RESPONSE.compile(webhook=application, token=token) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Edit the initial response to a command interaction.
Notes
Mentioning everyone, roles, or users in message edits currently will not send a push notification showing a new mention to people on Discord. It will still highlight in their chat as if they were mentioned, however.
Also important to note that if you specify a text content
, mentions_everyone
, mentions_reply
, user_mentions
, and role_mentions
will default to False
as the message will be re-parsed for mentions. This will also occur if only one of the four are specified
This is a limitation of Discord's design. If in doubt, specify all four of them each time.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to edit a command response for.
- token (str): The interaction's token.
Other Parameters
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message content to update with. If
hikari.undefined.UNDEFINED
, then the content will not be changed. IfNone
, then the content will be removed.Any other value will be cast to a
str
before sending.If this is a
hikari.embeds.Embed
and neither theembed
orembeds
kwargs are provided or if this is ahikari.files.Resourceish
and neither theattachment
orattachments
kwargs are provided, the values will be overwritten. This allows for simpler syntax when sending an embed or an attachment alone.- attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the attachment to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachment, if present, is not changed. If this isNone
, then the attachment is removed, if present. Otherwise, the new attachment that was provided will be attached. - attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]]): If provided, the attachments to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachments, if present, are not changed. If this isNone
, then the attachments is removed, if present. Otherwise, the new attachments that were provided will be attached. - component (hikari.undefined.UndefinedNoneOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to set for this message. This component will replace any previously set components and passing
None
will remove all components. - components (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing
None
or an empty sequence will remove all components. - embed (hikari.undefined.UndefinedNoneOr[hikari.embeds.Embed]): If provided, the embed to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embed that was provided will be used as the replacement. - embeds (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the embeds to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embeds that were provided will be used as the replacement. replace_attachments (bool): Whether to replace the attachments with the provided ones. Defaults to
False
.Note this will also overwrite the embed attachments.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, whether the message should parse @everyone/@here mentions.
- user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, and
True
, all user mentions will be detected. If provided, andFalse
, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.users.PartialUser
derivatives to enforce mentioning specific users. - role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, and
True
, all role mentions will be detected. If provided, andFalse
, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.guilds.PartialRole
derivatives to enforce mentioning specific roles.
Returns
- hikari.messages.Message: The edited message.
Raises
- ValueError: If both
attachment
andattachments
,component
andcomponents
orembed
andembeds
are specified. - TypeError: If
attachments
,components
orembeds
is passed but is not a sequence. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the interaction or the message are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
nickname: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
nick: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
mute: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
deaf: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
voice_channel: Union[hikari.channels.GuildVoiceChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
communication_disabled_until: Union[datetime.datetime, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.Member:
View Source
async def edit_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, voice_channel: undefined.UndefinedNoneOr[ snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel] ] = undefined.UNDEFINED, communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: if nick is not undefined.UNDEFINED: deprecation.warn_deprecated("nick", "Use 'nickname' argument instead") nickname = nick route = routes.PATCH_GUILD_MEMBER.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) body.put("mute", mute) body.put("deaf", deaf) body.put_snowflake_array("roles", roles) if voice_channel is None: body.put("channel_id", None) else: body.put_snowflake("channel_id", voice_channel) if isinstance(communication_disabled_until, datetime.datetime): body.put("communication_disabled_until", communication_disabled_until.isoformat()) else: body.put("communication_disabled_until", communication_disabled_until) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild))
Edit a guild member.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to edit. This may be the object or the ID of an existing user.
Other Parameters
nickname (hikari.undefined.UndefinedNoneOr[str]): If provided, the new nick for the member. If
None
, will remove the members nick.Requires the
MANAGE_NICKNAMES
permission.- nick (hikari.undefined.UndefinedOr[str]): Deprecated alias for
nickname
. roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]): If provided, the new roles for the member.
Requires the
MANAGE_ROLES
permission.mute (hikari.undefined.UndefinedOr[bool]): If provided, the new server mute state for the member.
Requires the
MUTE_MEMBERS
permission.deaf (hikari.undefined.UndefinedOr[bool]): If provided, the new server deaf state for the member.
Requires the
DEAFEN_MEMBERS
permission.voice_channel (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]]): If provided,
None
or the object or the ID of an existing voice channel to move the member to. IfNone
, will disconnect the member from voice.Requires the
MOVE_MEMBERS
permission and theCONNECT
permission in the original voice channel and the target voice channel.Note: If the member is not in a voice channel, this will take no effect.
communication_disabled_until (hikari.undefined.UndefinedNoneOr[datetime.datetime]): If provided, the datetime when the timeout (disable communication) of the member expires, up to 28 days in the future, or
None
to remove the timeout from the member.Requires the
MODERATE_MEMBERS
permission.- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.Member: Object of the member that was updated.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing a permission to do an action.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or the user are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
content: Union[Any, hikari.undefined.UndefinedType] = UNDEFINED,
*,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
replace_attachments: bool = False,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
mentions_reply: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
flags: Union[hikari.undefined.UndefinedType, int, hikari.messages.MessageFlag] = UNDEFINED
) -> hikari.messages.Message:
View Source
async def edit_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_reply: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: route = routes.PATCH_CHANNEL_MESSAGE.compile(channel=channel, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, flags=flags, mentions_everyone=mentions_everyone, mentions_reply=mentions_reply, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder) else: response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Edit an existing message in a given channel.
Warning: If the message was not sent by your user, the only parameter you may provide to this call is the flags
parameter. Anything else will result in a hikari.errors.ForbiddenError
being raised.
Notes
Mentioning everyone, roles, or users in message edits currently will not send a push notification showing a new mention to people on Discord. It will still highlight in their chat as if they were mentioned, however.
Also important to note that if you specify a text content
, mentions_everyone
, mentions_reply
, user_mentions
, and role_mentions
will default to False
as the message will be re-parsed for mentions. This will also occur if only one of the four are specified
This is a limitation of Discord's design. If in doubt, specify all four of them each time.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to create the message in. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to edit. This may be the object or the ID of an existing message.
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message content to update with. If
hikari.undefined.UNDEFINED
, then the content will not be changed. IfNone
, then the content will be removed.Any other value will be cast to a
str
before sending.If this is a
hikari.embeds.Embed
and neither theembed
orembeds
kwargs are provided or if this is ahikari.files.Resourceish
and neither theattachment
orattachments
kwargs are provided, the values will be overwritten. This allows for simpler syntax when sending an embed or an attachment alone.
Other Parameters
- attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the attachment to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachment, if present, is not changed. If this isNone
, then the attachment is removed, if present. Otherwise, the new attachment that was provided will be attached. - attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]]): If provided, the attachments to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachments, if present, are not changed. If this isNone
, then the attachments is removed, if present. Otherwise, the new attachments that were provided will be attached. - component (hikari.undefined.UndefinedNoneOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to set for this message. This component will replace any previously set components and passing
None
will remove all components. - components (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing
None
or an empty sequence will remove all components. - embed (hikari.undefined.UndefinedNoneOr[hikari.embeds.Embed]): If provided, the embed to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embed that was provided will be used as the replacement. - embeds (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the embeds to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embeds that were provided will be used as the replacement. replace_attachments (bool): Whether to replace the attachments with the provided ones. Defaults to
False
.Note this will also overwrite the embed attachments.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, sanitation for
@everyone
mentions. Ifhikari.undefined.UNDEFINED
, then the previous setting is not changed. IfTrue
, then@everyone
/@here
mentions in the message content will show up as mentioning everyone that can view the chat. mentions_reply (hikari.undefined.UndefinedOr[bool]): If provided, whether to mention the author of the message that is being replied to.
This will not do anything if
message
is not a reply message.user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, sanitation for user mentions. If
hikari.undefined.UNDEFINED
, then the previous setting is not changed. IfTrue
, all valid user mentions will behave as mentions. IfFalse
, all valid user mentions will not behave as mentions.You may alternatively pass a collection of
hikari.snowflakes.Snowflake
user IDs, orhikari.users.PartialUser
-derived objects.role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, sanitation for role mentions. If
hikari.undefined.UNDEFINED
, then the previous setting is not changed. IfTrue
, all valid role mentions will behave as mentions. IfFalse
, all valid role mentions will not behave as mentions.You may alternatively pass a collection of
hikari.snowflakes.Snowflake
role IDs, orhikari.guilds.PartialRole
-derived objects.flags (hikari.undefined.UndefinedOr[hikari.messages.MessageFlag]): If provided, optional flags to set on the message. If
hikari.undefined.UNDEFINED
, then nothing is changed.Note that some flags may not be able to be set. Currently the only flags that can be set are
NONE
andSUPPRESS_EMBEDS
. If you haveMANAGE_MESSAGES
permissions, you can use this call to suppress embeds on another user's message.
Returns
- hikari.messages.Message: The edited message.
Raises
- ValueError: If both
attachment
andattachments
,component
andcomponents
orembed
andembeds
are specified. - TypeError: If
attachments
,components
orembeds
is passed but is not a sequence. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; invalid image URLs in embeds.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
SEND_MESSAGES
in the channel; if you try to change the contents of another user's message; or if you try to edit the flags on another user's message without theMANAGE_MESSAGES
permission. - hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
nickname: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.Member:
View Source
async def edit_my_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Member: route = routes.PATCH_MY_GUILD_MEMBER.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("nick", nickname) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild))
Edit the current user's member in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the member in. This may be the object or the ID of an existing guild.
Other Parameters
nickname (hikari.undefined.UndefinedNoneOr[str]): If provided, the new nickname for the member. If
None
, will remove the members nickname.Requires the
CHANGE_NICKNAME
permission. If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.Member: Object of the member that was updated.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing a permission to do an action.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.Guild, hikari.snowflakes.Snowflake, int],
nick: Optional[str],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
@deprecation.deprecated("2.0.0.dev104", "2.0.0.dev110", "Use `edit_my_member`'s `nick` argument instead.") async def edit_my_nick( self, guild: snowflakes.SnowflakeishOr[guilds.Guild], nick: typing.Optional[str], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: await self.edit_my_member(guild, nickname=nick, reason=reason)
Edit the associated token's member nick.
Deprecated since version 2.0.0.dev104: Will be removed in 2.0.0.dev110. Use edit_my_member
's nick
argument instead.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit. This may be the object or the ID of an existing guild.
- nick (typing.Optional[str]): The new nick. If
None
, will remove the nick.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing the
CHANGE_NICKNAME
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
*,
username: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
avatar: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED
) -> hikari.users.OwnUser:
View Source
async def edit_my_user( self, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, ) -> users.OwnUser: route = routes.PATCH_MY_USER.compile() body = data_binding.JSONObjectBuilder() body.put("username", username) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response)
Edit the token's associated user.
Other Parameters
- username (undefined.UndefinedOr[str]): If provided, the new username.
- avatar (undefined.UndefinedNoneOr[hikari.files.Resourceish]): If provided, the new avatar. If
None
, the avatar will be removed.
Returns
- hikari.users.OwnUser: The edited token's associated user.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
Discord also returns this on a rate limit: https://github.com/discord/discord-api-docs/issues/1462
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.GuildStageChannel, hikari.snowflakes.Snowflake, int],
*,
suppress: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
request_to_speak: Union[hikari.undefined.UndefinedType, bool, datetime.datetime] = UNDEFINED
) -> None:
View Source
async def edit_my_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, request_to_speak: typing.Union[undefined.UndefinedType, bool, datetime.datetime] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_MY_GUILD_VOICE_STATE.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) if isinstance(request_to_speak, datetime.datetime): body.put("request_to_speak_timestamp", request_to_speak.isoformat()) elif request_to_speak is True: body.put("request_to_speak_timestamp", time.utc_datetime().isoformat()) elif request_to_speak is False: body.put("request_to_speak_timestamp", None) await self._request(route, json=body)
Edit the current user's voice state in a stage channel.
Note: The current user has to have already joined the target stage channel before any calls can be made to this endpoint.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or Id of the guild to edit a voice state in.
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildStageChannel]): Object or Id of the channel to edit a voice state in.
Other Parameters
- suppress (hikari.undefined.UndefinedOr[bool]): If specified, whether the user should be allowed to become a speaker in the target stage channel with
builtin.True
suppressing them from becoming one. request_to_speak (typing.Union[hikari.undefined.UndefinedType, bool, datetime.datetime]): Whether to request to speak. This may be one of the following:
True
to indicate that the bot wants to speak.False
to remove any previously set request to speak.datetime.datetime
to specify when they want their request to speak timestamp to be set to. If a datetime from the past is passed then Discord will use the current time instead.
Raises
- hikari.errors.BadRequestError: If you try to target a non-staging channel.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MUTE_MEMBERS
permission in the channel. - hikari.errors.NotFoundError: If the channel, message or voice state is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int],
target: Union[hikari.snowflakes.Snowflake, int, hikari.users.PartialUser, hikari.guilds.PartialRole, hikari.channels.PermissionOverwrite],
*,
target_type: Union[hikari.channels.PermissionOverwriteType, int, hikari.undefined.UndefinedType] = UNDEFINED,
allow: Union[hikari.permissions.Permissions, hikari.undefined.UndefinedType] = UNDEFINED,
deny: Union[hikari.permissions.Permissions, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def edit_permission_overwrites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], target: typing.Union[ snowflakes.Snowflakeish, users.PartialUser, guilds.PartialRole, channels_.PermissionOverwrite ], *, target_type: undefined.UndefinedOr[typing.Union[channels_.PermissionOverwriteType, int]] = undefined.UNDEFINED, allow: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, deny: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: if target_type is undefined.UNDEFINED: if isinstance(target, users.PartialUser): target_type = channels_.PermissionOverwriteType.MEMBER elif isinstance(target, guilds.Role): target_type = channels_.PermissionOverwriteType.ROLE elif isinstance(target, channels_.PermissionOverwrite): target_type = target.type else: raise TypeError( "Cannot determine the type of the target to update. Try specifying 'target_type' manually." ) target = target.id if isinstance(target, channels_.PermissionOverwrite) else target route = routes.PUT_CHANNEL_PERMISSIONS.compile(channel=channel, overwrite=target) body = data_binding.JSONObjectBuilder() body.put("type", target_type) body.put("allow", allow) body.put("deny", deny) await self._request(route, json=body, reason=reason)
Edit permissions for a specific entity in the given guild channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The channel to edit a permission overwrite in. This may be the object, or the ID of an existing channel.
- target (typing.Union[hikari.users.PartialUser, hikari.guilds.PartialRole, hikari.channels.PermissionOverwrite, hikari.snowflakes.Snowflakeish]): The channel overwrite to edit. This may be the object or the ID of an existing overwrite.
Other Parameters
- target_type (hikari.undefined.UndefinedOr[typing.Union[hikari.channels.PermissionOverwriteType, int]]): If provided, the type of the target to update. If unset, will attempt to get the type from
target
. - allow (hikari.undefined.UndefinedOr[hikari.permissions.Permissions]): If provided, the new vale of all allowed permissions.
- deny (hikari.undefined.UndefinedOr[hikari.permissions.Permissions]): If provided, the new vale of all disallowed permissions.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- TypeError: If
target_type
is unset and we were unable to determine the type fromtarget
. - hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_PERMISSIONS
permission in the channel. - hikari.errors.NotFoundError: If the channel is not found or the target is not found if it is a role.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
role: Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
permissions: Union[hikari.permissions.Permissions, hikari.undefined.UndefinedType] = UNDEFINED,
color: Union[hikari.colors.Color, SupportsInt, Tuple[SupportsInt, SupportsInt, SupportsInt], Tuple[SupportsFloat, SupportsFloat, SupportsFloat], Sequence[SupportsInt], Sequence[SupportsFloat], str, hikari.undefined.UndefinedType] = UNDEFINED,
colour: Union[hikari.colors.Color, SupportsInt, Tuple[SupportsInt, SupportsInt, SupportsInt], Tuple[SupportsFloat, SupportsFloat, SupportsFloat], Sequence[SupportsInt], Sequence[SupportsFloat], str, hikari.undefined.UndefinedType] = UNDEFINED,
hoist: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
icon: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
unicode_emoji: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
mentionable: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.Role:
View Source
async def edit_role( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, permissions: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED, color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED, hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED, icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, unicode_emoji: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.Role: if not undefined.any_undefined(color, colour): raise TypeError("Can not specify 'color' and 'colour' together.") if not undefined.any_undefined(icon, unicode_emoji): raise TypeError("Can not specify 'icon' and 'unicode_emoji' together.") route = routes.PATCH_GUILD_ROLE.compile(guild=guild, role=role) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("permissions", permissions) body.put("color", color, conversion=colors.Color.of) body.put("color", colour, conversion=colors.Color.of) body.put("hoist", hoist) body.put("unicode_emoji", unicode_emoji) body.put("mentionable", mentionable) if icon is None: body.put("icon", None) elif icon is not undefined.UNDEFINED: icon_resource = files.ensure_resource(icon) async with icon_resource.stream(executor=self._executor) as stream: body.put("icon", await stream.data_uri()) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_role(response, guild_id=snowflakes.Snowflake(guild))
Edit a role.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the role in. This may be the object or the ID of an existing guild.
- role (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]): The role to edit. This may be the object or the ID of an existing role.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): If provided, the new name for the role.
- permissions (hikari.undefined.UndefinedOr[hikari.permissions.Permissions]): If provided, the new permissions for the role.
- color (hikari.undefined.UndefinedOr[hikari.colors.Colorish]): If provided, the new color for the role.
- colour (hikari.undefined.UndefinedOr[hikari.colors.Colorish]): An alias for
color
. - hoist (hikari.undefined.UndefinedOr[bool]): If provided, whether to hoist the role.
- icon (hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]): If provided, the new role icon. Must be a 64x64 image under 256kb.
- unicode_emoji (hikari.undefined.UndefinedNoneOr[str]): If provided, the new unicode emoji to set as the role icon.
- mentionable (hikari.undefined.UndefinedOr[bool]): If provided, whether to make the role mentionable.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.Role: The edited role.
Raises
- TypeError: If both
color
andcolour
are specified or if bothicon
andunicode_emoji
are specified. - hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or role are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
event: Union[hikari.scheduled_events.ScheduledEvent, hikari.snowflakes.Snowflake, int],
/,
*,
channel: Union[hikari.channels.PartialChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
description: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
entity_type: Union[int, hikari.scheduled_events.ScheduledEventType, hikari.undefined.UndefinedType] = UNDEFINED,
image: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
location: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
privacy_level: Union[int, hikari.scheduled_events.EventPrivacyLevel, hikari.undefined.UndefinedType] = UNDEFINED,
start_time: Union[datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
end_time: Union[datetime.datetime, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
status: Union[int, hikari.scheduled_events.ScheduledEventStatus, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.scheduled_events.ScheduledEvent:
View Source
async def edit_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.PartialChannel]] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, entity_type: undefined.UndefinedOr[ typing.Union[int, scheduled_events.ScheduledEventType] ] = undefined.UNDEFINED, image: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, location: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, privacy_level: undefined.UndefinedOr[ typing.Union[int, scheduled_events.EventPrivacyLevel] ] = undefined.UNDEFINED, start_time: undefined.UndefinedOr[datetime.datetime] = undefined.UNDEFINED, end_time: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, status: undefined.UndefinedOr[typing.Union[int, scheduled_events.ScheduledEventStatus]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> scheduled_events.ScheduledEvent: route = routes.PATCH_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) if entity_type is not undefined.UNDEFINED: entity_type = scheduled_events.ScheduledEventType(entity_type) # Yes this does have to be explicitly set to None when changing to EXTERNAL if entity_type is scheduled_events.ScheduledEventType.EXTERNAL and channel is undefined.UNDEFINED: channel = None response = await self._create_or_edit_scheduled_stage( route, entity_type, name, channel=channel, start_time=start_time, description=description, end_time=end_time, image=image, location=location, privacy_level=privacy_level, status=status, reason=reason, ) return self._entity_factory.deserialize_scheduled_event(response)
Edit a scheduled event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the event in.
- event (hikari.snowflakes.SnowflakeishOr[hikari.scheduled_events.ScheduledEvent]): The scheduled event to edit.
Other Parameters
- channel (hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]]): The channel a
VOICE
orSTAGE
event should be associated with. - description (hikari.undefined.UndefinedNoneOr[str]): The event's description.
- entity_type (hikari.undefined.UndefinedOr[hikari.scheduled_events.ScheduledEventType]): The type of entity the event should target.
- image (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): The event's display image.
location (hikari.undefined.UndefinedOr[str]): The location of an
EXTERNAL
event.Must be passed when changing an event to
EXTERNAL
.- name (hikari.undefined.UndefinedOr[str]): The event's name.
privacy_level (hikari.undefined.UndefinedOr[hikari.scheduled_events.EventPrivacyLevel]): The event's privacy level.
This effects who can view and subscribe to the event.
- start_time (hikari.undefined.UndefinedOr[datetime.datetime]): When the event should be scheduled to start.
end_time (hikari.undefined.UndefinedNoneOr[datetime.datetime]): When the event should be scheduled to end.
This can only be set to
None
forSTAGE
andVOICE
events. Must be provided when changing an event toEXTERNAL
.status (hikari.undefined.UndefinedOr[hikari.scheduled_events.ScheduledEventStatus]): The event's new status.
SCHEDULED
events can be set toACTIVE
andCANCELED
.ACTIVE
events can only be set toCOMPLETED
.- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.scheduled_events.ScheduledEvent: The edited scheduled event.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing permissions to edit the scheduled event.
For VOICE
and STAGE_INSTANCE
events, you need the following permissions in the event's associated channel: MANAGE_EVENTS
, VIEW_CHANNEL
and CONNECT
.
For EXTERNAL
events you just need the MANAGE_EVENTS
permission.
- hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
sticker: Union[hikari.stickers.PartialSticker, hikari.snowflakes.Snowflake, int],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
description: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
tag: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.stickers.GuildSticker:
View Source
async def edit_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedOr[str] = undefined.UNDEFINED, tag: undefined.UndefinedOr[str] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> stickers.GuildSticker: route = routes.PATCH_GUILD_STICKER.compile(guild=guild, sticker=sticker) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("tags", tag) body.put("description", description) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response)
Edit a sticker in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the sticker on. This can be a guild object or the ID of an existing guild.
- sticker (hikari.snowflakes.SnowflakeishOr[hikari.stickers.PartialSticker]): The sticker to edit. This can be a sticker object or the ID of an existing sticker.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): If provided, the new name for the sticker.
- description (hikari.undefined.UndefinedOr[str]): If provided, the new description for the sticker.
- tag (hikari.undefined.UndefinedOr[str]): If provided, the new sticker tag.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.stickers.GuildSticker: The edited sticker.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing
MANAGE_EMOJIS_AND_STICKERS
in the server. - hikari.errors.NotFoundError: If the guild or the sticker are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
template: Union[str, hikari.templates.Template],
*,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
description: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED
) -> hikari.templates.Template:
View Source
async def edit_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[str, templates.Template], *, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PATCH_GUILD_TEMPLATE.compile(guild=guild, template=template) body = data_binding.JSONObjectBuilder() body.put("name", name) body.put("description", description) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response)
Modify a guild template.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit a template in.
- template (typing.Union[str, hikari.templates.Template]): Object or string code of the template to modify.
Other Parameters
- name (hikari.undefined.UndefinedOr[str]): The name to set for this template.
- description (hikari.undefined.UndefinedNoneOr[str]): The description to set for the template.
Returns
- hikari.templates.Template: The object of the edited template.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found or you are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.GuildStageChannel, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
suppress: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def edit_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: snowflakes.SnowflakeishOr[channels_.GuildStageChannel], user: snowflakes.SnowflakeishOr[users.PartialUser], *, suppress: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: route = routes.PATCH_GUILD_VOICE_STATE.compile(guild=guild, user=user) body = data_binding.JSONObjectBuilder() body.put_snowflake("channel_id", channel) body.put("suppress", suppress) await self._request(route, json=body)
Edit an existing voice state in a stage channel.
Note: The target user must already be present in the stage channel before any calls are made to this endpoint.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or Id of the guild to edit a voice state in.
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildStageChannel]): Object or Id of the channel to edit a voice state in.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): Object or Id of the user to to edit the voice state of.
Other Parameters
- suppress (hikari.undefined.UndefinedOr[bool]): If defined, whether the user should be allowed to become a speaker in the target stage channel.
Raises
- hikari.errors.BadRequestError: If you try to target a non-staging channel.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MUTE_MEMBERS
permission in the channel. - hikari.errors.NotFoundError: If the channel, message or voice state is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.PartialWebhook, hikari.snowflakes.Snowflake, int],
*,
token: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
name: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
avatar: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
channel: Union[hikari.channels.GuildTextChannel, hikari.channels.GuildNewsChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.webhooks.PartialWebhook:
View Source
async def edit_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, name: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED, channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.WebhookChannelT]] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.PATCH_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.PATCH_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True body = data_binding.JSONObjectBuilder() body.put("name", name) body.put_snowflake("channel", channel) if avatar is None: body.put("avatar", None) elif avatar is not undefined.UNDEFINED: avatar_resource = files.ensure_resource(avatar) async with avatar_resource.stream(executor=self._executor) as stream: body.put("avatar", await stream.data_uri()) response = await self._request(route, json=body, reason=reason, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response)
Edit a webhook.
Parameters
- webhook (hikari.snowflakes.SnowflakeishOr[hikari.webhooks.PartialWebhook]): The webhook to edit. This may be the object or the ID of an existing webhook.
Other Parameters
- token (hikari.undefined.UndefinedOr[str]): If provided, the webhook token that will be used to edit the webhook instead of the token the client was initialized with.
- name (hikari.undefined.UndefinedOr[str]): If provided, the new webhook name.
- avatar (hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]): If provided, the new webhook avatar. If
None
, will remove the webhook avatar. - channel (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.WebhookChannelT]]): If provided, the text channel to move the webhook to.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.webhooks.PartialWebhook: The edited webhook.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission when not using a token. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.ExecutableWebhook, hikari.snowflakes.Snowflake, int],
token: str,
message: Union[hikari.messages.Message, hikari.snowflakes.Snowflake, int],
content: Union[Any, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
*,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
replace_attachments: bool = False,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.messages.Message:
View Source
async def edit_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.Message], content: undefined.UndefinedNoneOr[typing.Any] = undefined.UNDEFINED, *, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedNoneOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedNoneOr[ typing.Sequence[special_endpoints.ComponentBuilder] ] = undefined.UNDEFINED, embed: undefined.UndefinedNoneOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, replace_attachments: bool = False, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.PATCH_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, replace_attachments=replace_attachments, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, edit=True, ) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, no_auth=True) else: response = await self._request(route, json=body, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Edit a message sent by a webhook.
Notes
Mentioning everyone, roles, or users in message edits currently will not send a push notification showing a new mention to people on Discord. It will still highlight in their chat as if they were mentioned, however.
Also important to note that if you specify a text content
, mentions_everyone
, mentions_reply
, user_mentions
, and role_mentions
will default to False
as the message will be re-parsed for mentions. This will also occur if only one of the four are specified
This is a limitation of Discord's design. If in doubt, specify all four of them each time.
Parameters
- webhook (typing.Union[hikari.snowflakes.Snowflakeish, hikari.webhooks.ExecutableWebhook]): The webhook to execute. This may be the object or the ID of an existing webhook.
- token (str): The webhook token.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete. This may be the object or the ID of an existing message.
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message content to update with. If
hikari.undefined.UNDEFINED
, then the content will not be changed. IfNone
, then the content will be removed.Any other value will be cast to a
str
before sending.If this is a
hikari.embeds.Embed
and neither theembed
orembeds
kwargs are provided or if this is ahikari.files.Resourceish
and neither theattachment
orattachments
kwargs are provided, the values will be overwritten. This allows for simpler syntax when sending an embed or an attachment alone.
Other Parameters
- attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish]): If provided, the attachment to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachment, if present, is not changed. If this isNone
, then the attachment is removed, if present. Otherwise, the new attachment that was provided will be attached. - attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]]): If provided, the attachments to set on the message. If
hikari.undefined.UNDEFINED
, the previous attachments, if present, are not changed. If this isNone
, then the attachments is removed, if present. Otherwise, the new attachments that were provided will be attached. - component (hikari.undefined.UndefinedNoneOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to set for this message. This component will replace any previously set components and passing
None
will remove all components. - components (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing
None
or an empty sequence will remove all components. - embed (hikari.undefined.UndefinedNoneOr[hikari.embeds.Embed]): If provided, the embed to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embed that was provided will be used as the replacement. - embeds (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the embeds to set on the message. If
hikari.undefined.UNDEFINED
, the previous embed(s) are not changed. If this isNone
then any present embeds are removed. Otherwise, the new embeds that were provided will be used as the replacement. replace_attachments (bool): Whether to replace the attachments with the provided ones. Defaults to
False
.Note this will also overwrite the embed attachments.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, sanitation for
@everyone
mentions. Ifhikari.undefined.UNDEFINED
, then the previous setting is not changed. IfTrue
, then@everyone
/@here
mentions in the message content will show up as mentioning everyone that can view the chat. - user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, and
True
, all user mentions will be detected. If provided, andFalse
, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.users.PartialUser
derivatives to enforce mentioning specific users. - role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, and
True
, all role mentions will be detected. If provided, andFalse
, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.guilds.PartialRole
derivatives to enforce mentioning specific roles.
Returns
- hikari.messages.Message: The edited message.
Raises
- ValueError: If both
attachment
andattachments
,component
andcomponents
orembed
andembeds
are specified. - TypeError: If
attachments
,components
orembeds
is passed but is not a sequence. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook or the message are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
description: Union[str, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
enabled: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
channels: Union[Sequence[hikari.guilds.WelcomeChannel], hikari.undefined.UndefinedType, NoneType] = UNDEFINED
) -> hikari.guilds.WelcomeScreen:
View Source
async def edit_welcome_screen( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, description: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, channels: undefined.UndefinedNoneOr[typing.Sequence[guilds.WelcomeChannel]] = undefined.UNDEFINED, ) -> guilds.WelcomeScreen: route = routes.PATCH_GUILD_WELCOME_SCREEN.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("description", description) body.put("enabled", enabled) if channels is not None: body.put_array("welcome_channels", channels, conversion=self._entity_factory.serialize_welcome_channel) else: body.put("welcome_channels", None) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response)
Edit the welcome screen of a community guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): ID or object of the guild to edit the welcome screen for.
Other Parameters
- description (undefined.UndefinedNoneOr[str]): If provided, the description to set for the guild's welcome screen. This may be
None
to unset the description. - enabled (undefined.UndefinedOr[bool]): If provided, Whether the guild's welcome screen should be enabled.
channels (hikari.undefined.UndefinedNoneOr[typing.Sequence[hikari.guilds.WelcomeChannel]]): If provided, a sequence of up to 5 public channels to set in this guild's welcome screen. This may be passed as
None
to remove all welcome channelsNote: Custom emojis may only be included in a guild's welcome channels if it's boost status is tier 2 or above.
Returns
- hikari.guilds.WelcomeScreen: The edited guild welcome screen.
Raises
- hikari.errors.BadRequestError: If more than 5 welcome channels are provided or if a custom emoji is included on a welcome channel in a guild that doesn't have tier 2 of above boost status or if a private channel is included as a welcome channel.
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission, are not part of the guild or the guild doesn't have access to the community welcome screen feature. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
enabled: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.guilds.GuildWidget:
View Source
async def edit_widget( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildChannel]] = undefined.UNDEFINED, enabled: undefined.UndefinedOr[bool] = undefined.UNDEFINED, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> guilds.GuildWidget: route = routes.PATCH_GUILD_WIDGET.compile(guild=guild) body = data_binding.JSONObjectBuilder() body.put("enabled", enabled) if channel is None: body.put("channel", None) elif channel is not undefined.UNDEFINED: body.put_snowflake("channel", channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response)
Fetch a guilds's widget.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to edit the widget in. This can be the object or the ID of an existing guild.
Other Parameters
- channel (hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]]): If provided, the channel to set the widget to. If
None
, will not set to any. - enabled (hikari.undefined.UndefinedOr[bool]): If provided, whether to enable the widget.
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Returns
- hikari.guilds.GuildWidget: The edited guild widget.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
days: Union[int, hikari.undefined.UndefinedType] = UNDEFINED,
include_roles: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED
) -> int:
View Source
async def estimate_guild_prune_count( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, days: undefined.UndefinedOr[int] = undefined.UNDEFINED, include_roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[guilds.PartialRole]] = undefined.UNDEFINED, ) -> int: route = routes.GET_GUILD_PRUNE.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("days", days) if include_roles is not undefined.UNDEFINED: roles = ",".join(str(int(role)) for role in include_roles) query.put("include_roles", roles) response = await self._request(route, query=query) assert isinstance(response, dict) return int(response["pruned"])
Estimate the guild prune count.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to estimate the guild prune count for. This may be the object or the ID of an existing guild.
Other Parameters
- days (hikari.undefined.UndefinedOr[int]): If provided, number of days to count prune for.
- include_roles (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]]): If provided, the role(s) to include. By default, this endpoint will not count users with roles. Providing roles using this attribute will make members with the specified roles also get included into the count.
Returns
- int: The estimated guild prune count.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
KICK_MEMBERS
permission. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.ExecutableWebhook, hikari.snowflakes.Snowflake, int],
token: str,
content: Union[Any, hikari.undefined.UndefinedType] = UNDEFINED,
*,
username: Union[str, hikari.undefined.UndefinedType] = UNDEFINED,
avatar_url: Union[hikari.undefined.UndefinedType, str, hikari.files.URL] = UNDEFINED,
attachment: Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO, hikari.undefined.UndefinedType] = UNDEFINED,
attachments: Union[Sequence[Union[hikari.files.Resource[Any], os.PathLike[str], str, bytes, bytearray, memoryview, _io.BytesIO, _io.StringIO]], hikari.undefined.UndefinedType] = UNDEFINED,
component: Union[hikari.api.special_endpoints.ComponentBuilder, hikari.undefined.UndefinedType] = UNDEFINED,
components: Union[Sequence[hikari.api.special_endpoints.ComponentBuilder], hikari.undefined.UndefinedType] = UNDEFINED,
embed: Union[hikari.embeds.Embed, hikari.undefined.UndefinedType] = UNDEFINED,
embeds: Union[Sequence[hikari.embeds.Embed], hikari.undefined.UndefinedType] = UNDEFINED,
tts: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
mentions_everyone: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
user_mentions: Union[Sequence[Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
role_mentions: Union[Sequence[Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]], bool, hikari.undefined.UndefinedType] = UNDEFINED,
flags: Union[hikari.undefined.UndefinedType, int, hikari.messages.MessageFlag] = UNDEFINED
) -> hikari.messages.Message:
View Source
async def execute_webhook( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, content: undefined.UndefinedOr[typing.Any] = undefined.UNDEFINED, *, username: undefined.UndefinedOr[str] = undefined.UNDEFINED, avatar_url: typing.Union[undefined.UndefinedType, str, files.URL] = undefined.UNDEFINED, attachment: undefined.UndefinedOr[files.Resourceish] = undefined.UNDEFINED, attachments: undefined.UndefinedOr[typing.Sequence[files.Resourceish]] = undefined.UNDEFINED, component: undefined.UndefinedOr[special_endpoints.ComponentBuilder] = undefined.UNDEFINED, components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED, embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED, embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED, tts: undefined.UndefinedOr[bool] = undefined.UNDEFINED, mentions_everyone: undefined.UndefinedOr[bool] = undefined.UNDEFINED, user_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool] ] = undefined.UNDEFINED, role_mentions: undefined.UndefinedOr[ typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool] ] = undefined.UNDEFINED, flags: typing.Union[undefined.UndefinedType, int, messages_.MessageFlag] = undefined.UNDEFINED, ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.POST_WEBHOOK_WITH_TOKEN.compile(webhook=webhook_id, token=token) query = data_binding.StringMapBuilder() query.put("wait", True) body, form_builder = self._build_message_payload( content=content, attachment=attachment, attachments=attachments, component=component, components=components, embed=embed, embeds=embeds, tts=tts, flags=flags, mentions_everyone=mentions_everyone, user_mentions=user_mentions, role_mentions=role_mentions, ) body.put("username", username) body.put("avatar_url", avatar_url, conversion=str) if form_builder is not None: form_builder.add_field("payload_json", data_binding.dump_json(body), content_type=_APPLICATION_JSON) response = await self._request(route, form_builder=form_builder, query=query, no_auth=True) else: response = await self._request(route, json=body, query=query, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Execute a webhook.
Warning: As of writing, username
and avatar_url
are ignored for interaction webhooks.
Parameters
- webhook (typing.Union[hikari.snowflakes.Snowflakeish, hikari.webhooks.ExecutableWebhook]): The webhook to execute. This may be the object or the ID of an existing webhook.
- token (str): The webhook token.
content (hikari.undefined.UndefinedOr[typing.Any]): If provided, the message contents. If
hikari.undefined.UNDEFINED
, then nothing will be sent in the content. Any other value here will be cast to astr
.If this is a
hikari.embeds.Embed
and noembed
nor noembeds
kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone.Likewise, if this is a
hikari.files.Resource
, then the content is instead treated as an attachment if noattachment
and noattachments
kwargs are provided.
Other Parameters
- username (hikari.undefined.UndefinedOr[str]): If provided, the username to override the webhook's username for this request.
- avatar_url (typing.Union[hikari.undefined.UndefinedType, hikari.files.URL, str]): If provided, the url of an image to override the webhook's avatar with for this request.
attachment (hikari.undefined.UndefinedOr[hikari.files.Resourceish],): If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL.
Attachments can be passed as many different things, to aid in convenience.
- If a
pathlib.PurePath
orstr
to a valid URL, the resource at the given URL will be streamed to Discord when sending the message. Subclasses ofhikari.files.WebResource
such ashikari.files.URL
,hikari.messages.Attachment
,hikari.emojis.Emoji
,EmbedResource
, etc will also be uploaded this way. This will use bit-inception, so only a small percentage of the resource will remain in memory at any one time, thus aiding in scalability. - If a
hikari.files.Bytes
is passed, or astr
that contains a valid data URI is passed, then this is uploaded with a randomized file name if not provided. - If a
hikari.files.File
,pathlib.PurePath
orstr
that is an absolute or relative path to a file on your file system is passed, then this resource is uploaded as an attachment using non-blocking code internally and streamed using bit-inception where possible. This depends on the type ofconcurrent.futures.Executor
that is being used for the application (default is a thread pool which supports this behaviour).
- If a
- attachments (hikari.undefined.UndefinedOr[typing.Sequence[hikari.files.Resourceish]],): If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs.
- component (hikari.undefined.UndefinedOr[hikari.api.special_endpoints.ComponentBuilder]): If provided, builder object of the component to include in this message.
- components (hikari.undefined.UndefinedOr[typing.Sequence[hikari.api.special_endpoints.ComponentBuilder]]): If provided, a sequence of the component builder objects to include in this message.
- embed (hikari.undefined.UndefinedOr[hikari.embeds.Embed]): If provided, the message embed.
- embeds (hikari.undefined.UndefinedOr[typing.Sequence[hikari.embeds.Embed]]): If provided, the message embeds.
- tts (hikari.undefined.UndefinedOr[bool]): If provided, whether the message will be read out by a screen reader using Discord's TTS (text-to-speech) system.
- mentions_everyone (hikari.undefined.UndefinedOr[bool]): If provided, whether the message should parse @everyone/@here mentions.
- user_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.users.PartialUser], bool]]): If provided, and
True
, all user mentions will be detected. If provided, andFalse
, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.users.PartialUser
derivatives to enforce mentioning specific users. - role_mentions (hikari.undefined.UndefinedOr[typing.Union[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole], bool]]): If provided, and
True
, all role mentions will be detected. If provided, andFalse
, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection ofhikari.snowflakes.Snowflake
, orhikari.guilds.PartialRole
derivatives to enforce mentioning specific roles. flags (typing.Union[hikari.undefined.UndefinedType, int, hikari.messages.MessageFlag]): The flags to set for this webhook message.
Warning: As of writing this can only be set for interaction webhooks and the only settable flag is EPHEMERAL; this field is just ignored for non-interaction webhooks.
Returns
- hikari.messages.Message: The created message.
Raises
- ValueError: If more than 100 unique objects/entities are passed for
role_mentions
oruser_mentions
or if bothattachment
andattachments
orembed
andembeds
are specified. - TypeError: If
attachments
, orembeds
is passed but is not a sequence. - hikari.errors.BadRequestError: This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_application(self) -> applications.Application: route = routes.GET_MY_APPLICATION.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_application(response)
Fetch the token's associated application.
Warning: This endpoint can only be used with a Bot token. Using this with a Bearer token will result in a hikari.errors.UnauthorizedError
.
Returns
- hikari.applications.Application: The token's associated application.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
command: Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.commands.PartialCommand:
View Source
async def fetch_application_command( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], command: snowflakes.SnowflakeishOr[commands.PartialCommand], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> commands.PartialCommand: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMAND.compile(application=application, command=command) else: route = routes.GET_APPLICATION_GUILD_COMMAND.compile(application=application, guild=guild, command=command) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_command( response, guild_id=snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None )
Fetch a command set for an application.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to fetch a command for.
- command (hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand]): Object or ID of the command to fetch.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the guild to fetch the command for. If left as
hikari.undefined.UNDEFINED
then this will return a global command, otherwise this will return a command made for the specified guild.
Returns
- hikari.commands.PartialCommand: Object of the fetched command.
Raises
- hikari.errors.ForbiddenError: If you cannot access the target command.
- hikari.errors.NotFoundError: If the command isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
command: Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int]
) -> hikari.commands.GuildCommandPermissions:
View Source
async def fetch_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], ) -> commands.GuildCommandPermissions: route = routes.GET_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response)
Fetch the permissions registered for a specific command in a guild.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to fetch the command permissions for.
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to fetch the command permissions for.
- command (hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand]): Object or ID of the command to fetch the command permissions for.
Returns
- hikari.commands.GuildCommandPermissions: Object of the command permissions set for the specified command.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands or guild.
- hikari.errors.NotFoundError: If the provided application or command isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> Sequence[hikari.commands.PartialCommand]:
View Source
async def fetch_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.GET_APPLICATION_COMMANDS.compile(application=application) else: route = routes.GET_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(command, guild_id=guild_id) for command in response]
Fetch the commands set for an application.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to fetch the commands for.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the guild to fetch the commands for. If left as
hikari.undefined.UNDEFINED
then this will only return the global commands, otherwise this will only return the commands set exclusively for the specific guild.
Returns
- typing.Sequence[hikari.commands.PartialCommand]: A sequence of the commands declared for the provided application. This will exclusively either contain the commands set for a specific guild if
guild
is provided or the global commands if not.
Raises
- hikari.errors.ForbiddenError: If you cannot access the target guild.
- hikari.errors.NotFoundError: If the provided application isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.commands.GuildCommandPermissions]:
View Source
async def fetch_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.GET_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response]
Fetch the command permissions registered in a guild.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to fetch the command permissions for.
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to fetch the command permissions for.
Returns
- typing.Sequence[hikari.commands.GuildCommandPermissions]: Sequence of the guild command permissions set for the specified guild.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands or guild.
- hikari.errors.NotFoundError: If the provided application isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
before: Union[hikari.snowflakes.Unique, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED,
event_type: Union[hikari.audit_logs.AuditLogEventType, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.iterators.LazyIterator[hikari.audit_logs.AuditLog]:
View Source
def fetch_audit_log( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, user: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, event_type: undefined.UndefinedOr[typing.Union[audit_logs.AuditLogEventType, int]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[audit_logs.AuditLog]: timestamp: undefined.UndefinedOr[str] if before is undefined.UNDEFINED: timestamp = undefined.UNDEFINED elif isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) return special_endpoints_impl.AuditLogIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild, before=timestamp, user=user, action_type=event_type, )
Fetch pages of the guild's audit log.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the audit logs from. This can be a guild object or the ID of an existing guild.
Other Parameters
- before (hikari.undefined.UndefinedOr[hikari.snowflakes.SearchableSnowflakeishOr[hikari.snowflakes.Unique]]): If provided, filter to only actions before this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may be any other Discord entity that has an ID. In this case, the date the object was first created will be used.
- user (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]]): If provided, the user to filter for.
- event_type (hikari.undefined.UndefinedOr[typing.Union[hikari.audit_logs.AuditLogEventType, int]]): If provided, the event type to filter for.
Returns
- hikari.iterators.LazyIterator[hikari.audit_logs.AuditLog]: The guild's audit log.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.ForbiddenError: If you are missing the
VIEW_AUDIT_LOG
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_available_sticker_packs(self) -> typing.Sequence[stickers.StickerPack]: route = routes.GET_STICKER_PACKS.compile() response = await self._request(route, no_auth=True) assert isinstance(response, dict) return [ self._entity_factory.deserialize_sticker_pack(sticker_pack_payload) for sticker_pack_payload in response["sticker_packs"] ]
Fetch the available sticker packs.
Returns
- typing.Sequence[hikari.stickers.StickerPack]: The available sticker packs.
Raises
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.GuildBan:
View Source
async def fetch_ban( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.GuildBan: route = routes.GET_GUILD_BAN.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_member_ban(response)
Fetch the guild's ban info for a user.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the ban from. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to fetch the ban of. This may be the object or the ID of an existing user.
Returns
- hikari.guilds.GuildBan: The requested ban info.
Raises
- hikari.errors.ForbiddenError: If you are missing the
BAN_MEMBERS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or user are not found or if the user is not banned.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.guilds.GuildBan]:
View Source
async def fetch_bans( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[guilds.GuildBan]: route = routes.GET_GUILD_BANS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_member_ban(ban_payload) for ban_payload in response]
Fetch the bans of a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the bans from. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.guilds.GuildBan]: The requested bans.
Raises
- hikari.errors.ForbiddenError: If you are missing the
BAN_MEMBERS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.PartialChannel, hikari.snowflakes.Snowflake, int]
) -> hikari.channels.PartialChannel:
View Source
async def fetch_channel( self, channel: snowflakes.SnowflakeishOr[channels_.PartialChannel] ) -> channels_.PartialChannel: route = routes.GET_CHANNEL.compile(channel=channel) response = await self._request(route) assert isinstance(response, dict) result = self._entity_factory.deserialize_channel(response) if self._cache and isinstance(result, channels_.DMChannel): self._cache.set_dm_channel_id(result.recipient.id, result.id) return result
Fetch a channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]): The channel to fetch. This may be the object or the ID of an existing channel.
Returns
- hikari.channels.PartialChannel: The channel. This will be a _derivative_ of
hikari.channels.PartialChannel
, depending on the type of channel you request for.
This means that you may get one of hikari.channels.DMChannel
, hikari.channels.GroupDMChannel
, hikari.channels.GuildTextChannel
, hikari.channels.GuildVoiceChannel
, hikari.channels.GuildStoreChannel
, hikari.channels.GuildNewsChannel
.
Likewise, the hikari.channels.GuildChannel
can be used to determine if a channel is guild-bound, and hikari.channels.TextableChannel
can be used to determine if the channel provides textual functionality to the application.
You can check for these using the isinstance
builtin function.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
READ_MESSAGES
permission in the channel. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.invites.InviteWithMetadata]:
View Source
async def fetch_channel_invites( self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel] ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_CHANNEL_INVITES.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response]
Fetch all invites pointing to the given guild channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The channel to fetch the invites from. This may be a channel object, or the ID of an existing channel.
Returns
- typing.Sequence[hikari.invites.InviteWithMetadata]: The invites pointing to the given guild channel.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission in the channel. - hikari.errors.NotFoundError: If the channel is not found in any guilds you are a member of.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.GuildTextChannel, hikari.channels.GuildNewsChannel, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.webhooks.PartialWebhook]:
View Source
async def fetch_channel_webhooks( self, channel: snowflakes.SnowflakeishOr[channels_.WebhookChannelT], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_CHANNEL_WEBHOOKS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_pl) for webhook_pl in response]
Fetch all channel webhooks.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.WebhookChannelT]): The channel to fetch the webhooks for. This may be an instance of any of the classes which are valid for
hikari.channels.WebhookChannelT
or the ID of an existing channel.
Returns
- typing.Sequence[hikari.webhooks.PartialWebhook]: The fetched webhooks.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
emoji: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int]
) -> hikari.emojis.KnownCustomEmoji:
View Source
async def fetch_emoji( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], emoji: snowflakes.SnowflakeishOr[emojis.CustomEmoji], ) -> emojis.KnownCustomEmoji: route = routes.GET_GUILD_EMOJI.compile(guild=guild, emoji=emoji) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_known_custom_emoji(response, guild_id=snowflakes.Snowflake(guild))
Fetch a guild emoji.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the emoji from. This can be a guild object or the ID of an existing guild.
- emoji (hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]): The emoji to fetch. This can be a
hikari.emojis.CustomEmoji
or the ID of an existing emoji.
Returns
- hikari.emojis.KnownCustomEmoji: The requested emoji.
Raises
- hikari.errors.NotFoundError: If the guild or the emoji are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_gateway_bot_info(self) -> sessions.GatewayBotInfo: route = routes.GET_GATEWAY_BOT.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_gateway_bot_info(response)
Fetch the gateway gateway info for the bot.
Returns
- hikari.sessions.GatewayBotInfo: The gateway bot information.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_gateway_url(self) -> str: route = routes.GET_GATEWAY.compile() # This doesn't need authorization. response = await self._request(route, no_auth=True) assert isinstance(response, dict) url = response["url"] assert isinstance(url, str) return url
Fetch the gateway url.
Note: This endpoint does not require any valid authorization.
Raises
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.RESTGuild:
View Source
async def fetch_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.RESTGuild: route = routes.GET_GUILD.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_counts", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_rest_guild(response)
Fetch a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch. This can be the object or the ID of an existing guild.
Returns
- hikari.guilds.RESTGuild: The requested guild.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.channels.GuildChannel]:
View Source
async def fetch_guild_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[channels_.GuildChannel]: route = routes.GET_GUILD_CHANNELS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) channel_sequence = [self._entity_factory.deserialize_channel(channel_payload) for channel_payload in response] # Will always be guild channels unless Discord messes up severely on something! return typing.cast("typing.Sequence[channels_.GuildChannel]", channel_sequence)
Fetch the channels in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the channels from. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.channels.GuildChannel]: The requested channels.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.emojis.KnownCustomEmoji]:
View Source
async def fetch_guild_emojis( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[emojis.KnownCustomEmoji]: route = routes.GET_GUILD_EMOJIS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_known_custom_emoji(emoji_payload, guild_id=guild_id) for emoji_payload in response ]
Fetch the emojis of a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the emojis from. This can be a guild object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.emojis.KnownCustomEmoji]: The requested emojis.
Raises
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.invites.InviteWithMetadata]:
View Source
async def fetch_guild_invites( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[invites.InviteWithMetadata]: route = routes.GET_GUILD_INVITES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_invite_with_metadata(invite_payload) for invite_payload in response]
Fetch the guild's invites.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the invites for. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.invites.InviteWithMetadata]: The invites for the guild.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.GuildPreview:
View Source
async def fetch_guild_preview(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildPreview: route = routes.GET_GUILD_PREVIEW.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_preview(response)
Fetch a guild preview.
Note: This will only work for guilds you are a part of or are public.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the preview of. This can be a guild object or the ID of an existing guild.
Returns
- hikari.guilds.GuildPreview: The requested guild preview.
Raises
- hikari.errors.NotFoundError: If the guild is not found or you are not part of the guild.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
sticker: Union[hikari.stickers.PartialSticker, hikari.snowflakes.Snowflake, int]
) -> hikari.stickers.GuildSticker:
View Source
async def fetch_guild_sticker( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> stickers.GuildSticker: route = routes.GET_GUILD_STICKER.compile(guild=guild, sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_sticker(response)
Fetch a guild sticker.
Parameters
- guild (snowflakes.SnowflakeishOr[stickers.PartialGuild]): The guild the sticker is in. This can be a guild object or the ID of an existing guild.
- sticker (snowflakes.SnowflakeishOr[stickers.PartialSticker]): The sticker to fetch. This can be a sticker object or the ID of an existing sticker.
Returns
- hikari.stickers.GuildSticker: The requested sticker.
Raises
- hikari.errors.ForbiddenError: If you are not part of the server.
- hikari.errors.NotFoundError: If the guild or the sticker are not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.stickers.GuildSticker]:
View Source
async def fetch_guild_stickers( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[stickers.GuildSticker]: route = routes.GET_GUILD_STICKERS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_guild_sticker(guild_sticker_payload) for guild_sticker_payload in response ]
Fetch a standard sticker.
Parameters
- guild (snowflakes.SnowflakeishOr[stickers.PartialGuild]): The guild to request stickers for. This can be a guild object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.stickers.GuildSticker]: The requested stickers.
Raises
- hikari.errors.ForbiddenError: If you are not part of the server.
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.templates.Template]:
View Source
async def fetch_guild_templates( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> typing.Sequence[templates.Template]: route = routes.GET_GUILD_TEMPLATES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_template(template_payload) for template_payload in response]
Fetch the templates for a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The object or ID of the guild to get the templates for.
Returns
- typing.Sequence[hikari.templates.Template]: A sequence of the found template objects.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found or are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.voices.VoiceRegion]:
View Source
async def fetch_guild_voice_regions( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_GUILD_VOICE_REGIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ]
Fetch the available voice regions for a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the voice regions for. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.voices.VoiceRegion]: The available voice regions for the guild.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.webhooks.PartialWebhook]:
View Source
async def fetch_guild_webhooks( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[webhooks.PartialWebhook]: route = routes.GET_GUILD_WEBHOOKS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_webhook(webhook_payload) for webhook_payload in response]
Fetch all guild webhooks.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the webhooks for. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.webhooks.PartialWebhook]: The fetched webhooks.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.guilds.Integration]:
View Source
async def fetch_integrations( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Integration]: route = routes.GET_GUILD_INTEGRATIONS.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_integration(integration_payload, guild_id=guild_id) for integration_payload in response ]
Fetch the guild's integrations.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the integrations for. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.guilds.Integration]: The integrations for the guild.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
token: str
) -> hikari.messages.Message:
View Source
async def fetch_interaction_response( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], token: str ) -> messages_.Message: route = routes.GET_INTERACTION_RESPONSE.compile(webhook=application, token=token) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Fetch the initial response for an interaction.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to fetch a command for.
- token (str): Token of the interaction to get the initial response for.
Returns
- hikari.messages.Message: Message object of the initial response.
Raises
- hikari.errors.ForbiddenError: If you cannot access the target interaction.
- hikari.errors.NotFoundError: If the initial response isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
invite: Union[hikari.invites.InviteCode, str]
) -> hikari.invites.Invite:
View Source
async def fetch_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite: route = routes.GET_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code) query = data_binding.StringMapBuilder() query.put("with_counts", True) query.put("with_expiration", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_invite(response)
Fetch an existing invite.
Parameters
- invite (typing.Union[hikari.invites.InviteCode, str]): The invite to fetch. This may be an invite object or the code of an existing invite.
Returns
- hikari.invites.Invite: The requested invite.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the invite is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.Member:
View Source
async def fetch_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], ) -> guilds.Member: route = routes.GET_GUILD_MEMBER.compile(guild=guild, user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild))
Fetch a guild member.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to get the member from. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to get the member for. This may be the object or the ID of an existing user.
Returns
- hikari.guilds.Member: The requested member.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or the user are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.iterators.LazyIterator[hikari.guilds.Member]:
View Source
def fetch_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] ) -> iterators.LazyIterator[guilds.Member]: return special_endpoints_impl.MemberIterator( entity_factory=self._entity_factory, request_call=self._request, guild=guild )
Fetch the members from a guild.
Warning: This endpoint requires the GUILD_MEMBERS
intent to be enabled in the dashboard, not necessarily authenticated with it if using the gateway. If you don't have the intents you can use search_members
which doesn't require any intents.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the members of. This may be the object or the ID of an existing guild.
Returns
- hikari.iterators.LazyIterator[hikari.guilds.Member]: An iterator to fetch the members.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> hikari.messages.Message:
View Source
async def fetch_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: route = routes.GET_CHANNEL_MESSAGE.compile(channel=channel, message=message) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Fetch a specific message in the given text channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to fetch messages in. This may be the object or the ID of an existing message.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to fetch. This may be the object or the ID of an existing channel.
Returns
- hikari.messages.Message: The requested message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
READ_MESSAGE_HISTORY
in the channel. - hikari.errors.NotFoundError: If the channel is not found or the message is not found in the given text channel.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
*,
before: Union[hikari.snowflakes.Unique, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
after: Union[hikari.snowflakes.Unique, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED,
around: Union[hikari.snowflakes.Unique, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.iterators.LazyIterator[hikari.messages.Message]:
View Source
def fetch_messages( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], *, before: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, after: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, around: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[snowflakes.Unique]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[messages_.Message]: if undefined.count(before, after, around) < 2: raise TypeError("Expected no kwargs, or a maximum of one of 'before', 'after', 'around'") timestamp: undefined.UndefinedOr[str] if before is not undefined.UNDEFINED: direction = "before" if isinstance(before, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(before)) else: timestamp = str(int(before)) elif after is not undefined.UNDEFINED: direction = "after" if isinstance(after, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(after)) else: timestamp = str(int(after)) elif around is not undefined.UNDEFINED: direction = "around" if isinstance(around, datetime.datetime): timestamp = str(snowflakes.Snowflake.from_datetime(around)) else: timestamp = str(int(around)) else: direction = "before" timestamp = undefined.UNDEFINED return special_endpoints_impl.MessageIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, direction=direction, first_id=timestamp, )
Browse the message history for a given text channel.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to fetch messages in. This may be the object or the ID of an existing channel.
Other Parameters
- before (hikari.undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[hikari.snowflakes.Unique]]): If provided, fetch messages before this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may be any other Discord entity that has an ID. In this case, the date the object was first created will be used.
- after (hikari.undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[hikari.snowflakes.Unique]]): If provided, fetch messages after this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may be any other Discord entity that has an ID. In this case, the date the object was first created will be used.
- around (hikari.undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[hikari.snowflakes.Unique]]): If provided, fetch messages around this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may be any other Discord entity that has an ID. In this case, the date the object was first created will be used.
Returns
- hikari.iterators.LazyIterator[hikari.messages.Message]: An iterator to fetch the messages.
Raises
- TypeError: If you specify more than one of
before
,after
,about
. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
READ_MESSAGE_HISTORY
in the channel. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_my_connections(self) -> typing.Sequence[applications.OwnConnection]: route = routes.GET_MY_CONNECTIONS.compile() response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_own_connection(connection_payload) for connection_payload in response]
Fetch the token's associated connections.
Returns
- hikari.applications.OwnConnection: The token's associated connections.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
*,
newest_first: bool = False,
start_at: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.iterators.LazyIterator[hikari.applications.OwnGuild]:
View Source
def fetch_my_guilds( self, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[applications.OwnGuild]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.OwnGuildIterator( entity_factory=self._entity_factory, request_call=self._request, newest_first=newest_first, first_id=str(start_at), )
Fetch the token's associated guilds.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Other Parameters
- newest_first (bool): Whether to fetch the newest first or the oldest first. Defaults to
False
. - start_at (hikari.undefined.UndefinedOr[hikari.snowflakes.SearchableSnowflakeishOr[hikari.guilds.PartialGuild]]): If provided, will start at this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may also be a guild object. In this case, the date the object was first created will be used.
Returns
- hikari.iterators.LazyIterator[hikari.applications.OwnGuild]: The token's associated guilds.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.Member:
View Source
async def fetch_my_member(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.Member: route = routes.GET_MY_GUILD_MEMBER.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_member(response, guild_id=snowflakes.Snowflake(guild))
Fetch the Oauth token's associated member in a guild.
Warning: This endpoint can only be used with a Bearer token. Using this with a Bot token will result in a hikari.errors.UnauthorizedError
.
Returns
- hikari.guilds.Member: The associated guild member.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_my_user(self) -> users.OwnUser: route = routes.GET_MY_USER.compile() response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_my_user(response)
Fetch the token's associated user.
Returns
- hikari.users.OwnUser: The token's associated user.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.messages.Message]:
View Source
async def fetch_pins( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> typing.Sequence[messages_.Message]: route = routes.GET_CHANNEL_PINS.compile(channel=channel) response = await self._request(route) assert isinstance(response, list) return [self._entity_factory.deserialize_message(message_pl) for message_pl in response]
Fetch the pinned messages in this text channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to fetch pins from. This may be the object or the ID of an existing channel.
Returns
- typing.Sequence[hikari.messages.Message]: The pinned messages in this text channel.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
READ_MESSAGES
in the channel. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int],
emoji: Union[str, hikari.emojis.Emoji],
emoji_id: Union[hikari.emojis.CustomEmoji, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.iterators.LazyIterator[hikari.users.User]:
View Source
def fetch_reactions_for_emoji( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], emoji: typing.Union[str, emojis.Emoji], emoji_id: undefined.UndefinedOr[snowflakes.SnowflakeishOr[emojis.CustomEmoji]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[users.User]: return special_endpoints_impl.ReactorIterator( entity_factory=self._entity_factory, request_call=self._request, channel=channel, message=message, emoji=self._transform_emoji_to_url_format(emoji, emoji_id), )
Fetch reactions for an emoji from a message.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel where the message to delete all reactions from is. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to delete all reaction from. This may be the object or the ID of an existing message.
- emoji (typing.Union[str, hikari.emojis.Emoji]): Object or name of the emoji to get the reactions for.
Other Parameters
- emoji_id (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]]): ID of the custom emoji to get the reactions for. This should only be provided when a custom emoji's name is passed for
emoji
.
Returns
- hikari.iterators.LazyIterator[hikari.users.User]: An iterator to fetch the users.
Raises
- hikari.errors.BadRequestError: If an invalid unicode emoji is given, or if the given custom emoji does not exist.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the channel or message is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> Sequence[hikari.guilds.Role]:
View Source
async def fetch_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], ) -> typing.Sequence[guilds.Role]: route = routes.GET_GUILD_ROLES.compile(guild=guild) response = await self._request(route) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [self._entity_factory.deserialize_role(role_payload, guild_id=guild_id) for role_payload in response]
Fetch the roles of a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the roles from. This may be the object or the ID of an existing guild.
Returns
- typing.Sequence[hikari.guilds.Role]: The requested roles.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
event: Union[hikari.scheduled_events.ScheduledEvent, hikari.snowflakes.Snowflake, int],
/
) -> hikari.scheduled_events.ScheduledEvent:
View Source
async def fetch_scheduled_event( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, ) -> scheduled_events.ScheduledEvent: route = routes.GET_GUILD_SCHEDULED_EVENT.compile(guild=guild, scheduled_event=event) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, dict) return self._entity_factory.deserialize_scheduled_event(response)
Fetch a scheduled event.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialGuild]): The guild the event bellongs to. This may be the object or the ID of an existing guild.
- event (hikari.snowflakes.SnowflakeishOr[hikari.scheduled_events.ScheduledEvent]): The event to fetch. This may be the object or the ID of an existing event.
Returns
- hikari.scheduled_events.ScheduledEvent: The scheduled event
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the permission needed to view this event.
For VOICE
and STAGE_CHANNEL
events, VIEW_CHANNEL
is required in their associated guild to see the event.
- hikari.errors.NotFoundError: If the guild or event is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
event: Union[hikari.scheduled_events.ScheduledEvent, hikari.snowflakes.Snowflake, int],
/,
*,
newest_first: bool = False,
start_at: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int, datetime.datetime, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.iterators.LazyIterator[hikari.scheduled_events.ScheduledEventUser]:
View Source
def fetch_scheduled_event_users( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], event: snowflakes.SnowflakeishOr[scheduled_events.ScheduledEvent], /, *, newest_first: bool = False, start_at: undefined.UndefinedOr[snowflakes.SearchableSnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED, ) -> iterators.LazyIterator[scheduled_events.ScheduledEventUser]: if start_at is undefined.UNDEFINED: start_at = snowflakes.Snowflake.max() if newest_first else snowflakes.Snowflake.min() elif isinstance(start_at, datetime.datetime): start_at = snowflakes.Snowflake.from_datetime(start_at) else: start_at = int(start_at) return special_endpoints_impl.ScheduledEventUserIterator( self._entity_factory, self._request, newest_first, str(start_at), guild, event )
Asynchronously iterate over the users who're subscribed to a scheduled event.
Notes
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
See hikari.iterators
for the full API for this iterator type.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the scheduled event users from.
- event (hikari.snowflakes.SnowflakeishOr[hikari.scheduled_events.ScheduledEvent]): The scheduled event to fetch the subscribed users for.
Other Parameters
newest_first (bool): Whether to fetch the newest first or the oldest first.
Defaults to
False
.- start_at (hikari.undefined.UndefinedOr[hikari.snowflakes.SearchableSnowflakeishOr[hikari.guilds.PartialGuild]]): If provided, will start at this snowflake. If you provide a datetime object, it will be transformed into a snowflake. This may also be a scheduled event object object. In this case, the date the object was first created will be used.
Returns
- hikari.iterators.LazyIterator[hikari.scheduled_events.ScheduledEventUser]: The token's associated guilds.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or event was not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
/
) -> Sequence[hikari.scheduled_events.ScheduledEvent]:
View Source
async def fetch_scheduled_events( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], / ) -> typing.Sequence[scheduled_events.ScheduledEvent]: route = routes.GET_GUILD_SCHEDULED_EVENTS.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("with_user_count", True) response = await self._request(route, query=query) assert isinstance(response, list) return [self._entity_factory.deserialize_scheduled_event(event) for event in response]
Fetch the scheduled events for a guild.
Note: VOICE
and STAGE_CHANNEL
events are only included if the bot has VOICE
or STAGE_CHANNEL
permissions in the associated channel.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the guild to fetch scheduled events for.
Returns
- typing.Sequence[hikari.scheduled_events.ScheduledEvent]: Sequence of the scheduled events.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
sticker: Union[hikari.stickers.PartialSticker, hikari.snowflakes.Snowflake, int]
) -> Union[hikari.stickers.StandardSticker, hikari.stickers.GuildSticker]:
View Source
async def fetch_sticker( self, sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker], ) -> typing.Union[stickers.StandardSticker, stickers.GuildSticker]: route = routes.GET_STICKER.compile(sticker=sticker) response = await self._request(route) assert isinstance(response, dict) return ( self._entity_factory.deserialize_guild_sticker(response) if "guild_id" in response else self._entity_factory.deserialize_standard_sticker(response) )
Fetch a sticker.
Parameters
- sticker (snowflakes.SnowflakeishOr[stickers.PartialSticker]): The sticker to fetch. This can be a sticker object or the ID of an existing sticker.
Returns
- typing.Union[hikari.stickers.GuildSticker, hikari.stickers.StandardSticker]: The requested sticker.
Raises
- hikari.errors.NotFoundError: If the sticker is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
template: Union[hikari.templates.Template, str]
) -> hikari.templates.Template:
View Source
async def fetch_template(self, template: typing.Union[templates.Template, str]) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.GET_TEMPLATE.compile(template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response)
Fetch a guild template.
Parameters
- template (typing.Union[str, hikari.templates.Template]): The object or string code of the template to fetch.
Returns
- hikari.templates.Template: The object of the found template.
Raises
- hikari.errors.NotFoundError: If the template was not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int]
) -> hikari.users.User:
View Source
async def fetch_user(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> users.User: route = routes.GET_USER.compile(user=user) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_user(response)
Fetch a user.
Parameters
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to fetch. This can be the object or the ID of an existing user.
Returns
- hikari.users.User: The requested user
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the user is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.invites.VanityURL:
View Source
async def fetch_vanity_url(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> invites.VanityURL: route = routes.GET_GUILD_VANITY_URL.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_vanity_url(response)
Fetch a guild's vanity url.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the vanity url from. This can be the object or the ID of an existing guild.
Returns
- hikari.invites.VanityURL: The requested invite.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild.
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
async def fetch_voice_regions(self) -> typing.Sequence[voices.VoiceRegion]: route = routes.GET_VOICE_REGIONS.compile() response = await self._request(route) assert isinstance(response, list) return [ self._entity_factory.deserialize_voice_region(voice_region_payload) for voice_region_payload in response ]
Fetch available voice regions.
Returns
- typing.Sequence[hikari.voices.VoiceRegion]: The available voice regions.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.PartialWebhook, hikari.snowflakes.Snowflake, int],
*,
token: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.webhooks.PartialWebhook:
View Source
async def fetch_webhook( self, webhook: snowflakes.SnowflakeishOr[webhooks.PartialWebhook], *, token: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> webhooks.PartialWebhook: if token is undefined.UNDEFINED: route = routes.GET_WEBHOOK.compile(webhook=webhook) no_auth = False else: route = routes.GET_WEBHOOK_WITH_TOKEN.compile(webhook=webhook, token=token) no_auth = True response = await self._request(route, no_auth=no_auth) assert isinstance(response, dict) return self._entity_factory.deserialize_webhook(response)
Fetch an existing webhook.
Parameters
- webhook (hikari.snowflakes.SnowflakeishOr[hikari.webhooks.PartialWebhook]): The webhook to fetch. This may be the object or the ID of an existing webhook.
Other Parameters
- token (hikari.undefined.UndefinedOr[str]): If provided, the webhook token that will be used to fetch the webhook instead of the token the client was initialized with.
Returns
- hikari.webhooks.PartialWebhook: The requested webhook.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission when not using a token. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
webhook: Union[hikari.webhooks.ExecutableWebhook, hikari.snowflakes.Snowflake, int],
token: str,
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> hikari.messages.Message:
View Source
async def fetch_webhook_message( self, webhook: typing.Union[webhooks.ExecutableWebhook, snowflakes.Snowflakeish], token: str, message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> messages_.Message: # int(ExecutableWebhook) isn't guaranteed to be valid nor the ID used to execute this entity as a webhook. webhook_id = webhook if isinstance(webhook, int) else webhook.webhook_id route = routes.GET_WEBHOOK_MESSAGE.compile(webhook=webhook_id, token=token, message=message) response = await self._request(route, no_auth=True) assert isinstance(response, dict) return self._entity_factory.deserialize_message(response)
Fetch an old message sent by the webhook.
Parameters
- webhook (typing.Union[hikari.snowflakes.Snowflakeish, hikari.webhooks.ExecutableWebhook]): The webhook to execute. This may be the object or the ID of an existing webhook.
- token (str): The webhook token.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to fetch. This may be the object or the ID of an existing channel.
Returns
- hikari.messages.Message: The requested message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the webhook is not found or the webhook's message wasn't found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.WelcomeScreen:
View Source
async def fetch_welcome_screen(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.WelcomeScreen: route = routes.GET_GUILD_WELCOME_SCREEN.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_welcome_screen(response)
Fetch a guild's welcome screen.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the guild to fetch the welcome screen for.
Returns
- hikari.guilds.WelcomeScreen: The requested welcome screen.
Raises
- hikari.errors.NotFoundError: If the guild is not found or the welcome screen has never been set for this guild (if the welcome screen has been set for a guild before and then disabled you should still be able to fetch it).
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int]
) -> hikari.guilds.GuildWidget:
View Source
async def fetch_widget(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> guilds.GuildWidget: route = routes.GET_GUILD_WIDGET.compile(guild=guild) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_widget(response)
Fetch a guilds's widget.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to fetch the widget from. This can be the object or the ID of an existing guild.
Returns
- hikari.guilds.GuildWidget: The requested guild widget.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_GUILD
permission. - hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
news_channel: Union[hikari.channels.GuildNewsChannel, hikari.snowflakes.Snowflake, int],
target_channel: Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.channels.ChannelFollow:
View Source
async def follow_channel( self, news_channel: snowflakes.SnowflakeishOr[channels_.GuildNewsChannel], target_channel: snowflakes.SnowflakeishOr[channels_.GuildChannel], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> channels_.ChannelFollow: route = routes.POST_CHANNEL_FOLLOWERS.compile(channel=news_channel) body = data_binding.JSONObjectBuilder() body.put_snowflake("webhook_channel_id", target_channel) response = await self._request(route, json=body, reason=reason) assert isinstance(response, dict) return self._entity_factory.deserialize_channel_follow(response)
Follow a news channel to send messages to a target channel.
Parameters
- news_channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildNewsChannel]): The object or ID of the news channel to follow.
- target_channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]): The object or ID of the channel to target.
Returns
- hikari.channels.ChannelFollow: Information about the new relationship that was made.
Raises
- hikari.errors.BadRequestError: If you try to follow a channel that's not a news channel or if the target channel has reached it's webhook limit, which is 10 at the time of writing.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_WEBHOOKS
permission in the target channel or are missing theVIEW_CHANNEL
permission in the origin channel. - hikari.errors.NotFoundError: If the origin or target channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
View Source
def guild_builder(self, name: str, /) -> special_endpoints.GuildBuilder: return special_endpoints_impl.GuildBuilder( entity_factory=self._entity_factory, executor=self._executor, request_call=self._request, name=name )
Make a guild builder to create a guild with.
Notes
This endpoint can only be used by bots in less than 10 guilds.
This call is not a coroutine function, it returns a special type of lazy iterator that will perform API calls as you iterate across it, thus any errors documented below will happen then.
Parameters
- name (str): The new guilds name.
Returns
- hikari.api.special_endpoints.GuildBuilder: The guild builder to use. This will allow to create a guild later with
hikari.api.special_endpoints.GuildBuilder.create
.
Raises
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value or if you call this as a bot that's in more than 10 guilds.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
See Also
self,
choices: Sequence[hikari.commands.CommandChoice]
) -> hikari.api.special_endpoints.InteractionAutocompleteBuilder:
View Source
def interaction_autocomplete_builder( self, choices: typing.Sequence[commands.CommandChoice] ) -> special_endpoints.InteractionAutocompleteBuilder: return special_endpoints_impl.InteractionAutocompleteBuilder(choices)
Create a builder for an autocomplete interaction response.
Returns
- hikari.api.special_endpoints.InteractionAutocompleteBuilder: The autocomplete interaction response builder object.
self,
type_: Union[hikari.interactions.base_interactions.ResponseType, int],
/
) -> hikari.api.special_endpoints.InteractionDeferredBuilder:
View Source
def interaction_deferred_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionDeferredBuilder: return special_endpoints_impl.InteractionDeferredBuilder(type=type_)
Create a builder for a deferred message interaction response.
Parameters
- type (typing.Union[hikari.interactions.base_interactions.ResponseType, int]): The type of deferred message response this builder is for.
Returns
- hikari.api.special_endpoints.InteractionDeferredBuilder: The deferred message interaction response builder object.
self,
type_: Union[hikari.interactions.base_interactions.ResponseType, int],
/
) -> hikari.api.special_endpoints.InteractionMessageBuilder:
View Source
def interaction_message_builder( self, type_: typing.Union[base_interactions.ResponseType, int], / ) -> special_endpoints.InteractionMessageBuilder: return special_endpoints_impl.InteractionMessageBuilder(type=type_)
Create a builder for a message interaction response.
Parameters
- type (typing.Union[hikari.interactions.base_interactions.ResponseType, int]): The type of message response this builder is for.
Returns
- hikari.api.special_endpoints.InteractionMessageBuilder: The interaction message response builder object.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> Coroutine[Any, Any, NoneType]:
View Source
def kick_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.kick_user(guild, user, reason=reason)
Alias of kick_user
.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def kick_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER.compile(guild=guild, user=user) await self._request(route, reason=reason)
Kick a member from a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to kick the member from. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to kick. This may be the object or the ID of an existing user.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing the
KICK_MEMBERS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or user are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
/
) -> None:
View Source
async def leave_guild(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], /) -> None: route = routes.DELETE_MY_GUILD.compile(guild=guild) await self._request(route)
Leave a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to leave. This may be the object or the ID of an existing guild.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found or you own the guild.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def pin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.PUT_CHANNEL_PINS.compile(channel=channel, message=message) await self._request(route)
Pin an existing message in the given text channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to pin a message in. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to pin. This may be the object or the ID of an existing message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
in the channel. - hikari.errors.NotFoundError: If the channel is not found, or if the message does not exist in the given channel.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
client: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
client_secret: str,
refresh_token: str,
*,
scopes: Union[Sequence[Union[hikari.applications.OAuth2Scope, str]], hikari.undefined.UndefinedType] = UNDEFINED
) -> hikari.applications.OAuth2AuthorizationToken:
View Source
async def refresh_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, refresh_token: str, *, scopes: undefined.UndefinedOr[ typing.Sequence[typing.Union[applications.OAuth2Scope, str]] ] = undefined.UNDEFINED, ) -> applications.OAuth2AuthorizationToken: route = routes.POST_TOKEN.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("grant_type", "refresh_token") form_builder.add_field("refresh_token", refresh_token) if scopes is not undefined.UNDEFINED: form_builder.add_field("scope", " ".join(scopes)) response = await self._request( route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret) ) assert isinstance(response, dict) return self._entity_factory.deserialize_authorization_token(response)
Refresh an access token.
Warning: As of writing this Discord currently ignores any passed scopes, therefore you should use hikari.applications.OAuth2AuthorizationToken.scopes
to validate that the expected scopes were actually authorized here.
Parameters
- client (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to authorize with.
- client_secret (str): Secret of the application to authorize with.
- refresh_token (str): The refresh token to use.
Other Parameters
- scopes (typing.Sequence[typing.Union[hikari.applications.OAuth2Scope, str]]): The scope of the access request.
Returns
- hikari.applications.OAuth2AuthorizationToken: Object of the authorized OAuth2 token.
Raises
- hikari.errors.BadRequestError: If an invalid redirect uri or refresh_token is passed.
- hikari.errors.UnauthorizedError: When an client or client secret is passed.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
role: Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def remove_role_from_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], role: snowflakes.SnowflakeishOr[guilds.PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_MEMBER_ROLE.compile(guild=guild, user=user, role=role) await self._request(route, reason=reason)
Remove a role from a member.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild where the member is in. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to remove the role from. This may be the object or the ID of an existing user.
- role (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]): The role to remove. This may be the object or the ID of an existing role.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild, user or role are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
positions: Mapping[int, Union[hikari.channels.GuildChannel, hikari.snowflakes.Snowflake, int]]
) -> None:
View Source
async def reposition_channels( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[channels_.GuildChannel]], ) -> None: route = routes.POST_GUILD_CHANNELS.compile(guild=guild) body = [{"id": str(int(channel)), "position": pos} for pos, channel in positions.items()] await self._request(route, json=body)
Reposition the channels in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to reposition the channels in. This may be the object or the ID of an existing guild.
- positions (typing.Mapping[int, hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]]): A mapping of of the object or the ID of an existing channel to the new position, relative to their parent category, if any.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_CHANNEL
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
positions: Mapping[int, Union[hikari.guilds.PartialRole, hikari.snowflakes.Snowflake, int]]
) -> None:
View Source
async def reposition_roles( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], positions: typing.Mapping[int, snowflakes.SnowflakeishOr[guilds.PartialRole]], ) -> None: route = routes.PATCH_GUILD_ROLES.compile(guild=guild) body = [{"id": str(int(role)), "position": pos} for pos, role in positions.items()] await self._request(route, json=body)
Reposition the roles in a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to reposition the roles in. This may be the object or the ID of an existing guild.
- positions (typing.Mapping[int, hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]]): A mapping of the position to the role.
Raises
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_ROLES
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
client: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
client_secret: str,
token: Union[str, hikari.applications.PartialOAuth2Token]
) -> None:
View Source
async def revoke_access_token( self, client: snowflakes.SnowflakeishOr[guilds.PartialApplication], client_secret: str, token: typing.Union[str, applications.PartialOAuth2Token], ) -> None: route = routes.POST_TOKEN_REVOKE.compile() form_builder = data_binding.URLEncodedFormBuilder() form_builder.add_field("token", str(token)) await self._request(route, form_builder=form_builder, auth=self._gen_oauth2_token(client, client_secret))
Revoke an OAuth2 token.
Parameters
- client (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to authorize with.
- client_secret (str): Secret of the application to authorize with.
- token (typing.Union[str, hikari.applications.PartialOAuth2Token]): Object or string of the access token to revoke.
Raises
- hikari.errors.UnauthorizedError: When an client or client secret is passed.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
name: str
) -> Sequence[hikari.guilds.Member]:
View Source
async def search_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], name: str, ) -> typing.Sequence[guilds.Member]: route = routes.GET_GUILD_MEMBERS_SEARCH.compile(guild=guild) query = data_binding.StringMapBuilder() query.put("query", name) query.put("limit", 1000) response = await self._request(route, query=query) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) return [ self._entity_factory.deserialize_member(member_payload, guild_id=guild_id) for member_payload in response ]
Search the members in a guild by nickname and username.
Note: Unlike RESTClient.fetch_members
this endpoint isn't paginated and therefore will return all the members in one go rather than needing to be asynchronously iterated over.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The object or ID of the guild to search members in.
- name (str): The query to match username(s) and nickname(s) against.
Returns
- typing.Sequence[hikari.guilds.Member]: A sequence of the members who matched the provided
name
.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
command: Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int],
permissions: Sequence[hikari.commands.CommandPermission]
) -> hikari.commands.GuildCommandPermissions:
View Source
async def set_application_command_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], command: snowflakes.SnowflakeishOr[commands.PartialCommand], permissions: typing.Sequence[commands.CommandPermission], ) -> commands.GuildCommandPermissions: route = routes.PUT_APPLICATION_COMMAND_PERMISSIONS.compile( application=application, guild=guild, command=command ) body = data_binding.JSONObjectBuilder() body.put_array("permissions", permissions, conversion=self._entity_factory.serialize_command_permission) response = await self._request(route, json=body) assert isinstance(response, dict) return self._entity_factory.deserialize_guild_command_permissions(response)
Set permissions for a specific command.
Note: This overwrites any previously set permissions.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to set the command permissions for.
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to set the command permissions for.
- command (hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand]): Object or ID of the command to set the permissions for.
- permissions (typing.Sequence[hikari.commands.CommandPermission]): Sequence of up to 10 of the permission objects to set.
Returns
- hikari.commands.GuildCommandPermissions: Object of the set permissions.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands or guild.
- hikari.errors.NotFoundError: If the provided application or command isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
commands: Sequence[hikari.api.special_endpoints.CommandBuilder],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int, hikari.undefined.UndefinedType] = UNDEFINED
) -> Sequence[hikari.commands.PartialCommand]:
View Source
async def set_application_commands( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], commands: typing.Sequence[special_endpoints.CommandBuilder], guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED, ) -> typing.Sequence[commands.PartialCommand]: if guild is undefined.UNDEFINED: route = routes.PUT_APPLICATION_COMMANDS.compile(application=application) else: route = routes.PUT_APPLICATION_GUILD_COMMANDS.compile(application=application, guild=guild) response = await self._request(route, json=[command.build(self._entity_factory) for command in commands]) assert isinstance(response, list) guild_id = snowflakes.Snowflake(guild) if guild is not undefined.UNDEFINED else None return [self._entity_factory.deserialize_command(payload, guild_id=guild_id) for payload in response]
Set the commands for an application.
Warning: Any existing commands not included in the provided commands array will be deleted.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to create a command for.
- commands (typing.Sequence[hikari.api.special_endpoints.CommandBuilder]): A sequence of up to 100 initialised command builder objects of the commands to set for this the application.
Other Parameters
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): Object or ID of the specific guild to set the commands for. If left as
hikari.undefined.UNDEFINED
then this set the global commands rather than guild specific commands.
Returns
- typing.Sequence[hikari.commands.PartialCommand]: A sequence of the set command objects.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands.
- hikari.errors.NotFoundError: If the provided application isn't found.
- hikari.errors.BadRequestError: If any of the fields that are passed have an invalid value.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
application: Union[hikari.guilds.PartialApplication, hikari.snowflakes.Snowflake, int],
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
permissions: Mapping[Union[hikari.commands.PartialCommand, hikari.snowflakes.Snowflake, int], Sequence[hikari.commands.CommandPermission]]
) -> Sequence[hikari.commands.GuildCommandPermissions]:
View Source
async def set_application_guild_commands_permissions( self, application: snowflakes.SnowflakeishOr[guilds.PartialApplication], guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], permissions: typing.Mapping[ snowflakes.SnowflakeishOr[commands.PartialCommand], typing.Sequence[commands.CommandPermission] ], ) -> typing.Sequence[commands.GuildCommandPermissions]: route = routes.PUT_APPLICATION_GUILD_COMMANDS_PERMISSIONS.compile(application=application, guild=guild) body = [ { "id": str(snowflakes.Snowflake(command)), "permissions": [self._entity_factory.serialize_command_permission(permission) for permission in perms], } for command, perms in permissions.items() ] response = await self._request(route, json=body) assert isinstance(response, list) return [self._entity_factory.deserialize_guild_command_permissions(payload) for payload in response]
Set permissions in a guild for multiple commands.
Note: This overwrites any previously set permissions for the specified commands.
Parameters
- application (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialApplication]): Object or ID of the application to set the command permissions for.
- guild (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]]): Object or ID of the guild to set the command permissions for.
permissions (typing.Mapping[hikari.snowflakes.SnowflakeishOr[hikari.commands.PartialCommand], typing.Sequence[hikari.commands.CommandPermission]]): Mapping of objects and/or IDs of commands to sequences of the commands to set for the specified guild.
Warning: Only a maximum of up to 10 permissions can be set per command.
Returns
- typing.Sequence[hikari.commands.GuildCommandPermissions]: Sequence of the set guild command permissions.
Raises
- hikari.errors.ForbiddenError: If you cannot access the provided application's commands or guild.
- hikari.errors.NotFoundError: If the provided application or command isn't found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
name: str,
description: str
) -> hikari.api.special_endpoints.SlashCommandBuilder:
View Source
def slash_command_builder(self, name: str, description: str) -> special_endpoints.SlashCommandBuilder: return special_endpoints_impl.SlashCommandBuilder(name, description)
Create a command builder for use in RESTClient.set_application_commands
.
Parameters
- name (str): The command's name. This should match the regex
^[\w-]{1,32}$
in Unicode mode and be lowercase. - description (str): The description to set for the command if this is a slash command. This should be inclusively between 1-100 characters in length.
Returns
- hikari.api.special_endpoints.SlashCommandBuilder: The created command builder object.
View Source
@typing.final def start(self) -> None: """Start the HTTP client. .. note:: This must be called within an active event loop. Raises ------ RuntimeError If this is called in an environment without an active event loop. """ if self._live_attributes: raise errors.ComponentStateConflictError("Cannot start a REST Client which is already alive") self._live_attributes = _LiveAttributes.build(self._max_rate_limit, self._http_settings, self._proxy_settings)
Start the HTTP client.
Note: This must be called within an active event loop.
Raises
- RuntimeError: If this is called in an environment without an active event loop.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
template: Union[hikari.templates.Template, str]
) -> hikari.templates.Template:
View Source
async def sync_guild_template( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], template: typing.Union[templates.Template, str], ) -> templates.Template: template = template if isinstance(template, str) else template.code route = routes.PUT_GUILD_TEMPLATE.compile(guild=guild, template=template) response = await self._request(route) assert isinstance(response, dict) return self._entity_factory.deserialize_template(response)
Create a guild template.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to sync a template in.
- template (typing.Union[str, hikari.templates.Template]): Object or code of the template to sync.
Returns
- hikari.templates.Template: The object of the synced template.
Raises
- hikari.errors.ForbiddenError: If you are not part of the guild or are missing the
MANAGE_GUILD
permission. - hikari.errors.NotFoundError: If the guild or template is not found.
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int]
) -> hikari.api.special_endpoints.TypingIndicator:
View Source
def trigger_typing( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel] ) -> special_endpoints.TypingIndicator: return special_endpoints_impl.TypingIndicator( request_call=self._request, channel=channel, rest_closed_event=self._get_live_attributes().closed_event )
Trigger typing in a text channel.
Note: The result of this call can be awaited to trigger typing once, or can be used as an async context manager to continually type until the context manager is left. Any errors documented below will happen then.
Examples
# Trigger typing just once.
await rest.trigger_typing(channel)
# Trigger typing repeatedly for 1 minute.
async with rest.trigger_typing(channel):
await asyncio.sleep(60)
Warning: Sending a message to the channel will cause the typing indicator to disappear until it is re-triggered.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to trigger typing in. This may be the object or the ID of an existing channel.
Returns
- hikari.api.special_endpoints.TypingIndicator: A typing indicator to use.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
SEND_MESSAGES
in the channel. - hikari.errors.NotFoundError: If the channel is not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> Coroutine[Any, Any, NoneType]:
View Source
def unban_member( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> typing.Coroutine[typing.Any, typing.Any, None]: return self.unban_user(guild, user, reason=reason)
Alias of unban_user
.
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
user: Union[hikari.users.PartialUser, hikari.snowflakes.Snowflake, int],
*,
reason: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def unban_user( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], user: snowflakes.SnowflakeishOr[users.PartialUser], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: route = routes.DELETE_GUILD_BAN.compile(guild=guild, user=user) await self._request(route, reason=reason)
Unban a member from a guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild to unban the member from. This may be the object or the ID of an existing guild.
- user (hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]): The user to unban. This may be the object or the ID of an existing user.
Other Parameters
- reason (hikari.undefined.UndefinedOr[str]): If provided, the reason that will be recorded in the audit logs. Maximum of 512 characters.
Raises
- hikari.errors.ForbiddenError: If you are missing the
BAN_MEMBERS
permission. - hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.NotFoundError: If the guild or user are not found.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.
self,
channel: Union[hikari.channels.TextableChannel, hikari.snowflakes.Snowflake, int],
message: Union[hikari.messages.PartialMessage, hikari.snowflakes.Snowflake, int]
) -> None:
View Source
async def unpin_message( self, channel: snowflakes.SnowflakeishOr[channels_.TextableChannel], message: snowflakes.SnowflakeishOr[messages_.PartialMessage], ) -> None: route = routes.DELETE_CHANNEL_PIN.compile(channel=channel, message=message) await self._request(route)
Unpin a given message from a given text channel.
Parameters
- channel (hikari.snowflakes.SnowflakeishOr[hikari.channels.TextableChannel]): The channel to unpin a message in. This may be the object or the ID of an existing channel.
- message (hikari.snowflakes.SnowflakeishOr[hikari.messages.PartialMessage]): The message to unpin. This may be the object or the ID of an existing message.
Raises
- hikari.errors.UnauthorizedError: If you are unauthorized to make the request (invalid/missing token).
- hikari.errors.ForbiddenError: If you are missing the
MANAGE_MESSAGES
permission. - hikari.errors.NotFoundError: If the channel is not found or the message is not a pinned message in the given channel.
- hikari.errors.RateLimitTooLongError: Raised in the event that a rate limit occurs that is longer than
max_rate_limit
when making a request. - hikari.errors.RateLimitedError: Usually, Hikari will handle and retry on hitting rate-limits automatically. This includes most bucket-specific rate-limits and global rate-limits. In some rare edge cases, however, Discord implements other undocumented rules for rate-limiting, such as limits per attribute. These cannot be detected or handled normally by Hikari due to their undocumented nature, and will trigger this exception if they occur.
- hikari.errors.InternalServerError: If an internal error occurs on Discord while handling the request.