@vrplatform/api 1.3.1-stage.4716 → 1.3.1-stage.4718

package/package.json

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

package/src/generated/v1.ts

@@ -2628,6 +2628,48 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/partner/billing": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event per team, including deleted teams; the current month uses live active-listing counts. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
+         *
+         *     Required scope: teams:read
+         */
+        get: operations["getPartnerBilling"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -42504,6 +42546,443 @@ export interface operations {
             };
         };
     };
+    getPartnerBilling: {
+        parameters: {
+            query: {
+                /** @description Month string in format `YYYY-MM`. */
+                month: string;
+                /** @description Filter by team or company name */
+                search?: string;
+                status?: "active" | "inactive" | "onboarding";
+                partnerId?: string;
+                product?: "vrtrust" | "vrintegrations";
+                billingPlan?: string;
+                /** @description Field to sort by, defaults to created */
+                sortBy?: "name" | "created" | "partnerName" | "product" | "activeListings" | "billingPlan";
+                /** @description Sort direction, defaults to desc */
+                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 | null;
+                            logo: string | null;
+                            /** @enum {string} */
+                            status: "active" | "inactive" | "deleted";
+                            /** @constant */
+                            type: "propertyManager";
+                            isOnboarding: boolean;
+                            isBillable: boolean | null;
+                            isGeneralLedger: boolean | null;
+                            partner: {
+                                /** Format: uuid */
+                                id: string;
+                                name: string;
+                            } | null;
+                            billingPartner: {
+                                /** Format: uuid */
+                                id: string;
+                                name: string;
+                            } | null;
+                            billingCustomerId: string | null;
+                            billingSubscriptionStatus: string | null;
+                            intercomId: string | null;
+                            billingPlan: string | null;
+                            migratedFromTenantId: string | null;
+                            createdAt: string | null;
+                            cancelledAt: string | null;
+                            activeListings: 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;
+                    };
+                };
+            };
+        };
+    };
+    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;