vaiz-sdk 0.4.9

Official SDK for interacting with the Vaiz API

Vaiz SDK for Python

Python SDK for accessing the Vaiz platform API.

Usage

Basic Setup

First, you need to set up your environment variables. Create a .env file in your project root with the following variables:

VAIZ_API_KEY=your_api_key
VAIZ_SPACE_ID=your_space_id

Creating a Client

from vaiz import VaizClient

# For production use (verify_ssl=True by default)
client = VaizClient(
    api_key="your_api_key",
    space_id="your_space_id"
)

# For local development (when using self-signed certificates)
client = VaizClient(
    api_key="your_api_key",
    space_id="your_space_id",
    verify_ssl=False,  # Only for local development
    base_url=""  # Local development URL
)

DateTime Support

The Vaiz SDK provides automatic datetime conversion for all date/time fields. You can work with Python datetime objects instead of ISO strings:

Features

• 📥 Automatic Parsing: ISO strings from API → Python datetime objects
• 📤 Automatic Serialization: Python datetime objects → ISO strings for API
• 🔄 Bidirectional: Works seamlessly in both directions
• ✨ Developer Friendly: Use native Python datetime operations

Example

from datetime import datetime
from vaiz.models import CreateTaskRequest, TaskPriority

# Create task with datetime objects (recommended)
task = CreateTaskRequest(
    name="Project Deadline",
    group="group_id",
    board="board_id",
    project="project_id",
    priority=TaskPriority.High,
    due_start=datetime(2025, 2, 1, 9, 0, 0),    # February 1st, 9:00 AM
    due_end=datetime(2025, 2, 15, 17, 0, 0)     # February 15th, 5:00 PM
)

response = client.create_task(task)

# Access as datetime objects
print(f"Created: {response.task.created_at}")    # datetime object
print(f"Due: {response.task.due_end}")           # datetime object
print(f"Year: {response.task.due_end.year}")     # 2025

# Automatic API serialization happens behind the scenes
# API receives: {"dueStart": "2025-02-01T09:00:00", "dueEnd": "2025-02-15T17:00:00"}

Supported Fields

All date/time fields across the SDK support datetime conversion:

• created_at, updated_at, edited_at, deleted_at
• archived_at, completed_at
• due_start, due_end
• registeredDate, passwordChangedDate

Enums

The SDK provides enums for icons and colors to ensure you are using valid values.

EIcon

from vaiz.models.enums import EIcon

# Example usage
icon = EIcon.Cursor

EColor

from vaiz.models.enums import EColor

# Example usage
color = EColor.Silver

Working with Projects

Get All Projects

response = client.get_projects()
projects = response.projects

for project in projects:
    print(f"Project: {project.name}")
    print(f"Color: {project.color}")  # Can be EColor enum or hex code like '#1F36AD'

Note: Project color field supports both EColor enum values and hex color codes for maximum flexibility.

Working with Milestones

Get All Milestones

response = client.get_milestones()
milestones = response.milestones

for milestone in milestones:
    print(f"Milestone: {milestone.name}")
    print(f"Progress: {milestone.completed}/{milestone.total}")
    print(f"Due Date: {milestone.due_end}")

Get a Single Milestone

milestone_id = "your_milestone_id"
response = client.get_milestone(milestone_id)
milestone = response.milestone

print(f"Milestone: {milestone.name}")
print(f"Description: {milestone.description}")
print(f"Progress: {milestone.completed}/{milestone.total}")
print(f"Due Date: {milestone.due_end}")
print(f"Created by: {milestone.creator}")
print(f"Last edited by: {milestone.editor}")

Create a Milestone

from datetime import datetime
from vaiz.models import CreateMilestoneRequest

# Basic milestone
milestone = CreateMilestoneRequest(
    name="New Milestone",
    board="board_id",
    project="project_id"
)

response = client.create_milestone(milestone)
created_milestone = response.milestone
print(f"Created milestone: {created_milestone.name}")
print(f"Milestone ID: {created_milestone.id}")

Create a Milestone with DateTime Ranges

You can create milestones with specific start and end dates using Python datetime objects:

from datetime import datetime
from vaiz.models import CreateMilestoneRequest

# Milestone with datetime ranges (recommended approach)
milestone_with_dates = CreateMilestoneRequest(
    name="Q1 2025 Milestone",
    description="First quarter milestone with specific dates",
    board="board_id",
    project="project_id",
    due_start=datetime(2025, 3, 1, 9, 0, 0),      # March 1st, 9:00 AM
    due_end=datetime(2025, 3, 31, 17, 0, 0),      # March 31st, 5:00 PM
    color="#4CAF50"  # Green color
)

response = client.create_milestone(milestone_with_dates)
milestone = response.milestone

