@vrplatform/api 1.3.0-stage.1158 → 1.3.0-stage.1159

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.0-stage.1158",
+  "version": "1.3.0-stage.1159",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",

package/src/generated/v1.ts

@@ -1426,6 +1426,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/dispatch/effects": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List effects with optional filters by dispatch ID, entity ID, entity type, or status. */
+        get: operations["listEffects"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/dispatch/{id}": {
         parameters: {
             query?: never;
@@ -1443,6 +1460,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/dispatch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List dispatched actions with optional filters. Use entityId to find dispatches related to a specific entity. */
+        get: operations["listDispatchActions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/plaid/connect": {
         parameters: {
             query?: never;
@@ -21370,15 +21404,22 @@ export interface operations {
             };
         };
     };
-    getDispatchAction: {
+    listEffects: {
         parameters: {
-            query?: never;
+            query?: {
+                limit?: number;
+                offset?: number;
+                dispatchId?: string;
+                entityId?: string;
+                entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
+                status?: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
+                effectType?: "CREATE_RECURRING_TRANSACTION_INSTANCE" | "REFRESH_RESERVATION_JOURNAL" | "REFRESH_TRANSACTION_JOURNAL" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
+                page?: number;
+            };
             header?: {
                 "X-Team-Id"?: string;
             };
-            path: {
-                id: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -21390,22 +21431,122 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** Format: uuid */
-                        id: string;
-                        /** Format: uuid */
-                        tenantId: string;
-                        actionType: string;
-                        message: string | null;
-                        payload?: unknown;
-                        userId: string | null;
-                        createdAt: string;
-                        effects: {
+                        data: {
                             /** Format: uuid */
                             id: string;
-                            effectType: string;
+                            dispatchedAction: {
+                                /** Format: uuid */
+                                id: string;
+                                actionType: string;
+                                apiEndpoint: string | null;
+                            };
+                            /** @enum {string} */
+                            effectType: "CREATE_RECURRING_TRANSACTION_INSTANCE" | "REFRESH_RESERVATION_JOURNAL" | "REFRESH_TRANSACTION_JOURNAL" | "UPDATE_RESERVATION_LINKABLES" | "UPDATE_RESERVATION_PAYMENTS" | "TENANT_CLERK_ALLOWED_IDS_SYNC" | "TENANT_HYPERLINE_SYNC" | "TENANT_LINEAR_WEBHOOK" | "TENANT_STATUS_TRACK" | "TENANT_SUSPENSION_EMAIL";
                             payload?: unknown;
-                            entityType: string | null;
-                            entityId: string | null;
+                            entity: ({
+                                /** @enum {string} */
+                                type: "reservation";
+                                data: {
+                                    id: string;
+                                    confirmationCode?: string | null;
+                                    uniqueRef: string;
+                                    /** @enum {string} */
+                                    status: "booked" | "canceled" | "inactive";
+                                    checkIn?: string | null;
+                                    checkOut?: string | null;
+                                };
+                            } | {
+                                /** @enum {string} */
+                                type: "transaction";
+                                data: {
+                                    id: string;
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
+                                    /** @description Value in cents (100 = 1€) */
+                                    amount: number;
+                                    account?: {
+                                        id: string;
+                                        name: string;
+                                        uniqueRef?: string | null;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                    } | null;
+                                    date: string;
+                                    description: string;
+                                    currency: string;
+                                    /** @enum {string} */
+                                    type: "deposit" | "expense" | "transfer";
+                                    contact?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name?: string | null;
+                                        uniqueRef?: string | null;
+                                    } | null;
+                                    connection?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name: string;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                        uniqueRef?: string | null;
+                                        appId: string;
+                                    } | null;
+                                    uniqueRef?: string | null;
+                                    recurringTemplate?: {
+                                        id: string;
+                                    } | null;
+                                };
+                            } | {
+                                /** @enum {string} */
+                                type: "recurringTransactionTemplate";
+                                data: {
+                                    id: string;
+                                    /** @enum {string} */
+                                    status: "active" | "inactive";
+                                    /** @description Value in cents (100 = 1€) */
+                                    amount: number;
+                                    account?: {
+                                        id: string;
+                                        name: string;
+                                        uniqueRef?: string | null;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                    } | null;
+                                    date: string;
+                                    description: string;
+                                    currency: string;
+                                    /** @enum {string} */
+                                    type: "deposit" | "expense" | "transfer";
+                                    contact?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name?: string | null;
+                                        uniqueRef?: string | null;
+                                    } | null;
+                                    connection?: {
+                                        /** Format: uuid */
+                                        id: string;
+                                        name: string;
+                                        /** @enum {string} */
+                                        status: "active" | "inactive";
+                                        uniqueRef?: string | null;
+                                        appId: string;
+                                    } | null;
+                                    uniqueRef?: string | null;
+                                    recurringTemplate?: {
+                                        id: string;
+                                    } | null;
+                                };
+                            } | {
+                                /** @enum {string} */
+                                type: "other";
+                                data: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    type: string;
+                                    name: string | null;
+                                };
+                            }) | null;
                             /** @enum {string} */
                             status: "pending" | "claimed" | "running" | "completed" | "failed" | "dead_letter";
                             priority: number;
@@ -21419,6 +21560,94 @@ export interface operations {
                             lastError: string | null;
                             createdAt: string;
                         }[];
+                        pagination: {
+                            /** @default 100 */
+                            limit: number;
+                            /** @default 1 */
+                            page: number;
+                            total: number;
+                            totalPage: number;
+                            nextPage?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Invalid input data */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.BAD_REQUEST"];
+                };
+            };
+            /** @description Authorization not provided */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.UNAUTHORIZED"];
+                };
+            };
+            /** @description Insufficient access */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.FORBIDDEN"];
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.NOT_FOUND"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
+                };
+            };
+        };
+    };
+    getDispatchAction: {
+        parameters: {
+            query?: never;
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id: string;
+                        /** Format: uuid */
+                        tenantId: string;
+                        actionType: string;
+                        message: string | null;
+                        payload?: unknown;
+                        userId: string | null;
+                        createdAt: string;
                         effectCounts: {
                             total: number;
                             pending: number;
@@ -21428,6 +21657,114 @@ export interface operations {
                             failed: number;
                             deadLetter: number;
                         };
+                        apiEndpoint: string | null;
+                    };
+                };
+            };
+            /** @description Invalid input data */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.BAD_REQUEST"];
+                };
+            };
+            /** @description Authorization not provided */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.UNAUTHORIZED"];
+                };
+            };
+            /** @description Insufficient access */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.FORBIDDEN"];
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.NOT_FOUND"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
+                };
+            };
+        };
+    };
+    listDispatchActions: {
+        parameters: {
+            query?: {
+                limit?: number;
+                offset?: number;
+                startDate?: string;
+                endDate?: string;
+                actionType?: string;
+                entityId?: string;
+                entityType?: "reservation" | "recurringTransactionTemplate" | "tenant" | "transaction";
+                page?: number;
+            };
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            /** Format: uuid */
+                            tenantId: string;
+                            actionType: string;
+                            message: string | null;
+                            payload?: unknown;
+                            userId: string | null;
+                            createdAt: string;
+                            effectCounts: {
+                                total: number;
+                                pending: number;
+                                claimed: number;
+                                running: number;
+                                completed: number;
+                                failed: number;
+                                deadLetter: number;
+                            };
+                            apiEndpoint: string | null;
+                        }[];
+                        pagination: {
+                            /** @default 100 */
+                            limit: number;
+                            /** @default 1 */
+                            page: number;
+                            total: number;
+                            totalPage: number;
+                            nextPage?: number;
+                        };
                     };
                 };
             };