@vrplatform/api 1.3.1-stage.4711 → 1.3.1-stage.4717

package/build/main/generated/v1.d.ts

@@ -2627,6 +2627,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/partner/connections": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description List managed teams in one regional partition of the partner portfolio with active connections and current sync state. Supports team and company search, lifecycle, app, and connection error-state filters, pagination, and team ordering. Select the partition with x-data-region.
+         *
+         *     Required scope: teams:read
+         */
+        get: operations["getPartnerConnections"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/partner/embed-sessions": {
         parameters: {
             query?: never;
@@ -4465,7 +4486,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get the current team (singleton: the team in scope via the x-team-id header). Cross-team access uses the plural /teams collection.
+         * @description Get the current team and its dashboard aggregates (singleton: the team in scope via the x-team-id header). Cross-team access uses the plural /teams collection.
          *
          *     Required scope: teams:read
          */
@@ -4659,7 +4680,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description List accessible teams in one regional data partition. Partner callers can select the partition with x-data-region.
+         * @description List and filter accessible teams in one regional data partition. Billability is always present; includeAggregates opt-in adds partner-dashboard counts. Partner callers can select the partition with x-data-region.
          *
          *     Required scope: teams:read
          */
@@ -31419,6 +31440,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -31745,6 +31774,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -42487,6 +42524,231 @@ export interface operations {
             };
         };
     };
+    getPartnerConnections: {
+        parameters: {
+            query?: {
+                /** @description Filter by team or company name */
+                search?: string;
+                status?: "active" | "inactive" | "onboarding";
+                /** @description Filter teams with an active connection to this app */
+                appId?: string;
+                /** @description Filter teams by whether an active connection is in error */
+                isErrorState?: boolean;
+                /** @description Team field to sort by; defaults to createdAt */
+                sortBy?: "name" | "createdAt";
+                /** @description Sort direction; defaults to desc for createdAt and asc for name */
+                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;
+                            /** @enum {string} */
+                            status: "active" | "inactive";
+                            isOnboarding: boolean;
+                            connections: {
+                                /** Format: uuid */
+                                id: string;
+                                name: string;
+                                isErrorState: boolean;
+                                app: {
+                                    id: string;
+                                    name: string;
+                                    icon: string | null;
+                                    /** @enum {string} */
+                                    category: "paymentGateway" | "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
+                                };
+                                currentSync: {
+                                    /** @enum {string} */
+                                    status: "queued" | "started" | "completed" | "failed" | "canceled";
+                                    /**
+                                     * 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;
+                                    message?: string | null;
+                                } | 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;
+                    };
+                };
+            };
+        };
+    };
     createEmbedSession: {
         parameters: {
             query?: never;
@@ -78308,6 +78570,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -78698,6 +78968,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -79968,6 +80246,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -81134,8 +81420,18 @@ export interface operations {
                 /** @description Comma-separated team IDs. */
                 ids?: string;
                 status?: "active" | "inactive";
+                /** @description Filter by onboarding state. */
+                isOnboarding?: boolean;
                 search?: string;
                 partnerId?: string;
+                billingPartnerId?: string;
+                billingSubscriptionStatus?: "active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner";
+                billingPlan?: string;
+                product?: "vrtrust" | "vrintegrations";
+                /** @description Comma-separated enabled feature IDs. */
+                featureIds?: string;
+                /** @description Include partner-dashboard listing, member, connection, issue, and child-team counts. */
+                includeAggregates?: boolean;
                 type?: "partner" | "propertyManager";
                 /** @description Field to sort by */
                 sortBy?: "created" | "name" | "type";
@@ -81320,6 +81616,14 @@ export interface operations {
                                 /** @enum {string} */
                                 status: "all" | "disabled" | "partially";
                             }[];
+                            isBillable: boolean;
+                            aggregates?: {
+                                activeListings: number;
+                                members: number;
+                                activeConnections: number;
+                                connectionIssues: number;
+                                childTeams: number;
+                            };
                         }[];
                         pagination: {
                             /** @default 100 */
@@ -81705,6 +82009,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                     };
                 };
             };
@@ -82883,6 +83195,14 @@ export interface operations {
                                 /** @enum {string} */
                                 status: "all" | "disabled" | "partially";
                             }[];
+                            isBillable: boolean;
+                            aggregates?: {
+                                activeListings: number;
+                                members: number;
+                                activeConnections: number;
+                                connectionIssues: number;
+                                childTeams: number;
+                            };
                         }[];
                         pagination: {
                             /** @default 100 */
@@ -83203,6 +83523,14 @@ export interface operations {
                             /** @enum {string} */
                             status: "all" | "disabled" | "partially";
                         }[];
+                        isBillable: boolean;
+                        aggregates?: {
+                            activeListings: number;
+                            members: number;
+                            activeConnections: number;
+                            connectionIssues: number;
+                            childTeams: number;
+                        };
                         /** Format: uri */
                         apiBaseUrl: string;
                     };