@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>
209 lines • 8.69 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export declare const Ownership: {
readonly Owned: "owned";
readonly Linked: "linked";
readonly Sandbox: "sandbox";
};
export type Ownership = ClosedEnum<typeof Ownership>;
export declare const ImportResourceStatus: {
readonly Ready: "ready";
readonly Pending: "pending";
readonly Onboarding: "onboarding";
readonly Suspended: "suspended";
readonly Resumed: "resumed";
readonly Uninstalled: "uninstalled";
readonly Error: "error";
};
export type ImportResourceStatus = ClosedEnum<typeof ImportResourceStatus>;
export declare const ImportResourceType: {
readonly Prepayment: "prepayment";
readonly Subscription: "subscription";
};
export type ImportResourceType = ClosedEnum<typeof ImportResourceType>;
export type ImportResourceDetails = {
label: string;
value?: string | undefined;
};
export type ImportResourceHighlightedDetails = {
label: string;
value?: string | undefined;
};
export type ImportResourceBillingPlan = {
id: string;
type: ImportResourceType;
name: string;
description?: string | undefined;
paymentMethodRequired?: boolean | undefined;
cost?: string | undefined;
details?: Array<ImportResourceDetails> | undefined;
highlightedDetails?: Array<ImportResourceHighlightedDetails> | undefined;
effectiveDate?: string | undefined;
additionalProperties?: {
[k: string]: any;
} | undefined;
};
export declare const ImportResourceLevel: {
readonly Info: "info";
readonly Warn: "warn";
readonly Error: "error";
};
export type ImportResourceLevel = ClosedEnum<typeof ImportResourceLevel>;
export type ImportResourceNotification = {
level: ImportResourceLevel;
title: string;
message?: string | undefined;
href?: string | undefined;
};
/**
* A map of environments to override values for the secret, used for setting different values across deployments in production, preview, and development environments. Note: the same value will be used for all deployments in the given environment.
*/
export type EnvironmentOverrides = {
/**
* Value used for development environment.
*/
development?: string | undefined;
/**
* Value used for preview environment.
*/
preview?: string | undefined;
/**
* Value used for production environment.
*/
production?: string | undefined;
};
export type ImportResourceSecrets = {
name: string;
value: string;
prefix?: string | undefined;
/**
* A map of environments to override values for the secret, used for setting different values across deployments in production, preview, and development environments. Note: the same value will be used for all deployments in the given environment.
*/
environmentOverrides?: EnvironmentOverrides | undefined;
};
export type ImportResourceRequestBody = {
ownership?: Ownership | undefined;
productId: string;
name: string;
status: ImportResourceStatus;
metadata?: {
[k: string]: any;
} | undefined;
billingPlan?: ImportResourceBillingPlan | undefined;
notification?: ImportResourceNotification | undefined;
extras?: {
[k: string]: any;
} | undefined;
secrets?: Array<ImportResourceSecrets> | undefined;
};
export type ImportResourceRequest = {
integrationConfigurationId: string;
resourceId: string;
requestBody?: ImportResourceRequestBody | undefined;
};
export type ImportResourceResponseBody = {
name: string;
};
/** @internal */
export declare const Ownership$outboundSchema: z.ZodNativeEnum<typeof Ownership>;
/** @internal */
export declare const ImportResourceStatus$outboundSchema: z.ZodNativeEnum<typeof ImportResourceStatus>;
/** @internal */
export declare const ImportResourceType$outboundSchema: z.ZodNativeEnum<typeof ImportResourceType>;
/** @internal */
export type ImportResourceDetails$Outbound = {
label: string;
value?: string | undefined;
};
/** @internal */
export declare const ImportResourceDetails$outboundSchema: z.ZodType<ImportResourceDetails$Outbound, z.ZodTypeDef, ImportResourceDetails>;
export declare function importResourceDetailsToJSON(importResourceDetails: ImportResourceDetails): string;
/** @internal */
export type ImportResourceHighlightedDetails$Outbound = {
label: string;
value?: string | undefined;
};
/** @internal */
export declare const ImportResourceHighlightedDetails$outboundSchema: z.ZodType<ImportResourceHighlightedDetails$Outbound, z.ZodTypeDef, ImportResourceHighlightedDetails>;
export declare function importResourceHighlightedDetailsToJSON(importResourceHighlightedDetails: ImportResourceHighlightedDetails): string;
/** @internal */
export type ImportResourceBillingPlan$Outbound = {
id: string;
type: string;
name: string;
description?: string | undefined;
paymentMethodRequired?: boolean | undefined;
cost?: string | undefined;
details?: Array<ImportResourceDetails$Outbound> | undefined;
highlightedDetails?: Array<ImportResourceHighlightedDetails$Outbound> | undefined;
effectiveDate?: string | undefined;
[additionalProperties: string]: unknown;
};
/** @internal */
export declare const ImportResourceBillingPlan$outboundSchema: z.ZodType<ImportResourceBillingPlan$Outbound, z.ZodTypeDef, ImportResourceBillingPlan>;
export declare function importResourceBillingPlanToJSON(importResourceBillingPlan: ImportResourceBillingPlan): string;
/** @internal */
export declare const ImportResourceLevel$outboundSchema: z.ZodNativeEnum<typeof ImportResourceLevel>;
/** @internal */
export type ImportResourceNotification$Outbound = {
level: string;
title: string;
message?: string | undefined;
href?: string | undefined;
};
/** @internal */
export declare const ImportResourceNotification$outboundSchema: z.ZodType<ImportResourceNotification$Outbound, z.ZodTypeDef, ImportResourceNotification>;
export declare function importResourceNotificationToJSON(importResourceNotification: ImportResourceNotification): string;
/** @internal */
export type EnvironmentOverrides$Outbound = {
development?: string | undefined;
preview?: string | undefined;
production?: string | undefined;
};
/** @internal */
export declare const EnvironmentOverrides$outboundSchema: z.ZodType<EnvironmentOverrides$Outbound, z.ZodTypeDef, EnvironmentOverrides>;
export declare function environmentOverridesToJSON(environmentOverrides: EnvironmentOverrides): string;
/** @internal */
export type ImportResourceSecrets$Outbound = {
name: string;
value: string;
prefix?: string | undefined;
environmentOverrides?: EnvironmentOverrides$Outbound | undefined;
};
/** @internal */
export declare const ImportResourceSecrets$outboundSchema: z.ZodType<ImportResourceSecrets$Outbound, z.ZodTypeDef, ImportResourceSecrets>;
export declare function importResourceSecretsToJSON(importResourceSecrets: ImportResourceSecrets): string;
/** @internal */
export type ImportResourceRequestBody$Outbound = {
ownership?: string | undefined;
productId: string;
name: string;
status: string;
metadata?: {
[k: string]: any;
} | undefined;
billingPlan?: ImportResourceBillingPlan$Outbound | undefined;
notification?: ImportResourceNotification$Outbound | undefined;
extras?: {
[k: string]: any;
} | undefined;
secrets?: Array<ImportResourceSecrets$Outbound> | undefined;
};
/** @internal */
export declare const ImportResourceRequestBody$outboundSchema: z.ZodType<ImportResourceRequestBody$Outbound, z.ZodTypeDef, ImportResourceRequestBody>;
export declare function importResourceRequestBodyToJSON(importResourceRequestBody: ImportResourceRequestBody): string;
/** @internal */
export type ImportResourceRequest$Outbound = {
integrationConfigurationId: string;
resourceId: string;
RequestBody?: ImportResourceRequestBody$Outbound | undefined;
};
/** @internal */
export declare const ImportResourceRequest$outboundSchema: z.ZodType<ImportResourceRequest$Outbound, z.ZodTypeDef, ImportResourceRequest>;
export declare function importResourceRequestToJSON(importResourceRequest: ImportResourceRequest): string;
/** @internal */
export declare const ImportResourceResponseBody$inboundSchema: z.ZodType<ImportResourceResponseBody, z.ZodTypeDef, unknown>;
export declare function importResourceResponseBodyFromJSON(jsonString: string): SafeParseResult<ImportResourceResponseBody, SDKValidationError>;
//# sourceMappingURL=importresourceop.d.ts.map