wealthbox-cli 1.0.0__py3-none-any.whl

wealthbox_tools/models/enums.py

@@ -0,0 +1,209 @@
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+# Contacts
+class RecordType(StrEnum):
+    PERSON = "Person"
+    HOUSEHOLD = "Household"
+    ORGANIZATION = "Organization"
+    TRUST = "Trust"
+
+
+class Gender(StrEnum):
+    FEMALE = "Female"
+    MALE = "Male"
+    NON_BINARY = "Non-binary"
+    UNKNOWN = "Unknown"
+
+
+class MaritalStatus(StrEnum):
+    MARRIED = "Married"
+    SINGLE = "Single"
+    DIVORCED = "Divorced"
+    WIDOWED = "Widowed"
+    LIFE_PARTNER = "Life partner"
+    SEPARATED = "Separated"
+    UNKNOWN = "Unknown"
+
+class ContactsOrder(StrEnum):
+    ASC = "asc"
+    DESC = "desc"
+    RECENT = "recent"
+    CREATED = "created"
+    UPDATED = "updated"
+
+
+# Households
+class HouseholdTitle(StrEnum):
+    HEAD = "Head"
+    SPOUSE = "Spouse"
+    CHILD = "Child"
+    OTHER_DEPENDENT = "Other Dependent"
+    PARTNER = "Partner"
+    PARENT = "Parent"
+    SIBLING = "Sibling"
+    GRANDPARENT = "Grandparent"
+    GRANDCHILD = "Grandchild"
+
+
+# Activity
+class ActivityType(StrEnum):
+    CONTACT = "Contact"
+    STATUS_UPDATE = "StatusUpdate"
+    DROPBOX_EMAIL = "DropboxEmail"
+    PHONE_CALL = "PhoneCall"
+    TASK = "Task"
+    EVENT = "Event"
+    WORKFLOW = "Workflow"
+    WORKFLOW_STEP = "WorkflowStep"
+    OPPORTUNITY = "Opportunity"
+    DATA_FILE = "DataFile"
+    MAIL_MERGE = "MailMerge"
+    PROJECT = "Project"
+    USER = "User"
+    MEETING = "Meeting"
+    CUSTOM_OBJECT = "CustomObject"
+
+
+# Categories
+class CategoryType(StrEnum):
+    TAGS = "tags"
+    CUSTOM_FIELDS = "custom_fields"
+    OPPORTUNITY_STAGES = "opportunity_stages"
+    OPPORTUNITY_PIPELINES = "opportunity_pipelines"
+    CONTACT_TYPES = "contact_types"
+    CONTACT_SOURCES = "contact_sources"
+    TASK_CATEGORIES = "task_categories"
+    EVENT_CATEGORIES = "event_categories"
+    FILE_CATEGORIES = "file_categories"
+    INVESTMENT_OBJECTIVES = "investment_objectives"
+    FINANCIAL_ACCOUNT_TYPES = "financial_account_types"
+    EMAIL_TYPES = "email_types"
+    PHONE_TYPES = "phone_types"
+    ADDRESS_TYPES = "address_types"
+    WEBSITE_TYPES = "website_types"
+    CONTACT_ROLES = "contact_roles"
+
+
+class DocumentType(StrEnum):
+    CONTACT = "Contact"
+    OPPORTUNITY = "Opportunity"
+    PROJECT = "Project"
+    TASK = "Task"
+    EVENT = "Event"
+    MANUAL_INVESTMENT_ACCOUNT = "ManualInvestmentAccount"
+    DATA_FILE = "DataFile"
+
+
+# Events
+class EventsState(StrEnum):
+    UNCONFIRMED = "unconfirmed"
+    CONFIRMED = "confirmed"
+    TENTATIVE = "tentative"
+    COMPLETED = "completed"
+    CANCELLED = "cancelled"
+
+
+class EventsOrder(StrEnum):
+    ASC = "asc"
+    DESC = "desc"
+    RECENT = "recent"
+    CREATED = "created"
+
+
+
+
+class EmailInviteeType(StrEnum):
+    USER = "User"
+    CONTACT = "Contact"
+
+
+# Notes
+class NotesOrder(StrEnum):
+    ASC = "asc"
+    CREATED = "created"
+    UPDATED = "updated"
+
+
+# Tasks
+class TaskFrame(StrEnum):
+    TODAY = "today"
+    TOMORROW = "tomorrow"
+    THIS_WEEK = "this_week"
+    NEXT_WEEK = "next_week"
+    FUTURE = "future"
+    SPECIFIC = "specific"
+
+
+class TaskResourceType(StrEnum):
+    CONTACT = "Contact"
+    PROJECT = "Project"
+    OPPORTUNITY = "Opportunity"
+
+
+class NoteResourceType(StrEnum):
+    CONTACT = "Contact"
+
+
+class CommentResourceType(StrEnum):
+    CONTACT = "Contact"
+    TASK = "Task"
+    EVENT = "Event"
+
+
+class OpportunityResourceType(StrEnum):
+    CONTACT = "Contact"
+    PROJECT = "Project"
+
+
+class WorkflowResourceType(StrEnum):
+    CONTACT = "Contact"
+    PROJECT = "Project"
+
+
+class TaskType(StrEnum):
+    ALL = "all"
+    PARENTS = "parents"
+    SUBTASKS = "subtasks"
+
+
+class TaskPriority(StrEnum):
+    LOW = "Low"
+    MEDIUM = "Medium"
+    HIGH = "High"
+
+
+class InvestmentRiskTolerance(StrEnum):
+    LOW = "Low"
+    MODERATE = "Moderate"
+    HIGH = "High Risk"
+
+
+class InvestmentTimeHorizon(StrEnum):
+    SHORT_TERM = "Short Term"
+    INTERMEDIATE = "Intermediate"
+    LONG_TERM = "Long Term"
+
+
+# Opportunities
+class OpportunityOrder(StrEnum):
+    ASC = "asc"
+    DESC = "desc"
+    RECENT = "recent"
+    CREATED = "created"
+
+
+class OpportunityAmountKind(StrEnum):
+    FEE = "Fee"
+    COMMISSION = "Commission"
+    AUM = "AUM"
+    OTHER = "Other"
+
+
+# Workflows
+class WorkflowStatus(StrEnum):
+    ACTIVE = "active"
+    COMPLETED = "completed"
+    SCHEDULED = "scheduled"

