com.atproto.repo.list_records

class atproto_client.models.com.atproto.repo.list_records.Params

Bases: ParamsModelBase

Parameters model for com.atproto.repo.listRecords.

field collection: str [Required]

The NSID of the record type.

Constraints:

• func = Validated by: string_formats.validate_nsid() (only when strict_string_format=True)

• json_schema_input_type = PydanticUndefined

field cursor: str | None = None

Cursor.

field limit: int | None = 50

The number of records to return.

Constraints:

• ge = 1

• le = 100

field repo: str | str [Required]

The handle or DID of the repo.

field reverse: bool | None = None

Flag to reverse the order of the returned records.

field rkey_end: str | None = None

DEPRECATED: The highest sort-ordered rkey to stop at (exclusive).

field rkey_start: str | None = None

DEPRECATED: The lowest sort-ordered rkey to start from (exclusive).

class atproto_client.models.com.atproto.repo.list_records.ParamsDict(*args, **kwargs)

Bases: dict

collection: str[str]

The NSID of the record type.

cursor: typing_extensions.NotRequired[str | None]

Cursor.

limit: typing_extensions.NotRequired[int | None]

The number of records to return.

repo: str[str] | str[str]

The handle or DID of the repo.

reverse: typing_extensions.NotRequired[bool | None]

Flag to reverse the order of the returned records.

rkey_end: typing_extensions.NotRequired[str | None]

The highest sort-ordered rkey to stop at (exclusive).

Type:

DEPRECATED

rkey_start: typing_extensions.NotRequired[str | None]

The lowest sort-ordered rkey to start from (exclusive).

Type:

DEPRECATED

class atproto_client.models.com.atproto.repo.list_records.Record

Bases: ModelBase

Definition model for com.atproto.repo.listRecords.

field cid: str [Required]

Cid.

Constraints:

• func = Validated by: string_formats.validate_cid() (only when strict_string_format=True)

• json_schema_input_type = PydanticUndefined

field py_type: Literal['com.atproto.repo.listRecords#record'] = 'com.atproto.repo.listRecords#record'

field uri: str [Required]

Uri.

Constraints:

• func = Validated by: string_formats.validate_at_uri() (only when strict_string_format=True)

• json_schema_input_type = PydanticUndefined

field value: UnknownType [Required]

Value.

class atproto_client.models.com.atproto.repo.list_records.Response

Bases: ResponseModelBase

Output data model for com.atproto.repo.listRecords.

field cursor: str | None = None

Cursor.

field records: List[models.ComAtprotoRepoListRecords.Record] [Required]

Records.