Release v0.18.0 - Add edit_document API method

Author: m-brtn

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.18.0] - 2025-10-29
+
+### Added
+
+- **📝 Edit Document API**: New method to edit document metadata
+  - `edit_document` - Update document properties
+
 ## [0.17.0] - 2025-10-24
 
 ### Added

docs-site/docs/api-reference/documents.md

@@ -43,6 +43,36 @@ print(f"Created: {document.id}")
 
 ---
 
+### `edit_document`
+
+```python
+edit_document(request: EditDocumentRequest) -> EditDocumentResponse
+```
+
+Edit document metadata such as title.
+
+**Parameters:**
+- `request` - EditDocumentRequest with document_id and title
+
+**Returns:** `EditDocumentResponse` with updated document
+
+**Example:**
+```python
+from vaiz.models import EditDocumentRequest
+
+response = client.edit_document(
+    EditDocumentRequest(
+        document_id="doc_id",
+        title="Updated Title"
+    )
+)
+
+edited_doc = response.payload.document
+print(f"Updated: {edited_doc.title}")
+```
+
+---
+
 ### `get_documents`
 
 ```python
@@ -96,6 +126,32 @@ class Document:
 
 ---
 
+### EditDocument
+
+Model representing an edited document (without internal fields like map).
+
+```python
+class EditDocument:
+    id: str                             # Document ID
+    title: str                          # Document title
+    space: str                          # Space ID
+    size: int                           # Document size in bytes
+    contributor_ids: List[str]          # List of contributor IDs
+    archiver: Optional[str]             # User who archived (if archived)
+    followers: Dict[str, str]           # Document followers
+    archived_at: Optional[datetime]     # Archive timestamp
+    kind_id: str                        # ID of document scope
+    kind: Kind                          # Document scope (Space/Member/Project)
+    creator: str                        # Creator user ID
+    created_at: datetime                # Creation timestamp
+    updated_at: datetime                # Last update timestamp
+    bucket: str                         # Storage bucket ID
+    content: Optional[str]              # Document content (encoded)
+    content_updated_at: Optional[datetime]  # Content update timestamp
+```
+
+---
+
 ## Request Models
 
 ### CreateDocumentRequest
@@ -111,6 +167,16 @@ class CreateDocumentRequest:
 
 ---
 
+### EditDocumentRequest
+
+```python
+class EditDocumentRequest:
+    document_id: str                    # Required - Document ID to edit
+    title: str                          # Required - New document title
+```
+
+---
+
 ## Response Models
 
 ### CreateDocumentResponse
@@ -132,6 +198,25 @@ class CreateDocumentPayload:
 
 ---
 
+### EditDocumentResponse
+
+```python
+class EditDocumentResponse:
+    payload: EditDocumentPayload        # Response payload
+    type: str                           # Response type ("EditDocument")
+```
+
+---
+
+### EditDocumentPayload
+
+```python
+class EditDocumentPayload:
+    document: EditDocument              # Edited document
+```
+
+---
+
 ### GetDocumentsRequest
 
 ```python

docs-site/docs/guides/documents.md