# Access datetime objects directly
print(f"Due start: {milestone.due_start}")  # datetime object
print(f"Due end: {milestone.due_end}")      # datetime object
print(f"Created at: {milestone.created_at}")  # datetime object

Edit a Milestone

from datetime import datetime
from vaiz.models import EditMilestoneRequest

# Edit an existing milestone with datetime objects
edit_request = EditMilestoneRequest(
    milestone_id="milestone_id",
    name="Updated Milestone Name",  # Optional
    description="Updated description",  # Optional
    due_start=datetime(2025, 6, 1, 9, 0, 0),      # June 1st, 9:00 AM (Optional)
    due_end=datetime(2025, 12, 31, 23, 59, 59)    # December 31st, 11:59 PM (Optional)
)

response = client.edit_milestone(edit_request)
updated_milestone = response.milestone
print(f"Updated milestone: {updated_milestone.name}")
print(f"Description: {updated_milestone.description}")
print(f"Due start: {updated_milestone.due_start}")  # datetime object
print(f"Due end: {updated_milestone.due_end}")      # datetime object
print(f"Last edited by: {updated_milestone.editor}")

Note: All fields except milestone_id are optional in EditMilestoneRequest. Only provide the fields you want to update. The SDK automatically converts datetime objects to ISO strings for the API.

Toggle Milestone Assignment

from vaiz.models import ToggleMilestoneRequest

# Attach/detach milestones to/from a task
toggle_request = ToggleMilestoneRequest(
    task_id="your_task_id",
    milestone_ids=["milestone_id_1", "milestone_id_2"]  # Can toggle multiple milestones at once
)

response = client.toggle_milestone(toggle_request)
updated_task = response.task

print(f"Task: {updated_task.name}")
print(f"Current milestones: {updated_task.milestones}")
print(f"Main milestone: {updated_task.milestone}")

# Check if milestone was attached or detached
if "milestone_id_1" in updated_task.milestones:
    print("✅ Milestone was attached to the task")
else:
    print("❌ Milestone was detached from the task")

Note: The toggle_milestone method works as a toggle - if the milestone is already assigned to the task, it will be removed; if not assigned, it will be added.

Working with Boards

Get All Boards

response = client.get_boards()

Get a Single Board

response = client.get_board("board_id")
board = response.payload["board"]

Create a Board Type

from vaiz.models import CreateBoardTypeRequest
from vaiz.models.enums import EIcon, EColor

request = CreateBoardTypeRequest(
    board_id="board_id",
    label="New Type",
    icon=EIcon.Cursor,
    color=EColor.Silver
)

response = client.create_board_type(request)
board_type = response.board_type

Edit a Board Type

from vaiz.models import EditBoardTypeRequest
from vaiz.models.enums import EIcon, EColor

request = EditBoardTypeRequest(
    board_type_id="board_type_id",
    board_id="board_id",
    label="Updated Type",
    icon=EIcon.Cursor,
    color=EColor.Silver,
    description="Updated description",
    hidden=True
)

response = client.edit_board_type(request)
board_type = response.board_type

Custom Fields with Helper Functions 🎛️

The Vaiz SDK provides strongly-typed helper functions for creating and managing custom fields with ease:

Create Custom Fields

from vaiz import (
    VaizClient,
    # Field creation helpers
    make_text_field,
    make_number_field,
    make_date_field,
    make_select_field,
    make_select_option
)
from vaiz.models.enums import EColor, EIcon

client = VaizClient(api_key="your-api-key", space_id="your-space-id")

# Text field - simple and clean
text_field = make_text_field(
    name="Customer Name",
    board_id="your-board-id",
    description="Name of the customer for this project"
)
response = client.create_board_custom_field(text_field)

# Date field with proper typing
date_field = make_date_field(
    name="Launch Date",
    board_id="your-board-id",
    description="When we plan to launch this feature"
)
response = client.create_board_custom_field(date_field)

# Select field with options
priority_options = [
    make_select_option("🔥 Critical", EColor.Red, EIcon.Fire),
    make_select_option("⚡ High", EColor.Orange, EIcon.Flag),
    make_select_option("📋 Medium", EColor.Blue, EIcon.Circle),
    make_select_option("🌱 Low", EColor.Green, EIcon.Target)
]

select_field = make_select_field(
    name="Priority Level",
    board_id="your-board-id",
    options=priority_options,
    description="Task priority level"
)
response = client.create_board_custom_field(select_field)

Edit Custom Fields

from vaiz import (
    edit_custom_field_name,
    edit_custom_field_description,
    edit_custom_field_complete
)

# Edit field name
name_edit = edit_custom_field_name(
    field_id="your-field-id",
    board_id="your-board-id",
    new_name="🎯 Updated Field Name"
)
client.edit_board_custom_field(name_edit)

