@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
427 lines • 21.6 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetWebhooksRequest = {
projectId?: string | undefined;
/**
* The Team identifier to perform the request on behalf of.
*/
teamId?: string | undefined;
/**
* The Team slug to perform the request on behalf of.
*/
slug?: string | undefined;
};
/**
* The webhooks events
*/
export declare const GetWebhooksResponseBodyEvents: {
readonly AiGatewayAutoReloadLimitReached: "ai-gateway.auto-reload.limit-reached";
readonly AiGatewayBalanceDepleted: "ai-gateway.balance-depleted";
readonly AlertsTriggered: "alerts.triggered";
readonly BotidAnomaly: "botid.anomaly";
readonly BudgetReached: "budget.reached";
readonly CommentCreated: "comment.created";
readonly CommentDeleted: "comment.deleted";
readonly CommentMentioned: "comment.mentioned";
readonly CommentReactionAdded: "comment.reaction-added";
readonly CommentReactionRemoved: "comment.reaction-removed";
readonly CommentResolved: "comment.resolved";
readonly CommentUnresolved: "comment.unresolved";
readonly CommentUpdated: "comment.updated";
readonly Deployment: "deployment";
readonly DeploymentCanceledHyphen: "deployment-canceled";
readonly DeploymentCheckRerequestedHyphen: "deployment-check-rerequested";
readonly DeploymentChecksCompleted: "deployment-checks-completed";
readonly DeploymentErrorHyphen: "deployment-error";
readonly DeploymentPreparedHyphen: "deployment-prepared";
readonly DeploymentReadyHyphen: "deployment-ready";
readonly DeploymentBlocked: "deployment.blocked";
readonly DeploymentBuildRequested: "deployment.build-requested";
readonly DeploymentCanceled: "deployment.canceled";
readonly DeploymentCheckRerequested: "deployment.check-rerequested";
readonly DeploymentCheckrunCancel: "deployment.checkrun.cancel";
readonly DeploymentCheckrunStart: "deployment.checkrun.start";
readonly DeploymentChecksFailed: "deployment.checks.failed";
readonly DeploymentChecksSucceeded: "deployment.checks.succeeded";
readonly DeploymentCleanup: "deployment.cleanup";
readonly DeploymentCreated: "deployment.created";
readonly DeploymentError: "deployment.error";
readonly DeploymentIntegrationActionCancel: "deployment.integration.action.cancel";
readonly DeploymentIntegrationActionCleanup: "deployment.integration.action.cleanup";
readonly DeploymentIntegrationActionStart: "deployment.integration.action.start";
readonly DeploymentPromoted: "deployment.promoted";
readonly DeploymentReady: "deployment.ready";
readonly DeploymentRollback: "deployment.rollback";
readonly DeploymentSucceeded: "deployment.succeeded";
readonly DomainCreatedHyphen: "domain-created";
readonly DomainAutoRenewChanged: "domain.auto-renew.changed";
readonly DomainCertificateAdd: "domain.certificate.add";
readonly DomainCertificateAddFailed: "domain.certificate.add.failed";
readonly DomainCertificateDeleted: "domain.certificate.deleted";
readonly DomainCertificateRenew: "domain.certificate.renew";
readonly DomainCertificateRenewFailed: "domain.certificate.renew.failed";
readonly DomainCreated: "domain.created";
readonly DomainDnsRecordsChanged: "domain.dns.records.changed";
readonly DomainRenewal: "domain.renewal";
readonly DomainRenewalFailed: "domain.renewal.failed";
readonly DomainTransferInCompleted: "domain.transfer-in.completed";
readonly DomainTransferInFailed: "domain.transfer-in.failed";
readonly DomainTransferInStarted: "domain.transfer-in.started";
readonly EdgeConfigCreated: "edge-config.created";
readonly EdgeConfigDeleted: "edge-config.deleted";
readonly EdgeConfigItemsUpdated: "edge-config.items.updated";
readonly FirewallAttack: "firewall.attack";
readonly FirewallCustomRuleAnomaly: "firewall.custom-rule-anomaly";
readonly FirewallSystemRuleAnomaly: "firewall.system-rule-anomaly";
readonly FlagCreated: "flag.created";
readonly FlagDeleted: "flag.deleted";
readonly FlagSegmentCreated: "flag.segment.created";
readonly FlagSegmentDeleted: "flag.segment.deleted";
readonly FlagSegmentUpdated: "flag.segment.updated";
readonly FlagUpdated: "flag.updated";
readonly FunctionArchivalRequired: "function.archival-required";
readonly FunctionRemovalRequired: "function.removal-required";
readonly IntegrationConfigurationPermissionUpdatedHyphen: "integration-configuration-permission-updated";
readonly IntegrationConfigurationRemovedHyphen: "integration-configuration-removed";
readonly IntegrationConfigurationScopeChangeConfirmedHyphen: "integration-configuration-scope-change-confirmed";
readonly IntegrationConfigurationPermissionUpgraded: "integration-configuration.permission-upgraded";
readonly IntegrationConfigurationRemoved: "integration-configuration.removed";
readonly IntegrationConfigurationScopeChangeConfirmed: "integration-configuration.scope-change-confirmed";
readonly IntegrationConfigurationTransferred: "integration-configuration.transferred";
readonly IntegrationResourceProjectConnected: "integration-resource.project-connected";
readonly IntegrationResourceProjectDisconnected: "integration-resource.project-disconnected";
readonly MarketplaceInvoiceCreated: "marketplace.invoice.created";
readonly MarketplaceInvoiceNotpaid: "marketplace.invoice.notpaid";
readonly MarketplaceInvoiceOverdue: "marketplace.invoice.overdue";
readonly MarketplaceInvoicePaid: "marketplace.invoice.paid";
readonly MarketplaceInvoiceRefunded: "marketplace.invoice.refunded";
readonly MarketplaceMemberChanged: "marketplace.member.changed";
readonly MessageCreated: "message.created";
readonly MessageDeleted: "message.deleted";
readonly MessageMentioned: "message.mentioned";
readonly MessageReactionAdded: "message.reaction-added";
readonly MessageReactionRemoved: "message.reaction-removed";
readonly MessageUpdated: "message.updated";
readonly ObservabilityAnomaly: "observability.anomaly";
readonly ObservabilityAnomalyError: "observability.anomaly-error";
readonly ObservabilityErrorAnomaly: "observability.error-anomaly";
readonly ObservabilityUsageAnomaly: "observability.usage-anomaly";
readonly ProjectCreatedHyphen: "project-created";
readonly ProjectRemovedHyphen: "project-removed";
readonly ProjectCreated: "project.created";
readonly ProjectDomainCreated: "project.domain.created";
readonly ProjectDomainDeleted: "project.domain.deleted";
readonly ProjectDomainMoved: "project.domain.moved";
readonly ProjectDomainUnverified: "project.domain.unverified";
readonly ProjectDomainUpdated: "project.domain.updated";
readonly ProjectDomainVerified: "project.domain.verified";
readonly ProjectEnvVariableCreated: "project.env-variable.created";
readonly ProjectEnvVariableDeleted: "project.env-variable.deleted";
readonly ProjectEnvVariableUpdated: "project.env-variable.updated";
readonly ProjectRemoved: "project.removed";
readonly ProjectRenamed: "project.renamed";
readonly ProjectRollingReleaseAborted: "project.rolling-release.aborted";
readonly ProjectRollingReleaseApproved: "project.rolling-release.approved";
readonly ProjectRollingReleaseCompleted: "project.rolling-release.completed";
readonly ProjectRollingReleaseStarted: "project.rolling-release.started";
readonly TestWebhook: "test-webhook";
readonly ThreadResolved: "thread.resolved";
readonly ThreadUnresolved: "thread.unresolved";
};
/**
* The webhooks events
*/
export type GetWebhooksResponseBodyEvents = ClosedEnum<typeof GetWebhooksResponseBodyEvents>;
export type GetWebhooksResponseBody2 = {
/**
* The webhooks events
*/
events: Array<GetWebhooksResponseBodyEvents>;
/**
* The webhook id
*/
id: string;
/**
* A string with the URL of the webhook
*/
url: string;
/**
* The unique ID of the team the webhook belongs to
*/
ownerId: string;
/**
* A number containing the date when the webhook was created in in milliseconds
*/
createdAt: number;
/**
* A number containing the date when the webhook was updated in in milliseconds
*/
updatedAt: number;
/**
* The ID of the projects the webhook is associated with
*/
projectIds?: Array<string> | undefined;
};
export declare const GetWebhooksResponseBodyFramework: {
readonly ActixWeb: "actix-web";
readonly Angular: "angular";
readonly Ash: "ash";
readonly Astro: "astro";
readonly Axum: "axum";
readonly Blitzjs: "blitzjs";
readonly Brunch: "brunch";
readonly Bun: "bun";
readonly CreateReactApp: "create-react-app";
readonly Django: "django";
readonly Docusaurus: "docusaurus";
readonly Docusaurus2: "docusaurus-2";
readonly Dojo: "dojo";
readonly Eleventy: "eleventy";
readonly Elysia: "elysia";
readonly Ember: "ember";
readonly Eve: "eve";
readonly Express: "express";
readonly Fastapi: "fastapi";
readonly Fasthtml: "fasthtml";
readonly Fastify: "fastify";
readonly Flask: "flask";
readonly Gatsby: "gatsby";
readonly Go: "go";
readonly Gridsome: "gridsome";
readonly H3: "h3";
readonly Hexo: "hexo";
readonly Hono: "hono";
readonly Hugo: "hugo";
readonly Hydrogen: "hydrogen";
readonly IonicAngular: "ionic-angular";
readonly IonicReact: "ionic-react";
readonly Jekyll: "jekyll";
readonly Koa: "koa";
readonly Mastra: "mastra";
readonly Middleman: "middleman";
readonly Nestjs: "nestjs";
readonly Nextjs: "nextjs";
readonly Nitro: "nitro";
readonly Node: "node";
readonly Nuxtjs: "nuxtjs";
readonly Parcel: "parcel";
readonly Polymer: "polymer";
readonly Preact: "preact";
readonly Python: "python";
readonly ReactRouter: "react-router";
readonly Redwoodjs: "redwoodjs";
readonly Remix: "remix";
readonly Ruby: "ruby";
readonly Rust: "rust";
readonly Saber: "saber";
readonly Sanity: "sanity";
readonly SanityV2: "sanity-v2";
readonly Sapper: "sapper";
readonly Scully: "scully";
readonly Services: "services";
readonly Solidstart: "solidstart";
readonly Solidstart1: "solidstart-1";
readonly Stencil: "stencil";
readonly Storybook: "storybook";
readonly Svelte: "svelte";
readonly Sveltekit: "sveltekit";
readonly Sveltekit1: "sveltekit-1";
readonly TanstackStart: "tanstack-start";
readonly Umijs: "umijs";
readonly Vite: "vite";
readonly Vitepress: "vitepress";
readonly Vue: "vue";
readonly Vuepress: "vuepress";
readonly Xmcp: "xmcp";
readonly Zola: "zola";
};
export type GetWebhooksResponseBodyFramework = ClosedEnum<typeof GetWebhooksResponseBodyFramework>;
export type GetWebhooksResponseBodyProjectsMetadata = {
id: string;
name: string;
framework?: GetWebhooksResponseBodyFramework | null | undefined;
latestDeployment?: string | undefined;
};
/**
* The webhooks events
*/
export declare const ResponseBodyEvents: {
readonly AiGatewayAutoReloadLimitReached: "ai-gateway.auto-reload.limit-reached";
readonly AiGatewayBalanceDepleted: "ai-gateway.balance-depleted";
readonly AlertsTriggered: "alerts.triggered";
readonly BotidAnomaly: "botid.anomaly";
readonly BudgetReached: "budget.reached";
readonly CommentCreated: "comment.created";
readonly CommentDeleted: "comment.deleted";
readonly CommentMentioned: "comment.mentioned";
readonly CommentReactionAdded: "comment.reaction-added";
readonly CommentReactionRemoved: "comment.reaction-removed";
readonly CommentResolved: "comment.resolved";
readonly CommentUnresolved: "comment.unresolved";
readonly CommentUpdated: "comment.updated";
readonly Deployment: "deployment";
readonly DeploymentCanceledHyphen: "deployment-canceled";
readonly DeploymentCheckRerequestedHyphen: "deployment-check-rerequested";
readonly DeploymentChecksCompleted: "deployment-checks-completed";
readonly DeploymentErrorHyphen: "deployment-error";
readonly DeploymentPreparedHyphen: "deployment-prepared";
readonly DeploymentReadyHyphen: "deployment-ready";
readonly DeploymentBlocked: "deployment.blocked";
readonly DeploymentBuildRequested: "deployment.build-requested";
readonly DeploymentCanceled: "deployment.canceled";
readonly DeploymentCheckRerequested: "deployment.check-rerequested";
readonly DeploymentCheckrunCancel: "deployment.checkrun.cancel";
readonly DeploymentCheckrunStart: "deployment.checkrun.start";
readonly DeploymentChecksFailed: "deployment.checks.failed";
readonly DeploymentChecksSucceeded: "deployment.checks.succeeded";
readonly DeploymentCleanup: "deployment.cleanup";
readonly DeploymentCreated: "deployment.created";
readonly DeploymentError: "deployment.error";
readonly DeploymentIntegrationActionCancel: "deployment.integration.action.cancel";
readonly DeploymentIntegrationActionCleanup: "deployment.integration.action.cleanup";
readonly DeploymentIntegrationActionStart: "deployment.integration.action.start";
readonly DeploymentPromoted: "deployment.promoted";
readonly DeploymentReady: "deployment.ready";
readonly DeploymentRollback: "deployment.rollback";
readonly DeploymentSucceeded: "deployment.succeeded";
readonly DomainCreatedHyphen: "domain-created";
readonly DomainAutoRenewChanged: "domain.auto-renew.changed";
readonly DomainCertificateAdd: "domain.certificate.add";
readonly DomainCertificateAddFailed: "domain.certificate.add.failed";
readonly DomainCertificateDeleted: "domain.certificate.deleted";
readonly DomainCertificateRenew: "domain.certificate.renew";
readonly DomainCertificateRenewFailed: "domain.certificate.renew.failed";
readonly DomainCreated: "domain.created";
readonly DomainDnsRecordsChanged: "domain.dns.records.changed";
readonly DomainRenewal: "domain.renewal";
readonly DomainRenewalFailed: "domain.renewal.failed";
readonly DomainTransferInCompleted: "domain.transfer-in.completed";
readonly DomainTransferInFailed: "domain.transfer-in.failed";
readonly DomainTransferInStarted: "domain.transfer-in.started";
readonly EdgeConfigCreated: "edge-config.created";
readonly EdgeConfigDeleted: "edge-config.deleted";
readonly EdgeConfigItemsUpdated: "edge-config.items.updated";
readonly FirewallAttack: "firewall.attack";
readonly FirewallCustomRuleAnomaly: "firewall.custom-rule-anomaly";
readonly FirewallSystemRuleAnomaly: "firewall.system-rule-anomaly";
readonly FlagCreated: "flag.created";
readonly FlagDeleted: "flag.deleted";
readonly FlagSegmentCreated: "flag.segment.created";
readonly FlagSegmentDeleted: "flag.segment.deleted";
readonly FlagSegmentUpdated: "flag.segment.updated";
readonly FlagUpdated: "flag.updated";
readonly FunctionArchivalRequired: "function.archival-required";
readonly FunctionRemovalRequired: "function.removal-required";
readonly IntegrationConfigurationPermissionUpdatedHyphen: "integration-configuration-permission-updated";
readonly IntegrationConfigurationRemovedHyphen: "integration-configuration-removed";
readonly IntegrationConfigurationScopeChangeConfirmedHyphen: "integration-configuration-scope-change-confirmed";
readonly IntegrationConfigurationPermissionUpgraded: "integration-configuration.permission-upgraded";
readonly IntegrationConfigurationRemoved: "integration-configuration.removed";
readonly IntegrationConfigurationScopeChangeConfirmed: "integration-configuration.scope-change-confirmed";
readonly IntegrationConfigurationTransferred: "integration-configuration.transferred";
readonly IntegrationResourceProjectConnected: "integration-resource.project-connected";
readonly IntegrationResourceProjectDisconnected: "integration-resource.project-disconnected";
readonly MarketplaceInvoiceCreated: "marketplace.invoice.created";
readonly MarketplaceInvoiceNotpaid: "marketplace.invoice.notpaid";
readonly MarketplaceInvoiceOverdue: "marketplace.invoice.overdue";
readonly MarketplaceInvoicePaid: "marketplace.invoice.paid";
readonly MarketplaceInvoiceRefunded: "marketplace.invoice.refunded";
readonly MarketplaceMemberChanged: "marketplace.member.changed";
readonly MessageCreated: "message.created";
readonly MessageDeleted: "message.deleted";
readonly MessageMentioned: "message.mentioned";
readonly MessageReactionAdded: "message.reaction-added";
readonly MessageReactionRemoved: "message.reaction-removed";
readonly MessageUpdated: "message.updated";
readonly ObservabilityAnomaly: "observability.anomaly";
readonly ObservabilityAnomalyError: "observability.anomaly-error";
readonly ObservabilityErrorAnomaly: "observability.error-anomaly";
readonly ObservabilityUsageAnomaly: "observability.usage-anomaly";
readonly ProjectCreatedHyphen: "project-created";
readonly ProjectRemovedHyphen: "project-removed";
readonly ProjectCreated: "project.created";
readonly ProjectDomainCreated: "project.domain.created";
readonly ProjectDomainDeleted: "project.domain.deleted";
readonly ProjectDomainMoved: "project.domain.moved";
readonly ProjectDomainUnverified: "project.domain.unverified";
readonly ProjectDomainUpdated: "project.domain.updated";
readonly ProjectDomainVerified: "project.domain.verified";
readonly ProjectEnvVariableCreated: "project.env-variable.created";
readonly ProjectEnvVariableDeleted: "project.env-variable.deleted";
readonly ProjectEnvVariableUpdated: "project.env-variable.updated";
readonly ProjectRemoved: "project.removed";
readonly ProjectRenamed: "project.renamed";
readonly ProjectRollingReleaseAborted: "project.rolling-release.aborted";
readonly ProjectRollingReleaseApproved: "project.rolling-release.approved";
readonly ProjectRollingReleaseCompleted: "project.rolling-release.completed";
readonly ProjectRollingReleaseStarted: "project.rolling-release.started";
readonly TestWebhook: "test-webhook";
readonly ThreadResolved: "thread.resolved";
readonly ThreadUnresolved: "thread.unresolved";
};
/**
* The webhooks events
*/
export type ResponseBodyEvents = ClosedEnum<typeof ResponseBodyEvents>;
export type GetWebhooksResponseBody1 = {
projectsMetadata: Array<GetWebhooksResponseBodyProjectsMetadata> | null;
/**
* The webhooks events
*/
events: Array<ResponseBodyEvents>;
/**
* The webhook id
*/
id: string;
/**
* A string with the URL of the webhook
*/
url: string;
/**
* The unique ID of the team the webhook belongs to
*/
ownerId: string;
/**
* A number containing the date when the webhook was created in in milliseconds
*/
createdAt: number;
/**
* A number containing the date when the webhook was updated in in milliseconds
*/
updatedAt: number;
/**
* The ID of the projects the webhook is associated with
*/
projectIds?: Array<string> | undefined;
};
export type GetWebhooksResponseBody = Array<GetWebhooksResponseBody1> | Array<GetWebhooksResponseBody2>;
/** @internal */
export type GetWebhooksRequest$Outbound = {
projectId?: string | undefined;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetWebhooksRequest$outboundSchema: z.ZodType<GetWebhooksRequest$Outbound, z.ZodTypeDef, GetWebhooksRequest>;
export declare function getWebhooksRequestToJSON(getWebhooksRequest: GetWebhooksRequest): string;
/** @internal */
export declare const GetWebhooksResponseBodyEvents$inboundSchema: z.ZodNativeEnum<typeof GetWebhooksResponseBodyEvents>;
/** @internal */
export declare const GetWebhooksResponseBody2$inboundSchema: z.ZodType<GetWebhooksResponseBody2, z.ZodTypeDef, unknown>;
export declare function getWebhooksResponseBody2FromJSON(jsonString: string): SafeParseResult<GetWebhooksResponseBody2, SDKValidationError>;
/** @internal */
export declare const GetWebhooksResponseBodyFramework$inboundSchema: z.ZodNativeEnum<typeof GetWebhooksResponseBodyFramework>;
/** @internal */
export declare const GetWebhooksResponseBodyProjectsMetadata$inboundSchema: z.ZodType<GetWebhooksResponseBodyProjectsMetadata, z.ZodTypeDef, unknown>;
export declare function getWebhooksResponseBodyProjectsMetadataFromJSON(jsonString: string): SafeParseResult<GetWebhooksResponseBodyProjectsMetadata, SDKValidationError>;
/** @internal */
export declare const ResponseBodyEvents$inboundSchema: z.ZodNativeEnum<typeof ResponseBodyEvents>;
/** @internal */
export declare const GetWebhooksResponseBody1$inboundSchema: z.ZodType<GetWebhooksResponseBody1, z.ZodTypeDef, unknown>;
export declare function getWebhooksResponseBody1FromJSON(jsonString: string): SafeParseResult<GetWebhooksResponseBody1, SDKValidationError>;
/** @internal */
export declare const GetWebhooksResponseBody$inboundSchema: z.ZodType<GetWebhooksResponseBody, z.ZodTypeDef, unknown>;
export declare function getWebhooksResponseBodyFromJSON(jsonString: string): SafeParseResult<GetWebhooksResponseBody, SDKValidationError>;
//# sourceMappingURL=getwebhooksop.d.ts.map