@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
389 lines (358 loc) • 11.2 kB
text/typescript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod/v3";
import { remap as remap$ } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { Result as SafeParseResult } from "../types/fp.js";
import * as types from "../types/primitives.js";
import { smartUnion } from "../types/smartUnion.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type DeleteRedirectsRequestBody = {
name?: string | undefined;
/**
* The redirects to delete. The source of the redirect is used to match the redirect to delete.
*/
redirects: Array<string>;
};
export type DeleteRedirectsRequest = {
projectId: string;
/**
* The Team identifier to perform the request on behalf of.
*/
teamId?: string | undefined;
/**
* The Team slug to perform the request on behalf of.
*/
slug?: string | undefined;
requestBody?: DeleteRedirectsRequestBody | undefined;
};
export type DeleteRedirectsResponseBodyBulkRedirectsResponseVersion = {
/**
* The unique identifier for the version.
*/
id: string;
/**
* The key of the version. The key may be duplicated across versions if the contents are the same as a different version.
*/
key: string;
lastModified: number;
createdBy: string;
/**
* Optional name for the version. If not provided, defaults to an ISO timestamp string.
*/
name?: string | undefined;
/**
* Whether this version has not been promoted to production yet and is not serving end users.
*/
isStaging?: boolean | undefined;
/**
* Whether this version is currently live in production.
*/
isLive?: boolean | undefined;
/**
* The number of redirects in this version.
*/
redirectCount?: number | undefined;
/**
* The staging link for previewing redirects in this version.
*/
alias?: string | undefined;
};
export type DeleteRedirectsResponseBody3 = {
alias: string | null;
version: DeleteRedirectsResponseBodyBulkRedirectsResponseVersion;
};
export type DeleteRedirectsResponseBodyBulkRedirectsVersion = {
/**
* The unique identifier for the version.
*/
id: string;
/**
* The key of the version. The key may be duplicated across versions if the contents are the same as a different version.
*/
key: string;
lastModified: number;
createdBy: string;
/**
* Optional name for the version. If not provided, defaults to an ISO timestamp string.
*/
name?: string | undefined;
/**
* Whether this version has not been promoted to production yet and is not serving end users.
*/
isStaging?: boolean | undefined;
/**
* Whether this version is currently live in production.
*/
isLive?: boolean | undefined;
/**
* The number of redirects in this version.
*/
redirectCount?: number | undefined;
/**
* The staging link for previewing redirects in this version.
*/
alias?: string | undefined;
};
export type DeleteRedirectsResponseBody2 = {
alias?: any | null | undefined;
version: DeleteRedirectsResponseBodyBulkRedirectsVersion;
};
export type DeleteRedirectsResponseBodyVersion = {
/**
* The unique identifier for the version.
*/
id: string;
/**
* The key of the version. The key may be duplicated across versions if the contents are the same as a different version.
*/
key: string;
lastModified: number;
createdBy: string;
/**
* Optional name for the version. If not provided, defaults to an ISO timestamp string.
*/
name?: string | undefined;
/**
* Whether this version has not been promoted to production yet and is not serving end users.
*/
isStaging?: boolean | undefined;
/**
* Whether this version is currently live in production.
*/
isLive?: boolean | undefined;
/**
* The number of redirects in this version.
*/
redirectCount?: number | undefined;
/**
* The staging link for previewing redirects in this version.
*/
alias?: string | undefined;
};
export type DeleteRedirectsResponseBody1 = {
alias?: string | undefined;
version: DeleteRedirectsResponseBodyVersion;
};
export type DeleteRedirectsResponseBody =
| DeleteRedirectsResponseBody2
| DeleteRedirectsResponseBody3
| DeleteRedirectsResponseBody1;
/** @internal */
export type DeleteRedirectsRequestBody$Outbound = {
name?: string | undefined;
redirects: Array<string>;
};
/** @internal */
export const DeleteRedirectsRequestBody$outboundSchema: z.ZodType<
DeleteRedirectsRequestBody$Outbound,
z.ZodTypeDef,
DeleteRedirectsRequestBody
> = z.object({
name: z.string().optional(),
redirects: z.array(z.string()),
});
export function deleteRedirectsRequestBodyToJSON(
deleteRedirectsRequestBody: DeleteRedirectsRequestBody,
): string {
return JSON.stringify(
DeleteRedirectsRequestBody$outboundSchema.parse(deleteRedirectsRequestBody),
);
}
/** @internal */
export type DeleteRedirectsRequest$Outbound = {
projectId: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody?: DeleteRedirectsRequestBody$Outbound | undefined;
};
/** @internal */
export const DeleteRedirectsRequest$outboundSchema: z.ZodType<
DeleteRedirectsRequest$Outbound,
z.ZodTypeDef,
DeleteRedirectsRequest
> = z.object({
projectId: z.string(),
teamId: z.string().optional(),
slug: z.string().optional(),
requestBody: z.lazy(() => DeleteRedirectsRequestBody$outboundSchema)
.optional(),
}).transform((v) => {
return remap$(v, {
requestBody: "RequestBody",
});
});
export function deleteRedirectsRequestToJSON(
deleteRedirectsRequest: DeleteRedirectsRequest,
): string {
return JSON.stringify(
DeleteRedirectsRequest$outboundSchema.parse(deleteRedirectsRequest),
);
}
/** @internal */
export const DeleteRedirectsResponseBodyBulkRedirectsResponseVersion$inboundSchema:
z.ZodType<
DeleteRedirectsResponseBodyBulkRedirectsResponseVersion,
z.ZodTypeDef,
unknown
> = z.object({
id: types.string(),
key: types.string(),
lastModified: types.number(),
createdBy: types.string(),
name: types.optional(types.string()),
isStaging: types.optional(types.boolean()),
isLive: types.optional(types.boolean()),
redirectCount: types.optional(types.number()),
alias: types.optional(types.string()),
});
export function deleteRedirectsResponseBodyBulkRedirectsResponseVersionFromJSON(
jsonString: string,
): SafeParseResult<
DeleteRedirectsResponseBodyBulkRedirectsResponseVersion,
SDKValidationError
> {
return safeParse(
jsonString,
(x) =>
DeleteRedirectsResponseBodyBulkRedirectsResponseVersion$inboundSchema
.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBodyBulkRedirectsResponseVersion' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBody3$inboundSchema: z.ZodType<
DeleteRedirectsResponseBody3,
z.ZodTypeDef,
unknown
> = z.object({
alias: types.nullable(types.string()),
version: z.lazy(() =>
DeleteRedirectsResponseBodyBulkRedirectsResponseVersion$inboundSchema
),
});
export function deleteRedirectsResponseBody3FromJSON(
jsonString: string,
): SafeParseResult<DeleteRedirectsResponseBody3, SDKValidationError> {
return safeParse(
jsonString,
(x) => DeleteRedirectsResponseBody3$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBody3' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBodyBulkRedirectsVersion$inboundSchema:
z.ZodType<
DeleteRedirectsResponseBodyBulkRedirectsVersion,
z.ZodTypeDef,
unknown
> = z.object({
id: types.string(),
key: types.string(),
lastModified: types.number(),
createdBy: types.string(),
name: types.optional(types.string()),
isStaging: types.optional(types.boolean()),
isLive: types.optional(types.boolean()),
redirectCount: types.optional(types.number()),
alias: types.optional(types.string()),
});
export function deleteRedirectsResponseBodyBulkRedirectsVersionFromJSON(
jsonString: string,
): SafeParseResult<
DeleteRedirectsResponseBodyBulkRedirectsVersion,
SDKValidationError
> {
return safeParse(
jsonString,
(x) =>
DeleteRedirectsResponseBodyBulkRedirectsVersion$inboundSchema.parse(
JSON.parse(x),
),
`Failed to parse 'DeleteRedirectsResponseBodyBulkRedirectsVersion' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBody2$inboundSchema: z.ZodType<
DeleteRedirectsResponseBody2,
z.ZodTypeDef,
unknown
> = z.object({
alias: z.nullable(z.any()).optional(),
version: z.lazy(() =>
DeleteRedirectsResponseBodyBulkRedirectsVersion$inboundSchema
),
});
export function deleteRedirectsResponseBody2FromJSON(
jsonString: string,
): SafeParseResult<DeleteRedirectsResponseBody2, SDKValidationError> {
return safeParse(
jsonString,
(x) => DeleteRedirectsResponseBody2$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBody2' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBodyVersion$inboundSchema: z.ZodType<
DeleteRedirectsResponseBodyVersion,
z.ZodTypeDef,
unknown
> = z.object({
id: types.string(),
key: types.string(),
lastModified: types.number(),
createdBy: types.string(),
name: types.optional(types.string()),
isStaging: types.optional(types.boolean()),
isLive: types.optional(types.boolean()),
redirectCount: types.optional(types.number()),
alias: types.optional(types.string()),
});
export function deleteRedirectsResponseBodyVersionFromJSON(
jsonString: string,
): SafeParseResult<DeleteRedirectsResponseBodyVersion, SDKValidationError> {
return safeParse(
jsonString,
(x) =>
DeleteRedirectsResponseBodyVersion$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBodyVersion' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBody1$inboundSchema: z.ZodType<
DeleteRedirectsResponseBody1,
z.ZodTypeDef,
unknown
> = z.object({
alias: types.optional(types.string()),
version: z.lazy(() => DeleteRedirectsResponseBodyVersion$inboundSchema),
});
export function deleteRedirectsResponseBody1FromJSON(
jsonString: string,
): SafeParseResult<DeleteRedirectsResponseBody1, SDKValidationError> {
return safeParse(
jsonString,
(x) => DeleteRedirectsResponseBody1$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBody1' from JSON`,
);
}
/** @internal */
export const DeleteRedirectsResponseBody$inboundSchema: z.ZodType<
DeleteRedirectsResponseBody,
z.ZodTypeDef,
unknown
> = smartUnion([
z.lazy(() => DeleteRedirectsResponseBody2$inboundSchema),
z.lazy(() => DeleteRedirectsResponseBody3$inboundSchema),
z.lazy(() => DeleteRedirectsResponseBody1$inboundSchema),
]);
export function deleteRedirectsResponseBodyFromJSON(
jsonString: string,
): SafeParseResult<DeleteRedirectsResponseBody, SDKValidationError> {
return safeParse(
jsonString,
(x) => DeleteRedirectsResponseBody$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'DeleteRedirectsResponseBody' from JSON`,
);
}