# Edit multiple properties at once
complete_edit = edit_custom_field_complete(
    field_id="your-field-id",
    board_id="your-board-id",
    name="New Name",
    description="New description",
    hidden=False
)
client.edit_board_custom_field(complete_edit)

Work with Field Values

from vaiz import (
    make_date_value,
    make_member_value,
    make_task_relation_value,
    make_checkbox_value,
    CustomField
)
from datetime import datetime

# Format values for different field types
date_value = make_date_value(datetime(2025, 12, 31))
member_value = make_member_value(["user1", "user2"])  # Multiple members
relations_value = make_task_relation_value(["task1", "task2", "task3"])
checkbox_value = make_checkbox_value(True)

# Use in task creation
custom_fields = [
    CustomField(id="date_field_id", value=date_value),
    CustomField(id="member_field_id", value=member_value),
    CustomField(id="relations_field_id", value=relations_value),
    CustomField(id="checkbox_field_id", value=checkbox_value)
]

Manage Select Field Options

from vaiz import (
    add_board_custom_field_select_option,
    remove_board_custom_field_select_option,
    edit_board_custom_field_select_field_option
)

# Add new option to existing select field
new_option = make_select_option("🚨 Emergency", EColor.Magenta, EIcon.Crown)
add_request = add_board_custom_field_select_option(
    field_id="select_field_id",
    board_id="your-board-id",
    new_option=new_option,
    existing_options=current_options  # Get from field.options
)
client.edit_board_custom_field(add_request)

# Remove option
remove_request = remove_board_custom_field_select_option(
    field_id="select_field_id",
    board_id="your-board-id",
    option_id="option_to_remove_id",
    existing_options=current_options
)
client.edit_board_custom_field(remove_request)

Create a Board Group

from vaiz.models import CreateBoardGroupRequest

request = CreateBoardGroupRequest(
    name="New Group",
    board_id="your-board-id",
    description="This is a new group."
)

response = client.create_board_group(request)
board_groups = response.board_groups
print(f"Board groups: {[g.name for g in board_groups]}")

Edit a Board Group

from vaiz.models import EditBoardGroupRequest

request = EditBoardGroupRequest(
    board_group_id="your-group-id",
    board_id="your-board-id",
    name="Updated Group Name",
    description="This is an updated description.",
    limit=20,
    hidden=False
)

response = client.edit_board_group(request)
board_groups = response.board_groups
print(f"Updated board groups: {[g.name for g in board_groups]}")

Available custom field types:

• CustomFieldType.TEXT - Text field
• CustomFieldType.NUMBER - Number field
• CustomFieldType.CHECKBOX - Checkbox field
• CustomFieldType.DATE - Date field
• CustomFieldType.MEMBER - Member field
• CustomFieldType.TASK_RELATIONS - Task relations field
• CustomFieldType.SELECT - Select field
• CustomFieldType.URL - Url field
• CustomFieldType.ESTIMATION - Estimation field

Working with Profile

Get User Profile

response = client.get_profile()
profile = response.payload["profile"]

Working with Tasks

Create a Task

from datetime import datetime
from vaiz.models import CreateTaskRequest, TaskPriority

# Basic task
task = CreateTaskRequest(
    name="My Task",
    group="group_id",
    board="board_id",
    project="project_id",
    priority=TaskPriority.High,
    completed=False,
    types=["type_id"],
    subtasks=[],
    milestones=[],
    rightConnectors=[],
    leftConnectors=[]
)

response = client.create_task(task)

Create a Task with DateTime Deadlines

The SDK automatically converts Python datetime objects to ISO strings for the API and parses ISO strings back to datetime objects:

from datetime import datetime
from vaiz.models import CreateTaskRequest, TaskPriority

# Task with datetime deadlines (recommended approach)
task_with_dates = CreateTaskRequest(
    name="Project Deadline Task",
    description="Task with specific start and end dates",
    group="group_id",
    board="board_id",
    project="project_id",
    priority=TaskPriority.Medium,
    completed=False,
    due_start=datetime(2025, 2, 1, 9, 0, 0),    # February 1st, 9:00 AM
    due_end=datetime(2025, 2, 15, 17, 0, 0)     # February 15th, 5:00 PM
)

response = client.create_task(task_with_dates)

# Access datetime objects directly
print(f"Due start: {response.task.due_start}")  # datetime object
print(f"Created at: {response.task.created_at}")  # datetime object

Edit a Task with DateTime Updates

You can update task deadlines and other fields using datetime objects:

from datetime import datetime
from vaiz.models import EditTaskRequest, TaskPriority

# Edit an existing task with new datetime deadlines
edit_request = EditTaskRequest(
    task_id="existing_task_id",
    name="Updated Task with New Deadlines",
    priority=TaskPriority.High,
    completed=False,
    assignees=["user_id"],
    due_start=datetime(2025, 4, 1, 9, 0, 0),    # April 1st, 9:00 AM
    due_end=datetime(2025, 4, 30, 17, 0, 0)     # April 30th, 5:00 PM
)

