@launchdarkly/mcp-server 0.7.1 → 0.7.2

package/src/models/components/metricdenominatorrep.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Filter,
+  Filter$inboundSchema,
+  Filter$Outbound,
+  Filter$outboundSchema,
+} from "./filter.js";
+import {
+  MetricDataSourceRefRep,
+  MetricDataSourceRefRep$inboundSchema,
+  MetricDataSourceRefRep$Outbound,
+  MetricDataSourceRefRep$outboundSchema,
+} from "./metricdatasourcerefrep.js";
+
+export type MetricDenominatorRep = {
+  /**
+   * The warehouse event column for the denominator
+   */
+  eventName?: string | undefined;
+  /**
+   * Whether the denominator aggregates a numeric value
+   */
+  isNumeric?: boolean | undefined;
+  /**
+   * How individual unit values are aggregated for the denominator
+   */
+  unitAggregationType?: string | undefined;
+  /**
+   * The column to count distinct values of; required when unitAggregationType is count_distinct
+   */
+  unitAggregationField?: string | undefined;
+  /**
+   * For a numeric denominator, the column holding the numeric value
+   */
+  valueColumn?: string | undefined;
+  dataSource?: MetricDataSourceRefRep | undefined;
+  filters?: Filter | undefined;
+  /**
+   * Start of the measurement window in milliseconds
+   */
+  windowStartOffset?: number | undefined;
+  /**
+   * End of the measurement window in milliseconds
+   */
+  windowEndOffset?: number | undefined;
+  /**
+   * Lower winsorization percentile in the open interval (0, 100)
+   */
+  winsorLowerPercentile?: number | undefined;
+  /**
+   * Upper winsorization percentile in the open interval (0, 100)
+   */
+  winsorUpperPercentile?: number | undefined;
+  /**
+   * When true, the percentile bound calculation includes imputed zeros
+   */
+  winsorIncludeImputed?: boolean | undefined;
+};
+
+/** @internal */
+export const MetricDenominatorRep$inboundSchema: z.ZodType<
+  MetricDenominatorRep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  eventName: z.string().optional(),
+  isNumeric: z.boolean().optional(),
+  unitAggregationType: z.string().optional(),
+  unitAggregationField: z.string().optional(),
+  valueColumn: z.string().optional(),
+  dataSource: MetricDataSourceRefRep$inboundSchema.optional(),
+  filters: Filter$inboundSchema.optional(),
+  windowStartOffset: z.number().int().optional(),
+  windowEndOffset: z.number().int().optional(),
+  winsorLowerPercentile: z.number().optional(),
+  winsorUpperPercentile: z.number().optional(),
+  winsorIncludeImputed: z.boolean().optional(),
+});
+/** @internal */
+export type MetricDenominatorRep$Outbound = {
+  eventName?: string | undefined;
+  isNumeric?: boolean | undefined;
+  unitAggregationType?: string | undefined;
+  unitAggregationField?: string | undefined;
+  valueColumn?: string | undefined;
+  dataSource?: MetricDataSourceRefRep$Outbound | undefined;
+  filters?: Filter$Outbound | undefined;
+  windowStartOffset?: number | undefined;
+  windowEndOffset?: number | undefined;
+  winsorLowerPercentile?: number | undefined;
+  winsorUpperPercentile?: number | undefined;
+  winsorIncludeImputed?: boolean | undefined;
+};
+
+/** @internal */
+export const MetricDenominatorRep$outboundSchema: z.ZodType<
+  MetricDenominatorRep$Outbound,
+  z.ZodTypeDef,
+  MetricDenominatorRep
+> = z.object({
+  eventName: z.string().optional(),
+  isNumeric: z.boolean().optional(),
+  unitAggregationType: z.string().optional(),
+  unitAggregationField: z.string().optional(),
+  valueColumn: z.string().optional(),
+  dataSource: MetricDataSourceRefRep$outboundSchema.optional(),
+  filters: Filter$outboundSchema.optional(),
+  windowStartOffset: z.number().int().optional(),
+  windowEndOffset: z.number().int().optional(),
+  winsorLowerPercentile: z.number().optional(),
+  winsorUpperPercentile: z.number().optional(),
+  winsorIncludeImputed: z.boolean().optional(),
+});
+
+export function metricDenominatorRepToJSON(
+  metricDenominatorRep: MetricDenominatorRep,
+): string {
+  return JSON.stringify(
+    MetricDenominatorRep$outboundSchema.parse(metricDenominatorRep),
+  );
+}
+export function metricDenominatorRepFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricDenominatorRep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricDenominatorRep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricDenominatorRep' from JSON`,
+  );
+}

