@vercel/sdk 1.10.3 → 1.10.4

package/src/models/listdeploymentaliasesop.ts

@@ -34,7 +34,7 @@ export type ListDeploymentAliasesProtectionBypassAliasesResponse200Scope =
 /**
  * The protection bypass for the alias
  */
-export type ProtectionBypass4 = {
+export type ListDeploymentAliasesProtectionBypass4 = {
   createdAt: number;
   lastUpdatedAt: number;
   lastUpdatedBy: string;
@@ -50,7 +50,7 @@ export type ListDeploymentAliasesProtectionBypassAliasesResponseScope =
 /**
  * The protection bypass for the alias
  */
-export type ProtectionBypass3 = {
+export type ListDeploymentAliasesProtectionBypass3 = {
   createdAt: number;
   createdBy: string;
   scope: ListDeploymentAliasesProtectionBypassAliasesResponseScope;
@@ -100,9 +100,9 @@ export type ListDeploymentAliasesProtectionBypass1 = {
 
 export type ListDeploymentAliasesProtectionBypass =
   | ListDeploymentAliasesProtectionBypass2
-  | ProtectionBypass4
+  | ListDeploymentAliasesProtectionBypass4
   | ListDeploymentAliasesProtectionBypass1
-  | ProtectionBypass3;
+  | ListDeploymentAliasesProtectionBypass3;
 
 /**
  * A list of the aliases assigned to the deployment
@@ -130,9 +130,9 @@ export type Aliases = {
   protectionBypass?: {
     [k: string]:
       | ListDeploymentAliasesProtectionBypass2
-      | ProtectionBypass4
+      | ListDeploymentAliasesProtectionBypass4
       | ListDeploymentAliasesProtectionBypass1
-      | ProtectionBypass3;
+      | ListDeploymentAliasesProtectionBypass3;
   } | undefined;
 };
 
@@ -237,8 +237,8 @@ export namespace ListDeploymentAliasesProtectionBypassAliasesResponse200Scope$ {
 }
 
 /** @internal */
-export const ProtectionBypass4$inboundSchema: z.ZodType<
-  ProtectionBypass4,
+export const ListDeploymentAliasesProtectionBypass4$inboundSchema: z.ZodType<
+  ListDeploymentAliasesProtectionBypass4,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -250,7 +250,7 @@ export const ProtectionBypass4$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type ProtectionBypass4$Outbound = {
+export type ListDeploymentAliasesProtectionBypass4$Outbound = {
   createdAt: number;
   lastUpdatedAt: number;
   lastUpdatedBy: string;
@@ -258,10 +258,10 @@ export type ProtectionBypass4$Outbound = {
 };
 
 /** @internal */
-export const ProtectionBypass4$outboundSchema: z.ZodType<
-  ProtectionBypass4$Outbound,
+export const ListDeploymentAliasesProtectionBypass4$outboundSchema: z.ZodType<
+  ListDeploymentAliasesProtectionBypass4$Outbound,
   z.ZodTypeDef,
-  ProtectionBypass4
+  ListDeploymentAliasesProtectionBypass4
 > = z.object({
   createdAt: z.number(),
   lastUpdatedAt: z.number(),
@@ -274,30 +274,36 @@ export const ProtectionBypass4$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ProtectionBypass4$ {
-  /** @deprecated use `ProtectionBypass4$inboundSchema` instead. */
-  export const inboundSchema = ProtectionBypass4$inboundSchema;
-  /** @deprecated use `ProtectionBypass4$outboundSchema` instead. */
-  export const outboundSchema = ProtectionBypass4$outboundSchema;
-  /** @deprecated use `ProtectionBypass4$Outbound` instead. */
-  export type Outbound = ProtectionBypass4$Outbound;
+export namespace ListDeploymentAliasesProtectionBypass4$ {
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass4$inboundSchema` instead. */
+  export const inboundSchema =
+    ListDeploymentAliasesProtectionBypass4$inboundSchema;
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass4$outboundSchema` instead. */
+  export const outboundSchema =
+    ListDeploymentAliasesProtectionBypass4$outboundSchema;
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass4$Outbound` instead. */
+  export type Outbound = ListDeploymentAliasesProtectionBypass4$Outbound;
 }
 
-export function protectionBypass4ToJSON(
-  protectionBypass4: ProtectionBypass4,
+export function listDeploymentAliasesProtectionBypass4ToJSON(
+  listDeploymentAliasesProtectionBypass4:
+    ListDeploymentAliasesProtectionBypass4,
 ): string {
   return JSON.stringify(
-    ProtectionBypass4$outboundSchema.parse(protectionBypass4),
+    ListDeploymentAliasesProtectionBypass4$outboundSchema.parse(
+      listDeploymentAliasesProtectionBypass4,
+    ),
   );
 }
 
-export function protectionBypass4FromJSON(
+export function listDeploymentAliasesProtectionBypass4FromJSON(
   jsonString: string,
-): SafeParseResult<ProtectionBypass4, SDKValidationError> {
+): SafeParseResult<ListDeploymentAliasesProtectionBypass4, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ProtectionBypass4$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ProtectionBypass4' from JSON`,
+    (x) =>
+      ListDeploymentAliasesProtectionBypass4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDeploymentAliasesProtectionBypass4' from JSON`,
   );
 }
 
@@ -327,8 +333,8 @@ export namespace ListDeploymentAliasesProtectionBypassAliasesResponseScope$ {
 }
 
 /** @internal */
-export const ProtectionBypass3$inboundSchema: z.ZodType<
-  ProtectionBypass3,
+export const ListDeploymentAliasesProtectionBypass3$inboundSchema: z.ZodType<
+  ListDeploymentAliasesProtectionBypass3,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -339,17 +345,17 @@ export const ProtectionBypass3$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type ProtectionBypass3$Outbound = {
+export type ListDeploymentAliasesProtectionBypass3$Outbound = {
   createdAt: number;
   createdBy: string;
   scope: string;
 };
 
 /** @internal */
-export const ProtectionBypass3$outboundSchema: z.ZodType<
-  ProtectionBypass3$Outbound,
+export const ListDeploymentAliasesProtectionBypass3$outboundSchema: z.ZodType<
+  ListDeploymentAliasesProtectionBypass3$Outbound,
   z.ZodTypeDef,
-  ProtectionBypass3
+  ListDeploymentAliasesProtectionBypass3
 > = z.object({
   createdAt: z.number(),
   createdBy: z.string(),
@@ -361,30 +367,36 @@ export const ProtectionBypass3$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ProtectionBypass3$ {
-  /** @deprecated use `ProtectionBypass3$inboundSchema` instead. */
-  export const inboundSchema = ProtectionBypass3$inboundSchema;
-  /** @deprecated use `ProtectionBypass3$outboundSchema` instead. */
-  export const outboundSchema = ProtectionBypass3$outboundSchema;
-  /** @deprecated use `ProtectionBypass3$Outbound` instead. */
-  export type Outbound = ProtectionBypass3$Outbound;
+export namespace ListDeploymentAliasesProtectionBypass3$ {
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass3$inboundSchema` instead. */
+  export const inboundSchema =
+    ListDeploymentAliasesProtectionBypass3$inboundSchema;
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass3$outboundSchema` instead. */
+  export const outboundSchema =
+    ListDeploymentAliasesProtectionBypass3$outboundSchema;
+  /** @deprecated use `ListDeploymentAliasesProtectionBypass3$Outbound` instead. */
+  export type Outbound = ListDeploymentAliasesProtectionBypass3$Outbound;
 }
 
-export function protectionBypass3ToJSON(
-  protectionBypass3: ProtectionBypass3,
+export function listDeploymentAliasesProtectionBypass3ToJSON(
+  listDeploymentAliasesProtectionBypass3:
+    ListDeploymentAliasesProtectionBypass3,
 ): string {
   return JSON.stringify(
-    ProtectionBypass3$outboundSchema.parse(protectionBypass3),
+    ListDeploymentAliasesProtectionBypass3$outboundSchema.parse(
+      listDeploymentAliasesProtectionBypass3,
+    ),
   );
 }
 
-export function protectionBypass3FromJSON(
+export function listDeploymentAliasesProtectionBypass3FromJSON(
   jsonString: string,
-): SafeParseResult<ProtectionBypass3, SDKValidationError> {
+): SafeParseResult<ListDeploymentAliasesProtectionBypass3, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ProtectionBypass3$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ProtectionBypass3' from JSON`,
+    (x) =>
+      ListDeploymentAliasesProtectionBypass3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDeploymentAliasesProtectionBypass3' from JSON`,
   );
 }
 
@@ -602,17 +614,17 @@ export const ListDeploymentAliasesProtectionBypass$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   z.lazy(() => ListDeploymentAliasesProtectionBypass2$inboundSchema),
-  z.lazy(() => ProtectionBypass4$inboundSchema),
+  z.lazy(() => ListDeploymentAliasesProtectionBypass4$inboundSchema),
   z.lazy(() => ListDeploymentAliasesProtectionBypass1$inboundSchema),
-  z.lazy(() => ProtectionBypass3$inboundSchema),
+  z.lazy(() => ListDeploymentAliasesProtectionBypass3$inboundSchema),
 ]);
 
 /** @internal */
 export type ListDeploymentAliasesProtectionBypass$Outbound =
   | ListDeploymentAliasesProtectionBypass2$Outbound
-  | ProtectionBypass4$Outbound
+  | ListDeploymentAliasesProtectionBypass4$Outbound
   | ListDeploymentAliasesProtectionBypass1$Outbound
-  | ProtectionBypass3$Outbound;
+  | ListDeploymentAliasesProtectionBypass3$Outbound;
 
 /** @internal */
 export const ListDeploymentAliasesProtectionBypass$outboundSchema: z.ZodType<
@@ -621,9 +633,9 @@ export const ListDeploymentAliasesProtectionBypass$outboundSchema: z.ZodType<
   ListDeploymentAliasesProtectionBypass
 > = z.union([
   z.lazy(() => ListDeploymentAliasesProtectionBypass2$outboundSchema),
-  z.lazy(() => ProtectionBypass4$outboundSchema),
+  z.lazy(() => ListDeploymentAliasesProtectionBypass4$outboundSchema),
   z.lazy(() => ListDeploymentAliasesProtectionBypass1$outboundSchema),
-  z.lazy(() => ProtectionBypass3$outboundSchema),
+  z.lazy(() => ListDeploymentAliasesProtectionBypass3$outboundSchema),
 ]);
 
 /**
@@ -672,9 +684,9 @@ export const Aliases$inboundSchema: z.ZodType<Aliases, z.ZodTypeDef, unknown> =
     protectionBypass: z.record(
       z.union([
         z.lazy(() => ListDeploymentAliasesProtectionBypass2$inboundSchema),
-        z.lazy(() => ProtectionBypass4$inboundSchema),
+        z.lazy(() => ListDeploymentAliasesProtectionBypass4$inboundSchema),
         z.lazy(() => ListDeploymentAliasesProtectionBypass1$inboundSchema),
-        z.lazy(() => ProtectionBypass3$inboundSchema),
+        z.lazy(() => ListDeploymentAliasesProtectionBypass3$inboundSchema),
       ]),
     ).optional(),
   });
@@ -688,9 +700,9 @@ export type Aliases$Outbound = {
   protectionBypass?: {
     [k: string]:
       | ListDeploymentAliasesProtectionBypass2$Outbound
-      | ProtectionBypass4$Outbound
+      | ListDeploymentAliasesProtectionBypass4$Outbound
       | ListDeploymentAliasesProtectionBypass1$Outbound
-      | ProtectionBypass3$Outbound;
+      | ListDeploymentAliasesProtectionBypass3$Outbound;
   } | undefined;
 };
 
@@ -707,9 +719,9 @@ export const Aliases$outboundSchema: z.ZodType<
   protectionBypass: z.record(
     z.union([
       z.lazy(() => ListDeploymentAliasesProtectionBypass2$outboundSchema),
-      z.lazy(() => ProtectionBypass4$outboundSchema),
+      z.lazy(() => ListDeploymentAliasesProtectionBypass4$outboundSchema),
       z.lazy(() => ListDeploymentAliasesProtectionBypass1$outboundSchema),
-      z.lazy(() => ProtectionBypass3$outboundSchema),
+      z.lazy(() => ListDeploymentAliasesProtectionBypass3$outboundSchema),
     ]),
   ).optional(),
 });

package/src/sdk/aliases.ts

@@ -17,7 +17,7 @@ import {
   DeleteAliasRequest,
   DeleteAliasResponseBody,
 } from "../models/deletealiasop.js";
-import { GetAliasRequest } from "../models/getaliasop.js";
+import { GetAliasRequest, GetAliasResponseBody } from "../models/getaliasop.js";
 import {
   ListAliasesRequest,
   ListAliasesResponseBody,
@@ -90,7 +90,7 @@ export class Aliases extends ClientSDK {
   async getAlias(
     request: GetAliasRequest,
     options?: RequestOptions,
-  ): Promise<any> {
+  ): Promise<Array<GetAliasResponseBody>> {
     return unwrapAsync(aliasesGetAlias(
       this,
       request,

package/vercel-spec.json

@@ -67557,7 +67557,356 @@
             "description": "The alias information",
             "content": {
               "application/json": {
-                "schema": {}
+                "schema": {
+                  "items": {
+                    "properties": {
+                      "alias": {
+                        "type": "string",
+                        "description": "The alias name, it could be a `.vercel.app` subdomain or a custom domain",
+                        "example": "my-alias.vercel.app"
+                      },
+                      "created": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date when the alias was created",
+                        "example": "2017-04-26T23:00:34.232Z"
+                      },
+                      "createdAt": {
+                        "type": "number",
+                        "description": "The date when the alias was created in milliseconds since the UNIX epoch",
+                        "example": 1540095775941
+                      },
+                      "creator": {
+                        "properties": {
+                          "uid": {
+                            "type": "string",
+                            "description": "ID of the user who created the alias",
+                            "example": "96SnxkFiMyVKsK3pnoHfx3Hz"
+                          },
+                          "email": {
+                            "type": "string",
+                            "description": "Email of the user who created the alias",
+                            "example": "john-doe@gmail.com"
+                          },
+                          "username": {
+                            "type": "string",
+                            "description": "Username of the user who created the alias",
+                            "example": "john-doe"
+                          }
+                        },
+                        "required": [
+                          "uid",
+                          "email",
+                          "username"
+                        ],
+                        "type": "object",
+                        "description": "Information of the user who created the alias"
+                      },
+                      "deletedAt": {
+                        "type": "number",
+                        "description": "The date when the alias was deleted in milliseconds since the UNIX epoch",
+                        "example": 1540095775941
+                      },
+                      "deployment": {
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "The deployment unique identifier",
+                            "example": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx"
+                          },
+                          "url": {
+                            "type": "string",
+                            "description": "The deployment unique URL",
+                            "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
+                          },
+                          "meta": {
+                            "type": "string",
+                            "description": "The deployment metadata",
+                            "example": {}
+                          }
+                        },
+                        "required": [
+                          "id",
+                          "url"
+                        ],
+                        "type": "object",
+                        "description": "A map with the deployment ID, URL and metadata"
+                      },
+                      "deploymentId": {
+                        "nullable": true,
+                        "type": "string",
+                        "description": "The deployment ID",
+                        "example": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx"
+                      },
+                      "projectId": {
+                        "nullable": true,
+                        "type": "string",
+                        "description": "The unique identifier of the project",
+                        "example": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
+                      },
+                      "redirect": {
+                        "nullable": true,
+                        "type": "string",
+                        "description": "Target destination domain for redirect when the alias is a redirect"
+                      },
+                      "redirectStatusCode": {
+                        "nullable": true,
+                        "type": "number",
+                        "enum": [
+                          301,
+                          302,
+                          307,
+                          308
+                        ],
+                        "description": "Status code to be used on redirect"
+                      },
+                      "uid": {
+                        "type": "string",
+                        "description": "The unique identifier of the alias"
+                      },
+                      "updatedAt": {
+                        "type": "number",
+                        "description": "The date when the alias was updated in milliseconds since the UNIX epoch",
+                        "example": 1540095775941
+                      },
+                      "protectionBypass": {
+                        "additionalProperties": {
+                          "oneOf": [
+                            {
+                              "properties": {
+                                "createdAt": {
+                                  "type": "number"
+                                },
+                                "createdBy": {
+                                  "type": "string"
+                                },
+                                "scope": {
+                                  "type": "string",
+                                  "enum": [
+                                    "shareable-link"
+                                  ]
+                                }
+                              },
+                              "required": [
+                                "createdAt",
+                                "createdBy",
+                                "scope"
+                              ],
+                              "type": "object",
+                              "description": "The protection bypass for the alias"
+                            },
+                            {
+                              "properties": {
+                                "createdAt": {
+                                  "type": "number"
+                                },
+                                "lastUpdatedAt": {
+                                  "type": "number"
+                                },
+                                "lastUpdatedBy": {
+                                  "type": "string"
+                                },
+                                "access": {
+                                  "type": "string",
+                                  "enum": [
+                                    "requested",
+                                    "granted"
+                                  ]
+                                },
+                                "scope": {
+                                  "type": "string",
+                                  "enum": [
+                                    "user"
+                                  ]
+                                }
+                              },
+                              "required": [
+                                "createdAt",
+                                "lastUpdatedAt",
+                                "lastUpdatedBy",
+                                "access",
+                                "scope"
+                              ],
+                              "type": "object",
+                              "description": "The protection bypass for the alias"
+                            },
+                            {
+                              "properties": {
+                                "createdAt": {
+                                  "type": "number"
+                                },
+                                "createdBy": {
+                                  "type": "string"
+                                },
+                                "scope": {
+                                  "type": "string",
+                                  "enum": [
+                                    "alias-protection-override"
+                                  ]
+                                }
+                              },
+                              "required": [
+                                "createdAt",
+                                "createdBy",
+                                "scope"
+                              ],
+                              "type": "object",
+                              "description": "The protection bypass for the alias"
+                            },
+                            {
+                              "properties": {
+                                "createdAt": {
+                                  "type": "number"
+                                },
+                                "lastUpdatedAt": {
+                                  "type": "number"
+                                },
+                                "lastUpdatedBy": {
+                                  "type": "string"
+                                },
+                                "scope": {
+                                  "type": "string",
+                                  "enum": [
+                                    "email_invite"
+                                  ]
+                                }
+                              },
+                              "required": [
+                                "createdAt",
+                                "lastUpdatedAt",
+                                "lastUpdatedBy",
+                                "scope"
+                              ],
+                              "type": "object",
+                              "description": "The protection bypass for the alias"
+                            }
+                          ]
+                        },
+                        "type": "object",
+                        "description": "The protection bypass for the alias"
+                      },
+                      "microfrontends": {
+                        "properties": {
+                          "defaultApp": {
+                            "properties": {
+                              "projectId": {
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "projectId"
+                            ],
+                            "type": "object"
+                          },
+                          "applications": {
+                            "oneOf": [
+                              {
+                                "items": {
+                                  "properties": {
+                                    "fallbackHost": {
+                                      "type": "string",
+                                      "description": "This is always set. In production it is used as a pointer to each apps production deployment. For pre-production, it's used as the fallback if there is no deployment for the branch."
+                                    },
+                                    "projectId": {
+                                      "type": "string",
+                                      "description": "The project ID of the microfrontends application."
+                                    }
+                                  },
+                                  "required": [
+                                    "fallbackHost",
+                                    "projectId"
+                                  ],
+                                  "type": "object",
+                                  "description": "A list of the deployment routing information for each project."
+                                },
+                                "type": "array",
+                                "description": "A list of the deployment routing information for each project."
+                              },
+                              {
+                                "items": {
+                                  "properties": {
+                                    "fallbackHost": {
+                                      "type": "string",
+                                      "description": "This is always set. For branch aliases, it's used as the fallback if there is no deployment for the branch."
+                                    },
+                                    "branchAlias": {
+                                      "type": "string",
+                                      "description": "Could point to a branch without a deployment if the project was never deployed. The proxy will fallback to the fallbackHost if there is no deployment."
+                                    },
+                                    "projectId": {
+                                      "type": "string",
+                                      "description": "The project ID of the microfrontends application."
+                                    }
+                                  },
+                                  "required": [
+                                    "fallbackHost",
+                                    "branchAlias",
+                                    "projectId"
+                                  ],
+                                  "type": "object",
+                                  "description": "A list of the deployment routing information for each project."
+                                },
+                                "type": "array",
+                                "description": "A list of the deployment routing information for each project."
+                              },
+                              {
+                                "items": {
+                                  "properties": {
+                                    "deploymentId": {
+                                      "type": "string",
+                                      "description": "This is the deployment for the same commit, it could be a cancelled deployment. The proxy will fallback to the branchDeploymentId and then the fallbackDeploymentId."
+                                    },
+                                    "branchDeploymentId": {
+                                      "type": "string",
+                                      "description": "This is the latest non-cancelled deployment of the branch alias at the time the commit alias was created. It is possible there is no deployment for the branch, or this was set before the deployment was canceled, in which case this will point to a cancelled deployment, in either case the proxy will fallback to the fallbackDeploymentId."
+                                    },
+                                    "fallbackDeploymentId": {
+                                      "type": "string",
+                                      "description": "This is the deployment of the fallback host at the time the commit alias was created. It is possible for this to be a deleted deployment, in which case the proxy will show that the deployment is deleted. It will not use the fallbackHost, as a future deployment on the fallback host could be invalid for this deployment, and it could lead to confusion / incorrect behavior for the commit alias."
+                                    },
+                                    "fallbackHost": {
+                                      "type": "string",
+                                      "description": "Temporary for backwards compatibility. Can remove when metadata change is released"
+                                    },
+                                    "branchAlias": {
+                                      "type": "string"
+                                    },
+                                    "projectId": {
+                                      "type": "string",
+                                      "description": "The project ID of the microfrontends application."
+                                    }
+                                  },
+                                  "required": [
+                                    "projectId"
+                                  ],
+                                  "type": "object",
+                                  "description": "A list of the deployment routing information for each project."
+                                },
+                                "type": "array",
+                                "description": "A list of the deployment routing information for each project."
+                              }
+                            ]
+                          }
+                        },
+                        "required": [
+                          "defaultApp",
+                          "applications"
+                        ],
+                        "type": "object",
+                        "description": "The microfrontends for the alias including the routing configuration"
+                      }
+                    },
+                    "required": [
+                      "alias",
+                      "created",
+                      "deploymentId",
+                      "projectId",
+                      "uid"
+                    ],
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
               }
             }
           },