@launchdarkly/mcp-server 0.7.0 → 0.7.2

package/src/models/components/iterationrep.ts

@@ -0,0 +1,247 @@
+/*
+ * 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 {
+  CovariateInfoRep,
+  CovariateInfoRep$inboundSchema,
+  CovariateInfoRep$Outbound,
+  CovariateInfoRep$outboundSchema,
+} from "./covariateinforep.js";
+import {
+  DependentMetricGroupRepWithMetrics,
+  DependentMetricGroupRepWithMetrics$inboundSchema,
+  DependentMetricGroupRepWithMetrics$Outbound,
+  DependentMetricGroupRepWithMetrics$outboundSchema,
+} from "./dependentmetricgrouprepwithmetrics.js";
+import {
+  DependentMetricOrMetricGroupRep,
+  DependentMetricOrMetricGroupRep$inboundSchema,
+  DependentMetricOrMetricGroupRep$Outbound,
+  DependentMetricOrMetricGroupRep$outboundSchema,
+} from "./dependentmetricormetricgrouprep.js";
+import {
+  FlagRep,
+  FlagRep$inboundSchema,
+  FlagRep$Outbound,
+  FlagRep$outboundSchema,
+} from "./flagrep.js";
+import {
+  LayerSnapshotRep,
+  LayerSnapshotRep$inboundSchema,
+  LayerSnapshotRep$Outbound,
+  LayerSnapshotRep$outboundSchema,
+} from "./layersnapshotrep.js";
+import {
+  MetricV2Rep,
+  MetricV2Rep$inboundSchema,
+  MetricV2Rep$Outbound,
+  MetricV2Rep$outboundSchema,
+} from "./metricv2rep.js";
+import {
+  TreatmentRep,
+  TreatmentRep$inboundSchema,
+  TreatmentRep$Outbound,
+  TreatmentRep$outboundSchema,
+} from "./treatmentrep.js";
+
+/**
+ * The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
+ */
+export const Status = {
+  NotStarted: "not_started",
+  Running: "running",
+  Stopped: "stopped",
+} as const;
+/**
+ * The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+export type IterationRep = {
+  /**
+   * The iteration ID
+   */
+  id?: string | undefined;
+  /**
+   * The expected outcome of this experiment
+   */
+  hypothesis?: string | undefined;
+  /**
+   * The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
+   */
+  status: Status;
+  createdAt: number;
+  startedAt?: number | undefined;
+  endedAt?: number | undefined;
+  /**
+   * The ID of the treatment chosen when the experiment stopped
+   */
+  winningTreatmentId?: string | undefined;
+  /**
+   * The reason you stopped the experiment
+   */
+  winningReason?: string | undefined;
+  /**
+   * Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).
+   */
+  canReshuffleTraffic?: boolean | undefined;
+  /**
+   * Details on the flag used in this experiment
+   */
+  flags?: { [k: string]: FlagRep } | undefined;
+  /**
+   * The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.
+   */
+  reallocationFrequencyMillis?: number | undefined;
+  /**
+   * The current version that the iteration is on
+   */
+  version?: number | undefined;
+  primaryMetric?: DependentMetricOrMetricGroupRep | undefined;
+  primarySingleMetric?: MetricV2Rep | undefined;
+  primaryFunnel?: DependentMetricGroupRepWithMetrics | undefined;
+  /**
+   * The unit of randomization for this iteration
+   */
+  randomizationUnit?: string | undefined;
+  /**
+   * The available attribute filters for this iteration
+   */
+  attributes?: Array<string> | undefined;
+  /**
+   * Details on the variations you are testing in the experiment
+   */
+  treatments?: Array<TreatmentRep> | undefined;
+  /**
+   * Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  secondaryMetrics?: Array<MetricV2Rep> | undefined;
+  /**
+   * Details on the metrics for this experiment
+   */
+  metrics?: Array<DependentMetricOrMetricGroupRep> | undefined;
+  layerSnapshot?: LayerSnapshotRep | undefined;
+  covariateInfo?: CovariateInfoRep | undefined;
+};
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
+
+/** @internal */
+export const IterationRep$inboundSchema: z.ZodType<
+  IterationRep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  hypothesis: z.string().optional(),
+  status: Status$inboundSchema,
+  createdAt: z.number().int(),
+  startedAt: z.number().int().optional(),
+  endedAt: z.number().int().optional(),
+  winningTreatmentId: z.string().optional(),
+  winningReason: z.string().optional(),
+  canReshuffleTraffic: z.boolean().optional(),
+  flags: z.record(FlagRep$inboundSchema).optional(),
+  reallocationFrequencyMillis: z.number().int().optional(),
+  version: z.number().int().optional(),
+  primaryMetric: DependentMetricOrMetricGroupRep$inboundSchema.optional(),
+  primarySingleMetric: MetricV2Rep$inboundSchema.optional(),
+  primaryFunnel: DependentMetricGroupRepWithMetrics$inboundSchema.optional(),
+  randomizationUnit: z.string().optional(),
+  attributes: z.array(z.string()).optional(),
+  treatments: z.array(TreatmentRep$inboundSchema).optional(),
+  secondaryMetrics: z.array(MetricV2Rep$inboundSchema).optional(),
+  metrics: z.array(DependentMetricOrMetricGroupRep$inboundSchema).optional(),
+  layerSnapshot: LayerSnapshotRep$inboundSchema.optional(),
+  covariateInfo: CovariateInfoRep$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+/** @internal */
+export type IterationRep$Outbound = {
+  _id?: string | undefined;
+  hypothesis?: string | undefined;
+  status: string;
+  createdAt: number;
+  startedAt?: number | undefined;
+  endedAt?: number | undefined;
+  winningTreatmentId?: string | undefined;
+  winningReason?: string | undefined;
+  canReshuffleTraffic?: boolean | undefined;
+  flags?: { [k: string]: FlagRep$Outbound } | undefined;
+  reallocationFrequencyMillis?: number | undefined;
+  version?: number | undefined;
+  primaryMetric?: DependentMetricOrMetricGroupRep$Outbound | undefined;
+  primarySingleMetric?: MetricV2Rep$Outbound | undefined;
+  primaryFunnel?: DependentMetricGroupRepWithMetrics$Outbound | undefined;
+  randomizationUnit?: string | undefined;
+  attributes?: Array<string> | undefined;
+  treatments?: Array<TreatmentRep$Outbound> | undefined;
+  secondaryMetrics?: Array<MetricV2Rep$Outbound> | undefined;
+  metrics?: Array<DependentMetricOrMetricGroupRep$Outbound> | undefined;
+  layerSnapshot?: LayerSnapshotRep$Outbound | undefined;
+  covariateInfo?: CovariateInfoRep$Outbound | undefined;
+};
+
+/** @internal */
+export const IterationRep$outboundSchema: z.ZodType<
+  IterationRep$Outbound,
+  z.ZodTypeDef,
+  IterationRep
+> = z.object({
+  id: z.string().optional(),
+  hypothesis: z.string().optional(),
+  status: Status$outboundSchema,
+  createdAt: z.number().int(),
+  startedAt: z.number().int().optional(),
+  endedAt: z.number().int().optional(),
+  winningTreatmentId: z.string().optional(),
+  winningReason: z.string().optional(),
+  canReshuffleTraffic: z.boolean().optional(),
+  flags: z.record(FlagRep$outboundSchema).optional(),
+  reallocationFrequencyMillis: z.number().int().optional(),
+  version: z.number().int().optional(),
+  primaryMetric: DependentMetricOrMetricGroupRep$outboundSchema.optional(),
+  primarySingleMetric: MetricV2Rep$outboundSchema.optional(),
+  primaryFunnel: DependentMetricGroupRepWithMetrics$outboundSchema.optional(),
+  randomizationUnit: z.string().optional(),
+  attributes: z.array(z.string()).optional(),
+  treatments: z.array(TreatmentRep$outboundSchema).optional(),
+  secondaryMetrics: z.array(MetricV2Rep$outboundSchema).optional(),
+  metrics: z.array(DependentMetricOrMetricGroupRep$outboundSchema).optional(),
+  layerSnapshot: LayerSnapshotRep$outboundSchema.optional(),
+  covariateInfo: CovariateInfoRep$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+export function iterationRepToJSON(iterationRep: IterationRep): string {
+  return JSON.stringify(IterationRep$outboundSchema.parse(iterationRep));
+}
+export function iterationRepFromJSON(
+  jsonString: string,
+): SafeParseResult<IterationRep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IterationRep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IterationRep' from JSON`,
+  );
+}

