Browse Source
Co-authored-by: Danny <[email protected]> Co-authored-by: Lucas Hardt <[email protected]> Co-authored-by: Andrin S. <[email protected]>pull/9618/head
Lucas Hardt
1 year ago
committed by
GitHub
GitHub
12 changed files with 828 additions and 4 deletions
@ -0,0 +1,200 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
|
|||
from __future__ import annotations |
|||
|
|||
from typing import Optional, TYPE_CHECKING |
|||
|
|||
from . import utils |
|||
from .app_commands import MissingApplicationID |
|||
from .enums import try_enum, SKUType, EntitlementType |
|||
from .flags import SKUFlags |
|||
|
|||
if TYPE_CHECKING: |
|||
from datetime import datetime |
|||
|
|||
from .guild import Guild |
|||
from .state import ConnectionState |
|||
from .types.sku import ( |
|||
SKU as SKUPayload, |
|||
Entitlement as EntitlementPayload, |
|||
) |
|||
from .user import User |
|||
|
|||
__all__ = ( |
|||
'SKU', |
|||
'Entitlement', |
|||
) |
|||
|
|||
|
|||
class SKU: |
|||
"""Represents a premium offering as a stock-keeping unit (SKU). |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Attributes |
|||
----------- |
|||
id: :class:`int` |
|||
The SKU's ID. |
|||
type: :class:`SKUType` |
|||
The type of the SKU. |
|||
application_id: :class:`int` |
|||
The ID of the application that the SKU belongs to. |
|||
name: :class:`str` |
|||
The consumer-facing name of the premium offering. |
|||
slug: :class:`str` |
|||
A system-generated URL slug based on the SKU name. |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'id', |
|||
'type', |
|||
'application_id', |
|||
'name', |
|||
'slug', |
|||
'_flags', |
|||
) |
|||
|
|||
def __init__(self, *, state: ConnectionState, data: SKUPayload): |
|||
self._state: ConnectionState = state |
|||
self.id: int = int(data['id']) |
|||
self.type: SKUType = try_enum(SKUType, data['type']) |
|||
self.application_id: int = int(data['application_id']) |
|||
self.name: str = data['name'] |
|||
self.slug: str = data['slug'] |
|||
self._flags: int = data['flags'] |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<SKU id={self.id} name={self.name!r} slug={self.slug!r}>' |
|||
|
|||
@property |
|||
def flags(self) -> SKUFlags: |
|||
"""Returns the flags of the SKU.""" |
|||
return SKUFlags._from_value(self._flags) |
|||
|
|||
@property |
|||
def created_at(self) -> datetime: |
|||
""":class:`datetime.datetime`: Returns the sku's creation time in UTC.""" |
|||
return utils.snowflake_time(self.id) |
|||
|
|||
|
|||
class Entitlement: |
|||
"""Represents an entitlement from user or guild which has been granted access to a premium offering. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Attributes |
|||
----------- |
|||
id: :class:`int` |
|||
The entitlement's ID. |
|||
sku_id: :class:`int` |
|||
The ID of the SKU that the entitlement belongs to. |
|||
application_id: :class:`int` |
|||
The ID of the application that the entitlement belongs to. |
|||
user_id: Optional[:class:`int`] |
|||
The ID of the user that is granted access to the entitlement. |
|||
type: :class:`EntitlementType` |
|||
The type of the entitlement. |
|||
deleted: :class:`bool` |
|||
Whether the entitlement has been deleted. |
|||
starts_at: Optional[:class:`datetime.datetime`] |
|||
A UTC start date which the entitlement is valid. Not present when using test entitlements. |
|||
ends_at: Optional[:class:`datetime.datetime`] |
|||
A UTC date which entitlement is no longer valid. Not present when using test entitlements. |
|||
guild_id: Optional[:class:`int`] |
|||
The ID of the guild that is granted access to the entitlement |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'id', |
|||
'sku_id', |
|||
'application_id', |
|||
'user_id', |
|||
'type', |
|||
'deleted', |
|||
'starts_at', |
|||
'ends_at', |
|||
'guild_id', |
|||
) |
|||
|
|||
def __init__(self, state: ConnectionState, data: EntitlementPayload): |
|||
self._state: ConnectionState = state |
|||
self.id: int = int(data['id']) |
|||
self.sku_id: int = int(data['sku_id']) |
|||
self.application_id: int = int(data['application_id']) |
|||
self.user_id: Optional[int] = utils._get_as_snowflake(data, 'user_id') |
|||
self.type: EntitlementType = try_enum(EntitlementType, data['type']) |
|||
self.deleted: bool = data['deleted'] |
|||
self.starts_at: Optional[datetime] = utils.parse_time(data.get('starts_at', None)) |
|||
self.ends_at: Optional[datetime] = utils.parse_time(data.get('ends_at', None)) |
|||
self.guild_id: Optional[int] = utils._get_as_snowflake(data, 'guild_id') |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<Entitlement id={self.id} type={self.type!r} user_id={self.user_id}>' |
|||
|
|||
@property |
|||
def user(self) -> Optional[User]: |
|||
"""The user that is granted access to the entitlement""" |
|||
if self.user_id is None: |
|||
return None |
|||
return self._state.get_user(self.user_id) |
|||
|
|||
@property |
|||
def guild(self) -> Optional[Guild]: |
|||
"""The guild that is granted access to the entitlement""" |
|||
return self._state._get_guild(self.guild_id) |
|||
|
|||
@property |
|||
def created_at(self) -> datetime: |
|||
""":class:`datetime.datetime`: Returns the entitlement's creation time in UTC.""" |
|||
return utils.snowflake_time(self.id) |
|||
|
|||
def is_expired(self) -> bool: |
|||
""":class:`bool`: Returns ``True`` if the entitlement is expired. Will be always False for test entitlements.""" |
|||
if self.ends_at is None: |
|||
return False |
|||
return utils.utcnow() >= self.ends_at |
|||
|
|||
async def delete(self) -> None: |
|||
"""|coro| |
|||
|
|||
Deletes the entitlement. |
|||
|
|||
Raises |
|||
------- |
|||
MissingApplicationID |
|||
The application ID could not be found. |
|||
NotFound |
|||
The entitlement could not be found. |
|||
HTTPException |
|||
Deleting the entitlement failed. |
|||
""" |
|||
|
|||
if self.application_id is None: |
|||
raise MissingApplicationID |
|||
|
|||
await self._state.http.delete_entitlement(self.application_id, self.id) |
|||
@ -0,0 +1,52 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
|
|||
from typing import TypedDict, Optional, Literal |
|||
from typing_extensions import NotRequired |
|||
|
|||
|
|||
class SKU(TypedDict): |
|||
id: str |
|||
type: int |
|||
application_id: str |
|||
name: str |
|||
slug: str |
|||
flags: int |
|||
|
|||
|
|||
class Entitlement(TypedDict): |
|||
id: str |
|||
sku_id: str |
|||
application_id: str |
|||
user_id: Optional[str] |
|||
type: int |
|||
deleted: bool |
|||
starts_at: NotRequired[str] |
|||
ends_at: NotRequired[str] |
|||
guild_id: Optional[str] |
|||
|
|||
|
|||
EntitlementOwnerType = Literal[1, 2] |
|||
Loading…
Reference in new issue