tools.ozone.inbox.defs

Shared type definitions.

class atproto_client.models.tools.ozone.inbox.defs.SubjectView

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. A subject belonging to the viewer that has moderation actions against it.

field action_count: int | None = None

Action count.

field appeal: models.ToolsOzoneInboxDefs.AppealView | None = None

Appeal.

field available_actions: List[Literal['appeal'] | str] | None = None

Available actions.

field created_at: DateTime [Required]

Created at.

field enforcement: models.ToolsOzoneInboxDefs.EnforcementView [Required]

Enforcement.

field is_read: bool [Required]

Is read.

field latest_action: models.ToolsOzoneInboxDefs.ActionView | None = None

Latest action.

field src: Did [Required]

DID of the moderation service that took the actions.

field subject: models.ComAtprotoAdminDefs.RepoRef | models.ComAtprotoRepoStrongRef.Main | DotDict [Required]

Subject.

Constraints:

  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7be1869d5bc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

field updated_at: DateTime [Required]

Updated at.

class atproto_client.models.tools.ozone.inbox.defs.EnforcementView

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. The current enforcement state of a subject.

field expires_at: DateTime | None = None

Expires at.

field labels: List[str] | None = None

Active label values on the subject, excluding negated and expired labels.

field scope: Literal['network', 'app', 'labelOnly'] | str | None = None

Scope.

field state: Literal['none', 'labeled', 'removed', 'suspended', 'takendown'] | str [Required]

State.

class atproto_client.models.tools.ozone.inbox.defs.AppealView

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. The state of the viewer’s appeal against the actions on a subject.

field appealable_until: DateTime | None = None

Appealable until.

field appealed_at: DateTime | None = None

Appealed at.

field outcome: Literal['approved', 'denied'] | str | None = None

Decision on a resolved appeal.

field resolved_at: DateTime | None = None

When the appeal’s report was closed.

field state: Literal['none', 'pending', 'resolved', 'superseded', 'expired'] | str [Required]

State.

class atproto_client.models.tools.ozone.inbox.defs.ActionView

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. A single moderation action taken against a subject.

field created_at: DateTime [Required]

Created at.

field expires_at: DateTime | None = None

Expires at.

field id: int [Required]

Action ID (moderation event ID).

field labels: List[str] | None = None

Label values, for labelApplied/labelRemoved.

field policies: List[models.ToolsOzoneInboxDefs.PolicyView] | None = None
field reversed_at: DateTime | None = None

Reversed at.

field scope: Literal['network', 'app', 'labelOnly'] | str | None = None

Scope.

field type: str [Required]

Public action type.

class atproto_client.models.tools.ozone.inbox.defs.PolicyView

Bases: ModelBase

Definition model for tools.ozone.inbox.defs.

field display_name: str [Required]

Display name.

field key: str [Required]

Key.

Link.

class atproto_client.models.tools.ozone.inbox.defs.SubjectViewDetail

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. A subject with a page of its action history and an aggregate report summary. Follow cursor to retrieve older actions; enforcement and appeal describe the current subject state on every page.

field actions: List[models.ToolsOzoneInboxDefs.ActionView] [Required]

A page of action history, most recent first. Reversal timestamps include changes outside this page.

Constraints:

  • max_length = 100

field appeal: models.ToolsOzoneInboxDefs.AppealView | None = None

Appeal.

field available_actions: List[Literal['appeal'] | str] | None = None

Available actions.

field created_at: DateTime [Required]

Created at.

field cursor: str | None = None

Cursor for the next page of action history. Omitted when no older actions remain.

field enforcement: models.ToolsOzoneInboxDefs.EnforcementView [Required]

Enforcement.

field is_read: bool [Required]

Is read.

field record: UnknownType | None = None
field reports: models.ToolsOzoneInboxDefs.ReportsSummary | None = None
field src: Did [Required]

Src.

field subject: models.ComAtprotoAdminDefs.RepoRef | models.ComAtprotoRepoStrongRef.Main | DotDict [Required]

Subject.

Constraints:

  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7be1869d5bc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

field updated_at: DateTime [Required]

Updated at.

class atproto_client.models.tools.ozone.inbox.defs.ReportsSummary

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. Aggregate view of reports filed against this subject. Deliberately carries no report IDs, no count, and no reporter identities.

field first_reported_on: DateTime [Required]

Day of the earliest report, truncated to midnight UTC. Render as a date; the time component is not meaningful.

field last_reported_on: DateTime [Required]

Day of the most recent report, truncated to midnight UTC. Render as a date; the time component is not meaningful.

field reason_types: List[str] [Required]

Distinct reason types reported, deduplicated and unordered. Excludes reasonAppeal.

class atproto_client.models.tools.ozone.inbox.defs.Notification

Bases: ModelBase

Definition model for tools.ozone.inbox.defs.

field created_at: DateTime [Required]

Created at.

field id: int [Required]

Id.

field is_read: bool [Required]

Is read.

field reason: Literal['reportResolved', 'reportReopened', 'actionTaken', 'actionReversed', 'appealResolved', 'standingChanged'] | str [Required]

Reason.

field target: models.ToolsOzoneInboxDefs.ReportRef | models.ToolsOzoneInboxDefs.SubjectRef | models.ToolsOzoneInboxDefs.StandingRef | DotDict [Required]

Target.

Constraints:

  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7be1869d5bc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

class atproto_client.models.tools.ozone.inbox.defs.NotificationPreferences

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. Push notification preferences by moderation notification category. These preferences do not hide in-app inbox activity. Each category defaults to enabled.

field account: bool [Required]

Notify about moderation actions against the account or its content, action reversals, appeal outcomes, and standing changes. Label application and removal are controlled by labels.

field labels: bool [Required]

Notify when labels are applied to or removed from the account or its content (labelApplied and labelRemoved actions).

field reports: bool [Required]

Notify about outcomes of reports filed by the account (reportResolved and reportReopened).

class atproto_client.models.tools.ozone.inbox.defs.ReportRef

Bases: ModelBase

Definition model for tools.ozone.inbox.defs. Reference to a report by its report table ID, as used by getReport and Ozone’s report detail page.

field report_id: int [Required]

Report id.

field status: Literal['pending', 'resolved'] | str | None = None

Status.

field subject: models.ComAtprotoAdminDefs.RepoRef | models.ComAtprotoRepoStrongRef.Main | DotDict | None = None

Subject.

class atproto_client.models.tools.ozone.inbox.defs.SubjectRef

Bases: ModelBase

Definition model for tools.ozone.inbox.defs.

field action_id: int | None = None

Action id.

field action_type: str | None = None

Action type.

field appeal_outcome: Literal['approved', 'denied'] | str | None = None
field subject: models.ComAtprotoAdminDefs.RepoRef | models.ComAtprotoRepoStrongRef.Main | DotDict [Required]

Subject.

Constraints:

  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7be1869d5bc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

class atproto_client.models.tools.ozone.inbox.defs.StandingRef

Bases: ModelBase

Definition model for tools.ozone.inbox.defs.

field previous_standing: Literal['good', 'warning', 'atRisk'] | str | None = None

Previous standing.

field standing: Literal['good', 'warning', 'atRisk'] | str [Required]

Standing.