@launchdarkly/mcp-server 0.7.1 → 0.7.2

package/src/funcs/metricsCreate.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LaunchDarklyCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { LaunchDarklyError } from "../models/errors/launchdarklyerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Create metric
+ *
+ * @remarks
+ * Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property.
+ */
+export function metricsCreate(
+  client: LaunchDarklyCore,
+  request: operations.PostMetricRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.MetricRep,
+    | errors.InvalidRequestErrorRep
+    | errors.UnauthorizedErrorRep
+    | errors.ForbiddenErrorRep
+    | errors.NotFoundErrorRep
+    | errors.StatusConflictErrorRep
+    | errors.RateLimitedErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LaunchDarklyCore,
+  request: operations.PostMetricRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.MetricRep,
+      | errors.InvalidRequestErrorRep
+      | errors.UnauthorizedErrorRep
+      | errors.ForbiddenErrorRep
+      | errors.NotFoundErrorRep
+      | errors.StatusConflictErrorRep
+      | errors.RateLimitedErrorRep
+      | LaunchDarklyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.PostMetricRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.MetricPost, { explode: true });
+
+  const pathParams = {
+    projectKey: encodeSimple("projectKey", payload.projectKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v2/metrics/{projectKey}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "postMetric",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "409", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.MetricRep,
+    | errors.InvalidRequestErrorRep
+    | errors.UnauthorizedErrorRep
+    | errors.ForbiddenErrorRep
+    | errors.NotFoundErrorRep
+    | errors.StatusConflictErrorRep
+    | errors.RateLimitedErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, components.MetricRep$inboundSchema),
+    M.jsonErr(400, errors.InvalidRequestErrorRep$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema),
+    M.jsonErr(403, errors.ForbiddenErrorRep$inboundSchema),
+    M.jsonErr(404, errors.NotFoundErrorRep$inboundSchema),
+    M.jsonErr(409, errors.StatusConflictErrorRep$inboundSchema),
+    M.jsonErr(429, errors.RateLimitedErrorRep$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/metricsGet.ts

@@ -0,0 +1,212 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LaunchDarklyCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { LaunchDarklyError } from "../models/errors/launchdarklyerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get metric
+ *
+ * @remarks
+ * Get information for a single metric from the specific project.
+ *
+ * ### Expanding the metric response
+ * LaunchDarkly supports four fields for expanding the "Get metric" response. By default, these fields are **not** included in the response.
+ *
+ * To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields:
+ *
+ * - `experiments` includes all experiments from the specific project that use the metric
+ * - `experimentCount` includes the number of experiments from the specific project that use the metric
+ * - `metricGroups` includes all metric groups from the specific project that use the metric
+ * - `metricGroupCount` includes the number of metric groups from the specific project that use the metric
+ *
+ * For example, `expand=experiments` includes the `experiments` field in the response.
+ */
+export function metricsGet(
+  client: LaunchDarklyCore,
+  request: operations.GetMetricRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.MetricRep,
+    | errors.UnauthorizedErrorRep
+    | errors.ForbiddenErrorRep
+    | errors.NotFoundErrorRep
+    | errors.RateLimitedErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LaunchDarklyCore,
+  request: operations.GetMetricRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.MetricRep,
+      | errors.UnauthorizedErrorRep
+      | errors.ForbiddenErrorRep
+      | errors.NotFoundErrorRep
+      | errors.RateLimitedErrorRep
+      | LaunchDarklyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetMetricRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    metricKey: encodeSimple("metricKey", payload.metricKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    projectKey: encodeSimple("projectKey", payload.projectKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v2/metrics/{projectKey}/{metricKey}")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+    "versionId": payload.versionId,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getMetric",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "404", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.MetricRep,
+    | errors.UnauthorizedErrorRep
+    | errors.ForbiddenErrorRep
+    | errors.NotFoundErrorRep
+    | errors.RateLimitedErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.MetricRep$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema),
+    M.jsonErr(403, errors.ForbiddenErrorRep$inboundSchema),
+    M.jsonErr(404, errors.NotFoundErrorRep$inboundSchema),
+    M.jsonErr(429, errors.RateLimitedErrorRep$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/metricsList.ts

@@ -0,0 +1,229 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LaunchDarklyCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { LaunchDarklyError } from "../models/errors/launchdarklyerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List metrics
+ *
+ * @remarks
+ * Get a list of all metrics for the specified project.
+ *
+ * ### Filtering metrics
+ *
+ * The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`.
+ *
+ * #### Supported fields and operators
+ *
+ * You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators.
+ *
+ * When you search for metrics, the `filter` parameter supports the following fields and operators:
+ *
+ * |<div style="width:120px">Field</div> |Description |Supported operators |
+ * |---|---|---|
+ * | `dataSourceKeys` | The data source that provides events for this metric (for example, "launchdarkly-hosted"). | `anyOf`, `notEquals` |
+ * | `eventKeys` | The metric event key. | `anyOf` |
+ * | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` |
+ * | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` |
+ * | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` |
+ * | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` |
+ * | `maintainerTeamKey` | The metric maintainer team key. | `equals` |
+ * | `metricUsedIn` | Filter by where the metric is used. One of `experiments`, `guarded_rollouts`, `any`, `none`. | `equals` |
+ * | `query` | A "fuzzy" search across metric key and name. Supply a string or list of strings to the operator. | `equals` |
+ * | `tags` | The metric tags. | `contains` |
+ * | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` |
+ * | `versionIds` | The metric version number. | `anyOf` |
+ * | `view` | The view used to restrict access to the metric. | `equals` |
+ *
+ * For example, the filter `?filter=tags contains ["tag1", "tag2", "tag3"]` matches metrics that have all three tags.
+ *
+ * The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains ["tag1", "tag2", "tag3"]` must be encoded to `%5B`.
+ *
+ * ### Expanding the metric list response
+ *
+ * LaunchDarkly supports expanding the "List metrics" response. By default, the expandable field is **not** included in the response.
+ *
+ * To expand the response, append the `expand` query parameter and add the following supported field:
+ *
+ * - `experimentCount` includes the number of experiments from the specific project that use the metric
+ *
+ * For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.
+ */
+export function metricsList(
+  client: LaunchDarklyCore,
+  request: operations.GetMetricsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.MetricCollectionRep,
+    | errors.UnauthorizedErrorRep
+    | errors.NotFoundErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LaunchDarklyCore,
+  request: operations.GetMetricsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.MetricCollectionRep,
+      | errors.UnauthorizedErrorRep
+      | errors.NotFoundErrorRep
+      | LaunchDarklyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetMetricsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    projectKey: encodeSimple("projectKey", payload.projectKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v2/metrics/{projectKey}")(pathParams);
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+    "filter": payload.filter,
+    "limit": payload.limit,
+    "offset": payload.offset,
+    "sort": payload.sort,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getMetrics",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.MetricCollectionRep,
+    | errors.UnauthorizedErrorRep
+    | errors.NotFoundErrorRep
+    | LaunchDarklyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.MetricCollectionRep$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema),
+    M.jsonErr(404, errors.NotFoundErrorRep$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}