response = client.edit_task(edit_request)

# Access updated datetime objects
updated_task = response.payload["task"]
print(f"Updated due start: {updated_task['dueStart']}")  # ISO string from API
print(f"Updated due end: {updated_task['dueEnd']}")      # ISO string from API

Create a Task with Description and Files

from vaiz.models import CreateTaskRequest, TaskPriority, TaskFile
from vaiz.models.enums import EUploadFileType

# First, upload a file
upload_response = client.upload_file("/path/to/file.pdf", file_type=EUploadFileType.Pdf)
uploaded_file = upload_response.file

# Create TaskFile object from uploaded file
task_file = TaskFile(
    url=uploaded_file.url,
    name=uploaded_file.name,
    dimension=uploaded_file.dimension,
    ext=uploaded_file.ext,
    _id=uploaded_file.id,
    type=uploaded_file.type
)

# Create task with description and files
task = CreateTaskRequest(
    name="Task with Files",
    group="group_id",
    board="board_id",
    project="project_id",
    priority=TaskPriority.High,
    completed=False,
    description="This task includes a detailed description and attached files for reference.",
    files=[task_file]
)

response = client.create_task(task)

Note: The examples in the examples/ folder use real files from the assets/ directory:

• assets/example.pdf - PDF document
• assets/example.png - PNG image
• assets/example.mp4 - MP4 video

These files are used in tests and examples to demonstrate real file upload functionality.

Create a Task with Multiple Files

from vaiz.models import CreateTaskRequest, TaskPriority, TaskFile
from vaiz.models.enums import EUploadFileType

# Upload multiple files
files_to_upload = [
    ("/path/to/document.pdf", EUploadFileType.Pdf),
    ("/path/to/image.png", EUploadFileType.Image),
    ("/path/to/video.mp4", EUploadFileType.Video)
]

task_files = []
for file_path, file_type in files_to_upload:
    try:
        upload_response = client.upload_file(file_path, file_type=file_type)
        uploaded_file = upload_response.file

        task_file = TaskFile(
            url=uploaded_file.url,
            name=uploaded_file.name,
            dimension=uploaded_file.dimension,
            ext=uploaded_file.ext,
            _id=uploaded_file.id,
            type=uploaded_file.type
        )
        task_files.append(task_file)
    except Exception as e:
        print(f"Error uploading {file_path}: {e}")

# Create task with multiple files
task = CreateTaskRequest(
    name="Task with Multiple Files",
    group="group_id",
    board="board_id",
    project="project_id",
    priority=TaskPriority.Medium,
    completed=False,
    description="This task contains multiple file attachments of different types.",
    files=task_files
)

response = client.create_task(task)

Edit a Task

from vaiz.models import EditTaskRequest

edit_task = EditTaskRequest(
    task_id="task_id",
    name="Updated Task Name",
    assignees=["assignee_id"]
)

response = client.edit_task(edit_task)

Edit a Task to Add Description and Files

Note: This functionality is not yet supported by the API. The examples below demonstrate the intended usage when the API supports these features.

from vaiz.models import EditTaskRequest, TaskFile
from vaiz.models.enums import EUploadFileType

# First, upload a file
upload_response = client.upload_file("/path/to/file.pdf", file_type=EUploadFileType.Pdf)
uploaded_file = upload_response.file

# Create TaskFile object from uploaded file
task_file = TaskFile(
    url=uploaded_file.url,
    name=uploaded_file.name,
    dimension=uploaded_file.dimension,
    ext=uploaded_file.ext,
    _id=uploaded_file.id,
    type=uploaded_file.type
)

# Edit task to add description and files
edit_task = EditTaskRequest(
    task_id="task_id",
    name="Updated Task with Files",
    description="This task has been updated to include a description and attached files.",
    files=[task_file]
)

response = client.edit_task(edit_task)

Edit a Task to Update Description Only

Note: This functionality is not yet supported by the API. The examples below demonstrate the intended usage when the API supports these features.

from vaiz.models import EditTaskRequest

edit_task = EditTaskRequest(
    task_id="task_id",
)

response = client.edit_task(edit_task)

Get Task Information

response = client.get_task("task_id")

Working with Files

Upload a File

from vaiz.models.enums import EUploadFileType

# Upload a PDF file
response = client.upload_file("/path/to/file.pdf", file_type=EUploadFileType.Pdf)

file = response.file
print(file.url)

Upload File from URL

Upload files directly from external URLs without downloading them locally first:

from vaiz.models.enums import EUploadFileType

# Upload with automatic file type detection
response = client.upload_file_from_url("https://example.com/image.png")