wealthbox_tools/models/events.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from .common import (
+    DateField,
+    DateTimeField,
+    LinkedToRef,
+    NonNullDateTimeField,
+    PaginationQuery,
+    RequireAnyFieldModel,
+    WealthboxModel,
+)
+from .enums import EmailInviteeType, EventsOrder, EventsState, TaskResourceType
+
+
+class EmailInvitees(WealthboxModel):
+    id: int | None = Field(default=None, ge=1)
+    type: EmailInviteeType | None = None
+
+
+class EventListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: TaskResourceType | None = None
+    start_date_min: DateField = None
+    start_date_max: DateField = None
+    order: EventsOrder | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class EventCreateInput(WealthboxModel):
+    title: str = Field(min_length=1)
+    starts_at: NonNullDateTimeField
+    ends_at: NonNullDateTimeField
+    repeats: bool | None = None
+    event_category: int | None = Field(default=None, ge=1)
+    all_day: bool | None = None
+    location: str | None = None
+    description: str | None = None
+    state: EventsState | None = None
+    # visible_to: str | None = None
+    email_invitees: bool | None = None
+    linked_to: list[LinkedToRef] | None = None
+    invitees: list[EmailInvitees] | None = None
+    # custom_fields: str | None = None
+
+
+class EventUpdateInput(RequireAnyFieldModel):
+    title: str | None = None
+    starts_at: DateTimeField = None
+    ends_at: DateTimeField = None
+    repeats: bool | None = None
+    event_category: int | None = Field(default=None, ge=1)
+    all_day: bool | None = None
+    location: str | None = None
+    description: str | None = None
+    state: EventsState | None = None
+    # visible_to: str | None = None
+    email_invitees: bool | None = None
+    linked_to: list[LinkedToRef] | None = None
+    invitees: list[EmailInvitees] | None = None
+    # custom_fields: str | None = None

