twitterapi.models.twitter_v2_spec module

Manual edits:

Change possible username length from 15 to 20: pattern=r”^[A-Za-z0-9_]{1,15}$” to pattern=r”^[A-Za-z0-9_]{1,20}$”.

Change profile_image_url and profile_banner_url because of blocked users with url length of 0: class User: profile_image_url and profile_banner_url from Optional[AnyUrl] to Optional[str]

Change country codes to allow upper and lower case: constr(pattern=r”^[A-Z]{2}$”) to constr(pattern=r”^[A-Za-z]{2}$”)

Change minimum items in TweetTakedownComplianceSchema and UserTakedownComplianceSchema withheld_in_countries to 0 withheld_in_countries: List[constr(pattern=r”^[A-Za-z]{2}$”)] = Field(…, min_length=0)

Make url from UrlFields to str

Add # type: ignore to all lines with confloat, conint, constr Hint: Use STRG + SHIFT + L

class sparta.twitterapi.models.twitter_v2_spec.AddOrDeleteRulesRequest(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[AddRulesRequest, DeleteRulesRequest]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: AddRulesRequest | DeleteRulesRequest
class sparta.twitterapi.models.twitter_v2_spec.AddOrDeleteRulesResponse(*, data: List[Rule] | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, meta: RulesResponseMetadata)

Bases: BaseModel

data: List[Rule] | None
errors: List[Problem] | None
meta: RulesResponseMetadata
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.AddRulesRequest(*, add: List[RuleNoId])

Bases: BaseModel

add: List[RuleNoId]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Affiliation(*, badge_url: ~pydantic.networks.AnyUrl | None = None, description: str | None = None, url: ~pydantic.networks.AnyUrl | None = None, user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None)

Bases: BaseModel

badge_url: AnyUrl | None
description: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: AnyUrl | None
user_id: constr(pattern='^[0-9]{1,19}$') | None
class sparta.twitterapi.models.twitter_v2_spec.Aggregate(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[int]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: int
class sparta.twitterapi.models.twitter_v2_spec.AnimatedGif(*, height: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, type: str, width: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, preview_image_url: ~pydantic.networks.AnyUrl | None = None, variants: ~typing.List[~sparta.twitterapi.models.twitter_v2_spec.Variant] | None = None)

Bases: Media

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

preview_image_url: AnyUrl | None
variants: List[Variant] | None
class sparta.twitterapi.models.twitter_v2_spec.Annotation(*, end: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], start: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], normalized_text: str | None = None, probability: Annotated[float, None, Interval(gt=None, ge=0.0, lt=None, le=1.0), None, None] | None = None, type: str | None = None)

Bases: EntityIndicesInclusiveInclusive

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

normalized_text: str | None
probability: confloat(ge=0.0, le=1.0) | None
type: str | None
class sparta.twitterapi.models.twitter_v2_spec.AppRulesCount(*, client_app_id: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=19, pattern=None)] | None = None, rule_count: int | None = None)

Bases: BaseModel

client_app_id: constr(min_length=1, max_length=19) | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rule_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Attachments(*, card_ids: ~typing.Annotated[~typing.List[str] | None, ~annotated_types.MinLen(min_length=1)] = None, media_keys: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)]] | None, ~annotated_types.MinLen(min_length=1)] = None)

Bases: BaseModel

card_ids: List[str] | None
media_keys: List[constr(pattern='^([0-9]+)_([0-9]+)$')] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Attachments1(*, media_keys: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)]] | None, ~annotated_types.MinLen(min_length=1)] = None, media_source_tweet_id: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)]] | None, ~annotated_types.MinLen(min_length=1)] = None, poll_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)]] | None, ~annotated_types.MinLen(min_length=1)] = None)

Bases: BaseModel

media_keys: List[constr(pattern='^([0-9]+)_([0-9]+)$')] | None
media_source_tweet_id: List[constr(pattern='^[0-9]{1,19}$')] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

poll_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
class sparta.twitterapi.models.twitter_v2_spec.BookmarkAddRequest(*, tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.BookmarkFolderPostsResponse(*, data: Data | None = None)

Bases: BaseModel

data: Data | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.BookmarkFoldersResponse(*, data: Data1 | None = None)

Bases: BaseModel

data: Data1 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.BookmarkMutationResponse(*, data: Data2 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data2 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.CashtagEntity(*, tag: str, end: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], start: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: EntityIndicesInclusiveExclusive, CashtagFields

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.CashtagFields(*, tag: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tag: str
class sparta.twitterapi.models.twitter_v2_spec.ClientAppUsage(*, client_app_id: str | None = None, usage: Annotated[List[UsageFields] | None, MinLen(min_length=1)] = None, usage_result_count: int | None = None)

Bases: BaseModel

client_app_id: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

usage: List[UsageFields] | None
usage_result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.ClientDisconnectedProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ClientForbiddenProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, reason: Reason | None = None, registration_url: AnyUrl | None = None)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reason: Reason | None
registration_url: AnyUrl | None
class sparta.twitterapi.models.twitter_v2_spec.Community(*, created_at: ~datetime.datetime | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], name: str)

Bases: BaseModel

created_at: datetime | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class sparta.twitterapi.models.twitter_v2_spec.ComplianceJob(*, created_at: ~datetime.datetime, download_expires_at: ~datetime.datetime, download_url: ~pydantic.networks.AnyUrl, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], name: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None = None, status: ~sparta.twitterapi.models.twitter_v2_spec.ComplianceJobStatus, type: ~sparta.twitterapi.models.twitter_v2_spec.ComplianceJobType, upload_expires_at: ~datetime.datetime, upload_url: ~pydantic.networks.AnyUrl)

Bases: BaseModel

created_at: datetime
download_expires_at: datetime
download_url: AnyUrl
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: constr(max_length=64) | None
status: ComplianceJobStatus
type: ComplianceJobType
upload_expires_at: datetime
upload_url: AnyUrl
class sparta.twitterapi.models.twitter_v2_spec.ComplianceJobStatus(value)

Bases: Enum

An enumeration.

complete = 'complete'
created = 'created'
expired = 'expired'
failed = 'failed'
in_progress = 'in_progress'
class sparta.twitterapi.models.twitter_v2_spec.ComplianceJobType(value)

Bases: Enum

An enumeration.

tweets = 'tweets'
users = 'users'
class sparta.twitterapi.models.twitter_v2_spec.ConflictProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ConnectionExceptionProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, connection_issue: ConnectionIssue | None = None)

Bases: Problem

connection_issue: ConnectionIssue | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ConnectionIssue(value)

Bases: Enum

An enumeration.

ProvisioningSubscription = 'ProvisioningSubscription'
RuleConfigurationIssue = 'RuleConfigurationIssue'
RulesInvalidIssue = 'RulesInvalidIssue'
TooManyConnections = 'TooManyConnections'
class sparta.twitterapi.models.twitter_v2_spec.ConnectionStatu(value)

Bases: Enum

An enumeration.

blocking = 'blocking'
follow_request_received = 'follow_request_received'
follow_request_sent = 'follow_request_sent'
followed_by = 'followed_by'
following = 'following'
muting = 'muting'
class sparta.twitterapi.models.twitter_v2_spec.ContextAnnotation(*, domain: ContextAnnotationDomainFields, entity: ContextAnnotationEntityFields)

Bases: BaseModel

domain: ContextAnnotationDomainFields
entity: ContextAnnotationEntityFields
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ContextAnnotationDomainFields(*, description: str | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], name: str | None = None)

Bases: BaseModel

description: str | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None
class sparta.twitterapi.models.twitter_v2_spec.ContextAnnotationEntityFields(*, description: str | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], name: str | None = None)

Bases: BaseModel

description: str | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None
class sparta.twitterapi.models.twitter_v2_spec.ConversationType(value)

Bases: Enum

An enumeration.

Group = 'Group'
class sparta.twitterapi.models.twitter_v2_spec.CreateAttachmentsMessageRequest(*, attachments: List[DmMediaAttachment], text: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None)

Bases: BaseModel

attachments: List[DmMediaAttachment]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: constr(min_length=1) | None
class sparta.twitterapi.models.twitter_v2_spec.CreateComplianceJobRequest(*, name: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None = None, resumable: bool | None = None, type: Type)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: constr(max_length=64) | None
resumable: bool | None
type: Type
class sparta.twitterapi.models.twitter_v2_spec.CreateComplianceJobResponse(*, data: ComplianceJob | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: ComplianceJob | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.CreateDmConversationRequest(*, conversation_type: ~sparta.twitterapi.models.twitter_v2_spec.ConversationType, message: ~sparta.twitterapi.models.twitter_v2_spec.CreateTextMessageRequest | ~sparta.twitterapi.models.twitter_v2_spec.CreateAttachmentsMessageRequest, participant_ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]])

