@vrplatform/api 1.3.1-stage.4001 → 1.3.1-stage.4003

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.1-stage.4001",
+  "version": "1.3.1-stage.4003",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",

package/src/generated/v1.ts

@@ -1283,6 +1283,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/listings/opening-balance/csv-template": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Listing opening balance CSV import template */
+        get: operations["getListingsOpeningBalanceCsvTemplate"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/listings/ownership-periods": {
         parameters: {
             query?: never;
@@ -18962,6 +18979,131 @@ export interface operations {
             };
         };
     };
+    getListingsOpeningBalanceCsvTemplate: {
+        parameters: {
+            query?: {
+                status?: "active" | "inactive";
+                connectionId?: string;
+                /** @description Filter by parent listing id. Use parent=null to return only parent/root listings. */
+                parent?: string | "null";
+                /** @description Comma-separated listing ids. */
+                ids?: string;
+                search?: string;
+                contactId?: string;
+                /** @description Filter listings by ownership period ID. */
+                ownershipPeriodId?: string;
+                /** @description Comma-separated listing short refs. */
+                shortRefs?: string;
+                /** @description Filter listings by whether they currently have an active ownership period. */
+                activeOwnership?: boolean;
+                /** @description Include child listing links on each listing. */
+                includeChildren?: boolean;
+                /** @description Filter by active recurring fee coverage. Use `active` or `inactive` for any recurring fee type, prefix a fee type with `!` to exclude it, or pass a recurring fee UUID for one specific fee. */
+                activeRecurringFeePeriods?: string;
+                /** @description Filter listings that have (true) or lack (false) opening balances */
+                openingBalance?: boolean;
+                /** @description Filter listings by setup issue code, "all" (all setup issues), or "any" (at least one setup issue) */
+                issue?: "all" | "any" | "missingOwnershipOrDeactivation" | "missingFeesAndCommission" | "missingOpeningBalance";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        url: string;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        issues?: {
+                            message: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     getListingsOwnershipPeriods: {
         parameters: {
             query?: {