Skip to content

GetAccountActivityResponse

Source code in docs_src/capo_freetier/types/get_account_activity_response.py
class GetAccountActivityResponse(TypedDict, closed=True):
    activity_id: "capo_freetier.types.activity_id.ActivityId"
    """<p> A unique identifier that identifies the activity. </p>"""
    title: "capo_freetier.types.generic_string.GenericString"
    """<p> A short activity title. </p>"""
    description: "capo_freetier.types.generic_string.GenericString"
    """<p> Provides detailed information about the activity and its expected outcomes. </p>"""
    status: "capo_freetier.types.activity_status.ActivityStatus"
    """<p> The current activity status. </p>"""
    instructions_url: "capo_freetier.types.generic_string.GenericString"
    """<p> The URL resource that provides guidance on activity requirements and completion. </p>"""
    reward: "capo_freetier.types.activity_reward.ActivityReward"
    """<p> A reward granted upon activity completion. </p>"""
    estimated_time_to_complete_in_minutes: NotRequired["int"]
    """<p> The estimated time to complete the activity. This is the duration in minutes. </p>"""
    expires_at: NotRequired["datetime.datetime"]
    """<p> The time by which the activity must be completed to receive a reward. </p>"""
    started_at: NotRequired["datetime.datetime"]
    """<p> The timestamp when the activity started. This field appears only for activities in the <code>IN_PROGRESS</code> or <code>COMPLETED</code> states. </p>"""
    completed_at: NotRequired["datetime.datetime"]
    """<p> The timestamp when the activity is completed. This field appears only for activities in the <code>COMPLETED</code> state. </p>"""

activity_id instance-attribute

activity_id: ActivityId

A unique identifier that identifies the activity.

completed_at instance-attribute

completed_at: NotRequired[datetime]

The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

description instance-attribute

description: GenericString

Provides detailed information about the activity and its expected outcomes.

estimated_time_to_complete_in_minutes instance-attribute

estimated_time_to_complete_in_minutes: NotRequired[int]

The estimated time to complete the activity. This is the duration in minutes.

expires_at instance-attribute

expires_at: NotRequired[datetime]

The time by which the activity must be completed to receive a reward.

instructions_url instance-attribute

instructions_url: GenericString

The URL resource that provides guidance on activity requirements and completion.

reward instance-attribute

A reward granted upon activity completion.

started_at instance-attribute

started_at: NotRequired[datetime]

The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

status instance-attribute

The current activity status.

title instance-attribute

A short activity title.