UNPKG

@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>

573 lines 24.5 kB
/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import * as z from "zod/v3"; import { collectExtraKeys as collectExtraKeys$, safeParse, } from "../lib/schemas.js"; import * as types from "../types/primitives.js"; import { smartUnion } from "../types/smartUnion.js"; export const QueryParam1 = { Hour: "hour", Day: "day", Week: "week", Month: "month", Year: "year", Country: "country", DeviceType: "deviceType", Environment: "environment", RequestPath: "requestPath", ReferrerHostname: "referrerHostname", OsName: "osName", BrowserName: "browserName", Route: "route", UtmSource: "utmSource", UtmMedium: "utmMedium", UtmCampaign: "utmCampaign", UtmContent: "utmContent", UtmTerm: "utmTerm", Flags: "flags", }; export const GroupBy2 = { BrowserName: "browserName", Country: "country", DeviceType: "deviceType", Environment: "environment", Flags: "flags", OsName: "osName", ReferrerHostname: "referrerHostname", RequestPath: "requestPath", Route: "route", UtmCampaign: "utmCampaign", UtmContent: "utmContent", UtmMedium: "utmMedium", UtmSource: "utmSource", UtmTerm: "utmTerm", }; /** @internal */ export const QueryParam1$outboundSchema = z .nativeEnum(QueryParam1); /** @internal */ export const By$outboundSchema = smartUnion([QueryParam1$outboundSchema, z.string()]); export function byToJSON(by) { return JSON.stringify(By$outboundSchema.parse(by)); } /** @internal */ export const Since$outboundSchema = smartUnion([z.number(), z.string()]); export function sinceToJSON(since) { return JSON.stringify(Since$outboundSchema.parse(since)); } /** @internal */ export const Until$outboundSchema = smartUnion([z.number(), z.string()]); export function untilToJSON(until) { return JSON.stringify(Until$outboundSchema.parse(until)); } /** @internal */ export const AggregatePageviewsRequest$outboundSchema = z.object({ projectId: z.string(), by: z.array(smartUnion([QueryParam1$outboundSchema, z.string()])), since: smartUnion([z.number(), z.string()]), until: smartUnion([z.number(), z.string()]), limit: z.number().int().default(10), filter: z.string().optional(), teamId: z.string().optional(), slug: z.string().optional(), }); export function aggregatePageviewsRequestToJSON(aggregatePageviewsRequest) { return JSON.stringify(AggregatePageviewsRequest$outboundSchema.parse(aggregatePageviewsRequest)); } /** @internal */ export const GroupBy2$inboundSchema = z .nativeEnum(GroupBy2); /** @internal */ export const GroupBy$inboundSchema = smartUnion([types.string(), GroupBy2$inboundSchema]); export function groupByFromJSON(jsonString) { return safeParse(jsonString, (x) => GroupBy$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GroupBy' from JSON`); } /** @internal */ export const Query$inboundSchema = z .object({ since: types.string(), until: types.string(), groupBy: types.optional(z.array(smartUnion([types.string(), GroupBy2$inboundSchema]))), filter: types.optional(types.string()), limit: types.number(), }); export function queryFromJSON(jsonString) { return safeParse(jsonString, (x) => Query$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Query' from JSON`); } /** @internal */ export const Data2$inboundSchema = collectExtraKeys$(z.object({ projectId: types.string(), country: types.string(), deviceType: types.string(), environment: types.string(), requestPath: types.string(), referrerHostname: types.string(), osName: types.string(), browserName: types.string(), route: types.string(), utmSource: types.string(), utmMedium: types.string(), utmCampaign: types.string(), utmContent: types.string(), utmTerm: types.string(), flags: types.string(), errorMessage: types.string(), entryRevalidateSeconds: types.string(), projectName: types.string(), deploymentId: types.string(), pathType: types.string(), pathTypeVariant: types.string(), requestHostname: types.string(), requestResolvedIp: types.string(), requestMethod: types.string(), requestExtension: types.string(), requestId: types.string(), requestApi: types.string(), referrerUrl: types.string(), serverActionName: types.string(), httpStatus: types.string(), errorCode: types.string(), source: types.string(), edgeType: types.string(), reason: types.string(), edgeNetworkRegion: types.string(), functionRegion: types.string(), imageTransformationRegion: types.string(), dataCacheRegion: types.string(), cause: types.string(), runtime: types.string(), provider: types.string(), isrCacheRegion: types.string(), isrAction: types.string(), cacheResult: types.string(), cacheOperation: types.string(), cacheHostname: types.string(), cachePath: types.string(), cacheHitState: types.string(), cacheHitLevel: types.string(), cacheApi: types.string(), cacheReason: types.string(), pprState: types.string(), clientIp: types.string(), clientIpCountry: types.string(), clientUserAgent: types.string(), httpAccept: types.string(), clientJa4Digest: types.string(), asnId: types.string(), asnName: types.string(), botName: types.string(), botCategory: types.string(), botCategoryLegacy: types.string(), botVerified: types.string(), botCheckResult: types.string(), deepAnalysisCheck: types.string(), wafAction: types.string(), wafRuleId: types.string(), ruleCategory: types.string(), skewProtection: types.string(), functionStartType: types.string(), functionDispatcher: types.string(), isAdditionalRequest: types.string(), originHostname: types.string(), originPath: types.string(), originRoute: types.string(), fetchType: types.string(), fetchIndex: types.string(), imageSource: types.string(), sourceImage: types.string(), sourceImagePathname: types.string(), sourceImageHostname: types.string(), sourceImageHash: types.string(), optimizedQuality: types.string(), optimizedWidthPixels: types.string(), optimizedFormatMimeType: types.string(), vdcOperationOrigin: types.string(), entryName: types.string(), entryId: types.string(), entryItemId: types.string(), tagName: types.string(), cacheTags: types.string(), storeId: types.string(), storeName: types.string(), blobOperationType: types.string(), blobOperationLevel: types.string(), visitorId: types.string(), eventName: types.string(), attributionTarget: types.string(), attributionEventName: types.string(), metricName: types.string(), attributes: types.string(), flagKey: types.string(), flagVariant: types.string(), flagEvaluationReason: types.string(), flagClientName: types.string(), sdkKeyId: types.string(), sdkKeyEnvironment: types.string(), reportingProjectId: types.string(), reportingProjectName: types.string(), eventData: types.string(), middlewareAction: types.string(), middlewareActionTarget: types.string(), aiModel: types.string(), aiGatewayModelId: types.string(), aiProvider: types.string(), aiModelType: types.string(), servedSpeed: types.string(), virtualModelSlug: types.string(), virtualModelKind: types.string(), inferenceEndpointSlug: types.string(), inferenceScope: types.string(), inferenceGeoRegion: types.string(), inferenceProviderRegion: types.string(), requestedInferenceRegion: types.string(), costCurrency: types.string(), marketCostCurrency: types.string(), cachedInputTokensCurrency: types.string(), cacheCreationInputTokensCurrency: types.string(), cacheCreation1hInputTokensCurrency: types.string(), surchargeCostCurrency: types.string(), gatewayCostCurrency: types.string(), keyId: types.string(), keyName: types.string(), authMethod: types.string(), appName: types.string(), codingAgent: types.string(), isByok: types.string(), spendAttribution: types.string(), isPrivateModel: types.string(), isStreaming: types.string(), isRequestZdr: types.string(), hipaaRequested: types.string(), quotaRequested: types.string(), quotaEntityId: types.string(), quotaEntityType: types.string(), videoResolution: types.string(), videoAspectRatio: types.string(), piiRedactionApplied: types.string(), moderationApplied: types.string(), queueName: types.string(), consumerGroup: types.string(), messageId: types.string(), eventType: types.string(), notificationUrl: types.string(), queueRegion: types.string(), sandboxSessionId: types.string(), sandboxName: types.string(), workflowRunId: types.string(), workflowName: types.string(), workflowStatus: types.string(), stepRunId: types.string(), workflowStepName: types.string(), workflowEventType: types.string(), region: types.string(), specVersion: types.string(), contentType: types.string(), rewriteDestinationHostname: types.string(), externalRewriteTargetHost: types.string(), externalRewriteTargetPath: types.string(), commitSha: types.string(), reviewConclusion: types.string(), pullRequestNumber: types.string(), repositoryName: types.string(), repositoryOwner: types.string(), reviewStatus: types.string(), pullRequestState: types.string(), triggeringTag: types.string(), redirectLocation: types.string(), microfrontendsResponseReason: types.string(), microfrontendsMatchedPath: types.string(), microfrontendsDefaultAppDeploymentId: types.string(), microfrontendsDefaultAppProjectId: types.string(), service: types.string(), isPrefetchRequest: types.string(), spendReportGroupBy: types.string(), spendReportDatePart: types.string(), providerAttemptCanonicalSlug: types.string(), providerAttemptCredentialType: types.string(), providerAttemptSuccess: types.string(), providerAttemptStatusCode: types.string(), providerAttemptTimeout: types.string(), providerAttemptIsFinal: types.string(), providerAttemptNumber: types.string(), providerAttemptTotalInRequest: types.string(), generationId: types.string(), sessionId: types.string(), contentCaptureStatus: types.string(), contentCaptureInputs: types.string(), contentCaptureOutputs: types.string(), transcriptStatus: types.string(), transcriptInputs: types.string(), transcriptOutputs: types.string(), providerAttemptError: types.string(), providerAttemptSafetyIdentifier: types.string(), providerAttemptDevSafetyIdentifier: types.string(), providerAttemptRegion: types.string(), providerAttemptModelIndex: types.string(), toolCallType: types.string(), toolCallProvider: types.string(), toolCallSuccess: types.string(), toolCallErrorType: types.string(), toolCallStatusCode: types.string(), environmentId: types.string(), billableRegion: types.string(), direction: types.string(), networkTenancy: types.string(), trafficSource: types.string(), networkId: types.string(), privatelinkEndpointId: types.string(), privatelinkDnsName: types.string(), privatelinkIpAddress: types.string(), }).catchall(types.number()), "additionalProperties", true); export function data2FromJSON(jsonString) { return safeParse(jsonString, (x) => Data2$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Data2' from JSON`); } /** @internal */ export const Data1$inboundSchema = z .object({ projectId: types.optional(types.string()), country: types.optional(types.string()), deviceType: types.optional(types.string()), environment: types.optional(types.string()), requestPath: types.optional(types.string()), referrerHostname: types.optional(types.string()), osName: types.optional(types.string()), browserName: types.optional(types.string()), route: types.optional(types.string()), utmSource: types.optional(types.string()), utmMedium: types.optional(types.string()), utmCampaign: types.optional(types.string()), utmContent: types.optional(types.string()), utmTerm: types.optional(types.string()), flags: types.optional(types.string()), errorMessage: types.optional(types.string()), entryRevalidateSeconds: types.optional(types.string()), projectName: types.optional(types.string()), deploymentId: types.optional(types.string()), pathType: types.optional(types.string()), pathTypeVariant: types.optional(types.string()), requestHostname: types.optional(types.string()), requestResolvedIp: types.optional(types.string()), requestMethod: types.optional(types.string()), requestExtension: types.optional(types.string()), requestId: types.optional(types.string()), requestApi: types.optional(types.string()), referrerUrl: types.optional(types.string()), serverActionName: types.optional(types.string()), httpStatus: types.optional(types.string()), errorCode: types.optional(types.string()), source: types.optional(types.string()), edgeType: types.optional(types.string()), reason: types.optional(types.string()), edgeNetworkRegion: types.optional(types.string()), functionRegion: types.optional(types.string()), imageTransformationRegion: types.optional(types.string()), dataCacheRegion: types.optional(types.string()), cause: types.optional(types.string()), runtime: types.optional(types.string()), provider: types.optional(types.string()), isrCacheRegion: types.optional(types.string()), isrAction: types.optional(types.string()), cacheResult: types.optional(types.string()), cacheOperation: types.optional(types.string()), cacheHostname: types.optional(types.string()), cachePath: types.optional(types.string()), cacheHitState: types.optional(types.string()), cacheHitLevel: types.optional(types.string()), cacheApi: types.optional(types.string()), cacheReason: types.optional(types.string()), pprState: types.optional(types.string()), clientIp: types.optional(types.string()), clientIpCountry: types.optional(types.string()), clientUserAgent: types.optional(types.string()), httpAccept: types.optional(types.string()), clientJa4Digest: types.optional(types.string()), asnId: types.optional(types.string()), asnName: types.optional(types.string()), botName: types.optional(types.string()), botCategory: types.optional(types.string()), botCategoryLegacy: types.optional(types.string()), botVerified: types.optional(types.string()), botCheckResult: types.optional(types.string()), deepAnalysisCheck: types.optional(types.string()), wafAction: types.optional(types.string()), wafRuleId: types.optional(types.string()), ruleCategory: types.optional(types.string()), skewProtection: types.optional(types.string()), functionStartType: types.optional(types.string()), functionDispatcher: types.optional(types.string()), isAdditionalRequest: types.optional(types.string()), originHostname: types.optional(types.string()), originPath: types.optional(types.string()), originRoute: types.optional(types.string()), fetchType: types.optional(types.string()), fetchIndex: types.optional(types.string()), imageSource: types.optional(types.string()), sourceImage: types.optional(types.string()), sourceImagePathname: types.optional(types.string()), sourceImageHostname: types.optional(types.string()), sourceImageHash: types.optional(types.string()), optimizedQuality: types.optional(types.string()), optimizedWidthPixels: types.optional(types.string()), optimizedFormatMimeType: types.optional(types.string()), vdcOperationOrigin: types.optional(types.string()), entryName: types.optional(types.string()), entryId: types.optional(types.string()), entryItemId: types.optional(types.string()), tagName: types.optional(types.string()), cacheTags: types.optional(types.string()), storeId: types.optional(types.string()), storeName: types.optional(types.string()), blobOperationType: types.optional(types.string()), blobOperationLevel: types.optional(types.string()), visitorId: types.optional(types.string()), eventName: types.optional(types.string()), attributionTarget: types.optional(types.string()), attributionEventName: types.optional(types.string()), metricName: types.optional(types.string()), attributes: types.optional(types.string()), flagKey: types.optional(types.string()), flagVariant: types.optional(types.string()), flagEvaluationReason: types.optional(types.string()), flagClientName: types.optional(types.string()), sdkKeyId: types.optional(types.string()), sdkKeyEnvironment: types.optional(types.string()), reportingProjectId: types.optional(types.string()), reportingProjectName: types.optional(types.string()), eventData: types.optional(types.string()), middlewareAction: types.optional(types.string()), middlewareActionTarget: types.optional(types.string()), aiModel: types.optional(types.string()), aiGatewayModelId: types.optional(types.string()), aiProvider: types.optional(types.string()), aiModelType: types.optional(types.string()), servedSpeed: types.optional(types.string()), virtualModelSlug: types.optional(types.string()), virtualModelKind: types.optional(types.string()), inferenceEndpointSlug: types.optional(types.string()), inferenceScope: types.optional(types.string()), inferenceGeoRegion: types.optional(types.string()), inferenceProviderRegion: types.optional(types.string()), requestedInferenceRegion: types.optional(types.string()), costCurrency: types.optional(types.string()), marketCostCurrency: types.optional(types.string()), cachedInputTokensCurrency: types.optional(types.string()), cacheCreationInputTokensCurrency: types.optional(types.string()), cacheCreation1hInputTokensCurrency: types.optional(types.string()), surchargeCostCurrency: types.optional(types.string()), gatewayCostCurrency: types.optional(types.string()), keyId: types.optional(types.string()), keyName: types.optional(types.string()), authMethod: types.optional(types.string()), appName: types.optional(types.string()), codingAgent: types.optional(types.string()), isByok: types.optional(types.string()), spendAttribution: types.optional(types.string()), isPrivateModel: types.optional(types.string()), isStreaming: types.optional(types.string()), isRequestZdr: types.optional(types.string()), hipaaRequested: types.optional(types.string()), quotaRequested: types.optional(types.string()), quotaEntityId: types.optional(types.string()), quotaEntityType: types.optional(types.string()), videoResolution: types.optional(types.string()), videoAspectRatio: types.optional(types.string()), piiRedactionApplied: types.optional(types.string()), moderationApplied: types.optional(types.string()), queueName: types.optional(types.string()), consumerGroup: types.optional(types.string()), messageId: types.optional(types.string()), eventType: types.optional(types.string()), notificationUrl: types.optional(types.string()), queueRegion: types.optional(types.string()), sandboxSessionId: types.optional(types.string()), sandboxName: types.optional(types.string()), workflowRunId: types.optional(types.string()), workflowName: types.optional(types.string()), workflowStatus: types.optional(types.string()), stepRunId: types.optional(types.string()), workflowStepName: types.optional(types.string()), workflowEventType: types.optional(types.string()), region: types.optional(types.string()), specVersion: types.optional(types.string()), contentType: types.optional(types.string()), rewriteDestinationHostname: types.optional(types.string()), externalRewriteTargetHost: types.optional(types.string()), externalRewriteTargetPath: types.optional(types.string()), commitSha: types.optional(types.string()), reviewConclusion: types.optional(types.string()), pullRequestNumber: types.optional(types.string()), repositoryName: types.optional(types.string()), repositoryOwner: types.optional(types.string()), reviewStatus: types.optional(types.string()), pullRequestState: types.optional(types.string()), triggeringTag: types.optional(types.string()), redirectLocation: types.optional(types.string()), microfrontendsResponseReason: types.optional(types.string()), microfrontendsMatchedPath: types.optional(types.string()), microfrontendsDefaultAppDeploymentId: types.optional(types.string()), microfrontendsDefaultAppProjectId: types.optional(types.string()), service: types.optional(types.string()), isPrefetchRequest: types.optional(types.string()), spendReportGroupBy: types.optional(types.string()), spendReportDatePart: types.optional(types.string()), providerAttemptCanonicalSlug: types.optional(types.string()), providerAttemptCredentialType: types.optional(types.string()), providerAttemptSuccess: types.optional(types.string()), providerAttemptStatusCode: types.optional(types.string()), providerAttemptTimeout: types.optional(types.string()), providerAttemptIsFinal: types.optional(types.string()), providerAttemptNumber: types.optional(types.string()), providerAttemptTotalInRequest: types.optional(types.string()), generationId: types.optional(types.string()), sessionId: types.optional(types.string()), contentCaptureStatus: types.optional(types.string()), contentCaptureInputs: types.optional(types.string()), contentCaptureOutputs: types.optional(types.string()), transcriptStatus: types.optional(types.string()), transcriptInputs: types.optional(types.string()), transcriptOutputs: types.optional(types.string()), providerAttemptError: types.optional(types.string()), providerAttemptSafetyIdentifier: types.optional(types.string()), providerAttemptDevSafetyIdentifier: types.optional(types.string()), providerAttemptRegion: types.optional(types.string()), providerAttemptModelIndex: types.optional(types.string()), toolCallType: types.optional(types.string()), toolCallProvider: types.optional(types.string()), toolCallSuccess: types.optional(types.string()), toolCallErrorType: types.optional(types.string()), toolCallStatusCode: types.optional(types.string()), environmentId: types.optional(types.string()), billableRegion: types.optional(types.string()), direction: types.optional(types.string()), networkTenancy: types.optional(types.string()), trafficSource: types.optional(types.string()), networkId: types.optional(types.string()), privatelinkEndpointId: types.optional(types.string()), privatelinkDnsName: types.optional(types.string()), privatelinkIpAddress: types.optional(types.string()), timestamp: types.date(), }); export function data1FromJSON(jsonString) { return safeParse(jsonString, (x) => Data1$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Data1' from JSON`); } /** @internal */ export const AggregatePageviewsData$inboundSchema = smartUnion([ z.array(z.lazy(() => Data1$inboundSchema)), z.array(z.lazy(() => Data2$inboundSchema)), ]); export function aggregatePageviewsDataFromJSON(jsonString) { return safeParse(jsonString, (x) => AggregatePageviewsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AggregatePageviewsData' from JSON`); } /** @internal */ export const AggregatePageviewsResponseBody$inboundSchema = z.object({ version: types.number(), query: z.lazy(() => Query$inboundSchema), data: smartUnion([ z.array(z.lazy(() => Data1$inboundSchema)), z.array(z.lazy(() => Data2$inboundSchema)), ]), }); export function aggregatePageviewsResponseBodyFromJSON(jsonString) { return safeParse(jsonString, (x) => AggregatePageviewsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AggregatePageviewsResponseBody' from JSON`); } //# sourceMappingURL=aggregatepageviewsop.js.map