# Upload with explicit file type and custom filename
response = client.upload_file_from_url(
    file_url="https://example.com/document.pdf",
    file_type=EUploadFileType.Pdf,
    filename="my_document.pdf"
)

file = response.file
print(f"Uploaded: {file.name} ({file.type})")
print(f"URL: {file.url}")

Create Task with External File

You can also create tasks with files uploaded from URLs:

from vaiz.models import CreateTaskRequest, TaskPriority, TaskFile

# 1. Upload file from URL
upload_response = client.upload_file_from_url(
    file_url="https://example.com/mockup.png",
    file_type=EUploadFileType.Image,
    filename="project_mockup.png"
)

# 2. Create TaskFile object
task_file = TaskFile(
    url=upload_response.file.url,
    name=upload_response.file.name,
    dimension=upload_response.file.dimension,
    ext=upload_response.file.ext,
    _id=upload_response.file.id,
    type=upload_response.file.type
)

# 3. Create task with attached file
task_request = CreateTaskRequest(
    name="Review Project Mockup",
    group="your_group_id",
    board="your_board_id",
    project="your_project_id",
    priority=TaskPriority.High,
    description="Please review the attached mockup",
    files=[task_file]
)

task_response = client.create_task(task_request)
print(f"Task created: {task_response.payload['task']['_id']}")

Available File Types

The SDK provides an enum for file types to ensure you are using valid values:

from vaiz.models.enums import EUploadFileType

# Available file types:
# EUploadFileType.Image  - For image files (jpg, png, gif, etc.)
# EUploadFileType.File   - For generic files
# EUploadFileType.Video  - For video files (mp4, avi, mov, etc.)
# EUploadFileType.Pdf    - For PDF documents

Retrieve JSON Document Content

You can fetch the JSON content of a task description document or a standalone document using get_document_body.

from vaiz import VaizClient

client = VaizClient(api_key="...", space_id="...")

# Known documentId
document_id = "6878ff0ad2c2d60e246402c2"
doc = client.get_document_body(document_id)

# The API returns a JSON structure. Example top-level keys:
print(doc.keys())  # dict_keys(['default'])

If you need a document_id, create a task and use its document field:

from vaiz.models import CreateTaskRequest, TaskPriority

task_response = client.create_task(CreateTaskRequest(
    name="My Task",
    group="your_group_id",
    board="your_board_id",
    project="your_project_id",
    priority=TaskPriority.General
))

document_id = task_response.task.document
doc = client.get_document_body(document_id)

You can also fetch the description directly from a `Task` instance:

```python
task = task_response.task
description_body = task.get_task_description(client)
print(type(description_body))  # dict
```

#### Replace Document Content

You can completely replace document content using `replace_document`:

```python
import json

# Get or create document ID (from task, for example)
document_id = task_response.task.document

# Create new content as PLAIN TEXT (current API supports plain text only)
new_description_text = (
    "New Content\n\n"
    "This content completely replaces the original document content.\n\n"
    "Features:\n"
    "- ✅ Complete content replacement\n"
    "- 📝 Plain text\n"
    "- 🎯 Direct API access\n\n"
    "Note: Content replaced via replace_document API\n"
)

# Replace document content
client.replace_document(
    document_id=document_id,
    description=new_description_text
)

# Verify the change
updated_content = client.get_document_body(document_id)
print(updated_content)  # Shows new content
```

You can also update a task's description directly via the `Task` model:

```python
task = task_response.task
task.update_task_description(client, "New plain text description")
```

### Retrieve Task History

You can retrieve the full change history for a task (or other supported entity) using the `get_history` method. This returns a list of history events with all relevant metadata.

