@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>
237 lines (226 loc) • 8.87 kB
text/typescript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod/v3";
import { safeParse } from "../lib/schemas.js";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import * as types from "../types/primitives.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetWebhookRequest = {
id: string;
/**
* 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 const GetWebhookEvents = {
AiGatewayAutoReloadLimitReached: "ai-gateway.auto-reload.limit-reached",
AiGatewayBalanceDepleted: "ai-gateway.balance-depleted",
AlertsTriggered: "alerts.triggered",
BotidAnomaly: "botid.anomaly",
BudgetReached: "budget.reached",
CommentCreated: "comment.created",
CommentDeleted: "comment.deleted",
CommentMentioned: "comment.mentioned",
CommentReactionAdded: "comment.reaction-added",
CommentReactionRemoved: "comment.reaction-removed",
CommentResolved: "comment.resolved",
CommentUnresolved: "comment.unresolved",
CommentUpdated: "comment.updated",
Deployment: "deployment",
DeploymentCanceledHyphen: "deployment-canceled",
DeploymentCheckRerequestedHyphen: "deployment-check-rerequested",
DeploymentChecksCompleted: "deployment-checks-completed",
DeploymentErrorHyphen: "deployment-error",
DeploymentPreparedHyphen: "deployment-prepared",
DeploymentReadyHyphen: "deployment-ready",
DeploymentBlocked: "deployment.blocked",
DeploymentBuildRequested: "deployment.build-requested",
DeploymentCanceled: "deployment.canceled",
DeploymentCheckRerequested: "deployment.check-rerequested",
DeploymentCheckrunCancel: "deployment.checkrun.cancel",
DeploymentCheckrunStart: "deployment.checkrun.start",
DeploymentChecksFailed: "deployment.checks.failed",
DeploymentChecksSucceeded: "deployment.checks.succeeded",
DeploymentCleanup: "deployment.cleanup",
DeploymentCreated: "deployment.created",
DeploymentError: "deployment.error",
DeploymentIntegrationActionCancel: "deployment.integration.action.cancel",
DeploymentIntegrationActionCleanup: "deployment.integration.action.cleanup",
DeploymentIntegrationActionStart: "deployment.integration.action.start",
DeploymentPromoted: "deployment.promoted",
DeploymentReady: "deployment.ready",
DeploymentRollback: "deployment.rollback",
DeploymentSucceeded: "deployment.succeeded",
DomainCreatedHyphen: "domain-created",
DomainAutoRenewChanged: "domain.auto-renew.changed",
DomainCertificateAdd: "domain.certificate.add",
DomainCertificateAddFailed: "domain.certificate.add.failed",
DomainCertificateDeleted: "domain.certificate.deleted",
DomainCertificateRenew: "domain.certificate.renew",
DomainCertificateRenewFailed: "domain.certificate.renew.failed",
DomainCreated: "domain.created",
DomainDnsRecordsChanged: "domain.dns.records.changed",
DomainRenewal: "domain.renewal",
DomainRenewalFailed: "domain.renewal.failed",
DomainTransferInCompleted: "domain.transfer-in.completed",
DomainTransferInFailed: "domain.transfer-in.failed",
DomainTransferInStarted: "domain.transfer-in.started",
EdgeConfigCreated: "edge-config.created",
EdgeConfigDeleted: "edge-config.deleted",
EdgeConfigItemsUpdated: "edge-config.items.updated",
FirewallAttack: "firewall.attack",
FirewallCustomRuleAnomaly: "firewall.custom-rule-anomaly",
FirewallSystemRuleAnomaly: "firewall.system-rule-anomaly",
FlagCreated: "flag.created",
FlagDeleted: "flag.deleted",
FlagSegmentCreated: "flag.segment.created",
FlagSegmentDeleted: "flag.segment.deleted",
FlagSegmentUpdated: "flag.segment.updated",
FlagUpdated: "flag.updated",
FunctionArchivalRequired: "function.archival-required",
FunctionRemovalRequired: "function.removal-required",
IntegrationConfigurationPermissionUpdatedHyphen:
"integration-configuration-permission-updated",
IntegrationConfigurationRemovedHyphen: "integration-configuration-removed",
IntegrationConfigurationScopeChangeConfirmedHyphen:
"integration-configuration-scope-change-confirmed",
IntegrationConfigurationPermissionUpgraded:
"integration-configuration.permission-upgraded",
IntegrationConfigurationRemoved: "integration-configuration.removed",
IntegrationConfigurationScopeChangeConfirmed:
"integration-configuration.scope-change-confirmed",
IntegrationConfigurationTransferred: "integration-configuration.transferred",
IntegrationResourceProjectConnected: "integration-resource.project-connected",
IntegrationResourceProjectDisconnected:
"integration-resource.project-disconnected",
MarketplaceInvoiceCreated: "marketplace.invoice.created",
MarketplaceInvoiceNotpaid: "marketplace.invoice.notpaid",
MarketplaceInvoiceOverdue: "marketplace.invoice.overdue",
MarketplaceInvoicePaid: "marketplace.invoice.paid",
MarketplaceInvoiceRefunded: "marketplace.invoice.refunded",
MarketplaceMemberChanged: "marketplace.member.changed",
MessageCreated: "message.created",
MessageDeleted: "message.deleted",
MessageMentioned: "message.mentioned",
MessageReactionAdded: "message.reaction-added",
MessageReactionRemoved: "message.reaction-removed",
MessageUpdated: "message.updated",
ObservabilityAnomaly: "observability.anomaly",
ObservabilityAnomalyError: "observability.anomaly-error",
ObservabilityErrorAnomaly: "observability.error-anomaly",
ObservabilityUsageAnomaly: "observability.usage-anomaly",
ProjectCreatedHyphen: "project-created",
ProjectRemovedHyphen: "project-removed",
ProjectCreated: "project.created",
ProjectDomainCreated: "project.domain.created",
ProjectDomainDeleted: "project.domain.deleted",
ProjectDomainMoved: "project.domain.moved",
ProjectDomainUnverified: "project.domain.unverified",
ProjectDomainUpdated: "project.domain.updated",
ProjectDomainVerified: "project.domain.verified",
ProjectEnvVariableCreated: "project.env-variable.created",
ProjectEnvVariableDeleted: "project.env-variable.deleted",
ProjectEnvVariableUpdated: "project.env-variable.updated",
ProjectRemoved: "project.removed",
ProjectRenamed: "project.renamed",
ProjectRollingReleaseAborted: "project.rolling-release.aborted",
ProjectRollingReleaseApproved: "project.rolling-release.approved",
ProjectRollingReleaseCompleted: "project.rolling-release.completed",
ProjectRollingReleaseStarted: "project.rolling-release.started",
TestWebhook: "test-webhook",
ThreadResolved: "thread.resolved",
ThreadUnresolved: "thread.unresolved",
} as const;
/**
* The webhooks events
*/
export type GetWebhookEvents = ClosedEnum<typeof GetWebhookEvents>;
export type GetWebhookResponseBody = {
/**
* The webhooks events
*/
events: Array<GetWebhookEvents>;
/**
* 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;
};
/** @internal */
export type GetWebhookRequest$Outbound = {
id: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export const GetWebhookRequest$outboundSchema: z.ZodType<
GetWebhookRequest$Outbound,
z.ZodTypeDef,
GetWebhookRequest
> = z.object({
id: z.string(),
teamId: z.string().optional(),
slug: z.string().optional(),
});
export function getWebhookRequestToJSON(
getWebhookRequest: GetWebhookRequest,
): string {
return JSON.stringify(
GetWebhookRequest$outboundSchema.parse(getWebhookRequest),
);
}
/** @internal */
export const GetWebhookEvents$inboundSchema: z.ZodNativeEnum<
typeof GetWebhookEvents
> = z.nativeEnum(GetWebhookEvents);
/** @internal */
export const GetWebhookResponseBody$inboundSchema: z.ZodType<
GetWebhookResponseBody,
z.ZodTypeDef,
unknown
> = z.object({
events: z.array(GetWebhookEvents$inboundSchema),
id: types.string(),
url: types.string(),
ownerId: types.string(),
createdAt: types.number(),
updatedAt: types.number(),
projectIds: types.optional(z.array(types.string())),
});
export function getWebhookResponseBodyFromJSON(
jsonString: string,
): SafeParseResult<GetWebhookResponseBody, SDKValidationError> {
return safeParse(
jsonString,
(x) => GetWebhookResponseBody$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'GetWebhookResponseBody' from JSON`,
);
}