@nominalso/vibe-host 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -718,12 +718,7 @@ type ActivityBillCreate = {
     journal_entry_id?: string | null;
     is_nominal?: boolean;
 };
-type ActivityBillDataInput = {
-    bill: ActivityBillCreate;
-    bill_items: Array<ActivityBillItemCreate>;
-    dimension_value_ids?: Array<string>;
-};
-type ActivityBillDataOutput = {
+type ActivityBillData = {
     bill: ActivityBillCreate;
     bill_items: Array<ActivityBillItemCreate>;
     dimension_value_ids?: Array<string>;
@@ -771,16 +766,15 @@ type ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost = {
     slim?: boolean;
     entity_ids?: Array<string>;
     entity_type?: ActivityTaskEntityType | null;
+    /**
+     * Include the associated entity objects (provider or subsidiary details) in the response.
+     */
     with_entities?: boolean;
 };
 type ActivityConsolidationExchangeRateType = 'current' | 'average' | 'historical';
-type ActivityCreateBillTaskActionDataInput = {
-    action_type?: 'create_bill';
-    bill_data: ActivityBillDataInput;
-};
-type ActivityCreateBillTaskActionDataOutput = {
+type ActivityCreateBillTaskActionData = {
     action_type?: 'create_bill';
-    bill_data: ActivityBillDataOutput;
+    bill_data: ActivityBillData;
 };
 type ActivityCreateIctEliminationActionTemplateInput = {
     action_type?: 'create_ict_elimination_entries';
@@ -866,11 +860,7 @@ type ActivityCreateJournalEntryTaskScheduleActionDataOutput = {
     due_date: ActivityDueDate;
     schedule_name: string;
 };
-type ActivityCreateLockPeriodTaskActionDataInput = {
-    action_type?: 'lock_consolidation_period';
-    period_data: ActivityPeriodData;
-};
-type ActivityCreateLockPeriodTaskActionDataOutput = {
+type ActivityCreateLockPeriodTaskActionData = {
     action_type?: 'lock_consolidation_period';
     period_data: ActivityPeriodData;
 };
@@ -1200,19 +1190,7 @@ type ActivityLeaseAmortizationScheduleActionTemplateOutput = {
 };
 type ActivityLeaseEscalatorFrequency = 'monthly' | 'quarterly' | 'annually';
 type ActivityLeasePaymentFrequency = 'monthly' | 'quarterly' | 'annually' | 'once';
-type ActivityLeasePaymentScheduleActionTemplateInput = {
-    action_type?: 'lease_payment';
-    lease_id: string;
-    lease_name: string;
-    currency: ActivityCurrency;
-    lease_dimension_value_id: string;
-    vendor_id: string;
-    billing_account_id: string;
-    payment_terms: Array<ActivityLeasePaymentTerm>;
-    migration_date?: string | null;
-    is_draft?: boolean;
-};
-type ActivityLeasePaymentScheduleActionTemplateOutput = {
+type ActivityLeasePaymentScheduleActionTemplate = {
     action_type?: 'lease_payment';
     lease_id: string;
     lease_name: string;
@@ -1237,15 +1215,7 @@ type ActivityLeasePaymentTerm = {
     subsidiary_id?: number | null;
     lease_id: string;
 };
-type ActivityLeaseTermReminderActionTemplateInput = {
-    action_type?: 'lease_term_reminder';
-    lease_id: string;
-    lease_name: string;
-    payment_terms: Array<ActivityLeasePaymentTerm>;
-    migration_date?: string | null;
-    is_draft?: boolean;
-};
-type ActivityLeaseTermReminderActionTemplateOutput = {
+type ActivityLeaseTermReminderActionTemplate = {
     action_type?: 'lease_term_reminder';
     lease_id: string;
     lease_name: string;
@@ -1350,25 +1320,15 @@ type ActivityPeriodInstanceProgressBreakdownApi = {
     progress: ActivityTasksProgress;
     activities?: Array<ActivityActivitySubsidiaryProgress>;
 };
-type ActivityPostBillDataInput = {
-    bill_id: string;
-    bill: ActivityBillUpdateBase;
-    bill_items?: Array<ActivityBillItemCreate> | null;
-    dimension_value_ids?: Array<string>;
-};
-type ActivityPostBillDataOutput = {
+type ActivityPostBillData = {
     bill_id: string;
     bill: ActivityBillUpdateBase;
     bill_items?: Array<ActivityBillItemCreate> | null;
     dimension_value_ids?: Array<string>;
 };
-type ActivityPostBillTaskActionDataInput = {
+type ActivityPostBillTaskActionData = {
     action_type?: 'post_bill';
-    bill_data: ActivityPostBillDataInput;
-};
-type ActivityPostBillTaskActionDataOutput = {
-    action_type?: 'post_bill';
-    bill_data: ActivityPostBillDataOutput;
+    bill_data: ActivityPostBillData;
 };
 type ActivityPostIctActionTemplate = {
     action_type?: 'post_ict';
@@ -1459,7 +1419,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
     due_date: ActivityTaskDueDate;
     preparer_due_date?: ActivityDueDate | null;
     description?: string | null;
+    /**
+     * User ID of the person responsible for preparing this task.
+     */
     preparer_id?: string | null;
+    /**
+     * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
+     */
     assignee_id?: string | null;
     blocks_tasks?: Array<ActivityTaskBlocking> | null;
     blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1489,13 +1455,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
         action_type?: 'test_schedule_action';
     } & ActivityTestScheduleActionTemplate) | ({
         action_type?: 'lease_payment';
-    } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
+    } & ActivityLeasePaymentScheduleActionTemplate) | ({
         action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
     } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
         action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
     } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
         action_type?: 'lease_term_reminder';
-    } & ActivityLeaseTermReminderActionTemplateOutput) | ({
+    } & ActivityLeaseTermReminderActionTemplate) | ({
         action_type?: 'create_journal_entry_schedule';
     } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
         action_type?: 'create_journal_entries';
@@ -1691,9 +1657,9 @@ type ActivityTaskActionInput = {
         action_type?: 'test_action';
     } & ActivityTestActionData) | ({
         action_type?: 'create_bill';
-    } & ActivityCreateBillTaskActionDataInput) | ({
+    } & ActivityCreateBillTaskActionData) | ({
         action_type?: 'post_bill';
-    } & ActivityPostBillTaskActionDataInput) | ({
+    } & ActivityPostBillTaskActionData) | ({
         action_type?: 'post_journal_entry';
     } & ActivityPostJournalEntryTaskActionDataInput) | ({
         action_type?: 'post_ict';
@@ -1703,7 +1669,7 @@ type ActivityTaskActionInput = {
         action_type?: 'failure_task';
     } & ActivityFailureTaskActionData) | ({
         action_type?: 'lock_consolidation_period';
-    } & ActivityCreateLockPeriodTaskActionDataInput) | ({
+    } & ActivityCreateLockPeriodTaskActionData) | ({
         action_type?: 'create_journal_entries_bulk';
     } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
         action_type?: 'match_resolution';
@@ -1718,9 +1684,9 @@ type ActivityTaskActionInput = {
         action_type?: 'test_action';
     } & ActivityTestActionData) | ({
         action_type?: 'create_bill';
-    } & ActivityCreateBillTaskActionDataInput) | ({
+    } & ActivityCreateBillTaskActionData) | ({
         action_type?: 'post_bill';
-    } & ActivityPostBillTaskActionDataInput) | ({
+    } & ActivityPostBillTaskActionData) | ({
         action_type?: 'post_journal_entry';
     } & ActivityPostJournalEntryTaskActionDataInput) | ({
         action_type?: 'post_ict';
@@ -1730,7 +1696,7 @@ type ActivityTaskActionInput = {
         action_type?: 'failure_task';
     } & ActivityFailureTaskActionData) | ({
         action_type?: 'lock_consolidation_period';
-    } & ActivityCreateLockPeriodTaskActionDataInput) | ({
+    } & ActivityCreateLockPeriodTaskActionData) | ({
         action_type?: 'create_journal_entries_bulk';
     } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
         action_type?: 'match_resolution';
@@ -1754,9 +1720,9 @@ type ActivityTaskActionOutput = {
         action_type?: 'test_action';
     } & ActivityTestActionData) | ({
         action_type?: 'create_bill';
-    } & ActivityCreateBillTaskActionDataOutput) | ({
+    } & ActivityCreateBillTaskActionData) | ({
         action_type?: 'post_bill';
-    } & ActivityPostBillTaskActionDataOutput) | ({
+    } & ActivityPostBillTaskActionData) | ({
         action_type?: 'post_journal_entry';
     } & ActivityPostJournalEntryTaskActionDataOutput) | ({
         action_type?: 'post_ict';
@@ -1766,7 +1732,7 @@ type ActivityTaskActionOutput = {
         action_type?: 'failure_task';
     } & ActivityFailureTaskActionData) | ({
         action_type?: 'lock_consolidation_period';
-    } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
+    } & ActivityCreateLockPeriodTaskActionData) | ({
         action_type?: 'create_journal_entries_bulk';
     } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
         action_type?: 'match_resolution';
@@ -1781,9 +1747,9 @@ type ActivityTaskActionOutput = {
         action_type?: 'test_action';
     } & ActivityTestActionData) | ({
         action_type?: 'create_bill';
-    } & ActivityCreateBillTaskActionDataOutput) | ({
+    } & ActivityCreateBillTaskActionData) | ({
         action_type?: 'post_bill';
-    } & ActivityPostBillTaskActionDataOutput) | ({
+    } & ActivityPostBillTaskActionData) | ({
         action_type?: 'post_journal_entry';
     } & ActivityPostJournalEntryTaskActionDataOutput) | ({
         action_type?: 'post_ict';
@@ -1793,7 +1759,7 @@ type ActivityTaskActionOutput = {
         action_type?: 'failure_task';
     } & ActivityFailureTaskActionData) | ({
         action_type?: 'lock_consolidation_period';
-    } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
+    } & ActivityCreateLockPeriodTaskActionData) | ({
         action_type?: 'create_journal_entries_bulk';
     } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
         action_type?: 'match_resolution';
@@ -1830,7 +1796,13 @@ type ActivityTaskDefinition = {
     due_date: ActivityTaskDueDate;
     preparer_due_date?: ActivityDueDate | null;
     description?: string | null;
+    /**
+     * User ID of the person responsible for preparing this task.
+     */
     preparer_id?: string | null;
+    /**
+     * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
+     */
     assignee_id?: string | null;
     blocks_tasks?: Array<ActivityTaskBlocking> | null;
     blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1860,13 +1832,13 @@ type ActivityTaskDefinition = {
         action_type?: 'test_schedule_action';
     } & ActivityTestScheduleActionTemplate) | ({
         action_type?: 'lease_payment';
-    } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
+    } & ActivityLeasePaymentScheduleActionTemplate) | ({
         action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
     } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
         action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
     } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
         action_type?: 'lease_term_reminder';
-    } & ActivityLeaseTermReminderActionTemplateOutput) | ({
+    } & ActivityLeaseTermReminderActionTemplate) | ({
         action_type?: 'create_journal_entry_schedule';
     } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
         action_type?: 'create_journal_entries';
@@ -1896,7 +1868,13 @@ type ActivityTaskDefinitionUpdate = {
     due_date: ActivityTaskDueDate;
     preparer_due_date?: ActivityDueDate | null;
     description?: string | null;
+    /**
+     * User ID of the person responsible for preparing this task.
+     */
     preparer_id?: string | null;
+    /**
+     * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
+     */
     assignee_id?: string | null;
     blocks_tasks?: Array<ActivityTaskBlocking> | null;
     blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1916,7 +1894,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
     due_date: ActivityTaskDueDate;
     preparer_due_date?: ActivityDueDate | null;
     description?: string | null;
+    /**
+     * User ID of the person responsible for preparing this task.
+     */
     preparer_id?: string | null;
+    /**
+     * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
+     */
     assignee_id?: string | null;
     blocks_tasks?: Array<ActivityTaskBlocking> | null;
     blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1946,13 +1930,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
         action_type?: 'test_schedule_action';
     } & ActivityTestScheduleActionTemplate) | ({
         action_type?: 'lease_payment';
-    } & ActivityLeasePaymentScheduleActionTemplateInput) | ({
+    } & ActivityLeasePaymentScheduleActionTemplate) | ({
         action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
     } & ActivityLeaseAmortizationScheduleActionTemplateInput) | ({
         action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
     } & ActivityLeaseAmortizationOpeningBalanceActionTemplateInput) | ({
         action_type?: 'lease_term_reminder';
-    } & ActivityLeaseTermReminderActionTemplateInput) | ({
+    } & ActivityLeaseTermReminderActionTemplate) | ({
         action_type?: 'create_journal_entry_schedule';
     } & ActivityCreateJournalEntryScheduleActionTemplateInput) | ({
         action_type?: 'create_journal_entries';
@@ -1971,6 +1955,79 @@ type ActivityTaskDefinitionWithActionCreateApi = {
         reconciliation_type?: 'account_reconciliation';
     } & ActivityAccountReconciliationParams) | null;
 };
+type ActivityTaskDefinitionWithInstances = {
+    name: string;
+    due_date: ActivityTaskDueDate;
+    preparer_due_date?: ActivityDueDate | null;
+    description?: string | null;
+    /**
+     * User ID of the person responsible for preparing this task.
+     */
+    preparer_id?: string | null;
+    /**
+     * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
+     */
+    assignee_id?: string | null;
+    blocks_tasks?: Array<ActivityTaskBlocking> | null;
+    blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
+    end_date?: string | null;
+    task_type?: ActivityTaskType | null;
+    created_at?: string | null;
+    last_modified_at?: string | null;
+    is_deleted?: boolean;
+    activity_definition_id: string;
+    start_date: string;
+    subsidiary_ids: Array<number>;
+    activity_instance_id?: string | null;
+    recurring: boolean;
+    id?: string;
+    creator_user_id?: string | null;
+    is_manual_task?: boolean;
+    entities?: Array<ActivityTaskEntityMapping>;
+    action_template?: (({
+        action_type?: 'create_journal_entry';
+    } & ActivityCreateJournalEntryActionTemplateOutput) | ({
+        action_type?: 'create_ict_elimination_entries';
+    } & ActivityCreateIctEliminationActionTemplateOutput) | ({
+        action_type?: 'post_ict';
+    } & ActivityPostIctActionTemplate) | ({
+        action_type?: 'test_action';
+    } & ActivityTestActionTemplate) | ({
+        action_type?: 'test_schedule_action';
+    } & ActivityTestScheduleActionTemplate) | ({
+        action_type?: 'lease_payment';
+    } & ActivityLeasePaymentScheduleActionTemplate) | ({
+        action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
+    } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
+        action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
+    } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
+        action_type?: 'lease_term_reminder';
+    } & ActivityLeaseTermReminderActionTemplate) | ({
+        action_type?: 'create_journal_entry_schedule';
+    } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
+        action_type?: 'create_journal_entries';
+    } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
+        action_type?: 'failure_task';
+    } & ActivityFailureActionTemplate) | ({
+        action_type?: 'lock_consolidation_period';
+    } & ActivityLockConsolidationRateActionTemplate) | ({
+        action_type?: 'create_journal_entries_bulk';
+    } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
+        action_type?: 'match_resolution';
+    } & ActivityMatchResolutionActionTemplate) | ({
+        action_type?: 'reconciliation_submit';
+    } & ActivityReconciliationSubmitActionTemplate)) | null;
+    reconciliation_definition_params?: ({
+        reconciliation_type?: 'account_reconciliation';
+    } & ActivityAccountReconciliationParams) | null;
+    trigger_id?: string | null;
+    workflow_execution_id?: string | null;
+    creator_task_id?: string | null;
+    activity_definition: ActivityActivityDefinitionCreateWithType;
+    action_type?: string | null;
+    task_instances?: Array<ActivityTaskInstanceWithAction>;
+    creator: ActivityTaskCreator | null;
+};
 /**
  * Task-specific DueDate that carries an optional preparer/reviewer offset.
  *
@@ -2016,6 +2073,9 @@ type ActivityTaskInstanceUpdate = {
     due_date?: string | null;
     assignee_id?: string | null;
     preparer_id?: string | null;
+    /**
+     * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
+     */
     reviewer_id?: string | null;
     status?: ActivityTaskStatus | null;
     preparer_due_date?: string | null;
@@ -2036,6 +2096,9 @@ type ActivityTaskInstanceUpdateClearAction = {
     due_date?: string | null;
     assignee_id?: string | null;
     preparer_id?: string | null;
+    /**
+     * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
+     */
     reviewer_id?: string | null;
     status?: ActivityTaskStatus | null;
     preparer_due_date?: string | null;
@@ -2050,6 +2113,9 @@ type ActivityTaskInstanceUpdateWithAction = {
     due_date?: string | null;
     assignee_id?: string | null;
     preparer_id?: string | null;
+    /**
+     * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
+     */
     reviewer_id?: string | null;
     status?: ActivityTaskStatus | null;
     preparer_due_date?: string | null;
@@ -2542,6 +2608,18 @@ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLin
         is_nominal_ledger?: boolean | null;
         memo?: string | null;
         journal_entry_line_ids?: Array<string> | null;
+        /**
+         * Filter to lines posted to any of these GL accounts.
+         */
+        account_ids?: Array<string> | null;
+        /**
+         * Filter to lines assigned any of these dimension values.
+         */
+        dimension_value_ids?: Array<string> | null;
+        /**
+         * Return only lines with no dimension assignment. Takes precedence over dimension_value_ids.
+         */
+        unassigned_only?: boolean | null;
         page?: number | null;
         per_page?: number | null;
         include_total?: boolean;
@@ -2563,13 +2641,25 @@ type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData
         subsidiary_id: number;
     };
     query?: {
+        /**
+         * Filter by journal entry type. Values: adjustment (manual Nominal entry), elimination (consolidation entry), book_entry, ic_transaction (inter-company).
+         */
         entry_types?: Array<AccountingJournalEntryType> | null;
+        /**
+         * Filter by one or more human-readable reference numbers (e.g. ref #42).
+         */
         ref_numbers?: Array<string> | null;
         child_subsidiaries?: Array<number> | null;
         from_date?: string | null;
         to_date?: string | null;
+        /**
+         * If true, return only manually created Nominal ledger entries, excluding provider-synced transactions.
+         */
         is_nominal_ledger?: boolean | null;
         memo?: string | null;
+        /**
+         * Filter by status. Values: Draft (not yet posted), Submitted (pending review), Posted (finalised and reflected in reports).
+         */
         entry_statuses?: Array<AccountingJournalEntryStatus> | null;
         /**
          * Filter entries where any line has this amount
@@ -2610,8 +2700,17 @@ type GetDimensionsApiAccountingDimensionGetData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Filter dimensions scoped to a specific subsidiary (integer ID).
+         */
         subsidiary_id?: number | null;
+        /**
+         * Maximum number of dimension values to return per dimension (default 1000).
+         */
         values_limit?: number | null;
+        /**
+         * If true, include the full set of dimension values and their auto-assignment rules in the response.
+         */
         with_rules_and_values?: boolean;
     };
     url: '/api/accounting/dimension';
@@ -2643,10 +2742,25 @@ type GetDimensionValuesApiAccountingDimensionValueGetData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Filter to values belonging to specific dimension IDs.
+         */
         dimension_ids?: Array<string> | null;
+        /**
+         * Filter to specific dimension value IDs.
+         */
         dimension_value_ids?: Array<string> | null;
+        /**
+         * Text search filter on the parent dimension name.
+         */
         dimension_name?: string | null;
+        /**
+         * Text search filter on the dimension value name.
+         */
         dimension_value?: string | null;
+        /**
+         * Return a lightweight response without rules and extended metadata.
+         */
         slim?: boolean;
         /**
          * Sort dimension values alphabetically by value
@@ -2728,7 +2842,13 @@ type GetActivityDefinitionsApiActivityActivityDefinitionGetData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Include disabled activity definitions in the response.
+         */
         with_disabled_activity?: boolean;
+        /**
+         * Include the nested task definition templates in the response.
+         */
         with_task_definitions?: boolean;
     };
     url: '/api/activity/activity-definition';
@@ -2748,6 +2868,9 @@ type GetPeriodInstancesApiActivityPeriodInstanceGetData = {
     path?: never;
     query?: {
         period?: ActivityPeriod | null;
+        /**
+         * Return lightweight response without task instance details.
+         */
         slim?: boolean;
         from_date?: string | null;
         to_date?: string | null;
@@ -2761,8 +2884,17 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
         period_instance_id: string;
     };
     query?: {
+        /**
+         * Include activities that are currently disabled in the response.
+         */
         with_disabled_activity?: boolean;
+        /**
+         * Include child subsidiary period instances in the response.
+         */
         include_children?: boolean;
+        /**
+         * Filter to specific subsidiary integer IDs.
+         */
         subsidiary_ids?: Array<number> | null;
     };
     url: '/api/activity/period-instance/{period_instance_id}';
@@ -2770,6 +2902,9 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
 type GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData = {
     body?: never;
     path: {
+        /**
+         * Human-readable period identifier, e.g. '2024-01' for January 2024 or '2024-Q1' for Q1 2024.
+         */
         period_display_id: string;
     };
     query?: {
@@ -2839,7 +2974,7 @@ type CreateTaskDefinitionApiActivityTaskDefinitionPostResponses = {
     /**
      * Successful Response
      */
-    200: ActivityTaskDefinition;
+    200: ActivityTaskDefinitionWithInstances;
 };
 type CreateTaskDefinitionApiActivityTaskDefinitionPostResponse = CreateTaskDefinitionApiActivityTaskDefinitionPostResponses[keyof CreateTaskDefinitionApiActivityTaskDefinitionPostResponses];
 type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
@@ -2847,6 +2982,9 @@ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
     path?: never;
     query?: {
         entity_ids?: Array<string>;
+        /**
+         * Filter by the type of entity the task applies to. Values: SUBSIDIARY (subsidiary-level tasks), PROVIDER (accounting provider tasks), ACTIVITY (activity-level tasks).
+         */
         entity_type?: ActivityTaskEntityType | null;
         with_instances?: boolean;
         q?: string | null;
@@ -2895,8 +3033,17 @@ type GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData = {
         activity_instance_id: string;
     };
     query?: {
+        /**
+         * Return lightweight task instance summaries instead of full task details.
+         */
         with_slim_task_instances?: boolean;
+        /**
+         * Include the nested task instance list in the response.
+         */
         with_instances?: boolean;
+        /**
+         * Include reconciliation-specific fields in the response.
+         */
         for_reconciliation?: boolean;
         subsidiary_ids?: Array<number> | null;
     };
@@ -2914,9 +3061,9 @@ type GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTask
         status?: Array<ActivityTaskStatus> | null;
         preparer_ids?: Array<string> | null;
         reviewer_ids?: Array<string> | null;
-        due_date_period?: ActivityPeriodFilter;
-        due_date_from?: string;
-        due_date_to?: string;
+        due_date_period?: ActivityPeriodFilter | null;
+        due_date_from?: string | null;
+        due_date_to?: string | null;
         slim?: boolean;
         without_activity_instance?: boolean;
         page?: number | null;
@@ -2936,6 +3083,9 @@ type GetActivityInstancesApiActivityActivityInstanceGetData = {
         activity_definition_id?: string | null;
         from_date?: string | null;
         to_date?: string | null;
+        /**
+         * Return enriched response including subsidiary details and provider information alongside each activity instance.
+         */
         as_enriched?: boolean;
     };
     url: '/api/activity/activity-instance';
@@ -2997,16 +3147,28 @@ type GetAllTaskInstancesApiActivityTaskInstanceGetData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Filter by task status. Values: PENDING (not started), IN_REVIEW (submitted for review), DONE (completed and approved), CANCELLED.
+         */
         status?: Array<ActivityTaskStatus>;
         subsidiary_ids?: Array<number>;
         activity_definition_ids?: Array<string>;
         preparer_ids?: Array<string> | null;
         reviewer_ids?: Array<string> | null;
         period_instance_id?: string | null;
+        /**
+         * Filter to tasks for a specific period (e.g. '2024-01').
+         */
         period_display_id?: string | null;
         period_instance_ids?: Array<string> | null;
         period_display_ids?: Array<string> | null;
+        /**
+         * Exclude task instances of specific types. Values: RECONCILIATION, APPROVAL, MANUAL.
+         */
         exclude_task_types?: Array<ActivityTaskType> | null;
+        /**
+         * Return lightweight response without full task details.
+         */
         slim?: boolean;
         sort?: ActivitySortableFieldsTask;
         order?: ActivitySortingOrder | null;
@@ -3110,6 +3272,9 @@ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse =
 type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData = {
     body?: never;
     path: {
+        /**
+         * The tenant UUID or its string name identifier (slug).
+         */
         tenant_id_or_name: string;
     };
     query?: never;
@@ -3143,9 +3308,15 @@ type GetAllSubsidiariesApiTenancySubsidiaryGetResponse = GetAllSubsidiariesApiTe
 type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData = {
     body?: never;
     path: {
+        /**
+         * Integer subsidiary ID from the tenancy hierarchy.
+         */
         subsidiary_id: number;
     };
     query?: {
+        /**
+         * If true, include consolidation-only elimination subsidiaries in the response.
+         */
         with_elimination_subsidiaries?: boolean;
     };
     url: '/api/tenancy/subsidiary/{subsidiary_id}';
@@ -3265,6 +3436,28 @@ interface ContextPayload {
     hostVersion: string;
 }
 
+/**
+ * Response type for operations whose Nominal OpenAPI `200` response declares
+ * **no content schema**. hey-api generates `200: unknown` for these, so there is
+ * genuinely no concrete type to narrow to at codegen time — the shape is
+ * undocumented upstream, not merely unmapped by this SDK.
+ *
+ * We surface this named alias instead of a bare `unknown` so the gap is
+ * self-documenting: editors show `UntypedApiResponse` (with this doc) rather than
+ * an anonymous `unknown`, signalling that the value must be explicitly asserted
+ * to a known shape (`const p = res as MyPeriod`) rather than trusted. It stays
+ * assignment-compatible with `unknown`, so no runtime or narrowing behaviour
+ * changes.
+ *
+ * The fix is upstream: document these endpoints' response bodies in the owning
+ * Nominal service's OpenAPI (then the registry entry can reference the generated
+ * `*Response` type). Affected ops today: `GET_PERIODS`, `GET_PERIOD_INSTANCE`,
+ * `GET_PERIOD_INSTANCE_BY_SLUG`, `POST_TASK_OUTPUT`, `GET_TASK_INSTANCE`,
+ * `GET_TASK_INSTANCES`, `GET_TASK_DEFINITION`, `GET_ACTIVITY_DEFINITION(S)`,
+ * `GET_ACTIVITY_INSTANCE`, `GET_ACTIVITY_INSTANCE_TASKS`,
+ * `GET_ACTIVITY_PERIOD_TASKS`.
+ */
+type UntypedApiResponse = unknown;
 interface UploadPayload {
     buffer: ArrayBuffer;
     fileName: string;
@@ -3337,11 +3530,11 @@ interface RequestRegistry {
     };
     GET_PERIODS: {
         payload: Omit<GetPeriodInstancesApiActivityPeriodInstanceGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     POST_TASK_OUTPUT: {
         payload: Omit<UpdateTaskInstanceApiActivityTaskInstanceTaskInstanceIdPutData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_DIMENSIONS: {
         payload: Omit<GetDimensionsApiAccountingDimensionGetData, 'url'>;
@@ -3357,7 +3550,7 @@ interface RequestRegistry {
     };
     GET_ACTIVITY_DEFINITIONS: {
         payload: Omit<GetActivityDefinitionsApiActivityActivityDefinitionGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_TASK_DEFINITIONS: {
         payload: Omit<GetAllTasksDefinitionsApiActivityTaskDefinitionGetData, 'url'>;
@@ -3365,7 +3558,7 @@ interface RequestRegistry {
     };
     GET_TASK_INSTANCES: {
         payload: Omit<GetAllTaskInstancesApiActivityTaskInstanceGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_FISCAL_CALENDARS: {
         payload: Omit<GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetData, 'url'>;
@@ -3433,11 +3626,11 @@ interface RequestRegistry {
     };
     GET_PERIOD_INSTANCE: {
         payload: Omit<GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_PERIOD_INSTANCE_BY_SLUG: {
         payload: Omit<GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_PERIOD_PROGRESS_BREAKDOWN: {
         payload: Omit<GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetData, 'url'>;
@@ -3445,7 +3638,7 @@ interface RequestRegistry {
     };
     GET_ACTIVITY_DEFINITION: {
         payload: Omit<GetActivityDefinitionByIdApiActivityActivityDefinitionActivityDefinitionIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_ACTIVITY_INSTANCES: {
         payload: Omit<GetActivityInstancesApiActivityActivityInstanceGetData, 'url'>;
@@ -3453,7 +3646,7 @@ interface RequestRegistry {
     };
     GET_ACTIVITY_INSTANCE: {
         payload: Omit<GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_ACTIVITY_INSTANCE_BY_PERIOD: {
         payload: Omit<GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetData, 'url'>;
@@ -3461,15 +3654,15 @@ interface RequestRegistry {
     };
     GET_ACTIVITY_INSTANCE_TASKS: {
         payload: Omit<GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTaskGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_ACTIVITY_PERIOD_TASKS: {
         payload: Omit<GetTaskInstancesByActivityPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdTaskGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_TASK_DEFINITION: {
         payload: Omit<GetTaskDefinitionByIdApiActivityTaskDefinitionTaskDefinitionIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     CREATE_TASK_DEFINITION: {
         payload: Omit<CreateTaskDefinitionApiActivityTaskDefinitionPostData, 'url'>;
@@ -3485,7 +3678,7 @@ interface RequestRegistry {
     };
     GET_TASK_INSTANCE: {
         payload: Omit<GetTaskInstanceByIdApiActivityTaskInstanceTaskInstanceIdGetData, 'url'>;
-        data: unknown;
+        data: UntypedApiResponse;
     };
     GET_TASK_INSTANCES_BY_FILTER: {
         payload: Omit<GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostData, 'url'>;
@@ -3545,12 +3738,24 @@ type RequestHandlers = {
  * string-matching `error.message`. A failed Nominal API call rehydrates as the
  * {@link HttpBridgeError} subtype, which adds the HTTP `status`.
  *
+ * SDK-originated codes you may also see: `'TIMEOUT'` (a request or the connect
+ * handshake timed out), `'DESTROYED'` (the bridge was torn down mid-flight),
+ * `'PARENT_ORIGIN_UNRESOLVED'` (no embedding origin could be resolved) and
+ * `'SERVER_ENVIRONMENT'` (a browser-only method was called where there is no
+ * `window` — e.g. during SSR / in a React Server Component / in a Worker).
+ *
+ * This class is safe to import from any environment (see the module header).
+ *
  * @example
  * ```ts
+ * import { BridgeError } from '@nominalso/vibe-bridge'
+ *
  * try {
  *   await bridge.getAccounts({})
  * } catch (err) {
- *   if (err instanceof BridgeError && err.code === 'RATE_LIMITED') {
+ *   // `instanceof` works within a single bundle; `isBridgeError` also works
+ *   // across independently-built server/client bundles.
+ *   if (BridgeError.isBridgeError(err) && err.code === 'RATE_LIMITED') {
  *     // back off and retry
  *   }
  * }
@@ -3559,6 +3764,13 @@ type RequestHandlers = {
 declare class BridgeError extends Error {
     readonly code: string;
     constructor(code: string, message: string);
+    /**
+     * Cross-realm-safe type guard. Prefer this over `instanceof BridgeError` when
+     * an error may have been thrown by a differently-built copy of the SDK (e.g.
+     * server bundle vs client bundle) — it matches on a process-global brand
+     * rather than class identity.
+     */
+    static isBridgeError(err: unknown): err is BridgeError;
 }
 /**
  * A {@link BridgeError} for a failed Nominal API call. Its `code` is always
@@ -3568,10 +3780,12 @@ declare class BridgeError extends Error {
  *
  * @example
  * ```ts
+ * import { HttpBridgeError } from '@nominalso/vibe-bridge'
+ *
  * try {
  *   await bridge.getAccount({ path: { account_id: 'missing' } })
  * } catch (err) {
- *   if (err instanceof HttpBridgeError && err.status === 404) {
+ *   if (HttpBridgeError.isHttpBridgeError(err) && err.status === 404) {
  *     // handle not-found
  *   }
  * }
@@ -3580,6 +3794,11 @@ declare class BridgeError extends Error {
 declare class HttpBridgeError extends BridgeError {
     readonly status: number;
     constructor(status: number, message: string);
+    /**
+     * Cross-realm-safe type guard (see {@link BridgeError.isBridgeError}). Returns
+     * `true` only for `HttpBridgeError` instances, not plain `BridgeError`s.
+     */
+    static isHttpBridgeError(err: unknown): err is HttpBridgeError;
 }
 
 interface VibeApiClientOptions {