@vrplatform/api 1.3.1-stage.4666 → 1.3.1-stage.4670

package/package.json

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

package/src/generated/v1.ts

@@ -1007,7 +1007,11 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get the current team email template for trigger-rendered emails. */
+        /**
+         * @description Get the current team email template for trigger-rendered emails.
+         *
+         *     Required scope: team-settings:read
+         */
         get: operations["getEmailTemplate"];
         put?: never;
         post?: never;
@@ -1017,6 +1021,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/email-templates/{type}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * @description Create or update an email template for the current team.
+         *
+         *     Required scope: team-settings:write
+         */
+        put: operations["upsertEmailTemplate"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/embed-sessions/exchange": {
         parameters: {
             query?: never;
@@ -1563,7 +1588,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List feature flags across all teams, with enabled-team and tester counts. VRP-admin only. */
+        /** @description List feature flags with team and user assignments. Omitted status returns testing and ready flags. Sorting defaults to createdAt desc. VRP-admin only. */
         get: operations["getInternalFeatureFlags"];
         put?: never;
         /** @description Create a feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
@@ -1599,9 +1624,9 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag. VRP-admin only. */
+        /** @description List team assignments for a feature flag. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. VRP-admin only. */
         get: operations["getInternalFeatureFlagsByIdTeams"];
-        /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag. Teams served from another data region are rejected. VRP-admin only. */
+        /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. Teams served from another data region are rejected. VRP-admin only. */
         put: operations["putInternalFeatureFlagsByIdTeams"];
         post?: never;
         delete?: never;
@@ -1617,9 +1642,9 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled. VRP-admin only. */
+        /** @description List user assignments for a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled; 'disabled' explicitly denies access. VRP-admin only. */
         get: operations["getInternalFeatureFlagsByIdUsers"];
-        /** @description Replace the set of testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled. VRP-admin only. */
+        /** @description Replace the set of testers approved on a feature flag. Status 'all' means the user sees the flag everywhere; 'partially' only on teams where the flag is 'partially' enabled; 'disabled' explicitly denies access. VRP-admin only. */
         put: operations["putInternalFeatureFlagsByIdUsers"];
         post?: never;
         delete?: never;
@@ -4390,7 +4415,7 @@ export interface paths {
          */
         get: operations["getTeam"];
         /**
-         * @description Update the current team (singleton: the team in scope via the x-team-id header). Setting statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active.
+         * @description Update the current team (singleton: the team in scope via the x-team-id header). Send null for logo or colorPrimary to clear that branding value. Setting statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active.
          *
          *     Required scope: teams:write
          */
@@ -20211,7 +20236,7 @@ export interface operations {
         parameters: {
             query: {
                 /** @description Email template type to fetch. */
-                type: "ownerInvite" | "ownerStatementPublished" | "owner-invite" | "ownerStatement-published";
+                type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager" | "owner-invite" | "ownerStatement-published";
             };
             header?: never;
             path?: never;
@@ -20230,7 +20255,7 @@ export interface operations {
                             /** Format: uuid */
                             id: string;
                             /** @enum {string} */
-                            type: "ownerInvite" | "ownerStatementPublished";
+                            type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
                             data: {
                                 subject: string;
                                 shortDescription: string;
@@ -20241,8 +20266,18 @@ export interface operations {
                                 buttonText: string;
                                 href?: string | null;
                             };
-                            createdAt?: string | null;
-                            updatedAt?: string | null;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp string with date, time, milliseconds, and timezone.
+                             * @example 2024-01-15T12:30:00.000+00:00
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp string with date, time, milliseconds, and timezone.
+                             * @example 2024-01-15T12:30:00.000+00:00
+                             */
+                            updatedAt: string;
                         } | null;
                     };
                 };
@@ -20381,6 +20416,204 @@ export interface operations {
             };
         };
     };
+    upsertEmailTemplate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Email template type to save. */
+                type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** @description Email template content to save. */
+                    data: {
+                        subject: string;
+                        shortDescription: string;
+                        banner?: string | null;
+                        header: string;
+                        bodyOne: string;
+                        bodyTwo: string;
+                        buttonText: string;
+                        href?: string | null;
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id: string;
+                        /** @enum {string} */
+                        type: "ownerInvite" | "ownerStatementPublished" | "invitePropertyManager";
+                        data: {
+                            subject: string;
+                            shortDescription: string;
+                            banner?: string | null;
+                            header: string;
+                            bodyOne: string;
+                            bodyTwo: string;
+                            buttonText: string;
+                            href?: string | null;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp string with date, time, milliseconds, and timezone.
+                         * @example 2024-01-15T12:30:00.000+00:00
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp string with date, time, milliseconds, and timezone.
+                         * @example 2024-01-15T12:30:00.000+00:00
+                         */
+                        updatedAt: string;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     exchangeEmbedSession: {
         parameters: {
             query?: never;
@@ -28108,6 +28341,9 @@ export interface operations {
         parameters: {
             query?: {
                 search?: string;
+                status?: "testing" | "ready" | "deployed";
+                sortBy?: "createdAt" | "title";
+                sortDirection?: "asc" | "desc";
                 limit?: number;
                 page?: number;
                 offset?: number;
@@ -28132,10 +28368,32 @@ export interface operations {
                             description: string | null;
                             url: string | null;
                             issueUrl: string | null;
-                            /** @description Catalog status of the flag itself (e.g. 'testing'). */
-                            status: string | null;
+                            /** @description Catalog status of the flag itself. */
+                            status: ("testing" | "ready" | "deployed") | null;
                             /** @description User ids required to approve this feature. */
                             requiredApprovals: string[];
+                            teams: {
+                                /** Format: uuid */
+                                id: string;
+                                name: string | null;
+                                /**
+                                 * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                                 * @enum {string}
+                                 */
+                                status: "all" | "partially" | "disabled";
+                            }[];
+                            users: {
+                                /** Format: uuid */
+                                id: string;
+                                email: string | null;
+                                firstName: string | null;
+                                lastName: string | null;
+                                /**
+                                 * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                                 * @enum {string}
+                                 */
+                                status: "all" | "partially" | "disabled";
+                            }[];
                             enabledTeamsCount: number;
                             testersCount: number;
                             /**
@@ -28311,7 +28569,7 @@ export interface operations {
                     description?: string | null;
                     url?: string | null;
                     issueUrl?: string | null;
-                    status?: string | null;
+                    status?: ("testing" | "ready" | "deployed") | null;
                     requiredApprovals?: string[];
                 };
             };
@@ -28330,10 +28588,32 @@ export interface operations {
                         description: string | null;
                         url: string | null;
                         issueUrl: string | null;
-                        /** @description Catalog status of the flag itself (e.g. 'testing'). */
-                        status: string | null;
+                        /** @description Catalog status of the flag itself. */
+                        status: ("testing" | "ready" | "deployed") | null;
                         /** @description User ids required to approve this feature. */
                         requiredApprovals: string[];
+                        teams: {
+                            /** Format: uuid */
+                            id: string;
+                            name: string | null;
+                            /**
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                             * @enum {string}
+                             */
+                            status: "all" | "partially" | "disabled";
+                        }[];
+                        users: {
+                            /** Format: uuid */
+                            id: string;
+                            email: string | null;
+                            firstName: string | null;
+                            lastName: string | null;
+                            /**
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                             * @enum {string}
+                             */
+                            status: "all" | "partially" | "disabled";
+                        }[];
                         enabledTeamsCount: number;
                         testersCount: number;
                         /**
@@ -28501,7 +28781,7 @@ export interface operations {
                     description?: string | null;
                     url?: string | null;
                     issueUrl?: string | null;
-                    status?: string | null;
+                    status?: ("testing" | "ready" | "deployed") | null;
                     requiredApprovals?: string[];
                 };
             };
@@ -28520,10 +28800,32 @@ export interface operations {
                         description: string | null;
                         url: string | null;
                         issueUrl: string | null;
-                        /** @description Catalog status of the flag itself (e.g. 'testing'). */
-                        status: string | null;
+                        /** @description Catalog status of the flag itself. */
+                        status: ("testing" | "ready" | "deployed") | null;
                         /** @description User ids required to approve this feature. */
                         requiredApprovals: string[];
+                        teams: {
+                            /** Format: uuid */
+                            id: string;
+                            name: string | null;
+                            /**
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                             * @enum {string}
+                             */
+                            status: "all" | "partially" | "disabled";
+                        }[];
+                        users: {
+                            /** Format: uuid */
+                            id: string;
+                            email: string | null;
+                            firstName: string | null;
+                            lastName: string | null;
+                            /**
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
+                             * @enum {string}
+                             */
+                            status: "all" | "partially" | "disabled";
+                        }[];
                         enabledTeamsCount: number;
                         testersCount: number;
                         /**
@@ -28852,13 +29154,13 @@ export interface operations {
                     "application/json": {
                         data: {
                             /** Format: uuid */
-                            teamId: string;
-                            teamName: string | null;
+                            id: string;
+                            name: string | null;
                             /**
-                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                              * @enum {string}
                              */
-                            status: "all" | "partially";
+                            status: "all" | "partially" | "disabled";
                         }[];
                     };
                 };
@@ -29011,12 +29313,12 @@ export interface operations {
                 "application/json": {
                     teams: {
                         /** Format: uuid */
-                        teamId: string;
+                        id: string;
                         /**
-                         * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                         * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                          * @enum {string}
                          */
-                        status: "all" | "partially";
+                        status: "all" | "partially" | "disabled";
                     }[];
                 };
             };
@@ -29031,13 +29333,13 @@ export interface operations {
                     "application/json": {
                         data: {
                             /** Format: uuid */
-                            teamId: string;
-                            teamName: string | null;
+                            id: string;
+                            name: string | null;
                             /**
-                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                              * @enum {string}
                              */
-                            status: "all" | "partially";
+                            status: "all" | "partially" | "disabled";
                         }[];
                     };
                 };
@@ -29196,14 +29498,15 @@ export interface operations {
                     "application/json": {
                         data: {
                             /** Format: uuid */
-                            userId: string;
+                            id: string;
                             email: string | null;
-                            name: string | null;
+                            firstName: string | null;
+                            lastName: string | null;
                             /**
-                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                              * @enum {string}
                              */
-                            status: "all" | "partially";
+                            status: "all" | "partially" | "disabled";
                         }[];
                     };
                 };
@@ -29356,12 +29659,12 @@ export interface operations {
                 "application/json": {
                     users: {
                         /** Format: uuid */
-                        userId: string;
+                        id: string;
                         /**
-                         * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                         * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                          * @enum {string}
                          */
-                        status: "all" | "partially";
+                        status: "all" | "partially" | "disabled";
                     }[];
                 };
             };
@@ -29376,14 +29679,15 @@ export interface operations {
                     "application/json": {
                         data: {
                             /** Format: uuid */
-                            userId: string;
+                            id: string;
                             email: string | null;
-                            name: string | null;
+                            firstName: string | null;
+                            lastName: string | null;
                             /**
-                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag.
+                             * @description 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access.
                              * @enum {string}
                              */
-                            status: "all" | "partially";
+                            status: "all" | "partially" | "disabled";
                         }[];
                     };
                 };
@@ -37714,6 +38018,7 @@ export interface operations {
                             reservationId: string | null;
                             hasPms: boolean;
                             activePmsConnectionId: string | null;
+                            hasOwnerBlockingConnection: boolean;
                             hasDeposit: boolean;
                             depositTransactionId: string | null;
                             hasListingNeedsReview: boolean;
@@ -77248,6 +77553,7 @@ export interface operations {
                     isOnboarding?: boolean | null;
                     isOpex?: boolean;
                     booksClosedAt?: string | null;
+                    /** @description Logo URL or data URI. Send null to clear it. */
                     logo?: string | null;
                     statementStartAt?: string | null;
                     effectiveStatementStartAt?: string | null;
@@ -77257,6 +77563,8 @@ export interface operations {
                     /** Format: email */
                     email?: string;
                     supportEmail?: string | null;
+                    /** @description Primary brand color. Send null to clear it. */
+                    colorPrimary?: string | null;
                     migratedFromTenantId?: string | null;
                     settings?: {
                         showVRPilotGuide?: boolean;