@vercel/sdk 1.16.0 → 1.16.1

package/esm/models/getdeploymentop.d.ts

@@ -21,9 +21,21 @@ export type GetDeploymentRequest = {
      */
     slug?: string | undefined;
 };
+/**
+ * Information about the deployment creator
+ */
 export type GetDeploymentResponseBodyCreator = {
+    /**
+     * The ID of the user that created the deployment
+     */
     uid: string;
+    /**
+     * The username of the user that created the deployment
+     */
     username?: string | undefined;
+    /**
+     * The avatar of the user that created the deployment
+     */
     avatar?: string | undefined;
 };
 export declare const GetDeploymentResponseBodyDeploymentsReadyState: {
@@ -57,12 +69,18 @@ export declare const GetDeploymentResponseBodyStatus: {
     readonly Canceled: "CANCELED";
 };
 export type GetDeploymentResponseBodyStatus = ClosedEnum<typeof GetDeploymentResponseBodyStatus>;
+/**
+ * The team that owns the deployment if any
+ */
 export type ResponseBodyTeam = {
     id: string;
     name: string;
     slug: string;
     avatar?: string | undefined;
 };
+/**
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
+ */
 export type GetDeploymentCustomEnvironment2 = {
     id: string;
 };
@@ -135,7 +153,7 @@ export type GetDeploymentCustomEnvironmentDomains = {
     verification?: Array<GetDeploymentCustomEnvironmentVerification> | undefined;
 };
 /**
- * Internal representation of a custom environment with all required properties
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
  */
 export type GetDeploymentCustomEnvironment1 = {
     /**
@@ -186,6 +204,9 @@ export type ResponseBodyAliasWarning = {
     link?: string | undefined;
     action?: string | undefined;
 };
+/**
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+ */
 export declare const GetDeploymentResponseBodyReadyState: {
     readonly Queued: "QUEUED";
     readonly Building: "BUILDING";
@@ -194,11 +215,17 @@ export declare const GetDeploymentResponseBodyReadyState: {
     readonly Ready: "READY";
     readonly Canceled: "CANCELED";
 };
+/**
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+ */
 export type GetDeploymentResponseBodyReadyState = ClosedEnum<typeof GetDeploymentResponseBodyReadyState>;
 export declare const GetDeploymentResponseBodyDeploymentsType: {
     readonly Lambdas: "LAMBDAS";
 };
 export type GetDeploymentResponseBodyDeploymentsType = ClosedEnum<typeof GetDeploymentResponseBodyDeploymentsType>;
+/**
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
+ */
 export type GetDeploymentResponseBodyAliasError = {
     code: string;
     message: string;
@@ -417,6 +444,9 @@ export declare const GetDeploymentResponseBodyNodeVersion: {
  * If set it overrides the `projectSettings.nodeVersion` for this deployment.
  */
 export type GetDeploymentResponseBodyNodeVersion = ClosedEnum<typeof GetDeploymentResponseBodyNodeVersion>;
+/**
+ * The public project information associated with the deployment.
+ */
 export type GetDeploymentResponseBodyProject = {
     id: string;
     name: string;
@@ -434,6 +464,9 @@ export declare const GetDeploymentResponseBodyReadySubstate: {
  * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
  */
 export type GetDeploymentResponseBodyReadySubstate = ClosedEnum<typeof GetDeploymentResponseBodyReadySubstate>;
+/**
+ * Where was the deployment created from
+ */
 export declare const GetDeploymentResponseBodySource: {
     readonly ApiTriggerGitDeploy: "api-trigger-git-deploy";
     readonly Cli: "cli";
@@ -444,11 +477,20 @@ export declare const GetDeploymentResponseBodySource: {
     readonly Redeploy: "redeploy";
     readonly V0Web: "v0-web";
 };
+/**
+ * Where was the deployment created from
+ */
 export type GetDeploymentResponseBodySource = ClosedEnum<typeof GetDeploymentResponseBodySource>;
+/**
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+ */
 export declare const GetDeploymentResponseBodyTarget: {
     readonly Staging: "staging";
     readonly Production: "production";
 };
+/**
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+ */
 export type GetDeploymentResponseBodyTarget = ClosedEnum<typeof GetDeploymentResponseBodyTarget>;
 export type GetDeploymentResponseBodyOidcTokenClaims = {
     iss: string;
@@ -465,7 +507,13 @@ export type GetDeploymentResponseBodyOidcTokenClaims = {
  * The deployment including only public information
  */
 export type GetDeploymentResponseBody2 = {
+    /**
+     * A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation
+     */
     alias?: Array<string> | undefined;
+    /**
+     * A boolean that will be true when the aliases from the alias property were assigned successfully
+     */
     aliasAssigned: boolean;
     bootedAt: number;
     buildingAt: number;
@@ -474,25 +522,55 @@ export type GetDeploymentResponseBody2 = {
      */
     buildContainerFinishedAt?: number | undefined;
     buildSkipped: boolean;
+    /**
+     * Information about the deployment creator
+     */
     creator: GetDeploymentResponseBodyCreator;
     initReadyAt?: number | undefined;
     isFirstBranchDeployment?: boolean | undefined;
     lambdas?: Array<ResponseBodyLambdas> | undefined;
+    /**
+     * A boolean representing if the deployment is public or not. By default this is `false`
+     */
     public: boolean;
     ready?: number | undefined;
     status: GetDeploymentResponseBodyStatus;
+    /**
+     * The team that owns the deployment if any
+     */
     team?: ResponseBodyTeam | undefined;
+    /**
+     * An array of domains that were provided by the user when creating the Deployment.
+     */
     userAliases?: Array<string> | undefined;
+    /**
+     * Whether or not preview comments are enabled for the deployment
+     */
     previewCommentsEnabled?: boolean | undefined;
     ttyBuildLogs?: boolean | undefined;
     customEnvironment?: GetDeploymentCustomEnvironment1 | GetDeploymentCustomEnvironment2 | undefined;
     oomReport?: ResponseBodyOomReport | undefined;
     aliasWarning?: ResponseBodyAliasWarning | null | undefined;
+    /**
+     * A string holding the unique ID of the deployment
+     */
     id: string;
+    /**
+     * A number containing the date when the deployment was created in milliseconds
+     */
     createdAt: number;
+    /**
+     * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+     */
     readyState: GetDeploymentResponseBodyReadyState;
+    /**
+     * The name of the project associated with the deployment at the time that the deployment was created
+     */
     name: string;
     type: GetDeploymentResponseBodyDeploymentsType;
+    /**
+     * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
+     */
     aliasError?: GetDeploymentResponseBodyAliasError | null | undefined;
     aliasFinal?: string | null | undefined;
     /**
@@ -503,6 +581,9 @@ export type GetDeploymentResponseBody2 = {
     buildErrorAt?: number | undefined;
     checksState?: GetDeploymentResponseBodyChecksState | undefined;
     checksConclusion?: GetDeploymentResponseBodyChecksConclusion | undefined;
+    /**
+     * A number containing the date when the deployment was deleted at milliseconds
+     */
     deletedAt?: number | null | undefined;
     /**
      * Computed field that is only available for deployments with a microfrontend configuration.
@@ -526,17 +607,41 @@ export type GetDeploymentResponseBody2 = {
      * If set it overrides the `projectSettings.nodeVersion` for this deployment.
      */
     nodeVersion?: GetDeploymentResponseBodyNodeVersion | undefined;
+    /**
+     * The public project information associated with the deployment.
+     */
     project?: GetDeploymentResponseBodyProject | undefined;
     /**
      * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
      */
     readySubstate?: GetDeploymentResponseBodyReadySubstate | undefined;
+    /**
+     * The regions the deployment exists in
+     */
     regions: Array<string>;
+    /**
+     * flag to indicate if the deployment was deleted by retention policy
+     */
     softDeletedByRetention?: boolean | undefined;
+    /**
+     * Where was the deployment created from
+     */
     source?: GetDeploymentResponseBodySource | undefined;
+    /**
+     * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+     */
     target?: GetDeploymentResponseBodyTarget | null | undefined;
+    /**
+     * A number containing the date when the deployment was undeleted at milliseconds
+     */
     undeletedAt?: number | undefined;
+    /**
+     * A string with the unique URL of the deployment
+     */
     url: string;
+    /**
+     * The platform version that was used to create the deployment.
+     */
     version: number;
     oidcTokenClaims?: GetDeploymentResponseBodyOidcTokenClaims | undefined;
 };
@@ -714,9 +819,21 @@ export type ResponseBodyImages = {
     contentSecurityPolicy?: string | undefined;
     contentDispositionType?: ResponseBodyContentDispositionType | undefined;
 };
+/**
+ * Information about the deployment creator
+ */
 export type ResponseBodyCreator = {
+    /**
+     * The ID of the user that created the deployment
+     */
     uid: string;
+    /**
+     * The username of the user that created the deployment
+     */
     username?: string | undefined;
+    /**
+     * The avatar of the user that created the deployment
+     */
     avatar?: string | undefined;
 };
 export declare const GetDeploymentResponseBodyDeploymentsResponseReadyState: {
@@ -750,12 +867,18 @@ export declare const ResponseBodyStatus: {
     readonly Canceled: "CANCELED";
 };
 export type ResponseBodyStatus = ClosedEnum<typeof ResponseBodyStatus>;
+/**
+ * The team that owns the deployment if any
+ */
 export type GetDeploymentResponseBodyTeam = {
     id: string;
     name: string;
     slug: string;
     avatar?: string | undefined;
 };
+/**
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
+ */
 export type GetDeploymentCustomEnvironmentDeployments2 = {
     id: string;
 };
@@ -828,7 +951,7 @@ export type GetDeploymentCustomEnvironmentDeploymentsDomains = {
     verification?: Array<GetDeploymentCustomEnvironmentDeploymentsVerification> | undefined;
 };
 /**
- * Internal representation of a custom environment with all required properties
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
  */
 export type GetDeploymentCustomEnvironmentDeployments1 = {
     /**
@@ -879,6 +1002,9 @@ export type GetDeploymentResponseBodyAliasWarning = {
     link?: string | undefined;
     action?: string | undefined;
 };
+/**
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+ */
 export declare const ResponseBodyReadyState: {
     readonly Queued: "QUEUED";
     readonly Building: "BUILDING";
@@ -887,11 +1013,17 @@ export declare const ResponseBodyReadyState: {
     readonly Ready: "READY";
     readonly Canceled: "CANCELED";
 };
+/**
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+ */
 export type ResponseBodyReadyState = ClosedEnum<typeof ResponseBodyReadyState>;
 export declare const GetDeploymentResponseBodyType: {
     readonly Lambdas: "LAMBDAS";
 };
 export type GetDeploymentResponseBodyType = ClosedEnum<typeof GetDeploymentResponseBodyType>;
+/**
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
+ */
 export type ResponseBodyAliasError = {
     code: string;
     message: string;
@@ -1110,6 +1242,9 @@ export declare const ResponseBodyNodeVersion: {
  * If set it overrides the `projectSettings.nodeVersion` for this deployment.
  */
 export type ResponseBodyNodeVersion = ClosedEnum<typeof ResponseBodyNodeVersion>;
+/**
+ * The public project information associated with the deployment.
+ */
 export type ResponseBodyProject = {
     id: string;
     name: string;
@@ -1127,6 +1262,9 @@ export declare const ResponseBodyReadySubstate: {
  * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
  */
 export type ResponseBodyReadySubstate = ClosedEnum<typeof ResponseBodyReadySubstate>;
+/**
+ * Where was the deployment created from
+ */
 export declare const ResponseBodySource: {
     readonly ApiTriggerGitDeploy: "api-trigger-git-deploy";
     readonly Cli: "cli";
@@ -1137,11 +1275,20 @@ export declare const ResponseBodySource: {
     readonly Redeploy: "redeploy";
     readonly V0Web: "v0-web";
 };
+/**
+ * Where was the deployment created from
+ */
 export type ResponseBodySource = ClosedEnum<typeof ResponseBodySource>;
+/**
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+ */
 export declare const ResponseBodyTarget: {
     readonly Staging: "staging";
     readonly Production: "production";
 };
+/**
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+ */
 export type ResponseBodyTarget = ClosedEnum<typeof ResponseBodyTarget>;
 export type ResponseBodyOidcTokenClaims = {
     iss: string;
@@ -1641,7 +1788,13 @@ export type GetDeploymentResponseBody1 = {
     readyStateReason?: string | undefined;
     integrations?: ResponseBodyIntegrations | undefined;
     images?: ResponseBodyImages | undefined;
+    /**
+     * A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation
+     */
     alias?: Array<string> | undefined;
+    /**
+     * A boolean that will be true when the aliases from the alias property were assigned successfully
+     */
     aliasAssigned: boolean;
     bootedAt: number;
     buildingAt: number;
@@ -1650,25 +1803,55 @@ export type GetDeploymentResponseBody1 = {
      */
     buildContainerFinishedAt?: number | undefined;
     buildSkipped: boolean;
+    /**
+     * Information about the deployment creator
+     */
     creator: ResponseBodyCreator;
     initReadyAt?: number | undefined;
     isFirstBranchDeployment?: boolean | undefined;
     lambdas?: Array<GetDeploymentResponseBodyLambdas> | undefined;
+    /**
+     * A boolean representing if the deployment is public or not. By default this is `false`
+     */
     public: boolean;
     ready?: number | undefined;
     status: ResponseBodyStatus;
+    /**
+     * The team that owns the deployment if any
+     */
     team?: GetDeploymentResponseBodyTeam | undefined;
+    /**
+     * An array of domains that were provided by the user when creating the Deployment.
+     */
     userAliases?: Array<string> | undefined;
+    /**
+     * Whether or not preview comments are enabled for the deployment
+     */
     previewCommentsEnabled?: boolean | undefined;
     ttyBuildLogs?: boolean | undefined;
     customEnvironment?: GetDeploymentCustomEnvironmentDeployments1 | GetDeploymentCustomEnvironmentDeployments2 | undefined;
     oomReport?: GetDeploymentResponseBodyOomReport | undefined;
     aliasWarning?: GetDeploymentResponseBodyAliasWarning | null | undefined;
+    /**
+     * A string holding the unique ID of the deployment
+     */
     id: string;
+    /**
+     * A number containing the date when the deployment was created in milliseconds
+     */
     createdAt: number;
+    /**
+     * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
+     */
     readyState: ResponseBodyReadyState;
+    /**
+     * The name of the project associated with the deployment at the time that the deployment was created
+     */
     name: string;
     type: GetDeploymentResponseBodyType;
+    /**
+     * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
+     */
     aliasError?: ResponseBodyAliasError | null | undefined;
     aliasFinal?: string | null | undefined;
     /**
@@ -1679,6 +1862,9 @@ export type GetDeploymentResponseBody1 = {
     buildErrorAt?: number | undefined;
     checksState?: ResponseBodyChecksState | undefined;
     checksConclusion?: ResponseBodyChecksConclusion | undefined;
+    /**
+     * A number containing the date when the deployment was deleted at milliseconds
+     */
     deletedAt?: number | null | undefined;
     /**
      * Computed field that is only available for deployments with a microfrontend configuration.
@@ -1702,17 +1888,41 @@ export type GetDeploymentResponseBody1 = {
      * If set it overrides the `projectSettings.nodeVersion` for this deployment.
      */
     nodeVersion?: ResponseBodyNodeVersion | undefined;
+    /**
+     * The public project information associated with the deployment.
+     */
     project?: ResponseBodyProject | undefined;
     /**
      * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
      */
     readySubstate?: ResponseBodyReadySubstate | undefined;
+    /**
+     * The regions the deployment exists in
+     */
     regions: Array<string>;
+    /**
+     * flag to indicate if the deployment was deleted by retention policy
+     */
     softDeletedByRetention?: boolean | undefined;
+    /**
+     * Where was the deployment created from
+     */
     source?: ResponseBodySource | undefined;
+    /**
+     * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
+     */
     target?: ResponseBodyTarget | null | undefined;
+    /**
+     * A number containing the date when the deployment was undeleted at milliseconds
+     */
     undeletedAt?: number | undefined;
+    /**
+     * A string with the unique URL of the deployment
+     */
     url: string;
+    /**
+     * The platform version that was used to create the deployment.
+     */
     version: number;
     oidcTokenClaims?: ResponseBodyOidcTokenClaims | undefined;
     projectId: string;