package/src/models/components/metricingrouprep.ts

@@ -0,0 +1,230 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Link,
+  Link$inboundSchema,
+  Link$Outbound,
+  Link$outboundSchema,
+} from "./link.js";
+
+/**
+ * The kind of event the metric tracks
+ */
+export const MetricInGroupRepKind = {
+  Pageview: "pageview",
+  Click: "click",
+  Custom: "custom",
+  Trace: "trace",
+} as const;
+/**
+ * The kind of event the metric tracks
+ */
+export type MetricInGroupRepKind = ClosedEnum<typeof MetricInGroupRepKind>;
+
+/**
+ * The type of unit aggregation to use for the metric
+ */
+export const MetricInGroupRepUnitAggregationType = {
+  Sum: "sum",
+  Average: "average",
+  CountDistinct: "count_distinct",
+} as const;
+/**
+ * The type of unit aggregation to use for the metric
+ */
+export type MetricInGroupRepUnitAggregationType = ClosedEnum<
+  typeof MetricInGroupRepUnitAggregationType
+>;
+
+/**
+ * The method for analyzing metric events
+ */
+export const MetricInGroupRepAnalysisType = {
+  Mean: "mean",
+  Percentile: "percentile",
+} as const;
+/**
+ * The method for analyzing metric events
+ */
+export type MetricInGroupRepAnalysisType = ClosedEnum<
+  typeof MetricInGroupRepAnalysisType
+>;
+
+export type MetricInGroupRep = {
+  /**
+   * The metric key
+   */
+  key: string;
+  /**
+   * The version ID of the metric
+   */
+  versionId?: string | undefined;
+  /**
+   * The metric name
+   */
+  name: string;
+  /**
+   * The kind of event the metric tracks
+   */
+  kind: MetricInGroupRepKind;
+  /**
+   * For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
+   */
+  isNumeric?: boolean | undefined;
+  /**
+   * The type of unit aggregation to use for the metric
+   */
+  unitAggregationType?: MetricInGroupRepUnitAggregationType | undefined;
+  /**
+   * The method for analyzing metric events
+   */
+  analysisType?: MetricInGroupRepAnalysisType | undefined;
+  /**
+   * The event key sent with the metric. Only relevant for custom metrics.
+   */
+  eventKey?: string | undefined;
+  /**
+   * The context kind used as the analysis unit for this metric in the experiment iteration
+   */
+  analysisUnit?: string | undefined;
+  /**
+   * The location and content type of related resources
+   */
+  links: { [k: string]: Link };
+  /**
+   * Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
+   */
+  nameInGroup?: string | undefined;
+  /**
+   * Deprecated, use <code>analysisUnits</code> instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  randomizationUnits?: Array<string> | undefined;
+  /**
+   * An array of analysis units allowed for this metric.
+   */
+  analysisUnits?: Array<string> | undefined;
+};
+
+/** @internal */
+export const MetricInGroupRepKind$inboundSchema: z.ZodNativeEnum<
+  typeof MetricInGroupRepKind
+> = z.nativeEnum(MetricInGroupRepKind);
+/** @internal */
+export const MetricInGroupRepKind$outboundSchema: z.ZodNativeEnum<
+  typeof MetricInGroupRepKind
+> = MetricInGroupRepKind$inboundSchema;
+
+/** @internal */
+export const MetricInGroupRepUnitAggregationType$inboundSchema: z.ZodNativeEnum<
+  typeof MetricInGroupRepUnitAggregationType
+> = z.nativeEnum(MetricInGroupRepUnitAggregationType);
+/** @internal */
+export const MetricInGroupRepUnitAggregationType$outboundSchema:
+  z.ZodNativeEnum<typeof MetricInGroupRepUnitAggregationType> =
+    MetricInGroupRepUnitAggregationType$inboundSchema;
+
+/** @internal */
+export const MetricInGroupRepAnalysisType$inboundSchema: z.ZodNativeEnum<
+  typeof MetricInGroupRepAnalysisType
+> = z.nativeEnum(MetricInGroupRepAnalysisType);
+/** @internal */
+export const MetricInGroupRepAnalysisType$outboundSchema: z.ZodNativeEnum<
+  typeof MetricInGroupRepAnalysisType
+> = MetricInGroupRepAnalysisType$inboundSchema;
+
+/** @internal */
+export const MetricInGroupRep$inboundSchema: z.ZodType<
+  MetricInGroupRep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  _versionId: z.string().optional(),
+  name: z.string(),
+  kind: MetricInGroupRepKind$inboundSchema,
+  isNumeric: z.boolean().optional(),
+  unitAggregationType: MetricInGroupRepUnitAggregationType$inboundSchema
+    .optional(),
+  analysisType: MetricInGroupRepAnalysisType$inboundSchema.optional(),
+  eventKey: z.string().optional(),
+  analysisUnit: z.string().optional(),
+  _links: z.record(Link$inboundSchema),
+  nameInGroup: z.string().optional(),
+  randomizationUnits: z.array(z.string()).optional(),
+  analysisUnits: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_versionId": "versionId",
+    "_links": "links",
+  });
+});
+/** @internal */
+export type MetricInGroupRep$Outbound = {
+  key: string;
+  _versionId?: string | undefined;
+  name: string;
+  kind: string;
+  isNumeric?: boolean | undefined;
+  unitAggregationType?: string | undefined;
+  analysisType?: string | undefined;
+  eventKey?: string | undefined;
+  analysisUnit?: string | undefined;
+  _links: { [k: string]: Link$Outbound };
+  nameInGroup?: string | undefined;
+  randomizationUnits?: Array<string> | undefined;
+  analysisUnits?: Array<string> | undefined;
+};
+
+/** @internal */
+export const MetricInGroupRep$outboundSchema: z.ZodType<
+  MetricInGroupRep$Outbound,
+  z.ZodTypeDef,
+  MetricInGroupRep
+> = z.object({
+  key: z.string(),
+  versionId: z.string().optional(),
+  name: z.string(),
+  kind: MetricInGroupRepKind$outboundSchema,
+  isNumeric: z.boolean().optional(),
+  unitAggregationType: MetricInGroupRepUnitAggregationType$outboundSchema
+    .optional(),
+  analysisType: MetricInGroupRepAnalysisType$outboundSchema.optional(),
+  eventKey: z.string().optional(),
+  analysisUnit: z.string().optional(),
+  links: z.record(Link$outboundSchema),
+  nameInGroup: z.string().optional(),
+  randomizationUnits: z.array(z.string()).optional(),
+  analysisUnits: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    versionId: "_versionId",
+    links: "_links",
+  });
+});
+
+export function metricInGroupRepToJSON(
+  metricInGroupRep: MetricInGroupRep,
+): string {
+  return JSON.stringify(
+    MetricInGroupRep$outboundSchema.parse(metricInGroupRep),
+  );
+}
+export function metricInGroupRepFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricInGroupRep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricInGroupRep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricInGroupRep' from JSON`,
+  );
+}