```python
from vaiz import VaizClient
from vaiz.models import GetHistoryRequest
from vaiz.models.enums import EKind

client = VaizClient(api_key="...", space_id="...")

# Retrieve history by task ID
task_id = "your_task_id"
request = GetHistoryRequest(kind=EKind.Task, kindId=task_id)
response = client.get_history(request)

for history in response.payload.histories:
    print(history.key, history.createdAt, history.data)

Working with Comments

Important: Comments require a valid document_id from an existing task. You can get this from getting or creating a task:

# First, create a task to get a document ID
task_response = client.create_task(CreateTaskRequest(
    name="My Task",
    group="your_group_id",
    board="your_board_id",
    project="your_project_id"
))
document_id = task_response.task.document

Post a Comment

# Post a simple text comment
response = client.post_comment(
    document_id="your_document_id",
    content="Simple text comment"
)

comment = response.comment
print(f"Comment ID: {comment.id}")

Post a Comment with HTML Content

# Post a comment with HTML formatting
response = client.post_comment(
    document_id="your_document_id",
    content="<p>Comment with <em>italic</em> and <strong>bold</strong> text</p>"
)

comment = response.comment
print(f"Comment content: {comment.content}")
print(f"Author ID: {comment.author_id}")
print(f"Created at: {comment.created_at}")

Post a Comment with File Attachments

from vaiz.models.enums import EUploadFileType

# First upload files with explicit type specification
upload_response1 = client.upload_file("path/to/image.png", EUploadFileType.Image)  # Will display as image preview
upload_response2 = client.upload_file("path/to/document.pdf", EUploadFileType.Pdf)  # Will display as PDF viewer
upload_response3 = client.upload_file("path/to/video.mp4", EUploadFileType.Video)  # Will display as video player

# You can also upload the same file as different types:
upload_response4 = client.upload_file("path/to/image.png", EUploadFileType.File)  # Will display as downloadable file

file_ids = [upload_response1.file.id, upload_response2.file.id, upload_response3.file.id]

# Post comment with file attachments
response = client.post_comment(
    document_id="your_document_id",
    content="<p>Comment with <strong>multiple files</strong> attached</p>",
    file_ids=file_ids
)

comment = response.comment
print(f"Attached files: {len(comment.files)}")
for file in comment.files:
    print(f"  - {file.original_name} ({file.size} bytes) [Type: {file.type.value}]")

File Type Options:

• EUploadFileType.Image - Displays as image preview/thumbnail
• EUploadFileType.Video - Displays as video player with controls
• EUploadFileType.Pdf - Displays as PDF viewer/preview
• EUploadFileType.File - Displays as downloadable file attachment

Important: You must explicitly specify the file type to control how it appears in the interface. The same file can be uploaded with different types for different display purposes.

Example - Same Image File, Different Display Types:

from vaiz.models.enums import EUploadFileType

# Upload same image file with different types
image_as_preview = client.upload_file("screenshot.png", EUploadFileType.Image)    # Shows preview thumbnail
image_as_file = client.upload_file("screenshot.png", EUploadFileType.File)       # Shows download link

# In comments, users will see:
# - Image type: Preview thumbnail that can be clicked to view full size
# - File type: File icon with filename for download only

# Use Image type for: photos, diagrams, screenshots you want to display
# Use File type for: images you want to share as downloadable assets

Post a Reply to a Comment

# First, create an original comment
original_response = client.post_comment(
    document_id="your_document_id",
    content="<p>Original comment</p>"
)

# Now post a reply to that comment
reply_response = client.post_comment(
    document_id="your_document_id",
    content="<p>This is a reply to the original comment</p>",
    reply_to=original_response.comment.id
)

reply_comment = reply_response.comment
print(f"Reply ID: {reply_comment.id}")
print(f"Replying to: {reply_comment.reply_to}")
print(f"Is reply: {reply_comment.reply_to is not None}")

React to a Comment (Simplified API)

from vaiz.models import CommentReactionType

# First, create a comment to react to
comment_response = client.post_comment(
    document_id="your_document_id",
    content="<p>This comment will get reactions!</p>"
)

# Add popular reactions using the simplified API
reaction_response = client.add_reaction(
    comment_id=comment_response.comment.id,
    reaction=CommentReactionType.THUMBS_UP
)

# Add more reactions
client.add_reaction(comment_response.comment.id, CommentReactionType.HEART)
client.add_reaction(comment_response.comment.id, CommentReactionType.LAUGHING)
client.add_reaction(comment_response.comment.id, CommentReactionType.WOW)
client.add_reaction(comment_response.comment.id, CommentReactionType.CRYING)
client.add_reaction(comment_response.comment.id, CommentReactionType.ANGRY)
client.add_reaction(comment_response.comment.id, CommentReactionType.PARTY)

# Access the reactions
for reaction in reaction_response.reactions:
    print(f"Reaction: {reaction.native} ({reaction.emoji_id})")
    print(f"Members who reacted: {len(reaction.member_ids)}")

Available Reactions

The SDK provides 7 popular emoji reactions based on emoji-picker-react standards:

• CommentReactionType.THUMBS_UP - 👍 Thumbs Up Sign
• CommentReactionType.HEART - ❤️ Red Heart
• CommentReactionType.LAUGHING - 😂 Face with Tears of Joy
• CommentReactionType.WOW - 😮 Face with Open Mouth
• CommentReactionType.CRYING - 😢 Crying Face
• CommentReactionType.ANGRY - 😡 Pouting Face
• CommentReactionType.PARTY - 🎉 Party Popper

React to a Comment (Advanced API)

For custom emoji reactions not in the popular list, use the advanced API:

# Add a custom reaction
reaction_response = client.react_to_comment(
    comment_id=comment_response.comment.id,
    emoji_id="kissing_smiling_eyes",
    emoji_name="Kissing Face with Smiling Eyes",
    emoji_native="😙",
    emoji_unified="1f619",
    emoji_keywords=["affection", "valentines", "infatuation", "kiss"],
    emoji_shortcodes=":kissing_smiling_eyes:"
)

Get Comments for a Document

# Get all comments for a document
comments_response = client.get_comments(document_id="your_document_id")

print(f"Total comments: {len(comments_response.comments)}")

# Iterate through comments
for comment in comments_response.comments:
    print(f"Comment: {comment.content}")
    print(f"Author: {comment.author_id}")
    print(f"Created: {comment.created_at}")

    # Check if it's a reply
    if comment.reply_to:
        print(f"Reply to: {comment.reply_to}")

    # Show reactions
    if comment.reactions:
        for reaction in comment.reactions:
            print(f"Reaction: {reaction.native} - {len(reaction.member_ids)} member(s)")

Edit a Comment

# Edit comment content
edit_response = client.edit_comment(
    comment_id="your_comment_id",
    content="<p><strong>Updated</strong> comment content</p>"
)

print(f"Comment edited at: {edit_response.comment.edited_at}")
print(f"New content: {edit_response.comment.content}")

# Edit comment with file operations
edit_response = client.edit_comment(
    comment_id="your_comment_id",
    content="<p>Updated content</p>",
    add_file_ids=["507f1f77bcf86cd799439011"],      # Add files (valid MongoDB IDs)
    order_file_ids=["507f1f77bcf86cd799439011"],     # Reorder files
    remove_file_ids=["507f1f77bcf86cd799439012"]     # Remove files
)

# Access file information from edited comment
for file in edit_response.comment.files:
    print(f"File: {file.original_name} (ID: {file.id})")

🎛️ Custom Field Helper Functions Reference

The Vaiz SDK provides a comprehensive set of helper functions for working with custom fields:

Field Creation Helpers

from vaiz import (
    make_text_field,
    make_number_field,
    make_checkbox_field,
    make_date_field,
    make_member_field,
    make_task_relations_field,
    make_select_field,
    make_url_field
)

# All field creation helpers follow the same pattern:
field_request = make_text_field(
    name="Field Name",
    board_id="board_id",
    description="Optional description",  # Optional
    hidden=False  # Optional, defaults to False
)

Field Editing Helpers

from vaiz import (
    edit_custom_field_name,
    edit_custom_field_description,
    edit_custom_field_visibility,
    edit_custom_field_complete
)

# Edit specific properties
edit_request = edit_custom_field_name(field_id, board_id, "New Name")

# Edit multiple properties at once
edit_request = edit_custom_field_complete(
    field_id=field_id,
    board_id=board_id,
    name="New Name",           # Optional
    description="New desc",    # Optional
    hidden=True               # Optional
)

Value Formatting Helpers

from vaiz import (
    make_text_value,
    make_number_value,
    make_checkbox_value,
    make_url_value,
    make_date_value,
    make_date_range_value
)
from datetime import datetime

# Format values for use with CustomField
text_val = make_text_value("Hello World")
number_val = make_number_value(42.5)
checkbox_val = make_checkbox_value(True)
url_val = make_url_value("https://example.com")
date_val = make_date_value(datetime.now())

date_range = make_date_range_value(
    start_date=datetime(2025, 1, 1),
    end_date=datetime(2025, 12, 31)
)

Task Relations Helpers

from vaiz import (
    make_task_relation_value,
    add_task_relation,
    remove_task_relation
)

# Create task relations
relations = make_task_relation_value(["task1", "task2", "task3"])

# Manage relations
updated_relations = add_task_relation(relations, "task4")
final_relations = remove_task_relation(updated_relations, "task1")

Member Field Helpers

from vaiz import (
    make_member_value,
    add_member_to_field,
    remove_member_from_field
)

# Create member values (single or multiple)
single_member = make_member_value("user123")
multiple_members = make_member_value(["user1", "user2", "user3"])

# Manage members
more_members = add_member_to_field(single_member, "user456")
fewer_members = remove_member_from_field(multiple_members, "user2")

Select Field & Options Helpers

from vaiz import (
    make_select_option,
    make_select_field,
    add_board_custom_field_select_option,
    remove_board_custom_field_select_option,
    edit_board_custom_field_select_field_option,
    SelectOption
)
from vaiz.models.enums import EColor, EIcon

# Create options
option = make_select_option("High Priority", EColor.Red, EIcon.Flag)

# Create select field with options
options = [
    make_select_option("High", EColor.Red, EIcon.Flag),
    make_select_option("Medium", EColor.Blue, EIcon.Circle),
    make_select_option("Low", EColor.Green, EIcon.Target)
]
select_field = make_select_field("Priority", board_id, options)

# Manage options in existing fields
add_request = add_board_custom_field_select_option(
    field_id, board_id, new_option, existing_options
)

File Operations:

• add_file_ids: Upload files first, then add their IDs to the comment
• order_file_ids: Specify the desired order of all files in the comment
• remove_file_ids: Remove specific files from the comment

Note: Files are UploadedFile objects with properties like id, original_name, size, url, etc.

Delete a Comment

# Soft delete (content cleared but comment preserved in system)
delete_response = client.delete_comment(comment_id="your_comment_id")

deleted_comment = delete_response.comment
print(f"Deleted at: {deleted_comment.deleted_at}")
print(f"Content: '{deleted_comment.content}'")  # Empty string after deletion

All comment models support field aliases and automatic serialization:

from vaiz.models import PostCommentRequest, ReactToCommentRequest

# Create a comment request manually
request = PostCommentRequest(
    document_id="your_document_id",
    content="<p>Manual comment request</p>",
    file_ids=["file1", "file2"]
)

# The request will be automatically serialized with correct field names
data = request.model_dump()
# Results in: {"documentId": "...", "content": "...", "fileIds": [...]}

# Create a reply request
reply_request = PostCommentRequest(
    document_id="your_document_id",
    content="<p>Reply to comment</p>",
    reply_to="original_comment_id"
)

reply_data = reply_request.model_dump()
# Results in: {"documentId": "...", "content": "...", "fileIds": [], "replyTo": "..."}

# Create a reaction request
reaction_request = ReactToCommentRequest(
    comment_id="comment_id",
    id="heart_eyes",
    name="Smiling Face with Heart-Eyes",
    native="😍",
    unified="1f60d",
    keywords=["love", "crush", "heart"],
    shortcodes=":heart_eyes:"
)

reaction_data = reaction_request.model_dump()
# Results in: {"commentId": "...", "id": "heart_eyes", "name": "...", "native": "😍", ...}

Development

Setting Up Development Environment

1. Create and activate a virtual environment:

python3 -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

2. Install the package in development mode:

pip install -e .

Testing

Setup

1. Install test dependencies:

pip install pytest pytest-mock python-dotenv

2. Create a .env file in the project root with your test credentials:

VAIZ_API_KEY=your_test_api_key
VAIZ_SPACE_ID=your_test_space_id

The test configuration (tests/test_config.py) will automatically load these credentials.

Running Tests

Run all tests:

PYTHONPATH=. pytest

Run specific test file:

PYTHONPATH=. pytest tests/test_client.py

Run with verbose output:

PYTHONPATH=. pytest -v

Note: Setting PYTHONPATH=. is required to ensure Python can find the package modules during testing.

Writing Tests

Tests in this project are designed to run against a real API and database, which requires a valid VAIZ_API_KEY and VAIZ_SPACE_ID to be configured in your .env file. The tests do not use mocks for API calls; instead, they interact with the live environment specified in your configuration.

When writing tests for the SDK:

1. Use the test configuration from tests/test_config.py to get a pre-configured client:

from tests.test_config import get_test_client, TEST_BOARD_ID

def test_get_board():
    client = get_test_client()
    response = client.get_board(TEST_BOARD_ID)
    # ... assertions to verify the response

2. Structure your tests to perform real operations and validate the responses from the API. For example, a test might create a resource, then retrieve it to ensure it was created correctly.

3. Include proper assertions to verify the state and data of the responses.

4. Be mindful that tests will create, modify, or delete real data in the configured Vaiz space.

Examples

The SDK includes comprehensive examples demonstrating various API operations:

• 🎛️ Custom Field Management: Complete examples for creating, editing, and managing custom fields
  • examples/custom_field_helpers_usage.py - Basic custom field operations
  • examples/advanced_custom_field_management.py - Advanced field editing, relations, and value formatting
• 📋 Task Management: Create and edit tasks with descriptions and file attachments
• 📁 File Upload: Upload real files from the assets/ folder (example.pdf, example.png, example.mp4)
• 🏗️ Board Operations: Create, edit, and manage boards with custom fields and groups
• 💬 Comment System: Complete CRUD operations with HTML content, reactions, replies, file attachments, and soft delete
• 📊 History Tracking: Retrieve change history for tasks and other objects

Testing and Development

For testing or development purposes, the examples use dynamic document IDs via helper functions in examples/test_helpers.py:

from examples.test_helpers import get_or_create_document_id

# This will create a test task and return its document_id
document_id = get_or_create_document_id()

# Now you can use this document_id for comment operations
response = client.post_comment(
    document_id=document_id,
    content="Test comment"
)

This approach ensures that examples and tests work across different environments without hardcoded IDs.

• Project Management: Retrieve project information and board lists
• Profile Management: Get user profile information
• Comment Management: Post comments with HTML content, file attachments, replies, and reactions

Contributing

1. Fork the repository
2. Create a feature branch
3. Write tests for your changes
4. Ensure all tests pass
5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.