Module twitchpy.dataclasses.redemption

Classes

class Redemption (channel: Channel,
redemption_id: str,
user: User,
user_input: str,
status: str,
redeemed_at: datetime.datetime,
reward: Reward)

Expand source code

@dataclass
class Redemption:
    """
    Represents a reward redemption

    Args:
        channel (Channel): The channel that the reward belongs to
        redemption_id (str): The ID of the redemption
        user (User): The user that redeemed the reward
        user_input (str): The user input provided
        status (str): One of UNFULFILLED, FULFILLED or CANCELED
        redeemed_at (datetime): Timestamp of when the reward was redeemed
        reward (Reward): The custom reward that was redeemed at the time it was redeemed
    """

    channel: Channel
    redemption_id: str
    user: User
    user_input: str
    status: str
    redeemed_at: datetime
    reward: Reward

Represents a reward redemption

Args

channel : Channel

The channel that the reward belongs to

redemption_id : str

The ID of the redemption

user : User

The user that redeemed the reward

user_input : str

The user input provided

status : str

One of UNFULFILLED, FULFILLED or CANCELED

redeemed_at : datetime

Timestamp of when the reward was redeemed

reward : Reward

The custom reward that was redeemed at the time it was redeemed

Class variables

var channel : Channel

The type of the None singleton.

var redeemed_at : datetime.datetime

The type of the None singleton.

var redemption_id : str

The type of the None singleton.

var reward : Reward

The type of the None singleton.

var status : str

The type of the None singleton.

var user : User

The type of the None singleton.

var user_input : str

The type of the None singleton.