module strapi_client.strapi_client

---

class StrapiClient

REST API client for Strapi.

---

property api_url

---

property client

---

method authorize

authorize(identifier: str, password: str) → None

Get auth token using identifier and password.

---

method close

close()

---

method create_document

create_document(plural_api_id: str, data: dict[str, Any]) → DocumentResponse

Create new document.

---

method delete_document

delete_document(plural_api_id: str, document_id: str) → None

Delete document by document id.

---

method get_document

get_document(
    plural_api_id: str,
    document_id: str,
    populate: list[str] | str | None = None,
    fields: list[str] | None = None
) → DocumentResponse

Get document by document id.

---

method get_documents

get_documents(
    plural_api_id: str,
    sort: list[str] | None = None,
    filters: dict[str, Any] | None = None,
    populate: list[str] | str | None = None,
    fields: list[str] | None = None,
    publication_state: str | None = None,
    locale: str | None = None,
    start: int | None = 0,
    page: int | None = None,
    batch_size: int = 25,
    with_count: bool = True
) → DocumentsResponse

Get list of documents. By default, operates in batch mode to get all documents automatically.

---

method get_uploaded_files

get_uploaded_files(filters: dict | None = None) → list[dict[str, Any]]

Get uploaded files.

---

method open

open() → Client

---

method send_delete_request

send_delete_request(route: str, use_auth: bool = True) → Response

Send DELETE request to custom endpoint.

---

method send_get_request

send_get_request(
    route: str,
    params: dict[str, Any] | None = None,
    use_auth: bool = True
) → Response

Send GET request to custom endpoint.

---

method send_post_request

send_post_request(
    route: str,
    json: dict[str, Any] | None = None,
    params: dict[str, Any] | None = None,
    data: dict[str, Any] | None = None,
    files: list | None = None,
    use_auth: bool = True
) → Response

Send POST request to custom endpoint.

---

method send_put_request

send_put_request(
    route: str,
    body: dict[str, Any] | None = None,
    params: dict[str, Any] | None = None,
    use_auth: bool = True
) → Response

Send PUT request to custom endpoint.

---

method update_document

update_document(
    plural_api_id: str,
    document_id: str,
    data: dict[str, Any]
) → DocumentResponse

Update document fields.

---

method upload_files

upload_files(
    files: list[Path | str],
    ref: str | None = None,
    ref_id: int | None = None,
    field: str | None = None
) → dict[str, Any]

Upload list of files.

---

This file was automatically generated via lazydocs.