pypresscart.models.files

File models.

Classes

DeleteFileResponse(*, success, **extra_data)

File(*, id[, name, file_key, file_url, ...])

Record returned by GET /files / GET /files/{id}.

MoveFilesRequest(*, file_ids[, folder_id])

Body for POST /files/move.

MoveFilesResponse(*, moved_count, **extra_data)

UploadFilesResponse(*[, files])

UploadedFile(*, id[, file_key, file_url, ...])

Entry in the POST /files/upload response.
class pypresscart.models.files.DeleteFileResponse(*, success, **extra_data)[source]

Bases: PresscartModel

Parameters:
success: bool
class pypresscart.models.files.File(*, id, name=None, file_key=None, file_url=None, size=None, mime_type=None, team_id=None, folder_id=None, uploaded_by=None, created_at=None, updated_at=None, deleted_at=None, **extra_data)[source]

Bases: PresscartModel

Record returned by GET /files / GET /files/{id}.

Parameters:

  • id (str)

  • name (str | None)

  • file_key (str | None)

  • file_url (str | None)

  • size (int | None)

  • mime_type (str | None)

  • team_id (str | None)

  • folder_id (str | None)

  • uploaded_by (str | None)

  • created_at (datetime | None)

  • updated_at (datetime | None)

  • deleted_at (datetime | None)

  • extra_data (Any)

id: str
name: str | None
file_key: str | None
file_url: str | None
size: int | None
mime_type: str | None
team_id: str | None
folder_id: str | None
uploaded_by: str | None
created_at: datetime | None
updated_at: datetime | None
deleted_at: datetime | None
class pypresscart.models.files.MoveFilesRequest(*, file_ids, folder_id=None, **extra_data)[source]

Bases: PresscartModel

Body for POST /files/move.

Parameters:
file_ids: list[str]
folder_id: str | None
class pypresscart.models.files.MoveFilesResponse(*, moved_count, **extra_data)[source]

Bases: PresscartModel

Parameters:

  • moved_count (int)

  • extra_data (Any)

moved_count: int
class pypresscart.models.files.UploadFilesResponse(*, files=[], **extra_data)[source]

Bases: PresscartModel

Parameters:
files: list[UploadedFile]
class pypresscart.models.files.UploadedFile(*, id, file_key=None, file_url=None, name=None, size=None, mime_type=None, folder_id=None, **extra_data)[source]

Bases: PresscartModel

Entry in the POST /files/upload response.

Parameters:

  • id (str)

  • file_key (str | None)

  • file_url (str | None)

  • name (str | None)

  • size (int | None)

  • mime_type (str | None)

  • folder_id (str | None)

  • extra_data (Any)

id: str
file_key: str | None
file_url: str | None
name: str | None
size: int | None
mime_type: str | None
folder_id: str | None