Bases: BaseModel

conversation_type: ConversationType
message: CreateTextMessageRequest | CreateAttachmentsMessageRequest
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

participant_ids: List[constr(pattern='^[0-9]{1,19}$')]
class sparta.twitterapi.models.twitter_v2_spec.CreateDmEventResponse(*, data: Data3 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data3 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.CreateTextMessageRequest(*, attachments: List[DmMediaAttachment] | None = None, text: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])

Bases: BaseModel

attachments: List[DmMediaAttachment] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: constr(min_length=1)
class sparta.twitterapi.models.twitter_v2_spec.DailyProjectUsage(*, project_id: int | None = None, usage: Annotated[List[UsageFields] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: int | None
usage: List[UsageFields] | None
class sparta.twitterapi.models.twitter_v2_spec.Data(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data1(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, name: str | None = None)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None
class sparta.twitterapi.models.twitter_v2_spec.Data10(*, pinned: bool | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pinned: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data12(*, updated: bool | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

updated: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data13(*, expires_after_secs: int | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None)

Bases: BaseModel

expires_after_secs: int | None
id: constr(pattern='^[0-9]{1,19}$') | None
media_key: constr(pattern='^([0-9]+)_([0-9]+)$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data14(*, expires_after_secs: int | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, processing_info: ~sparta.twitterapi.models.twitter_v2_spec.ProcessingInfo | None = None, size: int | None = None)

Bases: BaseModel

expires_after_secs: int | None
id: constr(pattern='^[0-9]{1,19}$') | None
media_key: constr(pattern='^([0-9]+)_([0-9]+)$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

processing_info: ProcessingInfo | None
size: int | None
class sparta.twitterapi.models.twitter_v2_spec.Data15(*, muting: bool | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

muting: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data16(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], text: str)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: str
class sparta.twitterapi.models.twitter_v2_spec.Data17(*, deleted: bool)

Bases: BaseModel

deleted: bool
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data18(*, hidden: bool | None = None)

Bases: BaseModel

hidden: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data19(*, blocked: bool | None = None)

Bases: BaseModel

blocked: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data2(*, bookmarked: bool | None = None)

Bases: BaseModel

bookmarked: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data21(*, following: bool | None = None, pending_follow: bool | None = None)

Bases: BaseModel

following: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pending_follow: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data22(*, following: bool | None = None)

Bases: BaseModel

following: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data23(*, liked: bool | None = None)

Bases: BaseModel

liked: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data25(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, retweeted: bool | None = None)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

retweeted: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data26(*, retweeted: bool | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

retweeted: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data3(*, dm_conversation_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$)], dm_event_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

dm_conversation_id: constr(pattern='^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$')
dm_event_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data4(*, deleted: bool | None = None)

Bases: BaseModel

deleted: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data5(*, killed_connections: bool | None = None)

Bases: BaseModel

killed_connections: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data6(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], name: str)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class sparta.twitterapi.models.twitter_v2_spec.Data7(*, deleted: bool | None = None)

Bases: BaseModel

deleted: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data8(*, following: bool | None = None)

Bases: BaseModel

following: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Data9(*, is_member: bool | None = None)

Bases: BaseModel

is_member: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Delete(*, ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)]] | None = None, values: ~typing.List[str] | None = None)

Bases: BaseModel

ids: List[constr(pattern='^[0-9]{1,19}$')] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

values: List[str] | None
class sparta.twitterapi.models.twitter_v2_spec.DeleteDmResponse(*, data: Data4 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data4 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.DeleteRulesRequest(*, delete: Delete)

Bases: BaseModel

delete: Delete
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.DisallowedResourceProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, resource_id: str, resource_type: ResourceType, section: Section)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resource_id: str
resource_type: ResourceType
section: Section
class sparta.twitterapi.models.twitter_v2_spec.DisconnectType(value)

Bases: Enum

An enumeration.

ClientApplicationStateDegraded = 'ClientApplicationStateDegraded'
ForceDisconnect = 'ForceDisconnect'
InternalError = 'InternalError'
InvalidRules = 'InvalidRules'
OperationalDisconnect = 'OperationalDisconnect'
SlowReader = 'SlowReader'
UpstreamOperationalDisconnect = 'UpstreamOperationalDisconnect'
UpstreamUncleanDisconnect = 'UpstreamUncleanDisconnect'
class sparta.twitterapi.models.twitter_v2_spec.DmEvent(*, attachments: ~sparta.twitterapi.models.twitter_v2_spec.Attachments | None = None, cashtags: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.CashtagEntity] | None, ~annotated_types.MinLen(min_length=1)] = None, created_at: ~datetime.datetime | None = None, dm_conversation_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$)] | None = None, event_type: str, hashtags: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.HashtagEntity] | None, ~annotated_types.MinLen(min_length=1)] = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], mentions: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.MentionEntity] | None, ~annotated_types.MinLen(min_length=1)] = None, participant_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None, ~annotated_types.MinLen(min_length=1)] = None, referenced_tweets: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.ReferencedTweet] | None, ~annotated_types.MinLen(min_length=1)] = None, sender_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, text: str | None = None, urls: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.UrlEntityDm] | None, ~annotated_types.MinLen(min_length=1)] = None)

Bases: BaseModel

attachments: Attachments | None
cashtags: List[CashtagEntity] | None
created_at: datetime | None
dm_conversation_id: constr(pattern='^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$') | None
event_type: str
hashtags: List[HashtagEntity] | None
id: constr(pattern='^[0-9]{1,19}$')
mentions: List[MentionEntity] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

participant_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
referenced_tweets: List[ReferencedTweet] | None
sender_id: constr(pattern='^[0-9]{1,19}$') | None
text: str | None
urls: List[UrlEntityDm] | None
class sparta.twitterapi.models.twitter_v2_spec.DmMediaAttachment(*, media_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

media_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.DuplicateRuleProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, id: str | None = None, value: str | None = None)

Bases: Problem

id: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: str | None
class sparta.twitterapi.models.twitter_v2_spec.EditControls(*, editable_until: datetime, edits_remaining: int, is_edit_eligible: bool)

Bases: BaseModel

editable_until: datetime
edits_remaining: int
is_edit_eligible: bool
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Engagement(*, errors: Annotated[List[Error] | None, MinLen(min_length=1)] = None, measurement: Measurement | None = None)

Bases: BaseModel

