@voyant-travel/apps 0.5.0 → 0.6.1

package/dist/routes-openapi.d.ts

@@ -0,0 +1,859 @@
+import { z } from "@hono/zod-openapi";
+export declare const listAppsRoute: {
+    method: "get";
+    path: "/";
+    request: {
+        query: z.ZodObject<{
+            ownerId: z.ZodOptional<z.ZodString>;
+            distribution: z.ZodOptional<z.ZodEnum<{
+                custom: "custom";
+                marketplace: "marketplace";
+            }>>;
+            limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+            offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodArray<z.ZodUnknown>;
+                        total: z.ZodNumber;
+                        limit: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/";
+};
+export declare const createCustomAppRoute: {
+    method: "post";
+    path: "/";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        ownerId: z.ZodString;
+                        displayName: z.ZodString;
+                        slug: z.ZodString;
+                        redirectUris: z.ZodDefault<z.ZodArray<z.ZodString>>;
+                        createdBy: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        201: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        409: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/";
+};
+export declare const authorizeAppOAuthRoute: {
+    method: "post";
+    path: "/oauth/authorize";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        response_type: z.ZodLiteral<"code">;
+                        client_id: z.ZodString;
+                        release_id: z.ZodString;
+                        redirect_uri: z.ZodString;
+                        state: z.ZodString;
+                        code_challenge: z.ZodString;
+                        code_challenge_method: z.ZodLiteral<"S256">;
+                        actor_id: z.ZodString;
+                        operator_scopes: z.ZodDefault<z.ZodString>;
+                        optional_scopes: z.ZodDefault<z.ZodString>;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodObject<{
+                            redirectUrl: z.ZodString;
+                            state: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        501: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/oauth/authorize";
+};
+export declare const issueAppOAuthTokenRoute: {
+    method: "post";
+    path: "/oauth/token";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                        grant_type: z.ZodLiteral<"authorization_code">;
+                        code: z.ZodString;
+                        redirect_uri: z.ZodString;
+                        code_verifier: z.ZodString;
+                        client_id: z.ZodString;
+                        client_secret: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>, z.ZodObject<{
+                        grant_type: z.ZodLiteral<"refresh_token">;
+                        refresh_token: z.ZodString;
+                        client_id: z.ZodString;
+                        client_secret: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>, z.ZodObject<{
+                        grant_type: z.ZodLiteral<"urn:voyant:params:oauth:grant-type:actor-token-exchange">;
+                        installation_id: z.ZodString;
+                        viewer_id: z.ZodString;
+                        viewer_scopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+                        contextual_scopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                        client_id: z.ZodString;
+                        client_secret: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strip>], "grant_type">, z.ZodTransform<{
+                        client_secret: string | undefined;
+                        grant_type: "authorization_code";
+                        code: string;
+                        redirect_uri: string;
+                        code_verifier: string;
+                        client_id: string;
+                    } | {
+                        client_secret: string | undefined;
+                        grant_type: "refresh_token";
+                        refresh_token: string;
+                        client_id: string;
+                    } | {
+                        client_secret: string | undefined;
+                        grant_type: "urn:voyant:params:oauth:grant-type:actor-token-exchange";
+                        installation_id: string;
+                        viewer_id: string;
+                        viewer_scopes: string[];
+                        client_id: string;
+                        contextual_scopes?: string[] | undefined;
+                    }, {
+                        grant_type: "authorization_code";
+                        code: string;
+                        redirect_uri: string;
+                        code_verifier: string;
+                        client_id: string;
+                        client_secret?: string | undefined;
+                    } | {
+                        grant_type: "refresh_token";
+                        refresh_token: string;
+                        client_id: string;
+                        client_secret?: string | undefined;
+                    } | {
+                        grant_type: "urn:voyant:params:oauth:grant-type:actor-token-exchange";
+                        installation_id: string;
+                        viewer_id: string;
+                        viewer_scopes: string[];
+                        client_id: string;
+                        contextual_scopes?: string[] | undefined;
+                        client_secret?: string | undefined;
+                    }>>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                };
+            };
+        };
+        501: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/oauth/token";
+};
+export declare const revokeAppInstallationCredentialsRoute: {
+    method: "post";
+    path: "/oauth/revoke-installation";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        installationId: z.ZodString;
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        installationId: z.ZodString;
+                        generation: z.ZodNumber;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        501: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/oauth/revoke-installation";
+};
+export declare const issueAppSessionTokenRoute: {
+    method: "post";
+    path: "/installations/{installationId}/session-token";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        entity: z.ZodOptional<z.ZodObject<{
+                            type: z.ZodString;
+                            id: z.ZodString;
+                        }, z.core.$strict>>;
+                        slot: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        201: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        501: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/session-token";
+};
+export declare const exchangeAppSessionTokenRoute: {
+    method: "post";
+    path: "/oauth/session-token/exchange";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodPipe<z.ZodObject<{
+                        session_token: z.ZodString;
+                        client_id: z.ZodString;
+                        client_secret: z.ZodOptional<z.ZodString>;
+                        viewer_scopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+                        contextual_scopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    }, z.core.$strict>, z.ZodTransform<{
+                        client_secret: string | undefined;
+                        session_token: string;
+                        client_id: string;
+                        viewer_scopes: string[];
+                        contextual_scopes?: string[] | undefined;
+                    }, {
+                        session_token: string;
+                        client_id: string;
+                        viewer_scopes: string[];
+                        client_secret?: string | undefined;
+                        contextual_scopes?: string[] | undefined;
+                    }>>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                };
+            };
+        };
+        501: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/oauth/session-token/exchange";
+};
+export declare const installAppRoute: {
+    method: "post";
+    path: "/install";
+    request: {
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        appId: z.ZodString;
+                        releaseId: z.ZodString;
+                        actorId: z.ZodString;
+                        grantedOptionalScopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                        updatePolicy: z.ZodOptional<z.ZodEnum<{
+                            manual: "manual";
+                            compatible: "compatible";
+                            patch: "patch";
+                            pinned: "pinned";
+                        }>>;
+                        deploymentId: z.ZodOptional<z.ZodString>;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        201: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/install";
+};
+export declare const listAppInstallationsRoute: {
+    method: "get";
+    path: "/installations";
+    request: {
+        query: z.ZodObject<{
+            appId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+                authorizing: "authorizing";
+                paused: "paused";
+                degraded: "degraded";
+                revoked: "revoked";
+                uninstalled: "uninstalled";
+            }>>;
+            deploymentId: z.ZodOptional<z.ZodString>;
+            limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+            offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodArray<z.ZodUnknown>;
+                        total: z.ZodNumber;
+                        limit: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations";
+};
+export declare const getAppInstallationRoute: {
+    method: "get";
+    path: "/installations/{installationId}";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        404: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId";
+};
+export declare const listAppInstallationAuditRoute: {
+    method: "get";
+    path: "/installations/{installationId}/audit";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        query: z.ZodObject<{
+            limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/audit";
+};
+export declare const pauseAppInstallationRoute: {
+    method: "post";
+    path: "/installations/{installationId}/pause";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/pause";
+};
+export declare const resumeAppInstallationRoute: {
+    method: "post";
+    path: "/installations/{installationId}/resume";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/resume";
+};
+export declare const uninstallAppInstallationRoute: {
+    method: "post";
+    path: "/installations/{installationId}/uninstall";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/uninstall";
+};
+export declare const activateAppInstallationRoute: {
+    method: "post";
+    path: "/installations/{installationId}/activate";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        releaseId: z.ZodString;
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/activate";
+};
+export declare const previewAppInstallationPurgeRoute: {
+    method: "post";
+    path: "/installations/{installationId}/purge-preview";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        actorId: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/purge-preview";
+};
+export declare const getAppRoute: {
+    method: "get";
+    path: "/{appId}";
+    request: {
+        params: z.ZodObject<{
+            appId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+        404: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        error: z.ZodString;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/:appId";
+};
+export declare const listAppReleasesRoute: {
+    method: "get";
+    path: "/{appId}/releases";
+    request: {
+        params: z.ZodObject<{
+            appId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/:appId/releases";
+};
+export declare const createAppReleaseRoute: {
+    method: "post";
+    path: "/{appId}/releases";
+    request: {
+        params: z.ZodObject<{
+            appId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        manifest: z.ZodUnknown;
+                        createdBy: z.ZodString;
+                        provenance: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        201: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                        digest: z.ZodString;
+                        created: z.ZodBoolean;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/:appId/releases";
+};
+export declare const fetchAppReleaseRoute: {
+    method: "post";
+    path: "/{appId}/releases/fetch";
+    request: {
+        params: z.ZodObject<{
+            appId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        manifestUrl: z.ZodString;
+                        createdBy: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        201: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                        digest: z.ZodString;
+                        created: z.ZodBoolean;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/:appId/releases/fetch";
+};
+export declare const listAppWebhooksRoute: {
+    method: "get";
+    path: "/installations/{installationId}/webhooks";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/webhooks";
+};
+export declare const replayAppWebhookRoute: {
+    method: "post";
+    path: "/installations/{installationId}/webhooks/replay";
+    request: {
+        params: z.ZodObject<{
+            installationId: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            required: boolean;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        deliveryId: z.ZodString;
+                        actorId: z.ZodString;
+                        signingKeyId: z.ZodString;
+                        signingSecret: z.ZodString;
+                    }, z.core.$strict>;
+                };
+            };
+        };
+    };
+    responses: {
+        202: {
+            description: string;
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodUnknown;
+                    }, z.core.$strip>;
+                };
+            };
+        };
+    };
+} & {
+    getRoutingPath(): "/installations/:installationId/webhooks/replay";
+};