From ec2cf45370b172f498e9d0649bdda585214a28f2 Mon Sep 17 00:00:00 2001 From: Johnny Sequeira Date: Fri, 30 Aug 2024 12:39:15 -0600 Subject: [PATCH] Adding better structure and improvements on the docstring --- qfieldcloud_sdk/sdk.py | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/qfieldcloud_sdk/sdk.py b/qfieldcloud_sdk/sdk.py index 8d14c18..5ced156 100644 --- a/qfieldcloud_sdk/sdk.py +++ b/qfieldcloud_sdk/sdk.py @@ -49,7 +49,7 @@ class FileTransferStatus(str, Enum): class FileTransferType(Enum): """Represents the type of file transfer. - + The PACKAGE transfer type is used only internally in QFieldCloud workers, so it should never be used by other API clients. Attributes: @@ -97,7 +97,7 @@ class ProjectCollaboratorRole(str, Enum): class OrganizationMemberRole(str, Enum): """Defines roles for organization members. - + See organization member roles documentation: https://docs.qfield.org/reference/qfieldcloud/permissions/#roles_2 Attributes: @@ -139,15 +139,13 @@ class OrganizationMemberModel(TypedDict): role (OrganizationMemberRole): The role of the member. organization (str): The associated organization identifier. is_public (bool): A boolean indicating if the membership is public. - - Todo: - * Future work that can be surely expected, check QF-4535 """ member: str role: OrganizationMemberRole organization: str is_public: bool + # TODO future work that can be surely expected, check QF-4535 # created_by: str # updated_by: str # created_at: datetime.datetime @@ -274,8 +272,6 @@ def login(self, username: str, password: str) -> Dict: def logout(self) -> None: """Logout from the current session. - Returns: - None Example: client.logout() @@ -358,7 +354,7 @@ def create_project( is_public (Optional[bool]): Whether the project should be public. Defaults to False. Returns: - Dict: A dictionary containing the details of the created project. + Dict[str, Any]: A dictionary containing the details of the created project. Example: client.create_project(name="my_project", is_public=False)