package/src/models/components/metricinput.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MetricInput = {
+  /**
+   * The metric key
+   */
+  key: string;
+  /**
+   * Whether this is a metric group (true) or a metric (false). Defaults to false
+   */
+  isGroup?: boolean | undefined;
+  /**
+   * Deprecated, use <code>primarySingleMetricKey</code> and <code>primaryFunnelKey</code>. Whether this is a primary metric (true) or a secondary metric (false)
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  primary?: boolean | undefined;
+  /**
+   * The analysis unit to use for this metric. If omitted, analysis uses the iteration's randomization unit.
+   */
+  analysisUnit?: string | undefined;
+};
+
+/** @internal */
+export const MetricInput$inboundSchema: z.ZodType<
+  MetricInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  isGroup: z.boolean().optional(),
+  primary: z.boolean().optional(),
+  analysisUnit: z.string().optional(),
+});
+/** @internal */
+export type MetricInput$Outbound = {
+  key: string;
+  isGroup?: boolean | undefined;
+  primary?: boolean | undefined;
+  analysisUnit?: string | undefined;
+};
+
+/** @internal */
+export const MetricInput$outboundSchema: z.ZodType<
+  MetricInput$Outbound,
+  z.ZodTypeDef,
+  MetricInput
+> = z.object({
+  key: z.string(),
+  isGroup: z.boolean().optional(),
+  primary: z.boolean().optional(),
+  analysisUnit: z.string().optional(),
+});
+
+export function metricInputToJSON(metricInput: MetricInput): string {
+  return JSON.stringify(MetricInput$outboundSchema.parse(metricInput));
+}
+export function metricInputFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricInput' from JSON`,
+  );
+}

