module strapi_client.smart_document


class SmartDocument

Fully automated ORM class for Strapi documents.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod get_document

get_document(client: StrapiClientAsync, document_id: str) → Self

Get document by document id.


classmethod get_documents

get_documents(
    client: StrapiClientAsync,
    sort: list[str] | None = None,
    filters: dict[str, Any] | None = None,
    publication_state: str | None = None,
    locale: str | None = None,
    start: int | None = 0,
    page: int | None = None,
    limit: int = 25,
    with_count: bool = True
) → list[Self]

Get list of documents.


classmethod get_first_document

get_first_document(
    client: StrapiClientAsync,
    sort: list[str] | None = None,
    filters: dict[str, Any] | None = None,
    publication_state: str | None = None,
    locale: str | None = None
) → Optional[Self]

First documents if available.


This file was automatically generated via lazydocs.