@steamsets/client-ts 0.34.5 → 0.34.6

package/src/funcs/analyticsGetTrend.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SteamSetsCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { SteamSetsError } from "../models/errors/steamsetserror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Daily quantiles over a window for a metric in a scope
+ */
+export function analyticsGetTrend(
+  client: SteamSetsCore,
+  request: components.AnalyticsGetTrendRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.AnalyticsGetTrendResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.AnalyticsGetTrendRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.AnalyticsGetTrendResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.AnalyticsGetTrendRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/analytics.getTrend")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "analytics.getTrend",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 1.5,
+          maxElapsedTime: 60000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["501", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    operations.AnalyticsGetTrendResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.AnalyticsGetTrendResponse$inboundSchema, {
+      key: "AnalyticsTrend",
+    }),
+    M.jsonErr([400, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr(500, errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    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/analyticsListMetrics.ts

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SteamSetsCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { SteamSetsError } from "../models/errors/steamsetserror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List every analytics domain, metric, and scope the data-library can serve
+ */
+export function analyticsListMetrics(
+  client: SteamSetsCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.AnalyticsListMetricsResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.AnalyticsListMetricsResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/analytics.listMetrics")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "analytics.listMetrics",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 1.5,
+          maxElapsedTime: 60000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["501", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    operations.AnalyticsListMetricsResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.AnalyticsListMetricsResponse$inboundSchema, {
+      key: "AnalyticsListMetricsResponseBody",
+    }),
+    M.jsonErr(500, errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    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/lib/config.ts

@@ -59,8 +59,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.34.5",
+  sdkVersion: "0.34.6",
   genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.34.5 2.882.0 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.34.6 2.882.0 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/analyticsbin.ts

@@ -0,0 +1,41 @@
+/*
+ * 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";
+
+export type AnalyticsBin = {
+  count: number;
+  xLower: number;
+  xUpper: number;
+};
+
+/** @internal */
+export const AnalyticsBin$inboundSchema: z.ZodType<
+  AnalyticsBin,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number(),
+  x_lower: z.number(),
+  x_upper: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "x_lower": "xLower",
+    "x_upper": "xUpper",
+  });
+});
+
+export function analyticsBinFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsBin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsBin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsBin' from JSON`,
+  );
+}

package/src/models/components/analyticsbivariate.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 {
+  AnalyticsBivariateBucket,
+  AnalyticsBivariateBucket$inboundSchema,
+} from "./analyticsbivariatebucket.js";
+
+export type AnalyticsBivariate = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  buckets: Array<AnalyticsBivariateBucket> | null;
+};
+
+/** @internal */
+export const AnalyticsBivariate$inboundSchema: z.ZodType<
+  AnalyticsBivariate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  buckets: z.nullable(z.array(AnalyticsBivariateBucket$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsBivariateFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsBivariate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsBivariate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsBivariate' from JSON`,
+  );
+}

package/src/models/components/analyticsbivariatebucket.ts

@@ -0,0 +1,41 @@
+/*
+ * 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";
+
+export type AnalyticsBivariateBucket = {
+  count: number;
+  xBucket: number;
+  yValue: number;
+};
+
+/** @internal */
+export const AnalyticsBivariateBucket$inboundSchema: z.ZodType<
+  AnalyticsBivariateBucket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  x_bucket: z.number(),
+  y_value: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "x_bucket": "xBucket",
+    "y_value": "yValue",
+  });
+});
+
+export function analyticsBivariateBucketFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsBivariateBucket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsBivariateBucket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsBivariateBucket' from JSON`,
+  );
+}

package/src/models/components/analyticsdistribution.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 { AnalyticsBin, AnalyticsBin$inboundSchema } from "./analyticsbin.js";
+import {
+  AnalyticsSummary,
+  AnalyticsSummary$inboundSchema,
+} from "./analyticssummary.js";
+
+export type AnalyticsDistribution = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  bins: Array<AnalyticsBin> | null;
+  summary: AnalyticsSummary;
+};
+
+/** @internal */
+export const AnalyticsDistribution$inboundSchema: z.ZodType<
+  AnalyticsDistribution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  bins: z.nullable(z.array(AnalyticsBin$inboundSchema)),
+  summary: AnalyticsSummary$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsDistributionFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsDistribution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsDistribution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsDistribution' from JSON`,
+  );
+}

package/src/models/components/analyticsdomainentry.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 {
+  AnalyticsMetricEntry,
+  AnalyticsMetricEntry$inboundSchema,
+} from "./analyticsmetricentry.js";
+import {
+  AnalyticsScopeEntry,
+  AnalyticsScopeEntry$inboundSchema,
+} from "./analyticsscopeentry.js";
+
+export type AnalyticsDomainEntry = {
+  id: string;
+  metrics: Array<AnalyticsMetricEntry> | null;
+  scopes: Array<AnalyticsScopeEntry> | null;
+};
+
+/** @internal */
+export const AnalyticsDomainEntry$inboundSchema: z.ZodType<
+  AnalyticsDomainEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  metrics: z.nullable(z.array(AnalyticsMetricEntry$inboundSchema)),
+  scopes: z.nullable(z.array(AnalyticsScopeEntry$inboundSchema)),
+});
+
+export function analyticsDomainEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsDomainEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsDomainEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsDomainEntry' from JSON`,
+  );
+}

package/src/models/components/analyticsgetbivariaterequestbody.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * How to aggregate Y inside each X bucket.
+ */
+export const Agg = {
+  Avg: "avg",
+  Median: "median",
+  Count: "count",
+} as const;
+/**
+ * How to aggregate Y inside each X bucket.
+ */
+export type Agg = ClosedEnum<typeof Agg>;
+
+export type AnalyticsGetBivariateRequestBody = {
+  /**
+   * How to aggregate Y inside each X bucket.
+   */
+  agg: Agg;
+  domain: string;
+  scope: string;
+  scopeValue?: number | undefined;
+  /**
+   * Metric ID for the X axis (bucketed).
+   */
+  x: string;
+  /**
+   * Metric ID for the Y axis (aggregated within each X bucket).
+   */
+  y: string;
+};
+
+/** @internal */
+export const Agg$outboundSchema: z.ZodNativeEnum<typeof Agg> = z.nativeEnum(
+  Agg,
+);
+
+/** @internal */
+export type AnalyticsGetBivariateRequestBody$Outbound = {
+  agg: string;
+  domain: string;
+  scope: string;
+  scope_value?: number | undefined;
+  x: string;
+  y: string;
+};
+
+/** @internal */
+export const AnalyticsGetBivariateRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetBivariateRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetBivariateRequestBody
+> = z.object({
+  agg: Agg$outboundSchema,
+  domain: z.string(),
+  scope: z.string(),
+  scopeValue: z.number().int().optional(),
+  x: z.string(),
+  y: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    scopeValue: "scope_value",
+  });
+});
+
+export function analyticsGetBivariateRequestBodyToJSON(
+  analyticsGetBivariateRequestBody: AnalyticsGetBivariateRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetBivariateRequestBody$outboundSchema.parse(
+      analyticsGetBivariateRequestBody,
+    ),
+  );
+}