@vrplatform/api 1.3.1-4565 → 1.3.1-4578

package/package.json

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

package/src/generated/v1.ts

@@ -552,7 +552,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Connect an app and create the connection. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. */
+        /** @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. */
         post: operations["connectAppConnection"];
         delete?: never;
         options?: never;
@@ -586,7 +586,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Get a redirect URL to connect an app through OAuth2.0 */
+        /** @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes the legacy production /callback path to /callback/. */
         post: operations["connectConnection"];
         delete?: never;
         options?: never;
@@ -673,7 +673,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Reconnect an existing app connection. The built-in API app preserves its existing server-generated identity. */
+        /** @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. */
         post: operations["reconnectAppConnection"];
         delete?: never;
         options?: never;
@@ -1558,7 +1558,8 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
+        get: operations["getInternalUsers"];
         put?: never;
         /** @description Create or update a platform user by email, optionally granting an initial team membership. Used by the identity provider signup hooks. A duplicate email belonging to another user is rejected as a user error. */
         post: operations["postInternalUsers"];
@@ -1840,7 +1841,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including membership, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them. */
+        /** @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including placement, partner managed-team region discovery, membership, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them. */
         get: operations["getMe"];
         put?: never;
         post?: never;
@@ -2246,7 +2247,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List members of the partner itself with their child-team memberships */
+        /** @description List members of the partner itself with their partner-team role, status, invitation timestamp, and child-team memberships */
         get: operations["getPartnerMembers"];
         put?: never;
         post?: never;
@@ -2290,6 +2291,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/partner/owner-statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List VRT teams in one regional partition of the partner portfolio with owner statement counts by status. Supports team-name search, pagination, and ordering by each status count. Select the partition with x-data-region. */
+        get: operations["getPartnerOwnerStatements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/partner/users": {
         parameters: {
             query?: never;
@@ -2297,7 +2315,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List users across the partner portfolio (the partner and all of its teams) with their team memberships and owner accesses */
+        /** @description List child-team users across one regional partition of the partner portfolio with their team memberships and owner accesses. Users who belong to the partner team itself are excluded. Select the partition with x-data-region. */
         get: operations["getPartnerUsers"];
         put?: never;
         post?: never;
@@ -2314,7 +2332,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get a single portfolio user with their memberships across the partner and all of its teams, plus owner accesses */
+        /** @description Get a single portfolio user with memberships and owner accesses from one regional partition. Select the partition with x-data-region. */
         get: operations["getPartnerUser"];
         put?: never;
         post?: never;
@@ -3871,7 +3889,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get List of all Teams */
+        /** @description List accessible teams in one regional data partition. Partner callers can select the partition with x-data-region. */
         get: operations["getTeams"];
         put?: never;
         /** @description Create team */
@@ -3889,7 +3907,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List cursor-paginated materialized issue summaries across accessible teams. */
+        /** @description List cursor-paginated materialized issue summaries across accessible teams in one regional data partition. Partner callers can select the partition with x-data-region. */
         get: operations["getTeamsIssues"];
         put?: never;
         post?: never;
@@ -3906,7 +3924,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Look up teams by name */
+        /** @description Look up accessible teams by name in one regional data partition. Partner callers can select the partition with x-data-region. */
         get: operations["getTeamsLookup"];
         put?: never;
         post?: never;
@@ -14900,10 +14918,7 @@ export interface operations {
             content: {
                 "application/json": {
                     appId: string;
-                    /**
-                     * Format: uri
-                     * @default https://portal.vrplatform.app
-                     */
+                    /** Format: uri */
                     redirectTo?: string;
                 };
             };
@@ -29567,6 +29582,207 @@ export interface operations {
             };
         };
     };
+    getInternalUsers: {
+        parameters: {
+            query?: {
+                /** @description Filter by email, secondary email, first name, last name, or full name */
+                search?: string;
+                limit?: number;
+                page?: number;
+                offset?: number;
+            };
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            firstName: string | null;
+                            lastName: string | null;
+                            /** Format: email */
+                            email: string;
+                            secondaryEmails: string[];
+                            /** @description User kind (e.g. user, owner) */
+                            type?: string | null;
+                            lastSeen: string | null;
+                            createdAt: string | null;
+                            memberships: {
+                                /** Format: uuid */
+                                teamId: string;
+                                teamName: string;
+                                role?: string | null;
+                                status?: string | null;
+                                lastInvitedAt: string | null;
+                            }[];
+                            ownerAccesses: {
+                                /** Format: uuid */
+                                teamId: string;
+                                contactId: string | null;
+                                ownerId: string | null;
+                                role?: string | null;
+                                /** @description Owner contact name */
+                                name?: string | null;
+                            }[];
+                        }[];
+                        pagination: {
+                            /** @default 100 */
+                            limit: number;
+                            /** @default 1 */
+                            page: number;
+                            total: number;
+                            totalPage: number;
+                            nextPage?: number;
+                        };
+                    };
+                };
+            };
+            /** @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;
+                    };
+                };
+            };
+        };
+    };
     postInternalUsers: {
         parameters: {
             query?: never;
@@ -35302,6 +35518,10 @@ export interface operations {
                             name: string | null;
                             slug: string;
                             /** @enum {string} */