package/src/models/components/metriclistingrep.ts

@@ -38,6 +38,12 @@ import {
   MetricDataSourceRefRep$Outbound,
   MetricDataSourceRefRep$outboundSchema,
 } from "./metricdatasourcerefrep.js";
+import {
+  MetricDenominatorRep,
+  MetricDenominatorRep$inboundSchema,
+  MetricDenominatorRep$Outbound,
+  MetricDenominatorRep$outboundSchema,
+} from "./metricdenominatorrep.js";
 import {
   MetricEventDefaultRep,
   MetricEventDefaultRep$inboundSchema,
@@ -58,6 +64,7 @@ export const MetricListingRepKind = {
   Pageview: "pageview",
   Click: "click",
   Custom: "custom",
+  Trace: "trace",
 } as const;
 /**
  * The kind of event the metric tracks
@@ -65,14 +72,14 @@ export const MetricListingRepKind = {
 export type MetricListingRepKind = ClosedEnum<typeof MetricListingRepKind>;
 
 /**
- * For custom metrics, the success criteria
+ * For custom and trace metrics, the success criteria
  */
 export const MetricListingRepSuccessCriteria = {
   HigherThanBaseline: "HigherThanBaseline",
   LowerThanBaseline: "LowerThanBaseline",
 } as const;
 /**
- * For custom metrics, the success criteria
+ * For custom and trace metrics, the success criteria
  */
 export type MetricListingRepSuccessCriteria = ClosedEnum<
   typeof MetricListingRepSuccessCriteria
@@ -84,6 +91,7 @@ export type MetricListingRepSuccessCriteria = ClosedEnum<
 export const MetricListingRepUnitAggregationType = {
   Average: "average",
   Sum: "sum",
+  CountDistinct: "count_distinct",
 } as const;
 /**
  * The method by which multiple unit event values are aggregated
@@ -177,15 +185,15 @@ export type MetricListingRep = {
    */
   category?: string | undefined;
   /**
-   * For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
+   * For custom and trace metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
    */
   isNumeric?: boolean | undefined;
   /**
-   * For custom metrics, the success criteria
+   * For custom and trace metrics, the success criteria
    */
   successCriteria?: MetricListingRepSuccessCriteria | undefined;
   /**
-   * For numeric custom metrics, the unit of measure
+   * For numeric custom and trace metrics, the unit of measure
    */
   unit?: string | undefined;
   /**
@@ -193,9 +201,15 @@ export type MetricListingRep = {
    */
   eventKey?: string | undefined;
   /**
-   * An array of randomization units allowed for this metric
+   * Deprecated, use <code>analysisUnits</code> instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   randomizationUnits?: Array<string> | undefined;
+  /**
+   * An array of analysis units allowed for this metric.
+   */
+  analysisUnits?: Array<string> | undefined;
   filters?: Filter | undefined;
   /**
    * The method by which multiple unit event values are aggregated
@@ -222,6 +236,39 @@ export type MetricListingRep = {
    */
   selector?: string | undefined;
   urls?: Array<{ [k: string]: any }> | undefined;
+  /**
+   * Not yet implemented - The start of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation
+   */
+  windowStartOffset?: number | undefined;
+  /**
+   * Not yet implemented - The end of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation
+   */
+  windowEndOffset?: number | undefined;
+  /**
+   * Lower winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, defines a two-sided clamp range. Otherwise lower-only winsorization.
+   */
+  winsorLowerPercentile?: number | undefined;
+  /**
+   * Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile.
+   */
+  winsorUpperPercentile?: number | undefined;
+  /**
+   * When true, the percentile bound calculation includes imputed zeros. Only meaningful when at least one bound is set and the metric includes units that didn't send events.
+   */
+  winsorIncludeImputed?: boolean | undefined;
+  /**
+   * For trace metrics, the trace query to use for the metric.
+   */
+  traceQuery?: string | undefined;
+  /**
+   * For trace metrics, the location in the trace to use for numeric values.
+   */
+  traceValueLocation?: string | undefined;
+  /**
+   * For count_distinct metrics, the column to count distinct values of
+   */
+  unitAggregationField?: string | undefined;
+  denominator?: MetricDenominatorRep | undefined;
 };
 
 /** @internal */
