@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>
170 lines • 6.57 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 type GetIntegrationLogDrainsRequest = {
/**
* 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;
};
/**
* The delivery log format
*/
export declare const GetIntegrationLogDrainsDeliveryFormat: {
readonly Json: "json";
readonly Ndjson: "ndjson";
readonly Protobuf: "protobuf";
};
/**
* The delivery log format
*/
export type GetIntegrationLogDrainsDeliveryFormat = ClosedEnum<typeof GetIntegrationLogDrainsDeliveryFormat>;
/**
* The sources from which logs are currently being delivered to this log drain.
*/
export declare const GetIntegrationLogDrainsSources: {
readonly Build: "build";
readonly Edge: "edge";
readonly External: "external";
readonly Firewall: "firewall";
readonly Lambda: "lambda";
readonly Redirect: "redirect";
readonly Static: "static";
};
/**
* The sources from which logs are currently being delivered to this log drain.
*/
export type GetIntegrationLogDrainsSources = ClosedEnum<typeof GetIntegrationLogDrainsSources>;
/**
* Whether the log drain was created by an integration or by a user
*/
export declare const CreatedFrom: {
readonly Integration: "integration";
readonly SelfServed: "self-served";
};
/**
* Whether the log drain was created by an integration or by a user
*/
export type CreatedFrom = ClosedEnum<typeof CreatedFrom>;
/**
* The environment of log drain
*/
export declare const GetIntegrationLogDrainsEnvironments: {
readonly Preview: "preview";
readonly Production: "production";
};
/**
* The environment of log drain
*/
export type GetIntegrationLogDrainsEnvironments = ClosedEnum<typeof GetIntegrationLogDrainsEnvironments>;
export type GetIntegrationLogDrainsSource2 = {
kind: "integration";
resourceId?: string | undefined;
externalResourceId?: string | undefined;
integrationId: string;
integrationConfigurationId: string;
};
export type GetIntegrationLogDrainsSource1 = {
kind: "self-served";
};
export type GetIntegrationLogDrainsSource = GetIntegrationLogDrainsSource1 | GetIntegrationLogDrainsSource2;
export type GetIntegrationLogDrainsResponseBody = {
/**
* The oauth2 client application id that created this log drain
*/
clientId?: string | undefined;
/**
* The client configuration this log drain was created with
*/
configurationId?: string | undefined;
/**
* A timestamp that tells you when the log drain was created
*/
createdAt: number;
/**
* The unique identifier of the log drain. Always prefixed with `ld_`
*/
id: string;
/**
* The delivery log format
*/
deliveryFormat?: GetIntegrationLogDrainsDeliveryFormat | undefined;
/**
* The name of the log drain
*/
name: string;
/**
* The identifier of the team or user whose events will trigger the log drain
*/
ownerId: string;
projectId?: string | null | undefined;
/**
* The identifier of the projects this log drain is associated with
*/
projectIds?: Array<string> | undefined;
/**
* The URL to call when logs are generated
*/
url: string;
/**
* The sources from which logs are currently being delivered to this log drain.
*/
sources?: Array<GetIntegrationLogDrainsSources> | undefined;
/**
* Whether the log drain was created by an integration or by a user
*/
createdFrom?: CreatedFrom | undefined;
/**
* The headers to send with the request
*/
headers?: {
[k: string]: string;
} | undefined;
/**
* The environment of log drain
*/
environments?: Array<GetIntegrationLogDrainsEnvironments> | undefined;
/**
* The branch regexp of log drain
*/
branch?: string | undefined;
/**
* The sampling rate of log drain
*/
samplingRate?: number | undefined;
source: GetIntegrationLogDrainsSource1 | GetIntegrationLogDrainsSource2;
};
/** @internal */
export type GetIntegrationLogDrainsRequest$Outbound = {
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetIntegrationLogDrainsRequest$outboundSchema: z.ZodType<GetIntegrationLogDrainsRequest$Outbound, z.ZodTypeDef, GetIntegrationLogDrainsRequest>;
export declare function getIntegrationLogDrainsRequestToJSON(getIntegrationLogDrainsRequest: GetIntegrationLogDrainsRequest): string;
/** @internal */
export declare const GetIntegrationLogDrainsDeliveryFormat$inboundSchema: z.ZodNativeEnum<typeof GetIntegrationLogDrainsDeliveryFormat>;
/** @internal */
export declare const GetIntegrationLogDrainsSources$inboundSchema: z.ZodNativeEnum<typeof GetIntegrationLogDrainsSources>;
/** @internal */
export declare const CreatedFrom$inboundSchema: z.ZodNativeEnum<typeof CreatedFrom>;
/** @internal */
export declare const GetIntegrationLogDrainsEnvironments$inboundSchema: z.ZodNativeEnum<typeof GetIntegrationLogDrainsEnvironments>;
/** @internal */
export declare const GetIntegrationLogDrainsSource2$inboundSchema: z.ZodType<GetIntegrationLogDrainsSource2, z.ZodTypeDef, unknown>;
export declare function getIntegrationLogDrainsSource2FromJSON(jsonString: string): SafeParseResult<GetIntegrationLogDrainsSource2, SDKValidationError>;
/** @internal */
export declare const GetIntegrationLogDrainsSource1$inboundSchema: z.ZodType<GetIntegrationLogDrainsSource1, z.ZodTypeDef, unknown>;
export declare function getIntegrationLogDrainsSource1FromJSON(jsonString: string): SafeParseResult<GetIntegrationLogDrainsSource1, SDKValidationError>;
/** @internal */
export declare const GetIntegrationLogDrainsSource$inboundSchema: z.ZodType<GetIntegrationLogDrainsSource, z.ZodTypeDef, unknown>;
export declare function getIntegrationLogDrainsSourceFromJSON(jsonString: string): SafeParseResult<GetIntegrationLogDrainsSource, SDKValidationError>;
/** @internal */
export declare const GetIntegrationLogDrainsResponseBody$inboundSchema: z.ZodType<GetIntegrationLogDrainsResponseBody, z.ZodTypeDef, unknown>;
export declare function getIntegrationLogDrainsResponseBodyFromJSON(jsonString: string): SafeParseResult<GetIntegrationLogDrainsResponseBody, SDKValidationError>;
//# sourceMappingURL=getintegrationlogdrainsop.d.ts.map