pypresscart.resources.folders

Folders resource: /folders endpoints.

Classes

FoldersResource(client)

Folder management.

class pypresscart.resources.folders.FoldersResource(client)

Bases: ResourceBase

Folder management.

Parameters:

client (PresscartClient)

list(*, q=None, as_json=None)

List folders. Required scope: folders.lists.

Parameters:

• q (str | None)

• as_json (bool | None)

Return type:

Paginated[Folder] | dict[str, Any]

create(body, *, as_json=None)

Create a folder. Required scope: folders.create.

Parameters:

• body (FolderCreateRequest | BaseModel | dict[str, Any])

• as_json (bool | None)

Return type:

Folder | dict[str, Any]

rename(folder_id, body, *, as_json=None)

Rename a folder. Required scope: folders.update.

Parameters:

• folder_id (str)

• body (FolderRenameRequest | BaseModel | dict[str, Any])

• as_json (bool | None)

Return type:

Folder | dict[str, Any]

delete(folder_id, *, as_json=None)

Delete a folder (files within lose their folder association). Scope: folders.delete.

Parameters:

• folder_id (str)

• as_json (bool | None)

Return type:

DeleteFolderResponse | dict[str, Any]