@@ -292,6 +339,7 @@ export const MetricListingRep$inboundSchema: z.ZodType<
   unit: z.string().optional(),
   eventKey: z.string().optional(),
   randomizationUnits: z.array(z.string()).optional(),
+  analysisUnits: z.array(z.string()).optional(),
   filters: Filter$inboundSchema.optional(),
   unitAggregationType: MetricListingRepUnitAggregationType$inboundSchema
     .optional(),
@@ -304,6 +352,15 @@ export const MetricListingRep$inboundSchema: z.ZodType<
   archivedAt: z.number().int().optional(),
   selector: z.string().optional(),
   urls: z.array(z.record(z.any())).optional(),
+  windowStartOffset: z.number().int().optional(),
+  windowEndOffset: z.number().int().optional(),
+  winsorLowerPercentile: z.number().optional(),
+  winsorUpperPercentile: z.number().optional(),
+  winsorIncludeImputed: z.boolean().optional(),
+  traceQuery: z.string().optional(),
+  traceValueLocation: z.string().optional(),
+  unitAggregationField: z.string().optional(),
+  denominator: MetricDenominatorRep$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -345,6 +402,7 @@ export type MetricListingRep$Outbound = {
   unit?: string | undefined;
   eventKey?: string | undefined;
   randomizationUnits?: Array<string> | undefined;
+  analysisUnits?: Array<string> | undefined;
   filters?: Filter$Outbound | undefined;
   unitAggregationType?: string | undefined;
   analysisType?: string | undefined;
@@ -356,6 +414,15 @@ export type MetricListingRep$Outbound = {
   archivedAt?: number | undefined;
   selector?: string | undefined;
   urls?: Array<{ [k: string]: any }> | undefined;
+  windowStartOffset?: number | undefined;
+  windowEndOffset?: number | undefined;
+  winsorLowerPercentile?: number | undefined;
+  winsorUpperPercentile?: number | undefined;
+  winsorIncludeImputed?: boolean | undefined;
+  traceQuery?: string | undefined;
+  traceValueLocation?: string | undefined;
+  unitAggregationField?: string | undefined;
+  denominator?: MetricDenominatorRep$Outbound | undefined;
 };
 
 /** @internal */
@@ -390,6 +457,7 @@ export const MetricListingRep$outboundSchema: z.ZodType<
   unit: z.string().optional(),
   eventKey: z.string().optional(),
   randomizationUnits: z.array(z.string()).optional(),
+  analysisUnits: z.array(z.string()).optional(),
   filters: Filter$outboundSchema.optional(),
   unitAggregationType: MetricListingRepUnitAggregationType$outboundSchema
     .optional(),
@@ -402,6 +470,15 @@ export const MetricListingRep$outboundSchema: z.ZodType<
   archivedAt: z.number().int().optional(),
   selector: z.string().optional(),
   urls: z.array(z.record(z.any())).optional(),
+  windowStartOffset: z.number().int().optional(),
+  windowEndOffset: z.number().int().optional(),
+  winsorLowerPercentile: z.number().optional(),
+  winsorUpperPercentile: z.number().optional(),
+  winsorIncludeImputed: z.boolean().optional(),
+  traceQuery: z.string().optional(),
+  traceValueLocation: z.string().optional(),
+  unitAggregationField: z.string().optional(),
+  denominator: MetricDenominatorRep$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",