package/src/models/components/judgeattachment.ts

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type JudgeAttachment = {
   /**
-   * Key of the judge AI Config
+   * Judge config key
    */
   judgeConfigKey: string;
   /**

package/src/models/components/layersnapshotrep.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 LayerSnapshotRep = {
+  /**
+   * Key of the layer the experiment was part of
+   */
+  key: string;
+  /**
+   * Layer name at the time this experiment iteration was stopped
+   */
+  name: string;
+  /**
+   * Percent of layer traffic that was reserved in the layer for this experiment iteration
+   */
+  reservationPercent: number;
+  /**
+   * Percent of layer traffic that was reserved for other experiments in the same environment, when this experiment iteration was stopped
+   */
+  otherReservationPercent: number;
+};
+
+/** @internal */
+export const LayerSnapshotRep$inboundSchema: z.ZodType<
+  LayerSnapshotRep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  name: z.string(),
+  reservationPercent: z.number().int(),
+  otherReservationPercent: z.number().int(),
+});
+/** @internal */
+export type LayerSnapshotRep$Outbound = {
+  key: string;
+  name: string;
+  reservationPercent: number;
+  otherReservationPercent: number;
+};
+
+/** @internal */
+export const LayerSnapshotRep$outboundSchema: z.ZodType<
+  LayerSnapshotRep$Outbound,
+  z.ZodTypeDef,
+  LayerSnapshotRep
+> = z.object({
+  key: z.string(),
+  name: z.string(),
+  reservationPercent: z.number().int(),
+  otherReservationPercent: z.number().int(),
+});
+
+export function layerSnapshotRepToJSON(
+  layerSnapshotRep: LayerSnapshotRep,
+): string {
+  return JSON.stringify(
+    LayerSnapshotRep$outboundSchema.parse(layerSnapshotRep),
+  );
+}
+export function layerSnapshotRepFromJSON(
+  jsonString: string,
+): SafeParseResult<LayerSnapshotRep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LayerSnapshotRep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LayerSnapshotRep' from JSON`,
+  );
+}

