@pulumiverse/vercel 1.1.2 → 1.9.0

package/types/output.d.ts

@@ -65,6 +65,16 @@ export interface GetProjectEnvironment {
      */
     value: string;
 }
+export interface GetProjectGitComments {
+    /**
+     * Whether Commit comments are enabled
+     */
+    onCommit: boolean;
+    /**
+     * Whether Pull Request comments are enabled
+     */
+    onPullRequest: boolean;
+}
 export interface GetProjectGitRepository {
     /**
      * By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
@@ -101,9 +111,6 @@ export interface GetProjectTrustedIps {
 }
 export interface GetProjectTrustedIpsAddress {
     note: string;
-    /**
-     * The value of the environment variable.
-     */
     value: string;
 }
 export interface GetProjectVercelAuthentication {
@@ -138,7 +145,21 @@ export interface ProjectEnvironment {
      */
     value: string;
 }
+export interface ProjectGitComments {
+    /**
+     * Whether Commit comments are enabled
+     */
+    onCommit: boolean;
+    /**
+     * Whether Pull Request comments are enabled
+     */
+    onPullRequest: boolean;
+}
 export interface ProjectGitRepository {
+    /**
+     * Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
+     */
+    deployHooks?: outputs.ProjectGitRepositoryDeployHook[];
     /**
      * By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
      */
@@ -152,6 +173,24 @@ export interface ProjectGitRepository {
      */
     type: string;
 }
+export interface ProjectGitRepositoryDeployHook {
+    /**
+     * The ID of the deploy hook.
+     */
+    id: string;
+    /**
+     * The name of the deploy hook.
+     */
+    name: string;
+    /**
+     * The branch or commit hash that should be deployed.
+     */
+    ref: string;
+    /**
+     * A URL that, when a POST request is made to, will trigger a new deployment.
+     */
+    url: string;
+}
 export interface ProjectPasswordProtection {
     /**
      * The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, or `onlyPreviewDeployments`.
@@ -182,7 +221,7 @@ export interface ProjectTrustedIpsAddress {
      */
     note?: string;
     /**
-     * The value of the Environment Variable.
+     * The address or CIDR range that can access deployments.
      */
     value: string;
 }

package/webhook.d.ts

@@ -0,0 +1,127 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * A webhook is a trigger-based HTTP endpoint configured to receive HTTP POST requests through events.
+ *
+ * When an event happens, a webhook is sent to a third-party app, which can then take appropriate action.
+ *
+ * > Only Pro and Enterprise teams are able to configure these webhooks at the account level.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumiverse/vercel";
+ *
+ * const example = new vercel.Project("example", {});
+ * const example2 = new vercel.Project("example2", {});
+ * const withProjectIds = new vercel.Webhook("withProjectIds", {
+ *     events: [
+ *         "deployment.created",
+ *         "deployment.succeeded",
+ *     ],
+ *     endpoint: "https://example.com/endpoint",
+ *     projectIds: [
+ *         example.id,
+ *         example2.id,
+ *     ],
+ * });
+ * const withoutProjectIds = new vercel.Webhook("withoutProjectIds", {
+ *     events: [
+ *         "deployment.created",
+ *         "deployment.succeeded",
+ *     ],
+ *     endpoint: "https://example.com/endpoint",
+ * });
+ * ```
+ */
+export declare class Webhook extends pulumi.CustomResource {
+    /**
+     * Get an existing Webhook resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WebhookState, opts?: pulumi.CustomResourceOptions): Webhook;
+    /**
+     * Returns true if the given object is an instance of Webhook.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is Webhook;
+    /**
+     * Webhooks events will be sent as POST requests to this URL.
+     */
+    readonly endpoint: pulumi.Output<string>;
+    /**
+     * A list of the events the webhook will listen to. At least one must be present.
+     */
+    readonly events: pulumi.Output<string[]>;
+    /**
+     * A list of project IDs that the webhook should be associated with. These projects should send events to the specified endpoint.
+     */
+    readonly projectIds: pulumi.Output<string[] | undefined>;
+    /**
+     * A secret value which will be provided in the `x-vercel-signature` header and can be used to verify the authenticity of the webhook. See https://vercel.com/docs/observability/webhooks-overview/webhooks-api#securing-webhooks for further details.
+     */
+    readonly secret: pulumi.Output<string>;
+    /**
+     * The ID of the team the Webhook should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
+    readonly teamId: pulumi.Output<string>;
+    /**
+     * Create a Webhook resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: WebhookArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering Webhook resources.
+ */
+export interface WebhookState {
+    /**
+     * Webhooks events will be sent as POST requests to this URL.
+     */
+    endpoint?: pulumi.Input<string>;
+    /**
+     * A list of the events the webhook will listen to. At least one must be present.
+     */
+    events?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A list of project IDs that the webhook should be associated with. These projects should send events to the specified endpoint.
+     */
+    projectIds?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A secret value which will be provided in the `x-vercel-signature` header and can be used to verify the authenticity of the webhook. See https://vercel.com/docs/observability/webhooks-overview/webhooks-api#securing-webhooks for further details.
+     */
+    secret?: pulumi.Input<string>;
+    /**
+     * The ID of the team the Webhook should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
+    teamId?: pulumi.Input<string>;
+}
+/**
+ * The set of arguments for constructing a Webhook resource.
+ */
+export interface WebhookArgs {
+    /**
+     * Webhooks events will be sent as POST requests to this URL.
+     */
+    endpoint: pulumi.Input<string>;
+    /**
+     * A list of the events the webhook will listen to. At least one must be present.
+     */
+    events: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A list of project IDs that the webhook should be associated with. These projects should send events to the specified endpoint.
+     */
+    projectIds?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The ID of the team the Webhook should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
+    teamId?: pulumi.Input<string>;
+}

package/webhook.js

@@ -0,0 +1,100 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhook = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * A webhook is a trigger-based HTTP endpoint configured to receive HTTP POST requests through events.
+ *
+ * When an event happens, a webhook is sent to a third-party app, which can then take appropriate action.
+ *
+ * > Only Pro and Enterprise teams are able to configure these webhooks at the account level.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumiverse/vercel";
+ *
+ * const example = new vercel.Project("example", {});
+ * const example2 = new vercel.Project("example2", {});
+ * const withProjectIds = new vercel.Webhook("withProjectIds", {
+ *     events: [
+ *         "deployment.created",
+ *         "deployment.succeeded",
+ *     ],
+ *     endpoint: "https://example.com/endpoint",
+ *     projectIds: [
+ *         example.id,
+ *         example2.id,
+ *     ],
+ * });
+ * const withoutProjectIds = new vercel.Webhook("withoutProjectIds", {
+ *     events: [
+ *         "deployment.created",
+ *         "deployment.succeeded",
+ *     ],
+ *     endpoint: "https://example.com/endpoint",
+ * });
+ * ```
+ */
+class Webhook extends pulumi.CustomResource {
+    /**
+     * Get an existing Webhook resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, state, opts) {
+        return new Webhook(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of Webhook.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === Webhook.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["endpoint"] = state ? state.endpoint : undefined;
+            resourceInputs["events"] = state ? state.events : undefined;
+            resourceInputs["projectIds"] = state ? state.projectIds : undefined;
+            resourceInputs["secret"] = state ? state.secret : undefined;
+            resourceInputs["teamId"] = state ? state.teamId : undefined;
+        }
+        else {
+            const args = argsOrState;
+            if ((!args || args.endpoint === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'endpoint'");
+            }
+            if ((!args || args.events === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'events'");
+            }
+            resourceInputs["endpoint"] = args ? args.endpoint : undefined;
+            resourceInputs["events"] = args ? args.events : undefined;
+            resourceInputs["projectIds"] = args ? args.projectIds : undefined;
+            resourceInputs["teamId"] = args ? args.teamId : undefined;
+            resourceInputs["secret"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        const secretOpts = { additionalSecretOutputs: ["secret"] };
+        opts = pulumi.mergeOptions(opts, secretOpts);
+        super(Webhook.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.Webhook = Webhook;
+/** @internal */
+Webhook.__pulumiType = 'vercel:index/webhook:Webhook';
+//# sourceMappingURL=webhook.js.map

package/webhook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../webhook.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoB,EAAE,IAAmC;QAClH,OAAO,IAAI,OAAO,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAwC,EAAE,IAAmC;QACnG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuC,CAAC;YACtD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAsC,CAAC;YACpD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AArFL,0BAsFC;AAxEG,gBAAgB;AACO,oBAAY,GAAG,8BAA8B,CAAC"}