wealthbox_tools/models/households.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from pydantic import Field, model_validator
+
+from .common import WealthboxModel
+from .enums import HouseholdTitle
+
+
+class HouseholdMemberInput(WealthboxModel):
+    id: int | None = Field(default=None, ge=1)
+    title: HouseholdTitle | None = Field(default=None, min_length=1)
+
+    @model_validator(mode="after")
+    def ensure_member_target(self) -> "HouseholdMemberInput":
+        if self.id is None and self.title is None:
+            raise ValueError("Either id or title must be provided.")
+        return self

wealthbox_tools/models/notes.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from .common import DateTimeField, LinkedToRef, PaginationQuery, RequireAnyFieldModel, WealthboxModel
+from .enums import NoteResourceType, NotesOrder
+
+
+class NoteListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: NoteResourceType | None = None
+    order: NotesOrder | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class NoteCreateInput(WealthboxModel):
+    content: str = Field(min_length=1)
+    linked_to: list[LinkedToRef] | None = None
+    # visable_to: str | None = None
+    # tags: list[str] | None = None
+
+
+class NoteUpdateInput(RequireAnyFieldModel):
+    content: str | None = Field(default=None, min_length=1)
+    linked_to: list[LinkedToRef] | None = None
+    # visable_to: str | None = None
+    # tags: list[str] | None = None

wealthbox_tools/models/opportunities.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from .common import DateTimeField, LinkedToRef, PaginationQuery, RequireAnyFieldModel, WealthboxModel
+from .custom_fields import CustomFieldValue
+from .enums import OpportunityAmountKind, OpportunityOrder, OpportunityResourceType
+
+
+class OpportunityAmount(WealthboxModel):
+    amount: float
+    currency: str = Field(min_length=1)
+    kind: OpportunityAmountKind
+
+
+class OpportunityListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: OpportunityResourceType | None = None
+    order: OpportunityOrder | None = None
+    include_closed: bool | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class OpportunityCreateInput(WealthboxModel):
+    name: str = Field(min_length=1)
+    description: str | None = None
+    target_close: str = Field(min_length=1)
+    probability: int = Field(ge=0, le=100)
+    stage: int = Field(ge=1)
+    manager: int | None = None
+    amounts: list[OpportunityAmount] | None = None
+    linked_to: list[LinkedToRef] | None = None
+    visible_to: str | None = None
+    custom_fields: list[CustomFieldValue] | None = None
+
+
+class OpportunityUpdateInput(RequireAnyFieldModel):
+    name: str | None = None
+    description: str | None = None
+    target_close: str | None = None
+    probability: int | None = Field(default=None, ge=0, le=100)
+    stage: int | None = Field(default=None, ge=1)
+    manager: int | None = None
+    amounts: list[OpportunityAmount] | None = None
+    linked_to: list[LinkedToRef] | None = None
+    visible_to: str | None = None
+    custom_fields: list[CustomFieldValue] | None = None

wealthbox_tools/models/projects.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from .common import DateTimeField, PaginationQuery, RequireAnyFieldModel, WealthboxModel
+from .custom_fields import CustomFieldValue
+
+
+class ProjectListQuery(PaginationQuery):
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class ProjectCreateInput(WealthboxModel):
+    name: str = Field(min_length=1)
+    description: str = Field(min_length=1)
+    organizer: int | None = None
+    visible_to: str | None = None
+    custom_fields: list[CustomFieldValue] | None = None
+
+
+class ProjectUpdateInput(RequireAnyFieldModel):
+    name: str | None = None
+    description: str | None = None
+    organizer: int | None = None
+    visible_to: str | None = None
+    custom_fields: list[CustomFieldValue] | None = None