@@ -260,6 +260,65 @@ root_doc = create_doc_tree(client, project_id)
 print(f"\n✅ Created documentation tree with root: {root_doc.id}")
 ```
 
+## Editing Documents
+
+Update document metadata such as title:
+
+```python
+from vaiz.models import EditDocumentRequest
+
+# Edit document title
+response = client.edit_document(
+    EditDocumentRequest(
+        document_id="document_id",
+        title="Updated Document Title"
+    )
+)
+
+edited_doc = response.payload.document
+print(f"✅ Updated document: {edited_doc.title}")
+```
+
+### Complete Edit Workflow
+
+Create, edit, and verify document changes:
+
+```python
+from vaiz import CreateDocumentRequest, EditDocumentRequest, GetDocumentsRequest, Kind
+
+# 1. Create document
+create_response = client.create_document(
+    CreateDocumentRequest(
+        kind=Kind.Project,
+        kind_id=project_id,
+        title="Initial Title",
+        index=0
+    )
+)
+
+doc_id = create_response.payload.document.id
+print(f"Created: {create_response.payload.document.title}")
+
+# 2. Edit document title
+edit_response = client.edit_document(
+    EditDocumentRequest(
+        document_id=doc_id,
+        title="Updated Title"
+    )
+)
+
+print(f"Updated: {edit_response.payload.document.title}")
+
+# 3. Verify change in document list
+docs = client.get_documents(
+    GetDocumentsRequest(kind=Kind.Project, kind_id=project_id)
+)
+
+updated_doc = next((d for d in docs.payload.documents if d.id == doc_id), None)
+if updated_doc:
+    print(f"✅ Verified: {updated_doc.title}")
+```
+
 ## Working with Document Content
 
 In addition to listing and creating documents, you can work with their content using document API methods.

docs-site/docs/patterns/ready-to-run.md

@@ -31,6 +31,7 @@ The SDK includes a collection of ready-to-run examples in the [`/examples`](http
 ### Basic Operations
 - **`get_documents.py`** - List documents by scope (Space/Member/Project)
 - **`create_document.py`** - Create new documents
+- **`edit_document.py`** - Edit document metadata (e.g., title)
 - **`get_document.py`** - Get single document
 - **`replace_document.py`** - Replace document content with plain text
 - **`replace_json_document.py`** - Replace document content with rich JSON (document structure format)

docs-site/docusaurus.config.ts

@@ -206,8 +206,8 @@ const config: Config = {
       },
       items: [
         {
-          label: "v0.17.0",
-          href: "https://pypi.org/project/vaiz-sdk/0.17.0/",
+          label: "v0.18.0",
+          href: "https://pypi.org/project/vaiz-sdk/0.18.0/",
           position: "left",
         },
         {

examples/edit_document.py

@@ -0,0 +1,89 @@
+"""
+Edit Document Example
+
+This example demonstrates how to edit a document's title using the editDocument API.
+It shows the complete workflow:
+1. Creating a new document
+2. Editing the document title
+3. Verifying the change
+"""
+
+from datetime import datetime
+from vaiz import VaizClient, CreateDocumentRequest, EditDocumentRequest, GetDocumentsRequest, Kind
+from config import API_KEY, SPACE_ID
+
+
+def main():
+    # Initialize client
+    client = VaizClient(api_key=API_KEY, space_id=SPACE_ID, verify_ssl=False)
+    
+    print("=== Edit Document Example ===\n")
+    
+    # 1. Create a new document
+    print("1. Creating a new document...")
+    original_title = f"Test Document - {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
+    
+    create_request = CreateDocumentRequest(
+        kind=Kind.Space,
+        kind_id=SPACE_ID,
+        title=original_title,
+        index=0
+    )
+    
+    create_response = client.create_document(create_request)
+    document = create_response.payload.document
+    
+    print(f"✅ Created document:")
+    print(f"   ID: {document.id}")
+    print(f"   Title: {document.title}")
+    print(f"   Kind: {document.kind}")
+    print(f"   Size: {document.size} bytes\n")
+    
+    # 2. Edit document title
+    print("2. Editing document title...")
+    new_title = f"Updated Document - {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
+    
+    edit_request = EditDocumentRequest(
+        document_id=document.id,
+        title=new_title
+    )
+    
+    edit_response = client.edit_document(edit_request)
+    edited_document = edit_response.payload.document
+    
+    print(f"✅ Edited document:")
+    print(f"   ID: {edited_document.id}")
+    print(f"   Old Title: {original_title}")
+    print(f"   New Title: {edited_document.title}")
+    print(f"   Updated At: {edited_document.updated_at}\n")
+    
+    # 3. Verify the change
+    print("3. Verifying title change in document list...")
+    list_request = GetDocumentsRequest(
+        kind=Kind.Space,
+        kind_id=SPACE_ID
+    )
+    
+    list_response = client.get_documents(list_request)
+    
+    # Find our document in the list
+    found_document = None
+    for doc in list_response.payload.documents:
+        if doc.id == document.id:
+            found_document = doc
+            break
+    
+    if found_document:
+        print(f"✅ Document found in list:")
+        print(f"   ID: {found_document.id}")
+        print(f"   Title: {found_document.title}")
+        print(f"   Title matches: {found_document.title == new_title}")
+    else:
+        print("❌ Document not found in list")
+    
+    print("\n=== Example completed successfully! ===")
+
+
+if __name__ == "__main__":
+    main()
+

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vaiz-sdk"
-version = "0.17.0"
+version = "0.18.0"
 description = "Official SDK for interacting with the Vaiz API"
 authors = [{ name = "Vaiz", email = "mail@vaiz.com" }]
 license = "MIT"