com.atproto.temp.check_handle_availability¶

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

Bases: ParamsModelBase

Parameters model for com.atproto.temp.checkHandleAvailability.

field birth_date: str | None = None¶

field email: str | None = None¶: User-provided email. Might be used to build handle suggestions.

field handle: str [Required]¶

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

Constraints:

func = Validated by: string_formats.validate_handle() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

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

Bases: TypedDict

birth_date: typing_extensions.NotRequired[str | None]¶: User-provided birth date. Might be used to build handle suggestions.

email: typing_extensions.NotRequired[str | None]¶: User-provided email. Might be used to build handle suggestions.

handle: str¶: Tentative handle. Will be checked for availability or 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: str [Required]¶

Echo of the input handle.

Constraints:

func = Validated by: string_formats.validate_handle() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

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

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.

field py_type: Literal['com.atproto.temp.checkHandleAvailability#resultAvailable'] = 'com.atproto.temp.checkHandleAvailability#resultAvailable'¶

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 py_type: Literal['com.atproto.temp.checkHandleAvailability#resultUnavailable'] = 'com.atproto.temp.checkHandleAvailability#resultUnavailable'¶

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: str [Required]¶

Handle.

Constraints:

func = Validated by: string_formats.validate_handle() (only when strict_string_format=True)
json_schema_input_type = PydanticUndefined

field method: str [Required]¶: Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics.

field py_type: Literal['com.atproto.temp.checkHandleAvailability#suggestion'] = 'com.atproto.temp.checkHandleAvailability#suggestion'¶