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]

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

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)

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

Bases: RootModel[Union[AddRulesRequest, DeleteRulesRequest]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=Union[AddRulesRequest, DeleteRulesRequest], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Rule], NoneType], required=False, default=None, description='All user-specified stream filtering rules that were created.'), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'meta': FieldInfo(annotation=RulesResponseMetadata, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

add: List[RuleNoId]
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'add': FieldInfo(annotation=List[RuleNoId], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.Affiliation(*, badge_url: ~pydantic_core._pydantic_core.Url | None = None, description: str | None = None, url: ~pydantic_core._pydantic_core.Url | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'badge_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='The badge URL corresponding to the affiliation.'), 'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The description of the affiliation.'), 'url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='The URL, if available, to details about an affiliation.'), 'user_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=int, required=True, description='The sum of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_core._pydantic_core.Url | None = None, variants: ~typing.List[~sparta.twitterapi.models.twitter_v2_spec.Variant] | None = None)

Bases: Media

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'height': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The height of the media in pixels.'), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'preview_image_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None), 'type': FieldInfo(annotation=str, required=True), 'variants': FieldInfo(annotation=Union[List[Variant], NoneType], required=False, default=None, description='An array of all available variants of the media.'), 'width': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The width of the media in pixels.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is inclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'normalized_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Text used to determine annotation.', examples=['Barack Obama']), 'probability': FieldInfo(annotation=Union[Annotated[float, NoneType, Interval, NoneType, NoneType], NoneType], required=False, default=None, description='Confidence factor for annotation type.'), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Annotation type.', examples=['Person'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'client_app_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The ID of the client application'), 'rule_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of rules for client application')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'card_ids': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, description='A list of card IDs (if cards are attached).', metadata=[MinLen(min_length=1)]), 'media_keys': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of Media Keys for each one of the media attachments (if media are attached).', metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'media_keys': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of Media Keys for each one of the media attachments (if media are attached).', metadata=[MinLen(min_length=1)]), 'media_source_tweet_id': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of Posts the media on this Tweet was originally posted in. For example, if the media on a tweet is re-used in another Tweet, this refers to the original, source Tweet..', metadata=[MinLen(min_length=1)]), 'poll_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of poll IDs (if polls are attached).', metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'tag': FieldInfo(annotation=str, required=True, examples=['TWTR'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tag': FieldInfo(annotation=str, required=True, examples=['TWTR'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'client_app_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The unique identifier for this project'), 'usage': FieldInfo(annotation=Union[List[UsageFields], NoneType], required=False, default=None, description='The usage value', metadata=[MinLen(min_length=1)]), 'usage_result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Url | None = None)

Bases: Problem

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'reason': FieldInfo(annotation=Union[Reason, NoneType], required=False, default=None), 'registration_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

reason: Reason | None
registration_url: AnyUrl | None
class sparta.twitterapi.models.twitter_v2_spec.ComplianceJob(*, created_at: ~pydantic.types.AwareDatetime, download_expires_at: ~pydantic.types.AwareDatetime, download_url: ~pydantic_core._pydantic_core.Url, 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: ~pydantic.types.AwareDatetime, upload_url: ~pydantic_core._pydantic_core.Url)

Bases: BaseModel

created_at: AwareDatetime
download_expires_at: AwareDatetime
download_url: AnyUrl
id: constr(pattern='^[0-9]{1,19}$')
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created_at': FieldInfo(annotation=AwareDatetime, required=True, description='Creation time of the compliance job.', examples=['2021-01-06T18:40:40.000Z']), 'download_expires_at': FieldInfo(annotation=AwareDatetime, required=True, description='Expiration time of the download URL.', examples=['2021-01-06T18:40:40.000Z']), 'download_url': FieldInfo(annotation=Url, required=True, description='URL from which the user will retrieve their compliance results.'), 'id': FieldInfo(annotation=str, required=True, description='Compliance Job ID.', examples=['1372966999991541762'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'name': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='User-provided name for a compliance job.', examples=['my-job']), 'status': FieldInfo(annotation=ComplianceJobStatus, required=True), 'type': FieldInfo(annotation=ComplianceJobType, required=True), 'upload_expires_at': FieldInfo(annotation=AwareDatetime, required=True, description='Expiration time of the upload URL.', examples=['2021-01-06T18:40:40.000Z']), 'upload_url': FieldInfo(annotation=Url, required=True, description='URL to which the user will upload their Tweet or user IDs.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

name: constr(max_length=64) | None
status: ComplianceJobStatus
type: ComplianceJobType
upload_expires_at: AwareDatetime
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'connection_issue': FieldInfo(annotation=Union[ConnectionIssue, NoneType], required=False, default=None), 'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'domain': FieldInfo(annotation=ContextAnnotationDomainFields, required=True), 'entity': FieldInfo(annotation=ContextAnnotationEntityFields, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Description of the context annotation domain.'), 'id': FieldInfo(annotation=str, required=True, description='The unique id for a context annotation domain.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Name of the context annotation domain.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Description of the context annotation entity.'), 'id': FieldInfo(annotation=str, required=True, description='The unique id for a context annotation entity.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Name of the context annotation entity.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=List[DmMediaAttachment], required=True, description='Attachments to a DM Event.'), 'text': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Text of the message.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'name': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='User-provided name for a compliance job.', examples=['my-job']), 'resumable': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='If true, this endpoint will return a pre-signed URL with resumable uploads enabled.'), 'type': FieldInfo(annotation=Type, required=True, description='Type of compliance job to list.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[ComplianceJob, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'conversation_type': FieldInfo(annotation=ConversationType, required=True, description='The conversation type that is being created.'), 'message': FieldInfo(annotation=Union[CreateTextMessageRequest, CreateAttachmentsMessageRequest], required=True), 'participant_ids': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, description='Participants for the DM Conversation.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data1 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data1, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[List[DmMediaAttachment], NoneType], required=False, default=None, description='Attachments to a DM Event.'), 'text': FieldInfo(annotation=str, required=True, description='Text of the message.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'project_id': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The unique identifier for this project'), 'usage': FieldInfo(annotation=Union[List[UsageFields], NoneType], required=False, default=None, description='The usage value', metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

project_id: int | None
usage: List[UsageFields] | None
class sparta.twitterapi.models.twitter_v2_spec.Data(*, bookmarked: bool | None = None)

Bases: BaseModel

bookmarked: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'bookmarked': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.Data1(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'dm_conversation_id': FieldInfo(annotation=str, required=True, description="Unique identifier of a DM conversation. This can either be a numeric string, or a pair of numeric strings separated by a '-' character in the case of one-on-one DM Conversations.", examples=['123123123-456456456'], metadata=[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': FieldInfo(annotation=str, required=True, description='Unique identifier of a DM Event.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'muting': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

muting: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data11(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'text': FieldInfo(annotation=str, required=True, description='The content of the Tweet.', examples=['Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

deleted: bool
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'deleted': FieldInfo(annotation=bool, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

hidden: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'hidden': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

blocked: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'blocked': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

following: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'following': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'pending_follow': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

following: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'following': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

liked: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'liked': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

deleted: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'deleted': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.Data20(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'retweeted': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'retweeted': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

retweeted: bool | None
class sparta.twitterapi.models.twitter_v2_spec.Data3(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='The unique identifier of this List.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'name': FieldInfo(annotation=str, required=True, description='The name of this List.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

following: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'following': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

is_member: bool | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'is_member': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'pinned': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'updated': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

updated: bool | None
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='IDs of all deleted user-specified stream filtering rules.'), 'values': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, description='Values of all deleted user-specified stream filtering rules.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data2 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data2, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

delete: Delete
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'delete': FieldInfo(annotation=Delete, required=True, description='IDs and values of all deleted user-specified stream filtering rules.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'resource_id': FieldInfo(annotation=str, required=True), 'resource_type': FieldInfo(annotation=ResourceType, required=True), 'section': FieldInfo(annotation=Section, required=True), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: ~pydantic.types.AwareDatetime | 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: AwareDatetime | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[Attachments, NoneType], required=False, default=None, description='Specifies the type of attachments (if any) present in this DM.'), 'cashtags': FieldInfo(annotation=Union[List[CashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None), 'dm_conversation_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description="Unique identifier of a DM conversation. This can either be a numeric string, or a pair of numeric strings separated by a '-' character in the case of one-on-one DM Conversations.", examples=['123123123-456456456']), 'event_type': FieldInfo(annotation=str, required=True, examples=['MessageCreate']), 'hashtags': FieldInfo(annotation=Union[List[HashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of a DM Event.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'mentions': FieldInfo(annotation=Union[List[MentionEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'participant_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of participants for a ParticipantsJoin or ParticipantsLeave event_type.', metadata=[MinLen(min_length=1)]), 'referenced_tweets': FieldInfo(annotation=Union[List[ReferencedTweet], NoneType], required=False, default=None, description='A list of Posts this DM refers to.', metadata=[MinLen(min_length=1)]), 'sender_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'urls': FieldInfo(annotation=Union[List[UrlEntityDm], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'media_id': FieldInfo(annotation=str, required=True, description='The unique identifier of this Media.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True), 'value': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

editable_until: AwareDatetime
edits_remaining: int
is_edit_eligible: bool
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'editable_until': FieldInfo(annotation=AwareDatetime, required=True, description='Time when Tweet is no longer editable.', examples=['2021-01-06T18:40:40.000Z']), 'edits_remaining': FieldInfo(annotation=int, required=True, description='Number of times this Tweet can be edited.'), 'is_edit_eligible': FieldInfo(annotation=bool, required=True, description='Indicates if this Tweet is eligible to be edited.', examples=[False])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=Union[List[Error], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'measurement': FieldInfo(annotation=Union[Measurement, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'cashtags': FieldInfo(annotation=Union[List[CashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'hashtags': FieldInfo(annotation=Union[List[HashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'mentions': FieldInfo(annotation=Union[List[MentionEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'urls': FieldInfo(annotation=Union[List[UrlEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[FullTextEntities, NoneType], required=False, default=None), 'url': FieldInfo(annotation=Union[Url1, NoneType], required=False, default=None, description="Expanded details for the URL specified in the User's profile, with start and end indices.")}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is inclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'error': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tweets': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

code: int
message: str
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'code': FieldInfo(annotation=int, required=True), 'message': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'message': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'parameters': FieldInfo(annotation=Union[Dict[str, List[str]], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'media': FieldInfo(annotation=Union[List[Media], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'places': FieldInfo(annotation=Union[List[Place], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'polls': FieldInfo(annotation=Union[List[Poll], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'topics': FieldInfo(annotation=Union[List[Topic], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'tweets': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'users': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[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': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'field': FieldInfo(annotation=str, required=True), 'resource_type': FieldInfo(annotation=ResourceType, required=True), 'section': FieldInfo(annotation=Section, required=True), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'matching_rules': FieldInfo(annotation=Union[List[MatchingRule], NoneType], required=False, default=None, description='The list of rules which matched the Tweet')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'annotations': FieldInfo(annotation=Union[List[Annotation], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'cashtags': FieldInfo(annotation=Union[List[CashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'hashtags': FieldInfo(annotation=Union[List[HashtagEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'mentions': FieldInfo(annotation=Union[List[MentionEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'urls': FieldInfo(annotation=Union[List[UrlEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'bbox': FieldInfo(annotation=List[Annotated[float, NoneType, Interval, NoneType, NoneType]], required=True, examples=[[-105.193475, 39.60973, -105.053164, 39.761974]], metadata=[MinLen(min_length=4), MaxLen(max_length=4)]), 'geometry': FieldInfo(annotation=Union[Point, NoneType], required=False, default=None), 'properties': FieldInfo(annotation=Dict[str, Any], required=True), 'type': FieldInfo(annotation=Type1, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'coordinates': FieldInfo(annotation=Union[Point, NoneType], required=False, default=None), 'place_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The identifier for this place.', examples=['f7eb2fa2fea288b1'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'place_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

place_id: str | None
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[ComplianceJob, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta | None = None)

Bases: BaseModel

data: List[ComplianceJob] | None
errors: List[Problem] | None
meta: Meta | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[ComplianceJob], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[DmEvent], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[DmEvent], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[DmEvent, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[DmEvent] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[DmEvent], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Engagement], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Engagement], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[LikeWithTweetAuthor, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[LikeWithTweetAuthor, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[ListModel, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta1 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta1, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta7 | None = None)

Bases: BaseModel

data: List[Space] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta7 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Space], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta7, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta8 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta8 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta8, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Space, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta8 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta8 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta8, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Space], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta10 | None = None)

Bases: BaseModel

data: List[Space] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta10 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Space], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta10, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Trend], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta11 | None = None)

Bases: BaseModel

data: List[SearchCount] | None
errors: List[Problem] | None
meta: Meta11 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[SearchCount], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'meta': FieldInfo(annotation=Union[Meta11, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta11 | None = None)

Bases: BaseModel

data: List[SearchCount] | None
errors: List[Problem] | None
meta: Meta11 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[SearchCount], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'meta': FieldInfo(annotation=Union[Meta11, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta13 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta13 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta13, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta14 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta14 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta14, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta15 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta15 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta15, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta15 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta15 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta15, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta17 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta17 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta17, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta17 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta17 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta17, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[RulesCount, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Usage, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[User, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[ListModel], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta19 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta19 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[ListModel], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta19, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta26 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta26 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta26, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta27 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta27 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta27, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta27 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta27 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[ListModel], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta27, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta29 | None = None)

Bases: BaseModel

data: List[ListModel] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta29 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[ListModel], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta29, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[User, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta30 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta30 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta30, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta30 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta30 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta30, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[User, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta32 | None = None)

Bases: BaseModel

data: List[Tweet] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta32 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Tweet], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta32, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Meta33 | None = None)

Bases: BaseModel

data: List[User] | None
errors: List[Problem] | None
includes: Expansions | None
meta: Meta33 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[User], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=Union[Meta33, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'tag': FieldInfo(annotation=str, required=True, description='The text of the Hashtag.', examples=['MondayMotivation'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tag': FieldInfo(annotation=str, required=True, description='The text of the Hashtag.', examples=['MondayMotivation'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Error2], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: Problem

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

delete: UnlikeComplianceSchema
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'delete': FieldInfo(annotation=UnlikeComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.LikeWithTweetAuthor(*, created_at: ~pydantic.types.AwareDatetime | 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: AwareDatetime | None
id: constr(pattern='^[A-Za-z0-9_]{1,40}$') | None
liked_tweet_id: constr(pattern='^[0-9]{1,19}$') | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='Creation time of the Tweet.', examples=['2021-01-06T18:40:40.000Z']), 'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The unique identifier of this Like.', examples=['8ba4f34e6235d905a46bac021d98e923']), 'liked_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'timestamp_ms': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Timestamp in milliseconds of creation.'), 'tweet_author_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=Union[LikesComplianceStreamResponse1, LikesComplianceStreamResponse2], required=True, description='Likes compliance stream events.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: LikeComplianceSchema
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=LikeComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

errors: List[Problem]
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=List[Problem], required=True, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None), 'name': FieldInfo(annotation=str, required=True, metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)]), 'private': FieldInfo(annotation=Union[bool, NoneType], required=False, default=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data3 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data3, NoneType], required=False, default=None, description='A X List is a curated group of accounts.'), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data2 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data2, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'list_id': FieldInfo(annotation=str, required=True, description='The unique identifier of this List.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data5 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data5, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.ListModel(*, created_at: ~pydantic.types.AwareDatetime | 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: AwareDatetime | None
description: str | None
follower_count: int | None
id: constr(pattern='^[0-9]{1,19}$')
member_count: int | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None), 'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'follower_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'id': FieldInfo(annotation=str, required=True, description='The unique identifier of this List.', examples=['1146654567674912769'], metadata=[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': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'name': FieldInfo(annotation=str, required=True, description='The name of this List.'), 'owner_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'private': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data6 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data6, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'list_id': FieldInfo(annotation=str, required=True, description='The unique identifier of this List.', examples=['1146654567674912769'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data7 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data7, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data7 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data7, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None), 'name': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None), 'private': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data9 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data9, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this rule.', examples=['120897978112909812'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'tag': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='A tag meant for the labeling of user provided rules.', examples=['Non-retweeted coffee Posts'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'metrics_time_series': FieldInfo(annotation=Union[List[MetricsTimeSery], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'metrics_total': FieldInfo(annotation=Union[List[MetricsTotalItem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'height': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The height of the media in pixels.'), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'type': FieldInfo(annotation=str, required=True), 'width': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The width of the media in pixels.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'media_ids': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, description='A list of Media Ids to be attached to a created Tweet.', metadata=[MinLen(min_length=1), MaxLen(max_length=4)]), 'tagged_user_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of User Ids to be tagged in the media for created Tweet.', metadata=[MinLen(min_length=0), MaxLen(max_length=10)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

tagged_user_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'username': FieldInfo(annotation=str, required=True, description='The X handle (screen name) of this user.', metadata=[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}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'username': FieldInfo(annotation=str, required=True, description='The X handle (screen name) of this user.', metadata=[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}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

username: constr(pattern='^[A-Za-z0-9_]{1,20}$')
class sparta.twitterapi.models.twitter_v2_spec.Meta(*, result_count: int | None = None)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta1(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta10(*, result_count: int | None = None)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta11(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'newest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The newest id in this response.'), 'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'oldest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The oldest id in this response.'), 'total_tweet_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The sum of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta13(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.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, result_count: int | None = None)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

next_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, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta17(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'newest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The newest id in this response.'), 'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'oldest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The oldest id in this response.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta19(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta26(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'newest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The newest id in this response.'), 'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'oldest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The oldest id in this response.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta27(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta29(*, result_count: int | None = None)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta30(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'newest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The newest id in this response.'), 'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'oldest_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The oldest id in this response.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.Meta32(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.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)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

result_count: int | None
class sparta.twitterapi.models.twitter_v2_spec.Meta8(*, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'previous_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The previous token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'metric_type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'metric_value': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'value': FieldInfo(annotation=Union[Value, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'value': FieldInfo(annotation=Union[List[ValueItem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data10 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data10, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'target_user_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[str]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='The newest id in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='The next token.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

impression_count: int | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'impression_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been viewed.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'playback_0_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 0% of the video.'), 'playback_100_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 100% of the video.'), 'playback_25_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 25% of the video.'), 'playback_50_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 50% of the video.'), 'playback_75_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 75% of the video.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.NoteTweet(*, entities: Entities | None = None, text: str | None = None)

Bases: BaseModel

entities: Entities | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'entities': FieldInfo(annotation=Union[Entities, NoneType], required=False, default=None), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The note content of the Tweet.', examples=['Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[str]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='The oldest id in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'disconnect_type': FieldInfo(annotation=Union[DisconnectType, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'impression_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been viewed.'), 'like_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been liked.'), 'reply_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been replied to.'), 'retweet_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been Retweeted.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'playback_0_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 0% of the video.'), 'playback_100_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 100% of the video.'), 'playback_25_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 25% of the video.'), 'playback_50_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 50% of the video.'), 'playback_75_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 75% of the video.'), 'view_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this video has been viewed.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='A base32 pagination token.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=16, max_length=None, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='A base36 pagination token.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description="A 'long' pagination token.", metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=19, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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.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_core._pydantic_core.Url | None = None)

Bases: Media

alt_text: str | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'alt_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'height': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The height of the media in pixels.'), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'type': FieldInfo(annotation=str, required=True), 'url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None), 'width': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The width of the media in pixels.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'contained_within': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The full name of the county in which this place exists.', examples=['United States']), 'country_code': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='A two-letter ISO 3166-1 alpha-2 country code.', examples=['US']), 'full_name': FieldInfo(annotation=str, required=True, description='The full name of this place.', examples=['Lakewood, CO']), 'geo': FieldInfo(annotation=Union[Geo, NoneType], required=False, default=None), 'id': FieldInfo(annotation=str, required=True, description='The identifier for this place.', examples=['f7eb2fa2fea288b1']), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The human readable name of this place.', examples=['Lakewood']), 'place_type': FieldInfo(annotation=Union[PlaceType, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'coordinates': FieldInfo(annotation=List[float], required=True, description='A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`.', examples=[[-105.18816086351444, 40.247749999999996]]), 'type': FieldInfo(annotation=Type2, required=True, examples=['Point'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: ~pydantic.types.AwareDatetime | 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: AwareDatetime | None
id: constr(pattern='^[0-9]{1,19}$')
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'duration_minutes': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None), 'end_datetime': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this poll.', examples=['1365059861688410112'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'options': FieldInfo(annotation=List[PollOption], required=True, metadata=[MinLen(min_length=2), MaxLen(max_length=4)]), 'voting_status': FieldInfo(annotation=Union[VotingStatus, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'duration_minutes': FieldInfo(annotation=int, required=True, description='Duration of the poll in minutes.', metadata=[None, Interval(gt=None, ge=5, lt=None, le=10080), None]), 'options': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, metadata=[MinLen(min_length=2), MaxLen(max_length=4)]), 'reply_settings': FieldInfo(annotation=Union[ReplySettings1, NoneType], required=False, default=None, description='Settings to indicate who can reply to the Tweet.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'label': FieldInfo(annotation=str, required=True, description='The text of a poll choice.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=25, pattern=None)]), 'position': FieldInfo(annotation=int, required=True, description='Position of this choice in the poll.'), 'votes': FieldInfo(annotation=int, required=True, description='Number of users who voted for this choice.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='The previous token.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

status: int | None
title: str
type: str
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'impression_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been viewed.'), 'like_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been liked.'), 'reply_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been replied to.'), 'retweet_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been Retweeted.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'playback_0_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 0% of the video.'), 'playback_100_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 100% of the video.'), 'playback_25_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 25% of the video.'), 'playback_50_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 50% of the video.'), 'playback_75_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of users who made it through 75% of the video.'), 'view_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this video has been viewed.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'bookmark_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been bookmarked.'), 'impression_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been viewed.'), 'like_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been liked.'), 'quote_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this Tweet has been quoted.'), 'reply_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been replied to.'), 'retweet_count': FieldInfo(annotation=int, required=True, description='Number of times this Tweet has been Retweeted.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'followers_count': FieldInfo(annotation=int, required=True, description='Number of Users who are following this User.'), 'following_count': FieldInfo(annotation=int, required=True, description='Number of Users this User is following.'), 'like_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of likes created by this User.'), 'listed_count': FieldInfo(annotation=int, required=True, description='The number of lists that include this User.'), 'tweet_count': FieldInfo(annotation=int, required=True, description='The number of Posts (including Retweets) posted by this User.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'view_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of times this video has been viewed.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'type': FieldInfo(annotation=Type3, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'exclude_reply_user_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of User Ids to be excluded from the reply Tweet.'), 'in_reply_to_tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'parameter': FieldInfo(annotation=str, required=True, metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]), 'resource_id': FieldInfo(annotation=str, required=True), 'resource_type': FieldInfo(annotation=ResourceType, required=True), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True), 'value': FieldInfo(annotation=str, required=True, description='Value will match the schema of the field.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'parameter': FieldInfo(annotation=str, required=True), 'resource_id': FieldInfo(annotation=str, required=True), 'resource_type': FieldInfo(annotation=ResourceType, required=True), 'section': FieldInfo(annotation=Section, required=True), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True), 'value': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'parameter': FieldInfo(annotation=str, required=True, metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]), 'resource_id': FieldInfo(annotation=str, required=True), 'resource_type': FieldInfo(annotation=ResourceType, required=True), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=int, required=True, description='The number of results returned in this response.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this rule.', examples=['120897978112909812']), 'tag': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='A tag meant for the labeling of user provided rules.', examples=['Non-retweeted coffee Posts']), 'value': FieldInfo(annotation=str, required=True, description='The filterlang value of the rule.', examples=['coffee -is:retweet'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tag': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='A tag meant for the labeling of user provided rules.', examples=['Non-retweeted coffee Posts']), 'value': FieldInfo(annotation=str, required=True, description='The filterlang value of the rule.', examples=['coffee -is:retweet'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'all_project_client_apps': FieldInfo(annotation=Union[List[AppRulesCount], NoneType], required=False, default=None, description='Client App Rule Counts for all applications in the project'), 'cap_per_client_app': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Cap of number of rules allowed per client application'), 'cap_per_project': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Cap of number of rules allowed per project'), 'client_app_rules_count': FieldInfo(annotation=Union[AppRulesCount, NoneType], required=False, default=None), 'project_rules_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of rules for project')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[List[Rule], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=RulesResponseMetadata, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

created: int
invalid: int
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created': FieldInfo(annotation=int, required=True, description='Number of user-specified stream filtering rules that were created.', examples=[1]), 'invalid': FieldInfo(annotation=int, required=True, description='Number of invalid user-specified stream filtering rules.', examples=[1]), 'not_created': FieldInfo(annotation=int, required=True, description='Number of user-specified stream filtering rules that were not created.', examples=[1]), 'valid': FieldInfo(annotation=int, required=True, description='Number of valid user-specified stream filtering rules.', examples=[1])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

deleted: int
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'deleted': FieldInfo(annotation=int, required=True, description='Number of user-specified stream filtering rules that were deleted.'), 'not_deleted': FieldInfo(annotation=int, required=True, description='Number of user-specified stream filtering rules that were not deleted.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'next_token': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The next token.'), 'result_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of Rules in result set.'), 'sent': FieldInfo(annotation=str, required=True), 'summary': FieldInfo(annotation=Union[RulesRequestSummary1, RulesRequestSummary2, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'followers': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Indicates if this Tweet is viewable by followers without the Tweet ID', examples=[False])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

end: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'end': FieldInfo(annotation=AwareDatetime, required=True, description='The end time of the bucket.'), 'start': FieldInfo(annotation=AwareDatetime, required=True, description='The start time of the bucket.'), 'tweet_count': FieldInfo(annotation=int, required=True, description='The count for the bucket.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

start: AwareDatetime
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: ~pydantic.types.AwareDatetime | 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: ~pydantic.types.AwareDatetime | 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: ~pydantic.types.AwareDatetime | 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: ~pydantic.types.AwareDatetime | None = None, state: ~sparta.twitterapi.models.twitter_v2_spec.State, subscriber_count: int | None = None, title: str | None = None, topics: ~typing.List[~sparta.twitterapi.models.twitter_v2_spec.Topic1] | None = None, updated_at: ~pydantic.types.AwareDatetime | None = None)

Bases: BaseModel

created_at: AwareDatetime | None
creator_id: constr(pattern='^[0-9]{1,19}$') | None
ended_at: AwareDatetime | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='Creation time of the Space.', examples=['2021-07-06T18:40:40.000Z']), 'creator_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'ended_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='End time of the Space.', examples=['2021-07-06T18:40:40.000Z']), 'host_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='The user ids for the hosts of the Space.'), 'id': FieldInfo(annotation=str, required=True, description='The unique identifier of this Space.', examples=['1SLjjRYNejbKM'], metadata=[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': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='An array of user ids for people who were invited to a Space.'), 'is_ticketed': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Denotes if the Space is a ticketed Space.', examples=['false']), 'lang': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The language of the Space.', examples=['en']), 'participant_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of participants in a Space.', examples=[10]), 'scheduled_start': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='A date time stamp for when a Space is scheduled to begin.', examples=['2021-07-06T18:40:40.000Z']), 'speaker_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='An array of user ids for people who were speakers in a Space.'), 'started_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='When the Space was started as a date string.', examples=['2021-7-14T04:35:55Z']), 'state': FieldInfo(annotation=State, required=True, description='The current state of the Space.', examples=['live']), 'subscriber_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of people who have either purchased a ticket or set a reminder for this Space.', examples=[10]), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The title of the Space.', examples=['Spaces are Awesome']), 'topics': FieldInfo(annotation=Union[List[Topic1], NoneType], required=False, default=None, description='The topics of a Space, as selected by its creator.'), 'updated_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='When the Space was last updated.', examples=['2021-7-14T04:35:55Z'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

participant_count: int | None
scheduled_start: AwareDatetime | None
speaker_ids: List[constr(pattern='^[0-9]{1,19}$')] | None
started_at: AwareDatetime | None
state: State
subscriber_count: int | None
title: str | None
topics: List[Topic1] | None
updated_at: AwareDatetime | None
class sparta.twitterapi.models.twitter_v2_spec.State(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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[LikeWithTweetAuthor, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Tweet, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'includes': FieldInfo(annotation=Union[Expansions, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'iso8601_time': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

description: str | None
id: str
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The description of the given topic.', examples=['All about technology']), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Topic.'), 'name': FieldInfo(annotation=str, required=True, description='The name of the given topic.', examples=['Technology'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The description of the given topic.'), 'id': FieldInfo(annotation=str, required=True, description='An ID suitable for use in the REST API.'), 'name': FieldInfo(annotation=str, required=True, description='The name of the given topic.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'trend_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Name of the trend.'), 'tweet_count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of Posts in this trend.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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, 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: ~pydantic.types.AwareDatetime | 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
context_annotations: List[ContextAnnotation] | None
conversation_id: constr(pattern='^[0-9]{1,19}$') | None
created_at: AwareDatetime | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[Attachments1, NoneType], required=False, default=None, description='Specifies the type of attachments (if any) present in this Tweet.'), 'author_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'context_annotations': FieldInfo(annotation=Union[List[ContextAnnotation], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'conversation_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='Creation time of the Tweet.', examples=['2021-01-06T18:40:40.000Z']), 'edit_controls': FieldInfo(annotation=Union[EditControls, NoneType], required=False, default=None), 'edit_history_tweet_ids': FieldInfo(annotation=Union[List[Annotated[str, StringConstraints]], NoneType], required=False, default=None, description='A list of Tweet Ids in this Tweet chain.', metadata=[MinLen(min_length=1)]), 'entities': FieldInfo(annotation=Union[FullTextEntities, NoneType], required=False, default=None), 'geo': FieldInfo(annotation=Union[Geo1, NoneType], required=False, default=None, description='The location tagged on the Tweet, if the user provided one.'), 'id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'in_reply_to_user_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945']), 'lang': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Language of the Tweet, if detected by X. Returned as a BCP47 language tag.', examples=['en']), 'non_public_metrics': FieldInfo(annotation=Union[NonPublicMetrics, NoneType], required=False, default=None, description='Nonpublic engagement metrics for the Tweet at the time of the request.'), 'note_tweet': FieldInfo(annotation=Union[NoteTweet, NoneType], required=False, default=None, description='The full-content of the Tweet, including text beyond 280 characters.'), 'organic_metrics': FieldInfo(annotation=Union[OrganicMetrics, NoneType], required=False, default=None, description='Organic nonpublic engagement metrics for the Tweet at the time of the request.'), 'possibly_sensitive': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.', examples=[False]), 'promoted_metrics': FieldInfo(annotation=Union[PromotedMetrics, NoneType], required=False, default=None, description='Promoted nonpublic engagement metrics for the Tweet at the time of the request.'), 'public_metrics': FieldInfo(annotation=Union[PublicMetrics, NoneType], required=False, default=None, description='Engagement metrics for the Tweet at the time of the request.'), 'referenced_tweets': FieldInfo(annotation=Union[List[ReferencedTweet1], NoneType], required=False, default=None, description='A list of Posts this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.', metadata=[MinLen(min_length=1)]), 'reply_settings': FieldInfo(annotation=Union[ReplySettingsWithVerifiedUsers, NoneType], required=False, default=None), 'scopes': FieldInfo(annotation=Union[Scopes, NoneType], required=False, default=None, description='The scopes for this tweet'), 'source': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='This is deprecated.'), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The content of the Tweet.', examples=['Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i']), 'username': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The X handle (screen name) of this user.'), 'withheld': FieldInfo(annotation=Union[TweetWithheld, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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}$)], 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'author_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'author_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.TweetComplianceSchema(*, event_at: ~pydantic.types.AwareDatetime, 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: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'quote_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'tweet': FieldInfo(annotation=Tweet1, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=Union[TweetComplianceStreamResponse1, TweetComplianceStreamResponse2], required=True, description='Tweet compliance stream events.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[TweetDeleteComplianceSchema, TweetWithheldComplianceSchema, TweetDropComplianceSchema, TweetUndropComplianceSchema, TweetEditComplianceSchema], required=True, description='Tweet compliance data.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

errors: List[Problem]
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=List[Problem], required=True, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.TweetCreateRequest(*, card_uri: str | 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
for_super_followers_only: bool | None
geo: Geo2 | None
media: Media1 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'card_uri': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Card Uri Parameter. This is mutually exclusive from Quote Tweet Id, Poll, Media, and Direct Message Deep Link.'), 'direct_message_deep_link': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Link to take the conversation from the public timeline to a private Direct Message.'), 'for_super_followers_only': FieldInfo(annotation=Union[bool, NoneType], required=False, default=False, description='Exclusive Tweet for super followers.'), 'geo': FieldInfo(annotation=Union[Geo2, NoneType], required=False, default=None, description='Place ID being attached to the Tweet for geo location.'), 'media': FieldInfo(annotation=Union[Media1, NoneType], required=False, default=None, description='Media information being attached to created Tweet. This is mutually exclusive from Quote Tweet Id, Poll, and Card URI.'), 'nullcast': FieldInfo(annotation=Union[bool, NoneType], required=False, default=False, description='Nullcasted (promoted-only) Posts do not appear in the public timeline and are not served to followers.'), 'poll': FieldInfo(annotation=Union[Poll1, NoneType], required=False, default=None, description='Poll options for a Tweet with a poll. This is mutually exclusive from Media, Quote Tweet Id, and Card URI.'), 'quote_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'reply': FieldInfo(annotation=Union[Reply, NoneType], required=False, default=None, description='Tweet information of the Tweet being replied to.'), 'reply_settings': FieldInfo(annotation=Union[ReplySettings2, NoneType], required=False, default=None, description='Settings to indicate who can reply to the Tweet.'), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The content of the Tweet.', examples=['Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: Data11 | None = None, errors: Annotated[List[Problem] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

data: Data11 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data11, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

delete: TweetComplianceSchema
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'delete': FieldInfo(annotation=TweetComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data12 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data12, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

drop: TweetComplianceSchema
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'drop': FieldInfo(annotation=TweetComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: ~pydantic.types.AwareDatetime, 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: AwareDatetime
initial_tweet_id: constr(pattern='^[0-9]{1,19}$')
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'edit_tweet_ids': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, metadata=[MinLen(min_length=1)]), 'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'initial_tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'tweet': FieldInfo(annotation=Tweet2, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_edit': FieldInfo(annotation=TweetEditComplianceObjectSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

hidden: bool
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'hidden': FieldInfo(annotation=bool, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data13 | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data13, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[Union[TweetLabelStreamResponse1, TweetLabelStreamResponse2]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=Union[TweetLabelStreamResponse1, TweetLabelStreamResponse2], required=True, description='Tweet label stream events.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: TweetNoticeSchema | TweetUnviewableSchema
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[TweetNoticeSchema, TweetUnviewableSchema], required=True, description='Tweet label data.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

errors: List[Problem]
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=List[Problem], required=True, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.TweetNotice(*, application: str, details: str | None = None, event_at: AwareDatetime, 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: AwareDatetime
event_type: str
extended_details_url: str | None
label_title: str | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'application': FieldInfo(annotation=str, required=True, description='If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.', examples=['apply']), 'details': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Information shown on the Tweet label'), 'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'event_type': FieldInfo(annotation=str, required=True, description='The type of label on the Tweet', examples=['misleading']), 'extended_details_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Link to more information about this kind of label'), 'label_title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Title/header of the Tweet label'), 'tweet': FieldInfo(annotation=Tweet3, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'public_tweet_notice': FieldInfo(annotation=TweetNotice, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

public_tweet_notice: TweetNotice
class sparta.twitterapi.models.twitter_v2_spec.TweetTakedownComplianceSchema(*, event_at: ~pydantic.types.AwareDatetime, 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: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'quote_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'tweet': FieldInfo(annotation=Tweet3, required=True), 'withheld_in_countries': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, metadata=[MinLen(min_length=0)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'undrop': FieldInfo(annotation=TweetComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

application: str
event_at: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'application': FieldInfo(annotation=str, required=True, description='If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.', examples=['apply']), 'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'tweet': FieldInfo(annotation=Tweet3, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'public_tweet_unviewable': FieldInfo(annotation=TweetUnviewable, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'copyright': FieldInfo(annotation=bool, required=True, description='Indicates if the content is being withheld for on the basis of copyright infringement.'), 'country_codes': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, description='Provides a list of countries where this content is not available.', metadata=[MinLen(min_length=1)]), 'scope': FieldInfo(annotation=Union[Scope, NoneType], required=False, default=None, description='Indicates whether the content being withheld is the `tweet` or a `user`.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

scope: Scope | None
class sparta.twitterapi.models.twitter_v2_spec.TweetWithheldComplianceSchema(*, withheld: TweetTakedownComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'withheld': FieldInfo(annotation=TweetTakedownComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: AwareDatetime, favorite: Favorite)

Bases: BaseModel

event_at: AwareDatetime
favorite: Favorite
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'favorite': FieldInfo(annotation=Favorite, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: Problem

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.Url1(*, urls: Annotated[List[UrlEntity] | None, MinLen(min_length=1)] = None)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'urls': FieldInfo(annotation=Union[List[UrlEntity], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

urls: List[UrlEntity] | None
class sparta.twitterapi.models.twitter_v2_spec.UrlEntity(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic_core._pydantic_core.Url | 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_core._pydantic_core.Url | None = None, url: ~pydantic_core._pydantic_core.Url, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Description of the URL landing page.', examples=['This is a description of the website.']), 'display_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The URL as displayed in the X client.', examples=['twittercommunity.com/t/introducing-…']), 'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'expanded_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api']), 'images': FieldInfo(annotation=Union[List[UrlImage], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'status': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='HTTP Status Code.'), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Title of the page the URL points to.', examples=['Introducing the v2 follow lookup endpoints']), 'unwound_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='Fully resolved url.', examples=['https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118']), 'url': FieldInfo(annotation=Url, required=True, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.UrlEntityDm(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic_core._pydantic_core.Url | 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_core._pydantic_core.Url | None = None, url: ~pydantic_core._pydantic_core.Url, 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Description of the URL landing page.', examples=['This is a description of the website.']), 'display_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The URL as displayed in the X client.', examples=['twittercommunity.com/t/introducing-…']), 'end': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity ends.  The index is exclusive.', examples=[61], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'expanded_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api']), 'images': FieldInfo(annotation=Union[List[UrlImage], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'start': FieldInfo(annotation=int, required=True, description='Index (zero-based) at which position this entity starts.  The index is inclusive.', examples=[50], metadata=[None, Interval(gt=None, ge=0, lt=None, le=None), None]), 'status': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='HTTP Status Code.'), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Title of the page the URL points to.', examples=['Introducing the v2 follow lookup endpoints']), 'unwound_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='Fully resolved url.', examples=['https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118']), 'url': FieldInfo(annotation=Url, required=True, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.UrlFields(*, description: str | None = None, display_url: str | None = None, expanded_url: ~pydantic_core._pydantic_core.Url | 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_core._pydantic_core.Url | None = None, url: ~pydantic_core._pydantic_core.Url)

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Description of the URL landing page.', examples=['This is a description of the website.']), 'display_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The URL as displayed in the X client.', examples=['twittercommunity.com/t/introducing-…']), 'expanded_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api']), 'images': FieldInfo(annotation=Union[List[UrlImage], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)]), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'status': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='HTTP Status Code.'), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Title of the page the URL points to.', examples=['Introducing the v2 follow lookup endpoints']), 'unwound_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='Fully resolved url.', examples=['https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118']), 'url': FieldInfo(annotation=Url, required=True, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

status: conint(ge=100, le=599) | None
title: str | None
unwound_url: AnyUrl | None
url: AnyUrl
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: Url | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'height': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The height of the media in pixels.'), 'url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='A validly formatted URL.', examples=['https://developer.twitter.com/en/docs/twitter-api']), 'width': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The width of the media in pixels.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'cap_reset_day': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Number of days left for the Tweet cap to reset'), 'daily_client_app_usage': FieldInfo(annotation=Union[List[ClientAppUsage], NoneType], required=False, default=None, description='The daily usage breakdown for each Client Application a project', metadata=[MinLen(min_length=1)]), 'daily_project_usage': FieldInfo(annotation=Union[DailyProjectUsage, NoneType], required=False, default=None, description='The daily usage breakdown for a project'), 'project_cap': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='Total number of Posts that can be read in this project per month'), 'project_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The unique identifier for this project'), 'project_usage': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The number of Posts read in this project')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'period': FieldInfo(annotation=Union[Period, NoneType], required=False, default=None), 'scope': FieldInfo(annotation=Union[Scope1, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

period: Period | None
scope: Scope1 | None
class sparta.twitterapi.models.twitter_v2_spec.UsageFields(*, date: AwareDatetime | None = None, usage: int | None = None)

Bases: BaseModel

date: AwareDatetime | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'date': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='The time period for the usage', examples=['2021-01-06T18:40:40.000Z']), 'usage': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The usage value')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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: ~pydantic.types.AwareDatetime | 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,15}$)], 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: AwareDatetime | None
description: str | None
entities: Entities1 | None
id: constr(pattern='^[0-9]{1,19}$')
location: str | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'affiliation': FieldInfo(annotation=Union[Affiliation, NoneType], required=False, default=None, description="Metadata about a user's affiliation."), 'connection_status': FieldInfo(annotation=Union[List[ConnectionStatu], NoneType], required=False, default=None, description='Returns detailed information about the relationship between two users.', metadata=[MinLen(min_length=0)]), 'created_at': FieldInfo(annotation=Union[AwareDatetime, NoneType], required=False, default=None, description='Creation time of this User.'), 'description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="The text of this User's profile description (also known as bio), if the User provided one."), 'entities': FieldInfo(annotation=Union[Entities1, NoneType], required=False, default=None, description="A list of metadata found in the User's profile description."), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'location': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries."), 'most_recent_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'name': FieldInfo(annotation=str, required=True, description='The friendly name of this User, as shown on their profile.'), 'pinned_tweet_id': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968']), 'profile_banner_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The URL to the profile banner for this User.'), 'profile_image_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The URL to the profile image for this User.'), 'protected': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description="Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private)."), 'public_metrics': FieldInfo(annotation=Union[PublicMetrics1, NoneType], required=False, default=None, description='A list of metrics for this User.'), 'receives_your_dm': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Indicates if you can send a DM to this User'), 'subscription_type': FieldInfo(annotation=Union[SubscriptionType, NoneType], required=False, default=None, description='The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.'), 'url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="The URL specified in the User's profile."), 'username': FieldInfo(annotation=str, required=True, description='The X handle (screen name) of this user.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[A-Za-z0-9_]{1,15}$')]), 'verified': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Indicate if this User is a verified X User.'), 'verified_type': FieldInfo(annotation=Union[VerifiedType, NoneType], required=False, default=None, description='The X Blue verified type of the user, eg: blue, government, business or none.'), 'withheld': FieldInfo(annotation=Union[UserWithheld, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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,15}$')
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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.UserComplianceSchema(*, event_at: AwareDatetime, user: User2)

Bases: BaseModel

event_at: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'user': FieldInfo(annotation=User2, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user: User2
class sparta.twitterapi.models.twitter_v2_spec.UserComplianceStreamResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Union[UserComplianceStreamResponse1, UserComplianceStreamResponse2]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=Union[UserComplianceStreamResponse1, UserComplianceStreamResponse2], required=True, description='User compliance stream events.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[UserProtectComplianceSchema, UserUnprotectComplianceSchema, UserDeleteComplianceSchema, UserUndeleteComplianceSchema, UserSuspendComplianceSchema, UserUnsuspendComplianceSchema, UserWithheldComplianceSchema, UserScrubGeoSchema, UserProfileModificationComplianceSchema], required=True, description='User compliance data.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

errors: List[Problem]
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'errors': FieldInfo(annotation=List[Problem], required=True, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.UserDeleteComplianceSchema(*, user_delete: UserComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_delete': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_delete: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserId(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: RootModel[str]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. The value must be the same as the authenticated user.', examples=['2244994945'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

root: str
class sparta.twitterapi.models.twitter_v2_spec.UserProfileModificationComplianceSchema(*, user_profile_modification: UserProfileModificationObjectSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_profile_modification': FieldInfo(annotation=UserProfileModificationObjectSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_profile_modification: UserProfileModificationObjectSchema
class sparta.twitterapi.models.twitter_v2_spec.UserProfileModificationObjectSchema(*, event_at: AwareDatetime, new_value: str, profile_field: str, user: User2)

Bases: BaseModel

event_at: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'new_value': FieldInfo(annotation=str, required=True), 'profile_field': FieldInfo(annotation=str, required=True), 'user': FieldInfo(annotation=User2, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

new_value: str
profile_field: str
user: User2
class sparta.twitterapi.models.twitter_v2_spec.UserProtectComplianceSchema(*, user_protect: UserComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_protect': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_protect: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserScrubGeoObjectSchema(*, event_at: ~pydantic.types.AwareDatetime, 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: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'up_to_tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')]), 'user': FieldInfo(annotation=User2, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'scrub_geo': FieldInfo(annotation=UserScrubGeoObjectSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

scrub_geo: UserScrubGeoObjectSchema
class sparta.twitterapi.models.twitter_v2_spec.UserSearchQueryVnext(root: RootModelRootType = PydanticUndefined)

Bases: RootModel[Annotated[str, StringConstraints]]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'root': FieldInfo(annotation=str, required=True, description='The the search string by which to query for users.', metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern="^[A-Za-z0-9_\\' ]{1,50}$")])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

root: constr(pattern="^[A-Za-z0-9_\\' ]{1,50}$")
class sparta.twitterapi.models.twitter_v2_spec.UserSuspendComplianceSchema(*, user_suspend: UserComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_suspend': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_suspend: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserTakedownComplianceSchema(*, event_at: ~pydantic.types.AwareDatetime, 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: AwareDatetime
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'event_at': FieldInfo(annotation=AwareDatetime, required=True, description='Event time.', examples=['2021-07-06T18:40:40.000Z']), 'user': FieldInfo(annotation=User2, required=True), 'withheld_in_countries': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, metadata=[MinLen(min_length=0)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_undelete': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_undelete: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserUnprotectComplianceSchema(*, user_unprotect: UserComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_unprotect': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

user_unprotect: UserComplianceSchema
class sparta.twitterapi.models.twitter_v2_spec.UserUnsuspendComplianceSchema(*, user_unsuspend: UserComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_unsuspend': FieldInfo(annotation=UserComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'country_codes': FieldInfo(annotation=List[Annotated[str, StringConstraints]], required=True, description='Provides a list of countries where this content is not available.', metadata=[MinLen(min_length=1)]), 'scope': FieldInfo(annotation=Union[Scope2, NoneType], required=False, default=None, description='Indicates that the content being withheld is a `user`.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

scope: Scope2 | None
class sparta.twitterapi.models.twitter_v2_spec.UserWithheldComplianceSchema(*, user_withheld: UserTakedownComplianceSchema)

Bases: BaseModel

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'user_withheld': FieldInfo(annotation=UserTakedownComplianceSchema, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data14 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data14, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data14 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data14, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'target_user_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['2244994945'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data16 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data16, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data17 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data17, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data18 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data18, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data18 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data18, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'tweet_id': FieldInfo(annotation=str, required=True, description='Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.', examples=['1346889436626259968'], metadata=[StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^[0-9]{1,19}$')])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data20 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data20, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

data: Data21 | None
errors: List[Problem] | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Union[Data21, NoneType], required=False, default=None), 'errors': FieldInfo(annotation=Union[List[Problem], NoneType], required=False, default=None, metadata=[MinLen(min_length=1)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'metric_values': FieldInfo(annotation=Union[List[MetricValue], NoneType], required=False, default=None), 'timestamp': FieldInfo(annotation=Union[Timestamp, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'metric_type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'metric_value': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class sparta.twitterapi.models.twitter_v2_spec.Variant(*, bit_rate: int | None = None, content_type: str | None = None, url: Url | None = None)

Bases: BaseModel

bit_rate: int | None
content_type: str | None
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'bit_rate': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, description='The bit rate of the media.'), 'content_type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='The content type of the media.'), 'url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None, description='The url to the media.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_core._pydantic_core.Url | 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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'duration_ms': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'height': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The height of the media in pixels.'), 'media_key': FieldInfo(annotation=Union[Annotated[str, StringConstraints], NoneType], required=False, default=None, description='The Media Key identifier for this attachment.'), 'non_public_metrics': FieldInfo(annotation=Union[NonPublicMetrics1, NoneType], required=False, default=None, description='Nonpublic engagement metrics for the Media at the time of the request.'), 'organic_metrics': FieldInfo(annotation=Union[OrganicMetrics1, NoneType], required=False, default=None, description='Organic nonpublic engagement metrics for the Media at the time of the request.'), 'preview_image_url': FieldInfo(annotation=Union[Url, NoneType], required=False, default=None), 'promoted_metrics': FieldInfo(annotation=Union[PromotedMetrics1, NoneType], required=False, default=None, description='Promoted nonpublic engagement metrics for the Media at the time of the request.'), 'public_metrics': FieldInfo(annotation=Union[PublicMetrics2, NoneType], required=False, default=None, description='Engagement metrics for the Media at the time of the request.'), 'type': FieldInfo(annotation=str, required=True), 'variants': FieldInfo(annotation=Union[List[Variant], NoneType], required=False, default=None, description='An array of all available variants of the media.'), 'width': FieldInfo(annotation=Union[Annotated[int, NoneType, Interval, NoneType], NoneType], required=False, default=None, description='The width of the media in pixels.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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'