com.atproto.temp.checkHandleAvailability

Checks whether the provided handle is available. If the handle is not available, available suggestions will be returned. Optional inputs will be used to generate suggestions.

class atproto_client.models.com.atproto.temp.check_handle_availability.Params

Bases: ParamsModelBase

Parameters model for com.atproto.temp.checkHandleAvailability.

field birth_date: DateTime | None = None
field email: str | None = None

User-provided email. Might be used to build handle suggestions.

field handle: Handle [Required]

Tentative handle. Will be checked for availability or used to build handle suggestions.

class atproto_client.models.com.atproto.temp.check_handle_availability.ParamsDict

Bases: TypedDict

handle: Handle

Tentative handle. Will be checked for availability or used to build handle suggestions.

birth_date: NotRequired[DateTime | None]

User-provided birth date. Might be used to build handle suggestions.

email: NotRequired[str | None]

User-provided email. Might be used to build handle suggestions.

class atproto_client.models.com.atproto.temp.check_handle_availability.Response

Bases: ResponseModelBase

Output data model for com.atproto.temp.checkHandleAvailability.

field handle: Handle [Required]

Echo of the input handle.

field result: models.ComAtprotoTempCheckHandleAvailability.ResultAvailable | models.ComAtprotoTempCheckHandleAvailability.ResultUnavailable | DotDict [Required]

Result.

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 0x786e5ef30c20>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

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

class atproto_client.models.com.atproto.temp.check_handle_availability.ResultAvailable

Bases: ModelBase

Definition model for com.atproto.temp.checkHandleAvailability. Indicates the provided handle is available.

class atproto_client.models.com.atproto.temp.check_handle_availability.ResultUnavailable

Bases: ModelBase

Definition model for com.atproto.temp.checkHandleAvailability. Indicates the provided handle is unavailable and gives suggestions of available handles.

field suggestions: List[models.ComAtprotoTempCheckHandleAvailability.Suggestion] [Required]

List of suggested handles based on the provided inputs.

class atproto_client.models.com.atproto.temp.check_handle_availability.Suggestion

Bases: ModelBase

Definition model for com.atproto.temp.checkHandleAvailability.

field handle: Handle [Required]

Handle.

field method: str [Required]

Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics.