@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>
219 lines • 16.2 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { GetMicrofrontendsInGroupAlias, GetMicrofrontendsInGroupAnalytics, GetMicrofrontendsInGroupBlobs, GetMicrofrontendsInGroupConnectConfigurations, GetMicrofrontendsInGroupCreator, GetMicrofrontendsInGroupCrons, GetMicrofrontendsInGroupCustomEnvironments, GetMicrofrontendsInGroupDataCache, GetMicrofrontendsInGroupDeploymentExpiration, GetMicrofrontendsInGroupEnv, GetMicrofrontendsInGroupExpiration, GetMicrofrontendsInGroupFramework, GetMicrofrontendsInGroupIpBuckets, GetMicrofrontendsInGroupJobs, GetMicrofrontendsInGroupLatestDeployments, GetMicrofrontendsInGroupLink, GetMicrofrontendsInGroupMicrofrontends, GetMicrofrontendsInGroupNodeVersion, GetMicrofrontendsInGroupOptionsAllowlist, GetMicrofrontendsInGroupPassport, GetMicrofrontendsInGroupPasswordProtection, GetMicrofrontendsInGroupProtectionConfig, GetMicrofrontendsInGroupResourceConfig, GetMicrofrontendsInGroupRollbackDescription, GetMicrofrontendsInGroupRollingRelease, GetMicrofrontendsInGroupSandbox, GetMicrofrontendsInGroupServices, GetMicrofrontendsInGroupSpeedInsights } from "./getmicrofrontendsingroupbuildmachinetype.js";
import { GetMicrofrontendsInGroupAbuse, GetMicrofrontendsInGroupDefaultResourceConfig, GetMicrofrontendsInGroupDeploymentPolicy, GetMicrofrontendsInGroupFeatures, GetMicrofrontendsInGroupGitComments, GetMicrofrontendsInGroupGitProviderOptions, GetMicrofrontendsInGroupInternalRoutes2, GetMicrofrontendsInGroupLastAliasRequest, GetMicrofrontendsInGroupLastRollbackTarget, GetMicrofrontendsInGroupOidcTokenConfig, GetMicrofrontendsInGroupPermissions, GetMicrofrontendsInGroupProtectionBypass, GetMicrofrontendsInGroupSecurity, GetMicrofrontendsInGroupSsoProtection, GetMicrofrontendsInGroupStaticIps, GetMicrofrontendsInGroupTargets, GetMicrofrontendsInGroupTier, GetMicrofrontendsInGroupTrustedIps, GetMicrofrontendsInGroupTrustedSources, GetMicrofrontendsInGroupUsageStatus, GetMicrofrontendsInGroupWebAnalytics } from "./getmicrofrontendsingroupinternalroutes2.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetMicrofrontendsInGroupInternalRoutes1 = {
src: string;
status: number;
expiry?: number | undefined;
};
export type GetMicrofrontendsInGroupInternalRoutes = GetMicrofrontendsInGroupInternalRoutes1 | GetMicrofrontendsInGroupInternalRoutes2;
export declare const GetMicrofrontendsInGroupAction: {
readonly Accept: "accept";
readonly Cancel: "cancel";
readonly Delete: "delete";
};
export type GetMicrofrontendsInGroupAction = ClosedEnum<typeof GetMicrofrontendsInGroupAction>;
export type GetMicrofrontendsInGroupValuePreviousValue = string | number | boolean;
export type GetMicrofrontendsInGroupValueCurrentValue = string | number | boolean;
export type GetMicrofrontendsInGroupValue3 = {
previousValue: string | number | boolean;
currentValue: string | number | boolean;
};
export type GetMicrofrontendsInGroupValue = GetMicrofrontendsInGroupValue3 | string | number | boolean;
export type GetMicrofrontendsInGroupDismissedToasts = {
key: string;
dismissedAt: number;
action: GetMicrofrontendsInGroupAction;
value: GetMicrofrontendsInGroupValue3 | string | number | boolean | null;
};
export declare const GetMicrofrontendsInGroupMicrofrontendsEnv: {
readonly Preview: "preview";
readonly Production: "production";
};
export type GetMicrofrontendsInGroupMicrofrontendsEnv = ClosedEnum<typeof GetMicrofrontendsInGroupMicrofrontendsEnv>;
/**
* Which tracing destination this rule applies to. `internal` is the hidden Vercel production-tracing drain (internal delivery); `external` is any customer-configured drain. Derived from the owning drain's delivery type when project tracing is computed; absent on configs persisted before this field existed.
*/
export declare const GetMicrofrontendsInGroupDestination: {
readonly External: "external";
readonly Internal: "internal";
};
/**
* Which tracing destination this rule applies to. `internal` is the hidden Vercel production-tracing drain (internal delivery); `external` is any customer-configured drain. Derived from the owning drain's delivery type when project tracing is computed; absent on configs persisted before this field existed.
*/
export type GetMicrofrontendsInGroupDestination = ClosedEnum<typeof GetMicrofrontendsInGroupDestination>;
export type GetMicrofrontendsInGroupSamplingRules = {
rate: number;
env?: GetMicrofrontendsInGroupMicrofrontendsEnv | undefined;
requestPath?: string | undefined;
/**
* Which tracing destination this rule applies to. `internal` is the hidden Vercel production-tracing drain (internal delivery); `external` is any customer-configured drain. Derived from the owning drain's delivery type when project tracing is computed; absent on configs persisted before this field existed.
*/
destination?: GetMicrofrontendsInGroupDestination | undefined;
};
export type GetMicrofrontendsInGroupTracing = {
domains?: string | undefined;
ignorePaths?: Array<string> | undefined;
samplingRules?: Array<GetMicrofrontendsInGroupSamplingRules> | undefined;
};
export type GetMicrofrontendsInGroupProjects = {
accountId: string;
creator?: GetMicrofrontendsInGroupCreator | undefined;
alias: Array<GetMicrofrontendsInGroupAlias>;
analytics?: GetMicrofrontendsInGroupAnalytics | undefined;
appliedCve55182Migration?: boolean | undefined;
speedInsights?: GetMicrofrontendsInGroupSpeedInsights | undefined;
autoExposeSystemEnvs?: boolean | undefined;
autoAssignCustomDomains?: boolean | undefined;
autoAssignCustomDomainsUpdatedBy?: string | undefined;
buildCommand?: string | null | undefined;
commandForIgnoringBuildStep?: string | null | undefined;
connectConfigurations?: Array<GetMicrofrontendsInGroupConnectConfigurations> | null | undefined;
connectConfigurationId?: string | null | undefined;
connectBuildsEnabled?: boolean | undefined;
passiveConnectConfigurationId?: string | null | undefined;
createdAt?: number | undefined;
customerSupportCodeVisibility?: boolean | undefined;
crons?: GetMicrofrontendsInGroupCrons | undefined;
dataCache?: GetMicrofrontendsInGroupDataCache | undefined;
/**
* Retention policies for deployments. These are enforced at the project level, but we also maintain an instance of this at the team level as a default policy that gets applied to new projects.
*/
deploymentExpiration: GetMicrofrontendsInGroupDeploymentExpiration;
expiration?: GetMicrofrontendsInGroupExpiration | undefined;
devCommand?: string | null | undefined;
directoryListing: boolean;
installCommand?: string | null | undefined;
env?: Array<GetMicrofrontendsInGroupEnv> | undefined;
customEnvironments?: Array<GetMicrofrontendsInGroupCustomEnvironments> | undefined;
framework?: GetMicrofrontendsInGroupFramework | null | undefined;
services?: Array<GetMicrofrontendsInGroupServices> | undefined;
gitForkProtection?: boolean | undefined;
gitLFS?: boolean | undefined;
id: string;
ipBuckets?: Array<GetMicrofrontendsInGroupIpBuckets> | undefined;
jobs?: GetMicrofrontendsInGroupJobs | undefined;
latestDeployments?: Array<GetMicrofrontendsInGroupLatestDeployments> | undefined;
link?: GetMicrofrontendsInGroupLink | undefined;
blobs?: GetMicrofrontendsInGroupBlobs | undefined;
microfrontends?: GetMicrofrontendsInGroupMicrofrontends | undefined;
name: string;
nodeVersion: GetMicrofrontendsInGroupNodeVersion;
optionsAllowlist?: GetMicrofrontendsInGroupOptionsAllowlist | null | undefined;
outputDirectory?: string | null | undefined;
passwordProtection?: GetMicrofrontendsInGroupPasswordProtection | null | undefined;
passport?: GetMicrofrontendsInGroupPassport | null | undefined;
protectionConfig?: GetMicrofrontendsInGroupProtectionConfig | undefined;
sandbox?: GetMicrofrontendsInGroupSandbox | undefined;
productionDeploymentsFastLane?: boolean | undefined;
resourceConfig: GetMicrofrontendsInGroupResourceConfig;
/**
* Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback.
*/
rollbackDescription?: GetMicrofrontendsInGroupRollbackDescription | undefined;
/**
* Project-level rolling release configuration that defines how deployments should be gradually rolled out
*/
rollingRelease?: GetMicrofrontendsInGroupRollingRelease | null | undefined;
defaultResourceConfig: GetMicrofrontendsInGroupDefaultResourceConfig;
rootDirectory?: string | null | undefined;
serverlessFunctionZeroConfigFailover?: boolean | undefined;
skewProtectionBoundaryAt?: number | undefined;
skewProtectionMaxAge?: number | undefined;
skewProtectionAllowedDomains?: Array<string> | undefined;
skipGitConnectDuringLink?: boolean | undefined;
staticIps?: GetMicrofrontendsInGroupStaticIps | undefined;
sourceFilesOutsideRootDirectory?: boolean | undefined;
enableAffectedProjectsDeployments?: boolean | undefined;
enableExternalRewriteCaching?: boolean | undefined;
ssoProtection?: GetMicrofrontendsInGroupSsoProtection | null | undefined;
targets?: {
[k: string]: GetMicrofrontendsInGroupTargets | null;
} | undefined;
transferCompletedAt?: number | undefined;
transferStartedAt?: number | undefined;
transferToAccountId?: string | undefined;
transferredFromAccountId?: string | undefined;
updatedAt?: number | undefined;
live?: boolean | undefined;
enablePreviewFeedback?: boolean | null | undefined;
enableProductionFeedback?: boolean | null | undefined;
permissions?: GetMicrofrontendsInGroupPermissions | undefined;
lastRollbackTarget?: GetMicrofrontendsInGroupLastRollbackTarget | null | undefined;
lastAliasRequest?: GetMicrofrontendsInGroupLastAliasRequest | null | undefined;
protectionBypass?: {
[k: string]: GetMicrofrontendsInGroupProtectionBypass;
} | undefined;
hasActiveBranches?: boolean | undefined;
trustedIps?: GetMicrofrontendsInGroupTrustedIps | null | undefined;
trustedSources?: GetMicrofrontendsInGroupTrustedSources | null | undefined;
gitComments?: GetMicrofrontendsInGroupGitComments | undefined;
gitProviderOptions?: GetMicrofrontendsInGroupGitProviderOptions | undefined;
paused?: boolean | undefined;
concurrencyBucketName?: string | undefined;
webAnalytics?: GetMicrofrontendsInGroupWebAnalytics | undefined;
security?: GetMicrofrontendsInGroupSecurity | undefined;
oidcTokenConfig?: GetMicrofrontendsInGroupOidcTokenConfig | undefined;
/**
* Project shape. `null` on a rule list clears the project's override for that rule type (fall back to team for every env); omitting is equivalent. Setting `deploymentPolicy` itself to `null` clears every override at once. Kept structurally distinct from {@link TeamDeploymentPolicy} so the two storage locations don't share a type by accident.
*/
deploymentPolicy?: GetMicrofrontendsInGroupDeploymentPolicy | null | undefined;
tier?: GetMicrofrontendsInGroupTier | undefined;
usageStatus?: GetMicrofrontendsInGroupUsageStatus | undefined;
features?: GetMicrofrontendsInGroupFeatures | undefined;
v0?: boolean | undefined;
v0Created?: boolean | undefined;
abuse?: GetMicrofrontendsInGroupAbuse | undefined;
internalRoutes?: Array<GetMicrofrontendsInGroupInternalRoutes1 | GetMicrofrontendsInGroupInternalRoutes2> | undefined;
hasDeployments?: boolean | undefined;
dismissedToasts?: Array<GetMicrofrontendsInGroupDismissedToasts> | undefined;
protectedSourcemaps?: boolean | undefined;
tracing?: GetMicrofrontendsInGroupTracing | undefined;
avatar?: string | null | undefined;
};
export type GetMicrofrontendsInGroupResponseBody = {
projects: Array<GetMicrofrontendsInGroupProjects>;
};
/** @internal */
export declare const GetMicrofrontendsInGroupInternalRoutes1$inboundSchema: z.ZodType<GetMicrofrontendsInGroupInternalRoutes1, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupInternalRoutes1FromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupInternalRoutes1, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupInternalRoutes$inboundSchema: z.ZodType<GetMicrofrontendsInGroupInternalRoutes, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupInternalRoutesFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupInternalRoutes, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupAction$inboundSchema: z.ZodNativeEnum<typeof GetMicrofrontendsInGroupAction>;
/** @internal */
export declare const GetMicrofrontendsInGroupValuePreviousValue$inboundSchema: z.ZodType<GetMicrofrontendsInGroupValuePreviousValue, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupValuePreviousValueFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupValuePreviousValue, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupValueCurrentValue$inboundSchema: z.ZodType<GetMicrofrontendsInGroupValueCurrentValue, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupValueCurrentValueFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupValueCurrentValue, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupValue3$inboundSchema: z.ZodType<GetMicrofrontendsInGroupValue3, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupValue3FromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupValue3, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupValue$inboundSchema: z.ZodType<GetMicrofrontendsInGroupValue, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupValueFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupValue, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupDismissedToasts$inboundSchema: z.ZodType<GetMicrofrontendsInGroupDismissedToasts, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupDismissedToastsFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupDismissedToasts, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupMicrofrontendsEnv$inboundSchema: z.ZodNativeEnum<typeof GetMicrofrontendsInGroupMicrofrontendsEnv>;
/** @internal */
export declare const GetMicrofrontendsInGroupDestination$inboundSchema: z.ZodNativeEnum<typeof GetMicrofrontendsInGroupDestination>;
/** @internal */
export declare const GetMicrofrontendsInGroupSamplingRules$inboundSchema: z.ZodType<GetMicrofrontendsInGroupSamplingRules, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupSamplingRulesFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupSamplingRules, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupTracing$inboundSchema: z.ZodType<GetMicrofrontendsInGroupTracing, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupTracingFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupTracing, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupProjects$inboundSchema: z.ZodType<GetMicrofrontendsInGroupProjects, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupProjectsFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupProjects, SDKValidationError>;
/** @internal */
export declare const GetMicrofrontendsInGroupResponseBody$inboundSchema: z.ZodType<GetMicrofrontendsInGroupResponseBody, z.ZodTypeDef, unknown>;
export declare function getMicrofrontendsInGroupResponseBodyFromJSON(jsonString: string): SafeParseResult<GetMicrofrontendsInGroupResponseBody, SDKValidationError>;
//# sourceMappingURL=getmicrofrontendsingroupresponsebody.d.ts.map