@pulumiverse/vercel 1.15.0 → 2.9.0-alpha.1747136220

package/getProject.js

@@ -5,6 +5,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectOutput = exports.getProject = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides information about an existing project within Vercel.
+ *
+ * A Project groups deployments and custom domains. To deploy on Vercel, you need a Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/overview).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * ```
+ */
 function getProject(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getProject:getProject", {
@@ -13,6 +31,24 @@ function getProject(args, opts) {
     }, opts);
 }
 exports.getProject = getProject;
+/**
+ * Provides information about an existing project within Vercel.
+ *
+ * A Project groups deployments and custom domains. To deploy on Vercel, you need a Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/overview).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * ```
+ */
 function getProjectOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getProject:getProject", {

package/getProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProject.js","sourceRoot":"","sources":["../getProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IACxE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AAgDD,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,oCAAoC,EAAE;QACrE,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4CAMC"}
+{"version":3,"file":"getProject.js","sourceRoot":"","sources":["../getProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IACxE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AAyJD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,oCAAoC,EAAE;QACrE,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4CAMC"}

package/getProjectDeploymentRetention.d.ts

@@ -1,29 +1,76 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides a Project Deployment Retention datasource.
+ *
+ * A Project Deployment Retention datasource details information about Deployment Retention on a Vercel Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/security/deployment-retention).
+ */
 export declare function getProjectDeploymentRetention(args: GetProjectDeploymentRetentionArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectDeploymentRetentionResult>;
 /**
  * A collection of arguments for invoking getProjectDeploymentRetention.
  */
 export interface GetProjectDeploymentRetentionArgs {
+    /**
+     * The ID of the Project for the retention policy
+     */
     projectId: string;
+    /**
+     * The ID of the Vercel team.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getProjectDeploymentRetention.
  */
 export interface GetProjectDeploymentRetentionResult {
+    /**
+     * The retention period for canceled deployments.
+     */
     readonly expirationCanceled: string;
+    /**
+     * The retention period for errored deployments.
+     */
     readonly expirationErrored: string;
+    /**
+     * The retention period for preview deployments.
+     */
     readonly expirationPreview: string;
+    /**
+     * The retention period for production deployments.
+     */
     readonly expirationProduction: string;
+    /**
+     * The ID of this resource.
+     */
     readonly id: string;
+    /**
+     * The ID of the Project for the retention policy
+     */
     readonly projectId: string;
+    /**
+     * The ID of the Vercel team.
+     */
     readonly teamId: string;
 }
+/**
+ * Provides a Project Deployment Retention datasource.
+ *
+ * A Project Deployment Retention datasource details information about Deployment Retention on a Vercel Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/security/deployment-retention).
+ */
 export declare function getProjectDeploymentRetentionOutput(args: GetProjectDeploymentRetentionOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetProjectDeploymentRetentionResult>;
 /**
  * A collection of arguments for invoking getProjectDeploymentRetention.
  */
 export interface GetProjectDeploymentRetentionOutputArgs {
+    /**
+     * The ID of the Project for the retention policy
+     */
     projectId: pulumi.Input<string>;
+    /**
+     * The ID of the Vercel team.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getProjectDeploymentRetention.js

@@ -5,6 +5,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectDeploymentRetentionOutput = exports.getProjectDeploymentRetention = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides a Project Deployment Retention datasource.
+ *
+ * A Project Deployment Retention datasource details information about Deployment Retention on a Vercel Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/security/deployment-retention).
+ */
 function getProjectDeploymentRetention(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getProjectDeploymentRetention:getProjectDeploymentRetention", {
@@ -13,6 +20,13 @@ function getProjectDeploymentRetention(args, opts) {
     }, opts);
 }
 exports.getProjectDeploymentRetention = getProjectDeploymentRetention;
+/**
+ * Provides a Project Deployment Retention datasource.
+ *
+ * A Project Deployment Retention datasource details information about Deployment Retention on a Vercel Project.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/security/deployment-retention).
+ */
 function getProjectDeploymentRetentionOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getProjectDeploymentRetention:getProjectDeploymentRetention", {

package/getProjectDeploymentRetention.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProjectDeploymentRetention.js","sourceRoot":"","sources":["../getProjectDeploymentRetention.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,6BAA6B,CAAC,IAAuC,EAAE,IAA2B;IAC9G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0EAA0E,EAAE;QACrG,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,sEAMC;AAsBD,SAAgB,mCAAmC,CAAC,IAA6C,EAAE,IAA2B;IAC1H,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,0EAA0E,EAAE;QAC3G,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,kFAMC"}
+{"version":3,"file":"getProjectDeploymentRetention.js","sourceRoot":"","sources":["../getProjectDeploymentRetention.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAAC,IAAuC,EAAE,IAA2B;IAC9G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0EAA0E,EAAE;QACrG,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,sEAMC;AAiDD;;;;;;GAMG;AACH,SAAgB,mCAAmC,CAAC,IAA6C,EAAE,IAA2B;IAC1H,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,0EAA0E,EAAE;QAC3G,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,kFAMC"}

package/getProjectDirectory.d.ts

@@ -10,9 +10,15 @@ export interface GetProjectDirectoryArgs {
  * A collection of values returned by getProjectDirectory.
  */
 export interface GetProjectDirectoryResult {
+    /**
+     * A map of filename to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.
+     */
     readonly files: {
         [key: string]: string;
     };
+    /**
+     * The ID of this resource.
+     */
     readonly id: string;
     readonly path: string;
 }

package/getProjectDirectory.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProjectDirectory.js","sourceRoot":"","sources":["../getProjectDirectory.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sDAAsD,EAAE;QACjF,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kDAKC;AAiBD,SAAgB,yBAAyB,CAAC,IAAmC,EAAE,IAA2B;IACtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sDAAsD,EAAE;QACvF,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8DAKC"}
+{"version":3,"file":"getProjectDirectory.js","sourceRoot":"","sources":["../getProjectDirectory.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sDAAsD,EAAE;QACjF,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kDAKC;AAuBD,SAAgB,yBAAyB,CAAC,IAAmC,EAAE,IAA2B;IACtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sDAAsD,EAAE;QACvF,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,8DAKC"}

package/getProjectMembers.d.ts

@@ -1,11 +1,34 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
+/**
+ * Retrieves members and their roles for a Vercel Project.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const exampleProject = vercel.getProject({
+ *     name: "example-with-members",
+ * });
+ * const exampleProjectMembers = exampleProject.then(exampleProject => vercel.getProjectMembers({
+ *     projectId: exampleProject.id,
+ * }));
+ * ```
+ */
 export declare function getProjectMembers(args: GetProjectMembersArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectMembersResult>;
 /**
  * A collection of arguments for invoking getProjectMembers.
  */
 export interface GetProjectMembersArgs {
+    /**
+     * The ID of the Vercel Project.
+     */
     projectId: string;
+    /**
+     * The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
@@ -16,15 +39,47 @@ export interface GetProjectMembersResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * The set of members in this project.
+     */
     readonly members: outputs.GetProjectMembersMember[];
+    /**
+     * The ID of the Vercel Project.
+     */
     readonly projectId: string;
+    /**
+     * The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
+     */
     readonly teamId?: string;
 }
+/**
+ * Retrieves members and their roles for a Vercel Project.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const exampleProject = vercel.getProject({
+ *     name: "example-with-members",
+ * });
+ * const exampleProjectMembers = exampleProject.then(exampleProject => vercel.getProjectMembers({
+ *     projectId: exampleProject.id,
+ * }));
+ * ```
+ */
 export declare function getProjectMembersOutput(args: GetProjectMembersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetProjectMembersResult>;
 /**
  * A collection of arguments for invoking getProjectMembers.
  */
 export interface GetProjectMembersOutputArgs {
+    /**
+     * The ID of the Vercel Project.
+     */
     projectId: pulumi.Input<string>;
+    /**
+     * The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getProjectMembers.js

@@ -5,6 +5,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectMembersOutput = exports.getProjectMembers = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Retrieves members and their roles for a Vercel Project.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const exampleProject = vercel.getProject({
+ *     name: "example-with-members",
+ * });
+ * const exampleProjectMembers = exampleProject.then(exampleProject => vercel.getProjectMembers({
+ *     projectId: exampleProject.id,
+ * }));
+ * ```
+ */
 function getProjectMembers(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getProjectMembers:getProjectMembers", {
@@ -13,6 +30,23 @@ function getProjectMembers(args, opts) {
     }, opts);
 }
 exports.getProjectMembers = getProjectMembers;
+/**
+ * Retrieves members and their roles for a Vercel Project.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const exampleProject = vercel.getProject({
+ *     name: "example-with-members",
+ * });
+ * const exampleProjectMembers = exampleProject.then(exampleProject => vercel.getProjectMembers({
+ *     projectId: exampleProject.id,
+ * }));
+ * ```
+ */
 function getProjectMembersOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getProjectMembers:getProjectMembers", {

package/getProjectMembers.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProjectMembers.js","sourceRoot":"","sources":["../getProjectMembers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAA2B;IACtF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE;QAC7E,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,8CAMC;AAsBD,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAClG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kDAAkD,EAAE;QACnF,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0DAMC"}
+{"version":3,"file":"getProjectMembers.js","sourceRoot":"","sources":["../getProjectMembers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAA2B;IACtF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kDAAkD,EAAE;QAC7E,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,8CAMC;AAqCD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,uBAAuB,CAAC,IAAiC,EAAE,IAA2B;IAClG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kDAAkD,EAAE;QACnF,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,0DAMC"}

package/getSharedEnvironmentVariable.d.ts

@@ -1,34 +1,132 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides information about an existing Shared Environment Variable within Vercel.
+ *
+ * A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getSharedEnvironmentVariable({
+ *     id: "xxxxxxxxxxxxxxx",
+ * });
+ * const exampleByKeyAndTarget = vercel.getSharedEnvironmentVariable({
+ *     key: "MY_ENV_VAR",
+ *     targets: [
+ *         "production",
+ *         "preview",
+ *     ],
+ * });
+ * ```
+ */
 export declare function getSharedEnvironmentVariable(args?: GetSharedEnvironmentVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetSharedEnvironmentVariableResult>;
 /**
  * A collection of arguments for invoking getSharedEnvironmentVariable.
  */
 export interface GetSharedEnvironmentVariableArgs {
+    /**
+     * The ID of the Environment Variable.
+     */
     id?: string;
+    /**
+     * The name of the Environment Variable.
+     */
     key?: string;
+    /**
+     * The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
+     */
     targets?: string[];
+    /**
+     * The ID of the Vercel team. Shared environment variables require a team.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getSharedEnvironmentVariable.
  */
 export interface GetSharedEnvironmentVariableResult {
+    /**
+     * A comment explaining what the environment variable is for.
+     */
     readonly comment: string;
+    /**
+     * The ID of the Environment Variable.
+     */
     readonly id: string;
+    /**
+     * The name of the Environment Variable.
+     */
     readonly key: string;
+    /**
+     * The ID of the Vercel project.
+     */
     readonly projectIds: string[];
+    /**
+     * Whether the Environment Variable is sensitive or not.
+     */
     readonly sensitive: boolean;
+    /**
+     * The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
+     */
     readonly targets: string[];
+    /**
+     * The ID of the Vercel team. Shared environment variables require a team.
+     */
     readonly teamId: string;
+    /**
+     * The value of the Environment Variable.
+     */
     readonly value: string;
 }
+/**
+ * Provides information about an existing Shared Environment Variable within Vercel.
+ *
+ * A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getSharedEnvironmentVariable({
+ *     id: "xxxxxxxxxxxxxxx",
+ * });
+ * const exampleByKeyAndTarget = vercel.getSharedEnvironmentVariable({
+ *     key: "MY_ENV_VAR",
+ *     targets: [
+ *         "production",
+ *         "preview",
+ *     ],
+ * });
+ * ```
+ */
 export declare function getSharedEnvironmentVariableOutput(args?: GetSharedEnvironmentVariableOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetSharedEnvironmentVariableResult>;
 /**
  * A collection of arguments for invoking getSharedEnvironmentVariable.
  */
 export interface GetSharedEnvironmentVariableOutputArgs {
+    /**
+     * The ID of the Environment Variable.
+     */
     id?: pulumi.Input<string>;
+    /**
+     * The name of the Environment Variable.
+     */
     key?: pulumi.Input<string>;
+    /**
+     * The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
+     */
     targets?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The ID of the Vercel team. Shared environment variables require a team.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getSharedEnvironmentVariable.js

@@ -5,6 +5,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSharedEnvironmentVariableOutput = exports.getSharedEnvironmentVariable = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides information about an existing Shared Environment Variable within Vercel.
+ *
+ * A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getSharedEnvironmentVariable({
+ *     id: "xxxxxxxxxxxxxxx",
+ * });
+ * const exampleByKeyAndTarget = vercel.getSharedEnvironmentVariable({
+ *     key: "MY_ENV_VAR",
+ *     targets: [
+ *         "production",
+ *         "preview",
+ *     ],
+ * });
+ * ```
+ */
 function getSharedEnvironmentVariable(args, opts) {
     args = args || {};
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -16,6 +41,31 @@ function getSharedEnvironmentVariable(args, opts) {
     }, opts);
 }
 exports.getSharedEnvironmentVariable = getSharedEnvironmentVariable;
+/**
+ * Provides information about an existing Shared Environment Variable within Vercel.
+ *
+ * A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getSharedEnvironmentVariable({
+ *     id: "xxxxxxxxxxxxxxx",
+ * });
+ * const exampleByKeyAndTarget = vercel.getSharedEnvironmentVariable({
+ *     key: "MY_ENV_VAR",
+ *     targets: [
+ *         "production",
+ *         "preview",
+ *     ],
+ * });
+ * ```
+ */
 function getSharedEnvironmentVariableOutput(args, opts) {
     args = args || {};
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});

package/getSharedEnvironmentVariable.js.map

@@ -1 +1 @@
-{"version":3,"file":"getSharedEnvironmentVariable.js","sourceRoot":"","sources":["../getSharedEnvironmentVariable.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,4BAA4B,CAAC,IAAuC,EAAE,IAA2B;IAC7G,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wEAAwE,EAAE;QACnG,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,oEASC;AAyBD,SAAgB,kCAAkC,CAAC,IAA6C,EAAE,IAA2B;IACzH,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wEAAwE,EAAE;QACzG,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,gFASC"}
+{"version":3,"file":"getSharedEnvironmentVariable.js","sourceRoot":"","sources":["../getSharedEnvironmentVariable.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,4BAA4B,CAAC,IAAuC,EAAE,IAA2B;IAC7G,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wEAAwE,EAAE;QACnG,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,oEASC;AA6DD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,kCAAkC,CAAC,IAA6C,EAAE,IAA2B;IACzH,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wEAAwE,EAAE;QACzG,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,gFASC"}

package/getTeamConfig.d.ts

@@ -1,35 +1,111 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
+/**
+ * Retrieves the configuration of an existing Vercel Team.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getTeamConfig({
+ *     id: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
+ * });
+ * ```
+ */
 export declare function getTeamConfig(args: GetTeamConfigArgs, opts?: pulumi.InvokeOptions): Promise<GetTeamConfigResult>;
 /**
  * A collection of arguments for invoking getTeamConfig.
  */
 export interface GetTeamConfigArgs {
+    /**
+     * The ID of the existing Vercel Team.
+     */
     id: string;
 }
 /**
  * A collection of values returned by getTeamConfig.
  */
 export interface GetTeamConfigResult {
+    /**
+     * A description of the team.
+     */
     readonly description: string;
+    /**
+     * Hostname that'll be matched with emails on sign-up to automatically join the Team.
+     */
     readonly emailDomain: string;
+    /**
+     * Preview feedback configuration.
+     */
     readonly enablePreviewFeedback: string;
+    /**
+     * Production feedback configuration.
+     */
     readonly enableProductionFeedback: string;
+    /**
+     * Indicates if ip addresses should be accessible in o11y tooling.
+     */
     readonly hideIpAddresses: boolean;
+    /**
+     * Indicates if ip addresses should be accessible in log drains.
+     */
     readonly hideIpAddressesInLogDrains: boolean;
+    /**
+     * The ID of the existing Vercel Team.
+     */
     readonly id: string;
+    /**
+     * A code that can be used to join this team. Only visible to Team owners.
+     */
     readonly inviteCode: string;
+    /**
+     * The name of the team.
+     */
     readonly name: string;
+    /**
+     * The hostname that is used as the preview deployment suffix.
+     */
     readonly previewDeploymentSuffix: string;
+    /**
+     * Configuration for Remote Caching.
+     */
     readonly remoteCaching: outputs.GetTeamConfigRemoteCaching;
+    /**
+     * Configuration for SAML authentication.
+     */
     readonly saml: outputs.GetTeamConfigSaml;
+    /**
+     * The policy for sensitive environment variables.
+     */
     readonly sensitiveEnvironmentVariablePolicy: string;
+    /**
+     * The slug of the team. Used in the URL of the team's dashboard.
+     */
     readonly slug: string;
 }
+/**
+ * Retrieves the configuration of an existing Vercel Team.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getTeamConfig({
+ *     id: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
+ * });
+ * ```
+ */
 export declare function getTeamConfigOutput(args: GetTeamConfigOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetTeamConfigResult>;
 /**
  * A collection of arguments for invoking getTeamConfig.
  */
 export interface GetTeamConfigOutputArgs {
+    /**
+     * The ID of the existing Vercel Team.
+     */
     id: pulumi.Input<string>;
 }