@vrplatform/api 1.3.0-stage.1281 → 1.3.0-stage.1283

package/package.json

@@ -6,7 +6,7 @@
     "typings": "build/main/index.d.ts",
     "module": "build/module/index.js"
   },
-  "version": "1.3.0-stage.1281",
+  "version": "1.3.0-stage.1283",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",

package/src/generated/v1.ts

@@ -1868,6 +1868,74 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/reports/owner-statement-summaries-per-layout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Owner statement summaries aggregated by contact (per layout) */
+        get: operations["getOwnerStatementSummariesPerLayoutReport"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/reports/owner-statement-summaries-per-layout/csv": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Owner statement summaries aggregated by contact (per layout, CSV) */
+        get: operations["getOwnerStatementSummariesPerLayoutReportCsv"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/reports/owner-statement-summaries-per-layout/details/{contactId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Owner statement summary detail aggregated by listing, month, reservation, or booking channel (per layout) */
+        get: operations["getOwnerStatementSummaryPerLayoutDetailsReport"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/reports/owner-statement-summaries-per-layout/details/{contactId}/csv": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Owner statement summary detail aggregated by listing, month, reservation, or booking channel (per layout, CSV) */
+        get: operations["getOwnerStatementSummaryPerLayoutDetailsReportCsv"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/reports/trial-balance": {
         parameters: {
             query?: never;
@@ -24028,6 +24096,413 @@ export interface operations {
             };
         };
     };
+    getOwnerStatementSummariesPerLayoutReport: {
+        parameters: {
+            query: {
+                startAt: string;
+                endAt: string;
+                /** @description comma separated listings */
+                listingIds?: string;
+            };
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            contact: {
+                                contactId: string;
+                                name?: string;
+                                firstName?: string;
+                                /** Format: email */
+                                email?: string;
+                                phone?: string;
+                            };
+                            currency: string;
+                            financials: {
+                                balanceStart: number;
+                                netRevenue: number;
+                                expenses: number;
+                                transfers: number;
+                                netIncome: number;
+                                currentBalance: number;
+                                balanceEnd: 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"];
+                };
+            };
+        };
+    };
+    getOwnerStatementSummariesPerLayoutReportCsv: {
+        parameters: {
+            query: {
+                startAt: string;
+                endAt: string;
+                /** @description comma separated listings */
+                listingIds?: string;
+            };
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        url: string;
+                    };
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    getOwnerStatementSummaryPerLayoutDetailsReport: {
+        parameters: {
+            query: {
+                view: "listing" | "month" | "reservation" | "bookingChannel";
+                startAt: string;
+                endAt: string;
+                /** @description comma separated listings */
+                listingIds?: string;
+                currency?: string;
+                viewAs?: "owner" | "manager";
+            };
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path: {
+                contactId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        currency: string;
+                        contact: {
+                            contactId: string;
+                            name?: string;
+                            firstName?: string;
+                            /** Format: email */
+                            email?: string;
+                            phone?: string;
+                        };
+                        financials: {
+                            balanceStart: number;
+                            netRevenue: number;
+                            expenses: number;
+                            transfers: number;
+                            netIncome: number;
+                            currentBalance: number;
+                            balanceEnd: number;
+                        };
+                        layouts: {
+                            layoutId: string;
+                            layoutName: string;
+                            statementIds: string[];
+                            netRevenueSection: {
+                                title: string;
+                                rows: {
+                                    title: string;
+                                    statementIds?: string[];
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                }[];
+                                subtotal?: {
+                                    title: string;
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                };
+                            };
+                            otherSections: {
+                                title: string;
+                                rows: {
+                                    title: string;
+                                    statementIds?: string[];
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                }[];
+                                subtotal?: {
+                                    title: string;
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                };
+                            }[];
+                            transfersSection?: {
+                                title: string;
+                                rows: {
+                                    title: string;
+                                    statementIds?: string[];
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                }[];
+                                subtotal?: {
+                                    title: string;
+                                    columns: {
+                                        title: string;
+                                        value: number | string;
+                                        formatted: string;
+                                    }[];
+                                };
+                            };
+                        }[];
+                    };
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    getOwnerStatementSummaryPerLayoutDetailsReportCsv: {
+        parameters: {
+            query: {
+                view: "listing" | "month" | "reservation" | "bookingChannel";
+                startAt: string;
+                endAt: string;
+                /** @description comma separated listings */
+                listingIds?: string;
+                currency?: string;
+                viewAs?: "owner" | "manager";
+            };
+            header?: {
+                "X-Team-Id"?: string;
+            };
+            path: {
+                contactId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        url: string;
+                    };
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     getTrialBalanceReport: {
         parameters: {
             query: {