errors: List[Error] | None
measurement: Measurement | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Entities(*, cashtags: Annotated[List[CashtagEntity] | None, MinLen(min_length=1)] = None, hashtags: Annotated[List[HashtagEntity] | None, MinLen(min_length=1)] = None, mentions: Annotated[List[MentionEntity] | None, MinLen(min_length=1)] = None, urls: Annotated[List[UrlEntity] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

cashtags: List[CashtagEntity] | None
hashtags: List[HashtagEntity] | None
mentions: List[MentionEntity] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

urls: List[UrlEntity] | None
class sparta.twitterapi.models.twitter_v2_spec.Entities1(*, description: FullTextEntities | None = None, url: Url1 | None = None)

Bases: BaseModel

description: FullTextEntities | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: Url1 | None
class sparta.twitterapi.models.twitter_v2_spec.EntityIndicesInclusiveExclusive(*, end: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], start: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: BaseModel

end: conint(ge=0)
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: conint(ge=0)
class sparta.twitterapi.models.twitter_v2_spec.EntityIndicesInclusiveInclusive(*, end: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], start: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: BaseModel

end: conint(ge=0)
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: conint(ge=0)
class sparta.twitterapi.models.twitter_v2_spec.Error(*, error: str | None = None, tweets: List[str] | None = None)

Bases: BaseModel

error: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweets: List[str] | None
class sparta.twitterapi.models.twitter_v2_spec.Error1(*, code: int, message: str)

Bases: BaseModel

code: int
message: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Error2(*, message: str | None = None, parameters: Dict[str, List[str]] | None = None)

Bases: BaseModel

message: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameters: Dict[str, List[str]] | None
class sparta.twitterapi.models.twitter_v2_spec.Expansions(*, media: Annotated[List[Media] | None, MinLen(min_length=1)] = None, places: Annotated[List[Place] | None, MinLen(min_length=1)] = None, polls: Annotated[List[Poll] | None, MinLen(min_length=1)] = None, topics: Annotated[List[Topic] | None, MinLen(min_length=1)] = None, tweets: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, users: Annotated[List[User] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

media: List[Media] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

places: List[Place] | None
polls: List[Poll] | None
topics: List[Topic] | None
tweets: List[Tweet] | None
users: List[User] | None
class sparta.twitterapi.models.twitter_v2_spec.Favorite(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.FieldUnauthorizedProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, field: str, resource_type: ResourceType, section: Section)

Bases: Problem

field: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resource_type: ResourceType
section: Section
class sparta.twitterapi.models.twitter_v2_spec.FilteredStreamingTweetResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, matching_rules: List[MatchingRule] | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
matching_rules: List[MatchingRule] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.FullTextEntities(*, annotations: Annotated[List[Annotation] | None, MinLen(min_length=1)] = None, cashtags: Annotated[List[CashtagEntity] | None, MinLen(min_length=1)] = None, hashtags: Annotated[List[HashtagEntity] | None, MinLen(min_length=1)] = None, mentions: Annotated[List[MentionEntity] | None, MinLen(min_length=1)] = None, urls: Annotated[List[UrlEntity] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

annotations: List[Annotation] | None
cashtags: List[CashtagEntity] | None
hashtags: List[HashtagEntity] | None
mentions: List[MentionEntity] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

urls: List[UrlEntity] | None
class sparta.twitterapi.models.twitter_v2_spec.GenericProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Geo(*, bbox: Annotated[List[Annotated[float, None, Interval(gt=None, ge=-180.0, lt=None, le=180.0), None, None]], MinLen(min_length=4), MaxLen(max_length=4)], geometry: Point | None = None, properties: Dict[str, Any], type: Type1)

Bases: BaseModel

bbox: List[confloat(ge=-180.0, le=180.0)]
geometry: Point | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

properties: Dict[str, Any]
type: Type1
class sparta.twitterapi.models.twitter_v2_spec.Geo1(*, coordinates: Point | None = None, place_id: str | None = None)

Bases: BaseModel

coordinates: Point | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

place_id: str | None
class sparta.twitterapi.models.twitter_v2_spec.Geo2(*, place_id: str | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

place_id: str | None
class sparta.twitterapi.models.twitter_v2_spec.Get2CommunitiesIdResponse(*, data: Community | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Community | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2CommunitiesSearchResponse(*, data: Annotated[List[Community] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, meta: Meta | None = None)

Bases: BaseModel

data: List[Community] | None
errors: List[Problem] | None
meta: Meta | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ComplianceJobsIdResponse(*, data: ComplianceJob | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: ComplianceJob | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ComplianceJobsResponse(*, data: Annotated[List[ComplianceJob] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, meta: Meta1 | None = None)

Bases: BaseModel

data: List[ComplianceJob] | None
errors: List[Problem] | None
meta: Meta1 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2DmConversationsIdDmEventsResponse(*, data: Annotated[List[DmEvent] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2DmConversationsWithParticipantIdDmEventsResponse(*, data: Annotated[List[DmEvent] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2DmEventsEventIdResponse(*, data: DmEvent | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: DmEvent | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2DmEventsResponse(*, data: Annotated[List[DmEvent] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2Insights28hrResponse(*, data: Annotated[List[Engagement] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: List[Engagement] | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2InsightsHistoricalResponse(*, data: Annotated[List[Engagement] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: List[Engagement] | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2LikesFirehoseStreamResponse(*, data: LikeWithTweetAuthor | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: LikeWithTweetAuthor | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2LikesSample10StreamResponse(*, data: LikeWithTweetAuthor | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: LikeWithTweetAuthor | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ListsIdFollowersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ListsIdMembersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ListsIdResponse(*, data: ListModel | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: ListModel | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2ListsIdTweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta2 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta2 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2NotesResponse(*, data: Note | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Note | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesByCreatorIdsResponse(*, data: Annotated[List[Space] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta8 | None = None)

Bases: BaseModel

data: List[Space] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta8 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesIdBuyersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta9 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta9 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesIdResponse(*, data: Space | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Space | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesIdTweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta9 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta9 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesResponse(*, data: Annotated[List[Space] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: List[Space] | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2SpacesSearchResponse(*, data: Annotated[List[Space] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta11 | None = None)

Bases: BaseModel

data: List[Space] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta11 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TrendsByWoeidWoeidResponse(*, data: Annotated[List[Trend] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: List[Trend] | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsCountsAllResponse(*, data: Annotated[List[SearchCount] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, meta: Meta12 | None = None)

Bases: BaseModel

data: List[SearchCount] | None
errors: List[Problem] | None
meta: Meta12 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsCountsRecentResponse(*, data: Annotated[List[SearchCount] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, meta: Meta12 | None = None)

Bases: BaseModel

data: List[SearchCount] | None
errors: List[Problem] | None
meta: Meta12 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsFirehoseStreamLangEnResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsFirehoseStreamLangJaResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsFirehoseStreamLangKoResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsFirehoseStreamLangPtResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsFirehoseStreamResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsIdLikingUsersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta14 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta14 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsIdQuoteTweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta15 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta15 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsIdResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsIdRetweetedByResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta16 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta16 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsIdRetweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta16 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta16 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSample10StreamResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSampleStreamResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSearchAllResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta18 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta18 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSearchRecentResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta18 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta18 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSearchStreamResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2TweetsSearchStreamRulesCountsResponse(*, data: RulesCount | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: RulesCount | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsageTweetsResponse(*, data: Usage | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Usage | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersByResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersByUsernameUsernameResponse(*, data: User | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: User | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdBlockingResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdBookmarksResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdFollowedListsResponse(*, data: Annotated[List[ListModel] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdFollowersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdFollowingResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdLikedTweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdListMembershipsResponse(*, data: Annotated[List[ListModel] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta20 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta20 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdMentionsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta27 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta27 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdMutingResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta28 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta28 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdOwnedListsResponse(*, data: Annotated[List[ListModel] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta28 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta28 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdPinnedListsResponse(*, data: Annotated[List[ListModel] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta30 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta30 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdResponse(*, data: User | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: User | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdTimelinesReverseChronologicalResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta31 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta31 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersIdTweetsResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta31 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta31 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersMeResponse(*, data: User | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: User | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersPersonalizedTrendsResponse(*, data: Annotated[List[PersonalizedTrend] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: List[PersonalizedTrend] | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersRepostsOfMeResponse(*, data: Annotated[List[Tweet] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta33 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta33 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Get2UsersSearchResponse(*, data: Annotated[List[User] | None, MinLen(min_length=1)] = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None, meta: Meta34 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta34 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.HashtagEntity(*, tag: str, end: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None], start: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: EntityIndicesInclusiveExclusive, HashtagFields

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.HashtagFields(*, tag: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tag: str
class sparta.twitterapi.models.twitter_v2_spec.InvalidRequestProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, errors: Annotated[List[Error2] | None, MinLen(min_length=1)] = None)

Bases: Problem

errors: List[Error2] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.InvalidRuleProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.KillAllConnectionsResponse(*, data: Data5 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data5 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.LikeComplianceSchema(*, delete: UnlikeComplianceSchema)

Bases: BaseModel

delete: UnlikeComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.LikeWithTweetAuthor(*, created_at: ~datetime.datetime | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z0-9_]{1, 40}$)] | None = None, liked_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, timestamp_ms: int | None = None, tweet_author_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None)

Bases: BaseModel

created_at: datetime | None
id: constr(pattern='^[A-Za-z0-9_]{1,40}$') | None
liked_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp_ms: int | None
tweet_author_id: constr(pattern='^[0-9]{1,19}$') | None
class sparta.twitterapi.models.twitter_v2_spec.LikesComplianceStreamResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[LikesComplianceStreamResponse1, LikesComplianceStreamResponse2]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: LikesComplianceStreamResponse1 | LikesComplianceStreamResponse2
class sparta.twitterapi.models.twitter_v2_spec.LikesComplianceStreamResponse1(*, data: LikeComplianceSchema)

Bases: BaseModel

data: LikeComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.LikesComplianceStreamResponse2(*, errors: Annotated[List[Problem], MinLen(min_length=1)])

Bases: BaseModel

errors: List[Problem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListAddUserRequest(*, user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.ListCreateRequest(*, description: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=0, max_length=100, pattern=None)] | None = None, name: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)], private: bool | None = False)

Bases: BaseModel

description: constr(min_length=0, max_length=100) | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: constr(min_length=1, max_length=25)
private: bool | None
class sparta.twitterapi.models.twitter_v2_spec.ListCreateResponse(*, data: Data6 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data6 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListDeleteResponse(*, data: Data7 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data7 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListFollowedRequest(*, list_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

list_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListFollowedResponse(*, data: Data8 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data8 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListModel(*, created_at: ~datetime.datetime | None = None, description: str | None = None, follower_count: int | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], member_count: int | None = None, name: str, owner_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, private: bool | None = None)

Bases: BaseModel

created_at: datetime | None
description: str | None
follower_count: int | None
id: constr(pattern='^[0-9]{1,19}$')
member_count: int | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
owner_id: constr(pattern='^[0-9]{1,19}$') | None
private: bool | None
class sparta.twitterapi.models.twitter_v2_spec.ListMutateResponse(*, data: Data9 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data9 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListPinnedRequest(*, list_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

list_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListPinnedResponse(*, data: Data10 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data10 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListUnpinResponse(*, data: Data10 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data10 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ListUpdateRequest(*, description: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=0, max_length=100, pattern=None)] | None = None, name: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)] | None = None, private: bool | None = None)

Bases: BaseModel

description: constr(min_length=0, max_length=100) | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: constr(min_length=1, max_length=25) | None
private: bool | None
class sparta.twitterapi.models.twitter_v2_spec.ListUpdateResponse(*, data: Data12 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data12 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MatchingRule(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], tag: str | None = None)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tag: str | None
class sparta.twitterapi.models.twitter_v2_spec.Measurement(*, metrics_time_series: Annotated[List[MetricsTimeSery] | None, MinLen(min_length=1)] = None, metrics_total: Annotated[List[MetricsTotalItem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

metrics_time_series: List[MetricsTimeSery] | None
metrics_total: List[MetricsTotalItem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Media(*, height: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, type: str, width: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None)

Bases: BaseModel

height: conint(ge=0) | None
media_key: constr(pattern='^([0-9]+)_([0-9]+)$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: str
width: conint(ge=0) | None
class sparta.twitterapi.models.twitter_v2_spec.Media1(*, media_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]], ~annotated_types.MinLen(min_length=1), ~annotated_types.MaxLen(max_length=4)], tagged_user_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None, ~annotated_types.MinLen(min_length=0), ~annotated_types.MaxLen(max_length=10)] = None)

Bases: BaseModel

media_ids: List[constr(pattern='^[0-9]{1,19}$')]
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tagged_user_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
class sparta.twitterapi.models.twitter_v2_spec.MediaUploadInitResponse(*, data: Data13 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data13 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MediaUploadStatusResponse(*, data: Data14 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data14 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MentionEntity(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, username: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z0-9_]{1,20}$)], end: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None], start: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: EntityIndicesInclusiveExclusive, MentionFields

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MentionFields(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, username: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z0-9_]{1,20}$)])

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

username: constr(pattern='^[A-Za-z0-9_]{1,20}$')
class sparta.twitterapi.models.twitter_v2_spec.Meta(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
class sparta.twitterapi.models.twitter_v2_spec.Meta1(*, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta11(*, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta12(*, newest_id: str | None = None, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, oldest_id: str | None = None, total_tweet_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

newest_id: str | None
next_token: constr(min_length=1) | None
oldest_id: str | None
total_tweet_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta14(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta15(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta16(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta18(*, newest_id: str | None = None, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, oldest_id: str | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

newest_id: str | None
next_token: constr(min_length=1) | None
oldest_id: str | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta2(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta20(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta27(*, newest_id: str | None = None, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, oldest_id: str | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

newest_id: str | None
next_token: constr(min_length=1) | None
oldest_id: str | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta28(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta30(*, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta31(*, newest_id: str | None = None, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, oldest_id: str | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

newest_id: str | None
next_token: constr(min_length=1) | None
oldest_id: str | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta33(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta34(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
class sparta.twitterapi.models.twitter_v2_spec.Meta8(*, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta9(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, previous_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
previous_token: constr(min_length=1) | None
result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.MetricValue(*, metric_type: str | None = None, metric_value: float | None = None)

Bases: BaseModel

metric_type: str | None
metric_value: float | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MetricsTimeSery(*, tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, value: ~sparta.twitterapi.models.twitter_v2_spec.Value | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_id: constr(pattern='^[0-9]{1,19}$') | None
value: Value | None
class sparta.twitterapi.models.twitter_v2_spec.MetricsTotalItem(*, tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, value: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.ValueItem] | None, ~annotated_types.MinLen(min_length=1)] = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_id: constr(pattern='^[0-9]{1,19}$') | None
value: List[ValueItem] | None
class sparta.twitterapi.models.twitter_v2_spec.MuteUserMutationResponse(*, data: Data15 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data15 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.MuteUserRequest(*, target_user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target_user_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.NewestId(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: str
class sparta.twitterapi.models.twitter_v2_spec.NextToken(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(min_length=1)
class sparta.twitterapi.models.twitter_v2_spec.NonCompliantRulesProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.NonPublicMetrics(*, impression_count: int | None = None)

Bases: BaseModel

impression_count: int | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.NonPublicMetrics1(*, playback_0_count: int | None = None, playback_100_count: int | None = None, playback_25_count: int | None = None, playback_50_count: int | None = None, playback_75_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

playback_0_count: int | None
playback_100_count: int | None
playback_25_count: int | None
playback_50_count: int | None
playback_75_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Note(*, classification: ~sparta.twitterapi.models.twitter_v2_spec.NoteClassification | None = None, created_at: ~datetime.datetime | None = None, deleted: bool | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], rating_status: ~sparta.twitterapi.models.twitter_v2_spec.NoteRatingStatus | None = None, text: str)

Bases: BaseModel

classification: NoteClassification | None
created_at: datetime | None
deleted: bool | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rating_status: NoteRatingStatus | None
text: str
class sparta.twitterapi.models.twitter_v2_spec.NoteClassification(value)

Bases: Enum

An enumeration.

HarmfullyMisleading = 'HarmfullyMisleading'
MisinformedOrPotentiallyMisleading = 'MisinformedOrPotentiallyMisleading'
NotMisleading = 'NotMisleading'
PotentiallyMisleading = 'PotentiallyMisleading'
class sparta.twitterapi.models.twitter_v2_spec.NoteRatingStatus(value)

Bases: Enum

An enumeration.

CurrentlyRatedHelpful = 'CurrentlyRatedHelpful'
CurrentlyRatedNotHelpful = 'CurrentlyRatedNotHelpful'
InsufficientConsensus = 'InsufficientConsensus'
MinimumRatingsNotMet = 'MinimumRatingsNotMet'
NeedsMoreRatings = 'NeedsMoreRatings'
class sparta.twitterapi.models.twitter_v2_spec.NoteTweet(*, entities: Entities | None = None, text: str | None = None)

Bases: BaseModel

entities: Entities | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: str | None
class sparta.twitterapi.models.twitter_v2_spec.Oauth1PermissionsProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.OldestId(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: str
class sparta.twitterapi.models.twitter_v2_spec.OperationalDisconnectProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, disconnect_type: DisconnectType | None = None)

Bases: Problem

disconnect_type: DisconnectType | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.OrganicMetrics(*, impression_count: int, like_count: int, reply_count: int, retweet_count: int)

Bases: BaseModel

impression_count: int
like_count: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reply_count: int
retweet_count: int
class sparta.twitterapi.models.twitter_v2_spec.OrganicMetrics1(*, playback_0_count: int | None = None, playback_100_count: int | None = None, playback_25_count: int | None = None, playback_50_count: int | None = None, playback_75_count: int | None = None, view_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

playback_0_count: int | None
playback_100_count: int | None
playback_25_count: int | None
playback_50_count: int | None
playback_75_count: int | None
view_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.PaginationToken32(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(min_length=16)
class sparta.twitterapi.models.twitter_v2_spec.PaginationToken36(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(min_length=1)
class sparta.twitterapi.models.twitter_v2_spec.PaginationTokenLong(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(min_length=1, max_length=19)
class sparta.twitterapi.models.twitter_v2_spec.Period(value)

Bases: Enum

An enumeration.

Daily = 'Daily'
Monthly = 'Monthly'
class sparta.twitterapi.models.twitter_v2_spec.PersonalizedTrend(*, category: str | None = None, post_count: int | None = None, trend_name: str | None = None, trending_since: str | None = None)

Bases: BaseModel

category: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

post_count: int | None
trend_name: str | None
trending_since: str | None
class sparta.twitterapi.models.twitter_v2_spec.Photo(*, height: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, type: str, width: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, alt_text: str | None = None, url: ~pydantic.networks.AnyUrl | None = None)

Bases: Media

alt_text: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: AnyUrl | None
class sparta.twitterapi.models.twitter_v2_spec.Place(*, contained_within: ~typing.Annotated[~typing.List[str] | None, ~annotated_types.MinLen(min_length=1)] = None, country: str | None = None, country_code: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z]{2}$)] | None = None, full_name: str, geo: ~sparta.twitterapi.models.twitter_v2_spec.Geo | None = None, id: str, name: str | None = None, place_type: ~sparta.twitterapi.models.twitter_v2_spec.PlaceType | None = None)

Bases: BaseModel

contained_within: List[str] | None
country: str | None
country_code: constr(pattern='^[A-Za-z]{2}$') | None
full_name: str
geo: Geo | None
id: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None
place_type: PlaceType | None
class sparta.twitterapi.models.twitter_v2_spec.PlaceType(value)

Bases: Enum

An enumeration.

admin = 'admin'
city = 'city'
country = 'country'
neighborhood = 'neighborhood'
poi = 'poi'
unknown = 'unknown'
class sparta.twitterapi.models.twitter_v2_spec.Point(*, coordinates: List[float], type: Type2)

Bases: BaseModel

coordinates: List[float]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Type2
class sparta.twitterapi.models.twitter_v2_spec.Poll(*, duration_minutes: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=5, lt=None, le=10080), None] | None = None, end_datetime: ~datetime.datetime | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], options: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.PollOption], ~annotated_types.MinLen(min_length=2), ~annotated_types.MaxLen(max_length=4)], voting_status: ~sparta.twitterapi.models.twitter_v2_spec.VotingStatus | None = None)

Bases: BaseModel

duration_minutes: conint(ge=5, le=10080) | None
end_datetime: datetime | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: List[PollOption]
voting_status: VotingStatus | None
class sparta.twitterapi.models.twitter_v2_spec.Poll1(*, duration_minutes: Annotated[int, None, Interval(gt=None, ge=5, lt=None, le=10080), None], options: Annotated[List[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)]], MinLen(min_length=2), MaxLen(max_length=4)], reply_settings: ReplySettings1 | None = None)

Bases: BaseModel

duration_minutes: conint(ge=5, le=10080)
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: List[constr(min_length=1, max_length=25)]
reply_settings: ReplySettings1 | None
class sparta.twitterapi.models.twitter_v2_spec.PollOption(*, label: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)], position: int, votes: int)

Bases: BaseModel

label: constr(min_length=1, max_length=25)
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

position: int
votes: int
class sparta.twitterapi.models.twitter_v2_spec.PreviousToken(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(min_length=1)
class sparta.twitterapi.models.twitter_v2_spec.Problem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: BaseModel

detail: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: int | None
title: str
type: str
class sparta.twitterapi.models.twitter_v2_spec.ProcessingInfo(*, check_after_secs: int | None = None, progress_percent: int | None = None, state: State | None = None)

Bases: BaseModel

check_after_secs: int | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

progress_percent: int | None
state: State | None
class sparta.twitterapi.models.twitter_v2_spec.PromotedMetrics(*, impression_count: int | None = None, like_count: int | None = None, reply_count: int | None = None, retweet_count: int | None = None)

Bases: BaseModel

impression_count: int | None
like_count: int | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reply_count: int | None
retweet_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.PromotedMetrics1(*, playback_0_count: int | None = None, playback_100_count: int | None = None, playback_25_count: int | None = None, playback_50_count: int | None = None, playback_75_count: int | None = None, view_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

playback_0_count: int | None
playback_100_count: int | None
playback_25_count: int | None
playback_50_count: int | None
playback_75_count: int | None
view_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.PublicMetrics(*, bookmark_count: int, impression_count: int, like_count: int, quote_count: int | None = None, reply_count: int, retweet_count: int)

Bases: BaseModel

bookmark_count: int
impression_count: int
like_count: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quote_count: int | None
reply_count: int
retweet_count: int
class sparta.twitterapi.models.twitter_v2_spec.PublicMetrics1(*, followers_count: int, following_count: int, like_count: int | None = None, listed_count: int, tweet_count: int)

Bases: BaseModel

followers_count: int
following_count: int
like_count: int | None
listed_count: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_count: int
class sparta.twitterapi.models.twitter_v2_spec.PublicMetrics2(*, view_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

view_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Reason(value)

Bases: Enum

An enumeration.

client_not_enrolled = 'client-not-enrolled'
official_client_forbidden = 'official-client-forbidden'
class sparta.twitterapi.models.twitter_v2_spec.ReferencedTweet(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ReferencedTweet1(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], type: ~sparta.twitterapi.models.twitter_v2_spec.Type3)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Type3
class sparta.twitterapi.models.twitter_v2_spec.Reply(*, exclude_reply_user_ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None = None, in_reply_to_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

exclude_reply_user_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
in_reply_to_tweet_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.ReplySettings(value)

Bases: Enum

An enumeration.

everyone = 'everyone'
following = 'following'
mentionedUsers = 'mentionedUsers'
other = 'other'
class sparta.twitterapi.models.twitter_v2_spec.ReplySettings1(value)

Bases: Enum

An enumeration.

following = 'following'
mentionedUsers = 'mentionedUsers'
class sparta.twitterapi.models.twitter_v2_spec.ReplySettings2(value)

Bases: Enum

An enumeration.

following = 'following'
mentionedUsers = 'mentionedUsers'
subscribers = 'subscribers'
class sparta.twitterapi.models.twitter_v2_spec.ReplySettingsWithVerifiedUsers(value)

Bases: Enum

An enumeration.

everyone = 'everyone'
following = 'following'
mentionedUsers = 'mentionedUsers'
other = 'other'
subscribers = 'subscribers'
verified = 'verified'
class sparta.twitterapi.models.twitter_v2_spec.ResourceNotFoundProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, parameter: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], resource_id: str, resource_type: ResourceType, value: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameter: constr(min_length=1)
resource_id: str
resource_type: ResourceType
value: str
class sparta.twitterapi.models.twitter_v2_spec.ResourceType(value)

Bases: Enum

An enumeration.

list = 'list'
media = 'media'
space = 'space'
tweet = 'tweet'
user = 'user'
class sparta.twitterapi.models.twitter_v2_spec.ResourceUnauthorizedProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, parameter: str, resource_id: str, resource_type: ResourceType, section: Section, value: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameter: str
resource_id: str
resource_type: ResourceType
section: Section
value: str
class sparta.twitterapi.models.twitter_v2_spec.ResourceUnavailableProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, parameter: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], resource_id: str, resource_type: ResourceType)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameter: constr(min_length=1)
resource_id: str
resource_type: ResourceType
class sparta.twitterapi.models.twitter_v2_spec.ResultCount(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[int]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: int
class sparta.twitterapi.models.twitter_v2_spec.Rule(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, tag: str | None = None, value: str)

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tag: str | None
value: str
class sparta.twitterapi.models.twitter_v2_spec.RuleNoId(*, tag: str | None = None, value: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tag: str | None
value: str
class sparta.twitterapi.models.twitter_v2_spec.RulesCapProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.RulesCount(*, all_project_client_apps: List[AppRulesCount] | None = None, cap_per_client_app: int | None = None, cap_per_project: int | None = None, client_app_rules_count: AppRulesCount | None = None, project_rules_count: int | None = None)

Bases: BaseModel

all_project_client_apps: List[AppRulesCount] | None
cap_per_client_app: int | None
cap_per_project: int | None
client_app_rules_count: AppRulesCount | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_rules_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.RulesLookupResponse(*, data: List[Rule] | None = None, meta: RulesResponseMetadata)

Bases: BaseModel

data: List[Rule] | None
meta: RulesResponseMetadata
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.RulesRequestSummary1(*, created: int, invalid: int, not_created: int, valid: int)

Bases: BaseModel

created: int
invalid: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

not_created: int
valid: int
class sparta.twitterapi.models.twitter_v2_spec.RulesRequestSummary2(*, deleted: int, not_deleted: int)

Bases: BaseModel

deleted: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

not_deleted: int
class sparta.twitterapi.models.twitter_v2_spec.RulesResponseMetadata(*, next_token: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)] | None = None, result_count: int | None = None, sent: str, summary: RulesRequestSummary1 | RulesRequestSummary2 | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_token: constr(min_length=1) | None
result_count: int | None
sent: str
summary: RulesRequestSummary1 | RulesRequestSummary2 | None
class sparta.twitterapi.models.twitter_v2_spec.Scope(value)

Bases: Enum

An enumeration.

tweet = 'tweet'
user = 'user'
class sparta.twitterapi.models.twitter_v2_spec.Scope1(value)

Bases: Enum

An enumeration.

Account = 'Account'
Product = 'Product'
class sparta.twitterapi.models.twitter_v2_spec.Scope2(value)

Bases: Enum

An enumeration.

user = 'user'
class sparta.twitterapi.models.twitter_v2_spec.Scopes(*, followers: bool | None = None)

Bases: BaseModel

followers: bool | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.SearchCount(*, end: datetime, start: datetime, tweet_count: int)

Bases: BaseModel

end: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: datetime
tweet_count: int
class sparta.twitterapi.models.twitter_v2_spec.Section(value)

Bases: Enum

An enumeration.

data = 'data'
includes = 'includes'
class sparta.twitterapi.models.twitter_v2_spec.Space(*, created_at: ~datetime.datetime | None = None, creator_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, ended_at: ~datetime.datetime | None = None, host_ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[a-zA-Z0-9]{1,13}$)], invited_user_ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None = None, is_ticketed: bool | None = None, lang: str | None = None, participant_count: int | None = None, scheduled_start: ~datetime.datetime | None = None, speaker_ids: ~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]] | None = None, started_at: ~datetime.datetime | None = None, state: ~sparta.twitterapi.models.twitter_v2_spec.State1, subscriber_count: int | None = None, title: str | None = None, topics: ~typing.List[~sparta.twitterapi.models.twitter_v2_spec.Topic1] | None = None, updated_at: ~datetime.datetime | None = None)

Bases: BaseModel

created_at: datetime | None
creator_id: constr(pattern='^[0-9]{1,19}$') | None
ended_at: datetime | None
host_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
id: constr(pattern='^[a-zA-Z0-9]{1,13}$')
invited_user_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
is_ticketed: bool | None
lang: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

participant_count: int | None
scheduled_start: datetime | None
speaker_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
started_at: datetime | None
state: State1
subscriber_count: int | None
title: str | None
topics: List[Topic1] | None
updated_at: datetime | None
class sparta.twitterapi.models.twitter_v2_spec.State(value)

Bases: Enum

An enumeration.

failed = 'failed'
in_progress = 'in_progress'
pending = 'pending'
succeeded = 'succeeded'
class sparta.twitterapi.models.twitter_v2_spec.State1(value)

Bases: Enum

An enumeration.

ended = 'ended'
live = 'live'
scheduled = 'scheduled'
class sparta.twitterapi.models.twitter_v2_spec.StreamingLikeResponseV2(*, data: LikeWithTweetAuthor | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: LikeWithTweetAuthor | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.StreamingTweetResponse(*, data: Tweet | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None, includes: Expansions | None = None)

Bases: BaseModel

data: Tweet | None
errors: List[Problem] | None
includes: Expansions | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.SubscriptionType(value)

Bases: Enum

An enumeration.

Basic = 'Basic'
None_ = 'None'
Premium = 'Premium'
PremiumPlus = 'PremiumPlus'
class sparta.twitterapi.models.twitter_v2_spec.Timestamp(*, iso8601_time: str | None = None)

Bases: BaseModel

iso8601_time: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Topic(*, description: str | None = None, id: str, name: str)

Bases: BaseModel

description: str | None
id: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class sparta.twitterapi.models.twitter_v2_spec.Topic1(*, description: str | None = None, id: str, name: str)

Bases: BaseModel

description: str | None
id: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class sparta.twitterapi.models.twitter_v2_spec.Trend(*, trend_name: str | None = None, tweet_count: int | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trend_name: str | None
tweet_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Tweet(*, attachments: ~sparta.twitterapi.models.twitter_v2_spec.Attachments1 | None = None, author_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, community_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, context_annotations: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.ContextAnnotation] | None, ~annotated_types.MinLen(min_length=1)] = None, conversation_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, created_at: ~datetime.datetime | None = None, edit_controls: ~sparta.twitterapi.models.twitter_v2_spec.EditControls | None = None, edit_history_tweet_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)]] | None, ~annotated_types.MinLen(min_length=1)] = None, entities: ~sparta.twitterapi.models.twitter_v2_spec.FullTextEntities | None = None, geo: ~sparta.twitterapi.models.twitter_v2_spec.Geo1 | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, in_reply_to_user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, lang: str | None = None, non_public_metrics: ~sparta.twitterapi.models.twitter_v2_spec.NonPublicMetrics | None = None, note_tweet: ~sparta.twitterapi.models.twitter_v2_spec.NoteTweet | None = None, organic_metrics: ~sparta.twitterapi.models.twitter_v2_spec.OrganicMetrics | None = None, possibly_sensitive: bool | None = None, promoted_metrics: ~sparta.twitterapi.models.twitter_v2_spec.PromotedMetrics | None = None, public_metrics: ~sparta.twitterapi.models.twitter_v2_spec.PublicMetrics | None = None, referenced_tweets: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.ReferencedTweet1] | None, ~annotated_types.MinLen(min_length=1)] = None, reply_settings: ~sparta.twitterapi.models.twitter_v2_spec.ReplySettingsWithVerifiedUsers | None = None, scopes: ~sparta.twitterapi.models.twitter_v2_spec.Scopes | None = None, source: str | None = None, text: str | None = None, username: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z0-9_]{1, 20}$)] | None = None, withheld: ~sparta.twitterapi.models.twitter_v2_spec.TweetWithheld | None = None)

Bases: BaseModel

attachments: Attachments1 | None
author_id: constr(pattern='^[0-9]{1,19}$') | None
community_id: constr(pattern='^[0-9]{1,19}$') | None
context_annotations: List[ContextAnnotation] | None
conversation_id: constr(pattern='^[0-9]{1,19}$') | None
created_at: datetime | None
edit_controls: EditControls | None
edit_history_tweet_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
entities: FullTextEntities | None
geo: Geo1 | None
id: constr(pattern='^[0-9]{1,19}$') | None
in_reply_to_user_id: constr(pattern='^[0-9]{1,19}$') | None
lang: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

non_public_metrics: NonPublicMetrics | None
note_tweet: NoteTweet | None
organic_metrics: OrganicMetrics | None
possibly_sensitive: bool | None
promoted_metrics: PromotedMetrics | None
public_metrics: PublicMetrics | None
referenced_tweets: List[ReferencedTweet1] | None
reply_settings: ReplySettingsWithVerifiedUsers | None
scopes: Scopes | None
source: str | None
text: str | None
username: constr(pattern='^[A-Za-z0-9_]{1,20}$') | None
withheld: TweetWithheld | None
class sparta.twitterapi.models.twitter_v2_spec.Tweet1(*, author_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

author_id: constr(pattern='^[0-9]{1,19}$') | None
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Tweet2(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Tweet3(*, author_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

author_id: constr(pattern='^[0-9]{1,19}$')
id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetComplianceSchema(*, event_at: ~datetime.datetime, quote_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, tweet: ~sparta.twitterapi.models.twitter_v2_spec.Tweet1)

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quote_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
tweet: Tweet1
class sparta.twitterapi.models.twitter_v2_spec.TweetComplianceStreamResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[TweetComplianceStreamResponse1, TweetComplianceStreamResponse2]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: TweetComplianceStreamResponse1 | TweetComplianceStreamResponse2
class sparta.twitterapi.models.twitter_v2_spec.TweetComplianceStreamResponse1(*, data: TweetDeleteComplianceSchema | TweetWithheldComplianceSchema | TweetDropComplianceSchema | TweetUndropComplianceSchema | TweetEditComplianceSchema)

Bases: BaseModel

data: TweetDeleteComplianceSchema | TweetWithheldComplianceSchema | TweetDropComplianceSchema | TweetUndropComplianceSchema | TweetEditComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetComplianceStreamResponse2(*, errors: Annotated[List[Problem], MinLen(min_length=1)])

Bases: BaseModel

errors: List[Problem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetCreateRequest(*, card_uri: str | None = None, community_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, direct_message_deep_link: str | None = None, for_super_followers_only: bool | None = False, geo: ~sparta.twitterapi.models.twitter_v2_spec.Geo2 | None = None, media: ~sparta.twitterapi.models.twitter_v2_spec.Media1 | None = None, nullcast: bool | None = False, poll: ~sparta.twitterapi.models.twitter_v2_spec.Poll1 | None = None, quote_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1, 19}$)] | None = None, reply: ~sparta.twitterapi.models.twitter_v2_spec.Reply | None = None, reply_settings: ~sparta.twitterapi.models.twitter_v2_spec.ReplySettings2 | None = None, text: str | None = None)

Bases: BaseModel

card_uri: str | None
community_id: constr(pattern='^[0-9]{1,19}$') | None
for_super_followers_only: bool | None
geo: Geo2 | None
media: Media1 | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nullcast: bool | None
poll: Poll1 | None
quote_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
reply: Reply | None
reply_settings: ReplySettings2 | None
text: str | None
class sparta.twitterapi.models.twitter_v2_spec.TweetCreateResponse(*, data: Data16 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data16 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetDeleteComplianceSchema(*, delete: TweetComplianceSchema)

Bases: BaseModel

delete: TweetComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetDeleteResponse(*, data: Data17 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data17 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetDropComplianceSchema(*, drop: TweetComplianceSchema)

Bases: BaseModel

drop: TweetComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetEditComplianceObjectSchema(*, edit_tweet_ids: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)]], ~annotated_types.MinLen(min_length=1)], event_at: ~datetime.datetime, initial_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], tweet: ~sparta.twitterapi.models.twitter_v2_spec.Tweet2)

Bases: BaseModel

edit_tweet_ids: List[constr(pattern='^[0-9]{1,19}$')]
event_at: datetime
initial_tweet_id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet: Tweet2
class sparta.twitterapi.models.twitter_v2_spec.TweetEditComplianceSchema(*, tweet_edit: TweetEditComplianceObjectSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_edit: TweetEditComplianceObjectSchema
class sparta.twitterapi.models.twitter_v2_spec.TweetHideRequest(*, hidden: bool)

Bases: BaseModel

hidden: bool
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetHideResponse(*, data: Data18 | None = None)

Bases: BaseModel

data: Data18 | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetId(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.TweetLabelStreamResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[TweetLabelStreamResponse1, TweetLabelStreamResponse2]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: TweetLabelStreamResponse1 | TweetLabelStreamResponse2
class sparta.twitterapi.models.twitter_v2_spec.TweetLabelStreamResponse1(*, data: TweetNoticeSchema | TweetUnviewableSchema)

Bases: BaseModel

data: TweetNoticeSchema | TweetUnviewableSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetLabelStreamResponse2(*, errors: Annotated[List[Problem], MinLen(min_length=1)])

Bases: BaseModel

errors: List[Problem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.TweetNotice(*, application: str, details: str | None = None, event_at: datetime, event_type: str, extended_details_url: str | None = None, label_title: str | None = None, tweet: Tweet3)

Bases: BaseModel

application: str
details: str | None
event_at: datetime
event_type: str
extended_details_url: str | None
label_title: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet: Tweet3
class sparta.twitterapi.models.twitter_v2_spec.TweetNoticeSchema(*, public_tweet_notice: TweetNotice)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

public_tweet_notice: TweetNotice
class sparta.twitterapi.models.twitter_v2_spec.TweetTakedownComplianceSchema(*, event_at: ~datetime.datetime, quote_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, tweet: ~sparta.twitterapi.models.twitter_v2_spec.Tweet3, withheld_in_countries: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z]{2}$)]], ~annotated_types.MinLen(min_length=0)])

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quote_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
tweet: Tweet3
withheld_in_countries: List[constr(pattern='^[A-Za-z]{2}$')]
class sparta.twitterapi.models.twitter_v2_spec.TweetUndropComplianceSchema(*, undrop: TweetComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

undrop: TweetComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.TweetUnviewable(*, application: str, event_at: datetime, tweet: Tweet3)

Bases: BaseModel

application: str
event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet: Tweet3
class sparta.twitterapi.models.twitter_v2_spec.TweetUnviewableSchema(*, public_tweet_unviewable: TweetUnviewable)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

public_tweet_unviewable: TweetUnviewable
class sparta.twitterapi.models.twitter_v2_spec.TweetWithheld(*, copyright: bool, country_codes: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z]{2}$)]], ~annotated_types.MinLen(min_length=1)], scope: ~sparta.twitterapi.models.twitter_v2_spec.Scope | None = None)

Bases: BaseModel

copyright: bool
country_codes: List[constr(pattern='^[A-Za-z]{2}$')]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

scope: Scope | None
class sparta.twitterapi.models.twitter_v2_spec.TweetWithheldComplianceSchema(*, withheld: TweetTakedownComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

withheld: TweetTakedownComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.Type(value)

Bases: Enum

An enumeration.

tweets = 'tweets'
users = 'users'
class sparta.twitterapi.models.twitter_v2_spec.Type1(value)

Bases: Enum

An enumeration.

Feature = 'Feature'
class sparta.twitterapi.models.twitter_v2_spec.Type2(value)

Bases: Enum

An enumeration.

Point = 'Point'
class sparta.twitterapi.models.twitter_v2_spec.Type3(value)

Bases: Enum

An enumeration.

quoted = 'quoted'
replied_to = 'replied_to'
retweeted = 'retweeted'
class sparta.twitterapi.models.twitter_v2_spec.UnlikeComplianceSchema(*, event_at: datetime, favorite: Favorite)

Bases: BaseModel

event_at: datetime
favorite: Favorite
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UnsupportedAuthenticationProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Url1(*, urls: Annotated[List[UrlEntity] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

urls: List[UrlEntity] | None
class sparta.twitterapi.models.twitter_v2_spec.UrlEntity(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic.networks.AnyUrl | None = None, images: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.UrlImage] | None, ~annotated_types.MinLen(min_length=1)] = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, status: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=100, lt=None, le=599), None] | None = None, title: str | None = None, unwound_url: ~pydantic.networks.AnyUrl | None = None, url: str, end: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None], start: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: EntityIndicesInclusiveExclusive, UrlFields

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UrlEntityDm(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic.networks.AnyUrl | None = None, images: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.UrlImage] | None, ~annotated_types.MinLen(min_length=1)] = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, status: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=100, lt=None, le=599), None] | None = None, title: str | None = None, unwound_url: ~pydantic.networks.AnyUrl | None = None, url: str, end: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None], start: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None])

Bases: EntityIndicesInclusiveExclusive, UrlFields

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UrlFields(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic.networks.AnyUrl | None = None, images: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.UrlImage] | None, ~annotated_types.MinLen(min_length=1)] = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, status: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=100, lt=None, le=599), None] | None = None, title: str | None = None, unwound_url: ~pydantic.networks.AnyUrl | None = None, url: str)

Bases: BaseModel

description: str | None
display_url: str | None
expanded_url: AnyUrl | None
images: List[UrlImage] | None
media_key: constr(pattern='^([0-9]+)_([0-9]+)$') | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: conint(ge=100, le=599) | None
title: str | None
unwound_url: AnyUrl | None
url: str
class sparta.twitterapi.models.twitter_v2_spec.UrlImage(*, height: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, url: AnyUrl | None = None, width: Annotated[int, None, Interval(gt=None, ge=0, lt=None, le=None), None] | None = None)

Bases: BaseModel

height: conint(ge=0) | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: AnyUrl | None
width: conint(ge=0) | None
class sparta.twitterapi.models.twitter_v2_spec.Usage(*, cap_reset_day: int | None = None, daily_client_app_usage: Annotated[List[ClientAppUsage] | None, MinLen(min_length=1)] = None, daily_project_usage: DailyProjectUsage | None = None, project_cap: int | None = None, project_id: str | None = None, project_usage: int | None = None)

Bases: BaseModel

cap_reset_day: int | None
daily_client_app_usage: List[ClientAppUsage] | None
daily_project_usage: DailyProjectUsage | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_cap: int | None
project_id: str | None
project_usage: int | None
class sparta.twitterapi.models.twitter_v2_spec.UsageCapExceededProblem(*, detail: str | None = None, status: int | None = None, title: str, type: str, period: Period | None = None, scope: Scope1 | None = None)

Bases: Problem

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

period: Period | None
scope: Scope1 | None
class sparta.twitterapi.models.twitter_v2_spec.UsageFields(*, date: datetime | None = None, usage: int | None = None)

Bases: BaseModel

date: datetime | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

usage: int | None
class sparta.twitterapi.models.twitter_v2_spec.User(*, affiliation: ~sparta.twitterapi.models.twitter_v2_spec.Affiliation | None = None, connection_status: ~typing.Annotated[~typing.List[~sparta.twitterapi.models.twitter_v2_spec.ConnectionStatu] | None, ~annotated_types.MinLen(min_length=0)] = None, created_at: ~datetime.datetime | None = None, description: str | None = None, entities: ~sparta.twitterapi.models.twitter_v2_spec.Entities1 | None = None, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], location: str | None = None, most_recent_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, name: str, pinned_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)] | None = None, profile_banner_url: str | None = None, profile_image_url: str | None = None, protected: bool | None = None, public_metrics: ~sparta.twitterapi.models.twitter_v2_spec.PublicMetrics1 | None = None, receives_your_dm: bool | None = None, subscription_type: ~sparta.twitterapi.models.twitter_v2_spec.SubscriptionType | None = None, url: str | None = None, username: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z0-9_]{1,20}$)], verified: bool | None = None, verified_type: ~sparta.twitterapi.models.twitter_v2_spec.VerifiedType | None = None, withheld: ~sparta.twitterapi.models.twitter_v2_spec.UserWithheld | None = None)

Bases: BaseModel

affiliation: Affiliation | None
connection_status: List[ConnectionStatu] | None
created_at: datetime | None
description: str | None
entities: Entities1 | None
id: constr(pattern='^[0-9]{1,19}$')
location: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

most_recent_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
name: str
pinned_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
profile_banner_url: str | None
profile_image_url: str | None
protected: bool | None
public_metrics: PublicMetrics1 | None
receives_your_dm: bool | None
subscription_type: SubscriptionType | None
url: str | None
username: constr(pattern='^[A-Za-z0-9_]{1,20}$')
verified: bool | None
verified_type: VerifiedType | None
withheld: UserWithheld | None
class sparta.twitterapi.models.twitter_v2_spec.User2(*, id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

id: constr(pattern='^[0-9]{1,19}$')
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UserComplianceSchema(*, event_at: datetime, user: User2)

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user: User2
class sparta.twitterapi.models.twitter_v2_spec.UserComplianceStreamResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[UserComplianceStreamResponse1, UserComplianceStreamResponse2]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: UserComplianceStreamResponse1 | UserComplianceStreamResponse2
class sparta.twitterapi.models.twitter_v2_spec.UserComplianceStreamResponse1(*, data: UserProtectComplianceSchema | UserUnprotectComplianceSchema | UserDeleteComplianceSchema | UserUndeleteComplianceSchema | UserSuspendComplianceSchema | UserUnsuspendComplianceSchema | UserWithheldComplianceSchema | UserScrubGeoSchema | UserProfileModificationComplianceSchema)

Bases: BaseModel

data: UserProtectComplianceSchema | UserUnprotectComplianceSchema | UserDeleteComplianceSchema | UserUndeleteComplianceSchema | UserSuspendComplianceSchema | UserUnsuspendComplianceSchema | UserWithheldComplianceSchema | UserScrubGeoSchema | UserProfileModificationComplianceSchema
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UserComplianceStreamResponse2(*, errors: Annotated[List[Problem], MinLen(min_length=1)])

Bases: BaseModel

errors: List[Problem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UserDeleteComplianceSchema(*, user_delete: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_delete: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserId(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.UserIdMatchesAuthenticatedUser(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: str
class sparta.twitterapi.models.twitter_v2_spec.UserProfileModificationComplianceSchema(*, user_profile_modification: UserProfileModificationObjectSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_profile_modification: UserProfileModificationObjectSchema
class sparta.twitterapi.models.twitter_v2_spec.UserProfileModificationObjectSchema(*, event_at: datetime, new_value: str, profile_field: str, user: User2)

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

new_value: str
profile_field: str
user: User2
class sparta.twitterapi.models.twitter_v2_spec.UserProtectComplianceSchema(*, user_protect: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_protect: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserScrubGeoObjectSchema(*, event_at: ~datetime.datetime, up_to_tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)], user: ~sparta.twitterapi.models.twitter_v2_spec.User2)

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

up_to_tweet_id: constr(pattern='^[0-9]{1,19}$')
user: User2
class sparta.twitterapi.models.twitter_v2_spec.UserScrubGeoSchema(*, scrub_geo: UserScrubGeoObjectSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

scrub_geo: UserScrubGeoObjectSchema
class sparta.twitterapi.models.twitter_v2_spec.UserSearchQueryVnext(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: constr(pattern="^[A-Za-z0-9_\\' ]{1,50}$")
class sparta.twitterapi.models.twitter_v2_spec.UserSuspendComplianceSchema(*, user_suspend: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_suspend: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserTakedownComplianceSchema(*, event_at: ~datetime.datetime, user: ~sparta.twitterapi.models.twitter_v2_spec.User2, withheld_in_countries: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z]{2}$)]], ~annotated_types.MinLen(min_length=0)])

Bases: BaseModel

event_at: datetime
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user: User2
withheld_in_countries: List[constr(pattern='^[A-Za-z]{2}$')]
class sparta.twitterapi.models.twitter_v2_spec.UserUndeleteComplianceSchema(*, user_undelete: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_undelete: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserUnprotectComplianceSchema(*, user_unprotect: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_unprotect: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserUnsuspendComplianceSchema(*, user_unsuspend: UserComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_unsuspend: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserWithheld(*, country_codes: ~typing.Annotated[~typing.List[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[A-Za-z]{2}$)]], ~annotated_types.MinLen(min_length=1)], scope: ~sparta.twitterapi.models.twitter_v2_spec.Scope2 | None = None)

Bases: BaseModel

country_codes: List[constr(pattern='^[A-Za-z]{2}$')]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

scope: Scope2 | None
class sparta.twitterapi.models.twitter_v2_spec.UserWithheldComplianceSchema(*, user_withheld: UserTakedownComplianceSchema)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_withheld: UserTakedownComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UsersDMBlockCreateResponse(*, data: Data19 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data19 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersDMUnBlockCreateResponse(*, data: Data19 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data19 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersFollowingCreateRequest(*, target_user_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target_user_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.UsersFollowingCreateResponse(*, data: Data21 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data21 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersFollowingDeleteResponse(*, data: Data22 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data22 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersLikesCreateRequest(*, tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.UsersLikesCreateResponse(*, data: Data23 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data23 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersLikesDeleteResponse(*, data: Data23 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data23 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersRetweetsCreateRequest(*, tweet_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[0-9]{1,19}$)])

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tweet_id: constr(pattern='^[0-9]{1,19}$')
class sparta.twitterapi.models.twitter_v2_spec.UsersRetweetsCreateResponse(*, data: Data25 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data25 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.UsersRetweetsDeleteResponse(*, data: Data26 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data26 | None
errors: List[Problem] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Value(*, metric_values: List[MetricValue] | None = None, timestamp: Timestamp | None = None)

Bases: BaseModel

metric_values: List[MetricValue] | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: Timestamp | None
class sparta.twitterapi.models.twitter_v2_spec.ValueItem(*, metric_type: str | None = None, metric_value: float | None = None)

Bases: BaseModel

metric_type: str | None
metric_value: float | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class sparta.twitterapi.models.twitter_v2_spec.Variant(*, bit_rate: int | None = None, content_type: str | None = None, url: AnyUrl | None = None)

Bases: BaseModel

bit_rate: int | None
content_type: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: AnyUrl | None
class sparta.twitterapi.models.twitter_v2_spec.VerifiedType(value)

Bases: Enum

An enumeration.

blue = 'blue'
business = 'business'
government = 'government'
none = 'none'
class sparta.twitterapi.models.twitter_v2_spec.Video(*, height: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, media_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^([0-9]+)_([0-9]+)$)] | None = None, type: str, width: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=0, lt=None, le=None), None] | None = None, duration_ms: int | None = None, non_public_metrics: ~sparta.twitterapi.models.twitter_v2_spec.NonPublicMetrics1 | None = None, organic_metrics: ~sparta.twitterapi.models.twitter_v2_spec.OrganicMetrics1 | None = None, preview_image_url: ~pydantic.networks.AnyUrl | None = None, promoted_metrics: ~sparta.twitterapi.models.twitter_v2_spec.PromotedMetrics1 | None = None, public_metrics: ~sparta.twitterapi.models.twitter_v2_spec.PublicMetrics2 | None = None, variants: ~typing.List[~sparta.twitterapi.models.twitter_v2_spec.Variant] | None = None)

Bases: Media

duration_ms: int | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

non_public_metrics: NonPublicMetrics1 | None
organic_metrics: OrganicMetrics1 | None
preview_image_url: AnyUrl | None
promoted_metrics: PromotedMetrics1 | None
public_metrics: PublicMetrics2 | None
variants: List[Variant] | None
class sparta.twitterapi.models.twitter_v2_spec.VotingStatus(value)

Bases: Enum

An enumeration.

closed = 'closed'
open = 'open'