@vrplatform/api 1.3.1-stage.6225 → 1.3.1-stage.6249

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

@@ -818,7 +818,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @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. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp connections activate and run chart-of-accounts synchronization when autoExtract is enabled. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
+         * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-callback. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp connections activate and run chart-of-accounts synchronization when autoExtract is enabled. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
          *
          *     Required scope: integrations:write
          */
@@ -860,7 +860,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @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/.
+         * @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes legacy production /callback to /callback/ and legacy staging /callback to /connections/oauth-callback.
          *
          *     Required scope: integrations:write
          */
@@ -975,7 +975,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @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. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp reconnections run chart-of-accounts synchronization unless that flow is explicitly inactive. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
+         * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-callback. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp reconnections run chart-of-accounts synchronization unless that flow is explicitly inactive. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
          *
          *     Required scope: integrations:write
          */
@@ -1384,6 +1384,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/email-templates/test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Send unsaved email-template content to the authenticated user's email address through the API Trigger project. The recipient cannot be supplied by the caller.
+         *
+         *     Required scope: team-settings:write
+         */
+        post: operations["sendTestEmail"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/email-templates/{type}": {
         parameters: {
             query?: never;
@@ -4500,7 +4521,7 @@ export interface paths {
         get: operations["getReservations"];
         put?: never;
         /**
-         * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
+         * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Creation rejects duplicates by connection and unique reference or by connection, resolved listing, and confirmation code. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
          *
          *     Required scope: reservations:write
          */
@@ -5736,7 +5757,7 @@ export interface paths {
         get: operations["getTeams"];
         put?: never;
         /**
-         * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation.
+         * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation. An explicit General Ledger copyFromTeamId must use the target data region; a mismatch returns 400 before either tenant registry is written.
          *
          *     Required scope: teams:provision
          */
@@ -32135,6 +32156,262 @@ export interface operations {
             };
         };
     };
+    sendTestEmail: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    html: string;
+                    subject: string;
+                    text: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @constant */
+                        ok: true;
+                    };
+                };
+            };
+            /** @description Bad request */
+            400: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Not found */
+            404: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Gone */
+            410: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Unprocessable content */
+            422: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+            /** @description Service unavailable */
+            503: {
+                headers: {
+                    /** @description Seconds to wait when retryable=true and the server supplies a delay. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        message: string;
+                        links?: {
+                            docs: string;
+                            schema: string;
+                        };
+                        issues?: {
+                            message: string;
+                            path?: (string | number)[];
+                            schema?: string;
+                        }[];
+                        retryable?: boolean;
+                        context?: unknown;
+                    };
+                };
+            };
+        };
+    };
     upsertEmailTemplate: {
         parameters: {
             query?: never;
@@ -77781,6 +78058,7 @@ export interface operations {
     getGuestBalancesReport: {
         parameters: {
             query: {
+                /** @description As-of date or date range. For a range, the inclusive end is used. */
                 date: string;
                 occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
                 channels?: string;
@@ -78159,6 +78437,7 @@ export interface operations {
     getGuestBalancesReportCsv: {
         parameters: {
             query: {
+                /** @description As-of date or date range. For a range, the inclusive end is used. */
                 date: string;
                 occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
                 channels?: string;
@@ -78411,6 +78690,7 @@ export interface operations {
     getGuestBalancesReportAggregated: {
         parameters: {
             query: {
+                /** @description As-of date or date range. For a range, the inclusive end is used. */
                 date: string;
                 channels?: string;
             };