Skip to content

Types

`types` ¶

Return types of the Pretalx API

Documentation: https://docs.pretalx.org/api/resources/index.html

Attention: Quite often the API docs and the actual results of the API differ!

ToDo

Find out why extra=Extra.allow causes mypy to fail. Seems like a bug in pydantic.

`Answer` ¶

`answer: str` `class-attribute` ¶

`answer_file: Optional[str]` `class-attribute` ¶

`id: int` `class-attribute` ¶

`options: List[Option]` `class-attribute` ¶

`person: Optional[str]` `class-attribute` ¶

`question: AnswerQuestionRef` `class-attribute` ¶

`review: Optional[int]` `class-attribute` ¶

`submission: Optional[str]` `class-attribute` ¶

`AnswerQuestionRef` ¶

`id: int` `class-attribute` ¶

`question: MultiLingualStr` `class-attribute` ¶

`Event` ¶

`date_from: date` `class-attribute` ¶

`date_to: Optional[date]` `class-attribute` ¶

`is_public: bool` `class-attribute` ¶

`name: MultiLingualStr` `class-attribute` ¶

`slug: str` `class-attribute` ¶

`timezone: str` `class-attribute` ¶

`urls: URLs` `class-attribute` ¶

`Me` ¶

`email: str` `class-attribute` ¶

`local: Optional[str]` `class-attribute` ¶

`name: str` `class-attribute` ¶

`timezone: str` `class-attribute` ¶

`MultiLingualStr` ¶

`de: Optional[str]` `class-attribute` ¶

`en: Optional[str]` `class-attribute` ¶

`Option` ¶

`answer: MultiLingualStr` `class-attribute` ¶

`id: int` `class-attribute` ¶

`Question` ¶

`contains_personal_data: bool` `class-attribute` ¶

`deadline: Optional[datetime]` `class-attribute` ¶

`default_answer: Optional[str]` `class-attribute` ¶

`freeze_after: Optional[datetime]` `class-attribute` ¶

`help_text: MultiLingualStr` `class-attribute` ¶

`id: int` `class-attribute` ¶

`is_public: bool` `class-attribute` ¶

`is_visible_to_reviewers: bool` `class-attribute` ¶

`max_length: Optional[int]` `class-attribute` ¶

`min_length: Optional[int]` `class-attribute` ¶

`options: List[Option]` `class-attribute` ¶

`question: MultiLingualStr` `class-attribute` ¶

`question_required: QuestionRequirement` `class-attribute` ¶

`read_only: Optional[bool]` `class-attribute` ¶

`required: bool` `class-attribute` ¶

`target: str` `class-attribute` ¶

`variant: str` `class-attribute` ¶

`QuestionRequirement` ¶

`after_deadline = 'after deadline'` `class-attribute` ¶

`optional = 'optional'` `class-attribute` ¶

`required = 'required'` `class-attribute` ¶

`Resource` ¶

`description: str` `class-attribute` ¶

`resource: str` `class-attribute` ¶

`Review` ¶

`answers: List[str]` `class-attribute` ¶

`created: datetime` `class-attribute` ¶

`id: int` `class-attribute` ¶

`score: Optional[float]` `class-attribute` ¶

`submission: str` `class-attribute` ¶

`text: Optional[str]` `class-attribute` ¶

`updated: datetime` `class-attribute` ¶

`user: str` `class-attribute` ¶

`Room` ¶

`availabilities: Optional[List[RoomAvailability]]` `class-attribute` ¶

`capacity: Optional[int]` `class-attribute` ¶

`description: MultiLingualStr` `class-attribute` ¶

`id: int` `class-attribute` ¶

`name: MultiLingualStr` `class-attribute` ¶

`position: Optional[int]` `class-attribute` ¶

`speaker_info: Optional[MultiLingualStr]` `class-attribute` ¶

`RoomAvailability` ¶

`end: datetime` `class-attribute` ¶

`start: datetime` `class-attribute` ¶

`Slot` ¶

`end: str` `class-attribute` ¶

`room: MultiLingualStr` `class-attribute` ¶

`room_id: int` `class-attribute` ¶

`start: str` `class-attribute` ¶

`Speaker` ¶

`answers: Optional[List[Answer]]` `class-attribute` ¶

`availabilities: Optional[List[SpeakerAvailability]]` `class-attribute` ¶

`submissions: List[str]` `class-attribute` ¶

`SpeakerAvailability` ¶

`allDay: str = Field(Ellipsis, alias='all_day')` `class-attribute` ¶

`end: str` `class-attribute` ¶

`id: int` `class-attribute` ¶

`start: str` `class-attribute` ¶

`State` ¶

`accepted = 'accepted'` `class-attribute` ¶

`canceled = 'canceled'` `class-attribute` ¶

`confirmed = 'confirmed'` `class-attribute` ¶

`deleted = 'deleted'` `class-attribute` ¶

`rejected = 'rejected'` `class-attribute` ¶

`submitted = 'submitted'` `class-attribute` ¶

`withdrawn = 'withdrawn'` `class-attribute` ¶

`Submission` ¶

`abstract: str` `class-attribute` ¶

`answers: Optional[List[Answer]]` `class-attribute` ¶

`code: str` `class-attribute` ¶

`content_locale: str` `class-attribute` ¶

`created: Optional[datetime]` `class-attribute` ¶

`description: str` `class-attribute` ¶

`do_not_record: bool` `class-attribute` ¶

`duration: Optional[int]` `class-attribute` ¶

`image: Optional[str]` `class-attribute` ¶

`internal_notes: Optional[str]` `class-attribute` ¶

`is_featured: bool` `class-attribute` ¶

`notes: Optional[str]` `class-attribute` ¶

`pending_state: Optional[State]` `class-attribute` ¶

`resources: List[Resource]` `class-attribute` ¶

`slot: Optional[Slot]` `class-attribute` ¶

`slot_count: int` `class-attribute` ¶

`speakers: List[SubmissionSpeaker]` `class-attribute` ¶

`state: State` `class-attribute` ¶

`submission_type: MultiLingualStr` `class-attribute` ¶

`submission_type_id: int` `class-attribute` ¶

`tag_ids: Optional[List[int]]` `class-attribute` ¶

`tags: Optional[List[str]]` `class-attribute` ¶

`title: str` `class-attribute` ¶

`track: Optional[MultiLingualStr]` `class-attribute` ¶

`track_id: Optional[int]` `class-attribute` ¶

`SubmissionSpeaker` ¶

`avatar: Optional[str]` `class-attribute` ¶

`biography: Optional[str]` `class-attribute` ¶

`code: str` `class-attribute` ¶

`email: Optional[str]` `class-attribute` ¶

`name: str` `class-attribute` ¶

`Tag` ¶

`color: str` `class-attribute` ¶

`description: MultiLingualStr` `class-attribute` ¶

`tag: str` `class-attribute` ¶

`Talk` ¶

`URLs` ¶

`base: str` `class-attribute` ¶

`feed: str` `class-attribute` ¶

`login: str` `class-attribute` ¶

`schedule: str` `class-attribute` ¶

`User` ¶

`email: str` `class-attribute` ¶

`name: str` `class-attribute` ¶