package/src/models/components/message.ts

@@ -8,7 +8,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Message = {
+  /**
+   * The message text
+   */
   content: string;
+  /**
+   * The message role, such as system, user, or assistant
+   */
   role: string;
 };
 

package/src/models/components/metriccollectionrep.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Link,
+  Link$inboundSchema,
+  Link$Outbound,
+  Link$outboundSchema,
+} from "./link.js";
+import {
+  MetricListingRep,
+  MetricListingRep$inboundSchema,
+  MetricListingRep$Outbound,
+  MetricListingRep$outboundSchema,
+} from "./metriclistingrep.js";
+
+export type MetricCollectionRep = {
+  /**
+   * An array of metrics
+   */
+  items?: Array<MetricListingRep> | undefined;
+  /**
+   * The location and content type of related resources
+   */
+  links?: { [k: string]: Link } | undefined;
+  totalCount?: number | undefined;
+};
+
+/** @internal */
+export const MetricCollectionRep$inboundSchema: z.ZodType<
+  MetricCollectionRep,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(MetricListingRep$inboundSchema).optional(),
+  _links: z.record(Link$inboundSchema).optional(),
+  totalCount: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type MetricCollectionRep$Outbound = {
+  items?: Array<MetricListingRep$Outbound> | undefined;
+  _links?: { [k: string]: Link$Outbound } | undefined;
+  totalCount?: number | undefined;
+};
+
+/** @internal */
+export const MetricCollectionRep$outboundSchema: z.ZodType<
+  MetricCollectionRep$Outbound,
+  z.ZodTypeDef,
+  MetricCollectionRep
+> = z.object({
+  items: z.array(MetricListingRep$outboundSchema).optional(),
+  links: z.record(Link$outboundSchema).optional(),
+  totalCount: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function metricCollectionRepToJSON(
+  metricCollectionRep: MetricCollectionRep,
+): string {
+  return JSON.stringify(
+    MetricCollectionRep$outboundSchema.parse(metricCollectionRep),
+  );
+}
+export function metricCollectionRepFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricCollectionRep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricCollectionRep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricCollectionRep' from JSON`,
+  );
+}

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`,
+  );
+}