+                            dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+                            /** Format: uri */
+                            apiBaseUrl: string;
+                            /** @enum {string} */
                             type: "propertyManager" | "partner";
                             partnerId: string | null;
                             isGeneralLedger: boolean;
@@ -35375,6 +35595,18 @@ export interface operations {
                             ownerNeedsReviewId: string | null;
                             guideOnboardingStatus: ("skipped" | "completed") | null;
                         } | null;
+                        partnerContext: {
+                            managedTeamRegions: {
+                                /** @enum {string} */
+                                dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+                                /** Format: uri */
+                                apiBaseUrl: string;
+                                counts: {
+                                    active: number;
+                                    inactive: number;
+                                };
+                            }[];
+                        } | null;
                     };
                 };
             };
@@ -39271,6 +39503,10 @@ export interface operations {
                             /** Format: email */
                             email: string;
                             secondaryEmails: string[];
+                            /** @enum {string} */
+                            role: "admin" | "user";
+                            status: ("active" | "inactive" | "unconfirmed") | null;
+                            lastInvitedAt: string | null;
                             partnerId: string | null;
                             name: string | null;
                             firstName: string | null;
@@ -39757,6 +39993,198 @@ export interface operations {
             };
         };
     };
+    getPartnerOwnerStatements: {
+        parameters: {
+            query?: {
+                /** @description Filter by team name */
+                search?: string;
+                /** @description Owner statement status count to sort by */
+                sortBy?: "draft" | "inReview" | "published";
+                /** @description Sort direction, defaults to asc */
+                sortDirection?: "asc" | "desc";
+                limit?: number;
+                page?: number;
+                offset?: number;
+            };
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            name: string;
+                            logo?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp string with date, time, milliseconds, and timezone.
+                             * @example 2024-01-15T12:30:00.000+00:00
+                             */
+                            createdAt: string;
+                            ownerStatements: {
+                                draft: number;
+                                inReview: number;
+                                published: number;
+                            };
+                        }[];
+                        pagination: {
+                            /** @default 100 */
+                            limit: number;
+                            /** @default 1 */
+                            page: number;
+                            total: number;
+                            totalPage: number;
+                            nextPage?: number;
+                        };
+                    };
+                };
+            };
+            /** @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;
+                    };
+                };
+            };
+        };
+    };
     getPartnerUsers: {
         parameters: {
             query?: {
@@ -39776,7 +40204,10 @@ export interface operations {
                 page?: number;
                 offset?: number;
             };
-            header?: never;
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
             path?: never;
             cookie?: never;
         };
@@ -39968,7 +40399,10 @@ export interface operations {
     getPartnerUser: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
             path: {
                 id: string;
             };
@@ -77310,7 +77744,10 @@ export interface operations {
                 page?: number;
                 offset?: number;
             };
-            header?: never;
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
             path?: never;
             cookie?: never;
         };
@@ -78012,7 +78449,10 @@ export interface operations {
                 /** @description Opaque pagination cursor returned by a previous response. Pass it back unchanged. */
                 cursor?: string;
             };
-            header?: never;
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
             path?: never;
             cookie?: never;
         };
@@ -78864,7 +79304,10 @@ export interface operations {
                 page?: number;
                 offset?: number;
             };
-            header?: never;
+            header?: {
+                /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
+                "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
+            };
             path?: never;
             cookie?: never;
         };