@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>
279 lines • 12.4 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 UpdateResourceOwnership: {
readonly Owned: "owned";
readonly Linked: "linked";
readonly Sandbox: "sandbox";
};
export type UpdateResourceOwnership = ClosedEnum<typeof UpdateResourceOwnership>;
export declare const UpdateResourceStatus: {
readonly Ready: "ready";
readonly Pending: "pending";
readonly Onboarding: "onboarding";
readonly Suspended: "suspended";
readonly Resumed: "resumed";
readonly Uninstalled: "uninstalled";
readonly Error: "error";
};
export type UpdateResourceStatus = ClosedEnum<typeof UpdateResourceStatus>;
export declare const UpdateResourceType: {
readonly Prepayment: "prepayment";
readonly Subscription: "subscription";
};
export type UpdateResourceType = ClosedEnum<typeof UpdateResourceType>;
export type UpdateResourceDetails = {
label: string;
value?: string | undefined;
};
export type UpdateResourceHighlightedDetails = {
label: string;
value?: string | undefined;
};
export type UpdateResourceBillingPlan = {
id: string;
type: UpdateResourceType;
name: string;
description?: string | undefined;
paymentMethodRequired?: boolean | undefined;
cost?: string | undefined;
details?: Array<UpdateResourceDetails> | undefined;
highlightedDetails?: Array<UpdateResourceHighlightedDetails> | undefined;
effectiveDate?: string | undefined;
additionalProperties?: {
[k: string]: any;
} | undefined;
};
export declare const NotificationLevel: {
readonly Info: "info";
readonly Warn: "warn";
readonly Error: "error";
};
export type NotificationLevel = ClosedEnum<typeof NotificationLevel>;
export type UpdateResourceNotification1 = {
level: NotificationLevel;
title: string;
message?: string | undefined;
href?: string | undefined;
};
export type UpdateResourceNotification = UpdateResourceNotification1 | string;
/**
* 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 UpdateResourceSecretsMarketplaceEnvironmentOverrides = {
/**
* 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 SecretsSecrets = {
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?: UpdateResourceSecretsMarketplaceEnvironmentOverrides | undefined;
};
export type Secrets2 = {
secrets: Array<SecretsSecrets>;
/**
* If true, will only overwrite the provided secrets instead of replacing all secrets.
*/
partial?: boolean | 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 SecretsEnvironmentOverrides = {
/**
* 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 Secrets1 = {
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?: SecretsEnvironmentOverrides | undefined;
};
export type UpdateResourceSecrets = Secrets2 | Array<Secrets1>;
export type UpdateResourceRequestBody = {
ownership?: UpdateResourceOwnership | undefined;
name?: string | undefined;
status?: UpdateResourceStatus | undefined;
metadata?: {
[k: string]: any;
} | undefined;
billingPlan?: UpdateResourceBillingPlan | undefined;
notification?: UpdateResourceNotification1 | string | undefined;
extras?: {
[k: string]: any;
} | undefined;
secrets?: Secrets2 | Array<Secrets1> | undefined;
};
export type UpdateResourceRequest = {
integrationConfigurationId: string;
resourceId: string;
requestBody?: UpdateResourceRequestBody | undefined;
};
export type UpdateResourceResponseBody = {
name: string;
};
/** @internal */
export declare const UpdateResourceOwnership$outboundSchema: z.ZodNativeEnum<typeof UpdateResourceOwnership>;
/** @internal */
export declare const UpdateResourceStatus$outboundSchema: z.ZodNativeEnum<typeof UpdateResourceStatus>;
/** @internal */
export declare const UpdateResourceType$outboundSchema: z.ZodNativeEnum<typeof UpdateResourceType>;
/** @internal */
export type UpdateResourceDetails$Outbound = {
label: string;
value?: string | undefined;
};
/** @internal */
export declare const UpdateResourceDetails$outboundSchema: z.ZodType<UpdateResourceDetails$Outbound, z.ZodTypeDef, UpdateResourceDetails>;
export declare function updateResourceDetailsToJSON(updateResourceDetails: UpdateResourceDetails): string;
/** @internal */
export type UpdateResourceHighlightedDetails$Outbound = {
label: string;
value?: string | undefined;
};
/** @internal */
export declare const UpdateResourceHighlightedDetails$outboundSchema: z.ZodType<UpdateResourceHighlightedDetails$Outbound, z.ZodTypeDef, UpdateResourceHighlightedDetails>;
export declare function updateResourceHighlightedDetailsToJSON(updateResourceHighlightedDetails: UpdateResourceHighlightedDetails): string;
/** @internal */
export type UpdateResourceBillingPlan$Outbound = {
id: string;
type: string;
name: string;
description?: string | undefined;
paymentMethodRequired?: boolean | undefined;
cost?: string | undefined;
details?: Array<UpdateResourceDetails$Outbound> | undefined;
highlightedDetails?: Array<UpdateResourceHighlightedDetails$Outbound> | undefined;
effectiveDate?: string | undefined;
[additionalProperties: string]: unknown;
};
/** @internal */
export declare const UpdateResourceBillingPlan$outboundSchema: z.ZodType<UpdateResourceBillingPlan$Outbound, z.ZodTypeDef, UpdateResourceBillingPlan>;
export declare function updateResourceBillingPlanToJSON(updateResourceBillingPlan: UpdateResourceBillingPlan): string;
/** @internal */
export declare const NotificationLevel$outboundSchema: z.ZodNativeEnum<typeof NotificationLevel>;
/** @internal */
export type UpdateResourceNotification1$Outbound = {
level: string;
title: string;
message?: string | undefined;
href?: string | undefined;
};
/** @internal */
export declare const UpdateResourceNotification1$outboundSchema: z.ZodType<UpdateResourceNotification1$Outbound, z.ZodTypeDef, UpdateResourceNotification1>;
export declare function updateResourceNotification1ToJSON(updateResourceNotification1: UpdateResourceNotification1): string;
/** @internal */
export type UpdateResourceNotification$Outbound = UpdateResourceNotification1$Outbound | string;
/** @internal */
export declare const UpdateResourceNotification$outboundSchema: z.ZodType<UpdateResourceNotification$Outbound, z.ZodTypeDef, UpdateResourceNotification>;
export declare function updateResourceNotificationToJSON(updateResourceNotification: UpdateResourceNotification): string;
/** @internal */
export type UpdateResourceSecretsMarketplaceEnvironmentOverrides$Outbound = {
development?: string | undefined;
preview?: string | undefined;
production?: string | undefined;
};
/** @internal */
export declare const UpdateResourceSecretsMarketplaceEnvironmentOverrides$outboundSchema: z.ZodType<UpdateResourceSecretsMarketplaceEnvironmentOverrides$Outbound, z.ZodTypeDef, UpdateResourceSecretsMarketplaceEnvironmentOverrides>;
export declare function updateResourceSecretsMarketplaceEnvironmentOverridesToJSON(updateResourceSecretsMarketplaceEnvironmentOverrides: UpdateResourceSecretsMarketplaceEnvironmentOverrides): string;
/** @internal */
export type SecretsSecrets$Outbound = {
name: string;
value: string;
prefix?: string | undefined;
environmentOverrides?: UpdateResourceSecretsMarketplaceEnvironmentOverrides$Outbound | undefined;
};
/** @internal */
export declare const SecretsSecrets$outboundSchema: z.ZodType<SecretsSecrets$Outbound, z.ZodTypeDef, SecretsSecrets>;
export declare function secretsSecretsToJSON(secretsSecrets: SecretsSecrets): string;
/** @internal */
export type Secrets2$Outbound = {
secrets: Array<SecretsSecrets$Outbound>;
partial?: boolean | undefined;
};
/** @internal */
export declare const Secrets2$outboundSchema: z.ZodType<Secrets2$Outbound, z.ZodTypeDef, Secrets2>;
export declare function secrets2ToJSON(secrets2: Secrets2): string;
/** @internal */
export type SecretsEnvironmentOverrides$Outbound = {
development?: string | undefined;
preview?: string | undefined;
production?: string | undefined;
};
/** @internal */
export declare const SecretsEnvironmentOverrides$outboundSchema: z.ZodType<SecretsEnvironmentOverrides$Outbound, z.ZodTypeDef, SecretsEnvironmentOverrides>;
export declare function secretsEnvironmentOverridesToJSON(secretsEnvironmentOverrides: SecretsEnvironmentOverrides): string;
/** @internal */
export type Secrets1$Outbound = {
name: string;
value: string;
prefix?: string | undefined;
environmentOverrides?: SecretsEnvironmentOverrides$Outbound | undefined;
};
/** @internal */
export declare const Secrets1$outboundSchema: z.ZodType<Secrets1$Outbound, z.ZodTypeDef, Secrets1>;
export declare function secrets1ToJSON(secrets1: Secrets1): string;
/** @internal */
export type UpdateResourceSecrets$Outbound = Secrets2$Outbound | Array<Secrets1$Outbound>;
/** @internal */
export declare const UpdateResourceSecrets$outboundSchema: z.ZodType<UpdateResourceSecrets$Outbound, z.ZodTypeDef, UpdateResourceSecrets>;
export declare function updateResourceSecretsToJSON(updateResourceSecrets: UpdateResourceSecrets): string;
/** @internal */
export type UpdateResourceRequestBody$Outbound = {
ownership?: string | undefined;
name?: string | undefined;
status?: string | undefined;
metadata?: {
[k: string]: any;
} | undefined;
billingPlan?: UpdateResourceBillingPlan$Outbound | undefined;
notification?: UpdateResourceNotification1$Outbound | string | undefined;
extras?: {
[k: string]: any;
} | undefined;
secrets?: Secrets2$Outbound | Array<Secrets1$Outbound> | undefined;
};
/** @internal */
export declare const UpdateResourceRequestBody$outboundSchema: z.ZodType<UpdateResourceRequestBody$Outbound, z.ZodTypeDef, UpdateResourceRequestBody>;
export declare function updateResourceRequestBodyToJSON(updateResourceRequestBody: UpdateResourceRequestBody): string;
/** @internal */
export type UpdateResourceRequest$Outbound = {
integrationConfigurationId: string;
resourceId: string;
RequestBody?: UpdateResourceRequestBody$Outbound | undefined;
};
/** @internal */
export declare const UpdateResourceRequest$outboundSchema: z.ZodType<UpdateResourceRequest$Outbound, z.ZodTypeDef, UpdateResourceRequest>;
export declare function updateResourceRequestToJSON(updateResourceRequest: UpdateResourceRequest): string;
/** @internal */
export declare const UpdateResourceResponseBody$inboundSchema: z.ZodType<UpdateResourceResponseBody, z.ZodTypeDef, unknown>;
export declare function updateResourceResponseBodyFromJSON(jsonString: string): SafeParseResult<UpdateResourceResponseBody, SDKValidationError>;
//# sourceMappingURL=updateresourceop.d.ts.map