wealthbox_tools/models/tasks.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from pydantic import Field, model_validator
+
+from .common import DateTimeField, LinkedToRef, PaginationQuery, RequireAnyFieldModel, WealthboxModel
+from .enums import TaskFrame, TaskPriority, TaskResourceType, TaskType
+
+
+def _validate_assignment_target(assigned_to: int | None, assigned_to_team: int | None) -> None:
+    if assigned_to is not None and assigned_to_team is not None:
+        raise ValueError("Provide only one of assigned_to or assigned_to_team.")
+
+
+
+class TaskListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: TaskResourceType | None = None
+    assigned_to: int | None = Field(default=None, ge=1)
+    assigned_to_team: int | None = Field(default=None, ge=1)
+    created_by: int | None = Field(default=None, ge=1)
+    completed: bool | None = None
+    task_type: TaskType | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class TaskCreateInput(WealthboxModel):
+    name: str = Field(min_length=1)
+    due_date: DateTimeField = None
+    frame: TaskFrame | None = None
+    complete: bool | None = None
+    category: int | None = Field(default=None, ge=1)
+    linked_to: list[LinkedToRef] | None = None
+    priority: TaskPriority | None = None
+    # visible_to: str | None = None
+    # due_later: str | None = None
+    # subtasks: SubTaskInput | None = None
+    # custom_fields: TaskCustomFieldInput | None = None
+    assigned_to: int | None = Field(default=None, ge=1)
+    assigned_to_team: int | None = Field(default=None, ge=1)
+    description: str | None = None
+
+    @model_validator(mode="after")
+    def validate_assignment_target(self) -> "TaskCreateInput":
+        _validate_assignment_target(self.assigned_to, self.assigned_to_team)
+        return self
+
+    @model_validator(mode="after")
+    def validate_due_date_xor_frame(self) -> "TaskCreateInput":
+        if (self.due_date is None) == (self.frame is None):
+            # both None OR both set
+            raise ValueError("Provide exactly one of due_date or frame (not both).")
+        return self
+
+
+
+class TaskUpdateInput(RequireAnyFieldModel):
+    name: str | None = Field(default=None, min_length=1)
+    due_date: DateTimeField = None
+    frame: TaskFrame | None = None
+    complete: bool | None = None
+    category: int | None = Field(default=None, ge=1)
+    linked_to: list[LinkedToRef] | None = None
+    priority: TaskPriority | None = None
+    # visible_to: str | None = None
+    # due_later: str | None = None
+    # subtasks: SubTaskInput | None = None
+    # custom_fields: TaskCustomFieldInput | None = None
+    assigned_to: int | None = Field(default=None, ge=1)
+    assigned_to_team: int | None = Field(default=None, ge=1)
+    description: str | None = None
+
+    @model_validator(mode="after")
+    def validate_assignment_target(self) -> "TaskUpdateInput":
+        _validate_assignment_target(self.assigned_to, self.assigned_to_team)
+        return self

wealthbox_tools/models/workflows.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from .common import DateTimeField, LinkedToRef, PaginationQuery, WealthboxModel
+from .enums import WorkflowResourceType, WorkflowStatus
+
+
+class WorkflowMilestone(WealthboxModel):
+    id: int = Field(ge=1)
+    name: str = Field(min_length=1)
+    milestone_date: str = Field(min_length=1)
+
+
+class WorkflowListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: WorkflowResourceType | None = None
+    status: WorkflowStatus | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class WorkflowCreateInput(WealthboxModel):
+    label: str | None = None
+    linked_to: list[LinkedToRef] | None = None
+    visible_to: str | None = None
+    workflow_template: int = Field(ge=1)
+    starts_at: str | None = None
+    workflow_milestones: list[WorkflowMilestone] | None = None
+
+
+class WorkflowTemplateListQuery(PaginationQuery):
+    resource_id: int | None = Field(default=None, ge=1)
+    resource_type: WorkflowResourceType | None = None
+    status: WorkflowStatus | None = None
+    updated_since: DateTimeField = None
+    updated_before: DateTimeField = None
+
+
+class WorkflowStepCompleteInput(WealthboxModel):
+    complete: bool = Field(default=True)
+    workflow_outcome_id: int | None = None
+    # When selecting an outcome with the “Restart Step” action, this indicates
+    # whether the restarted step will have a due date.
+    due_date_set: bool = Field(default=False)
+    due_date: str | None = None
+
+
+class WorkflowStepRevertInput(WealthboxModel):
+    revert: bool = Field(default=True)