@steamsets/client-ts 0.34.5 → 0.34.7

package/src/models/components/analyticsscopebucket.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 AnalyticsScopeBucket = {
+  /**
+   * Sample size — accounts contributing to this bucket.
+   */
+  count: number;
+  /**
+   * Country ISO alpha-2 code, e.g. "DE". Stable join key for map data.
+   */
+  countryCode?: string | undefined;
+  /**
+   * Country name, e.g. "Germany"
+   */
+  countryName?: string | undefined;
+  /**
+   * Region name, e.g. "Europe"
+   */
+  region?: string | undefined;
+  /**
+   * The metric's aggregated value for this bucket.
+   */
+  value: number;
+};
+
+/** @internal */
+export const AnalyticsScopeBucket$inboundSchema: z.ZodType<
+  AnalyticsScopeBucket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  countryCode: z.string().optional(),
+  countryName: z.string().optional(),
+  region: z.string().optional(),
+  value: z.number(),
+});
+
+export function analyticsScopeBucketFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsScopeBucket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsScopeBucket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsScopeBucket' from JSON`,
+  );
+}

package/src/models/components/analyticsscopeentry.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 AnalyticsScopeEntry = {
+  column: string;
+  id: string;
+  valueType: string;
+};
+
+/** @internal */
+export const AnalyticsScopeEntry$inboundSchema: z.ZodType<
+  AnalyticsScopeEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  column: z.string(),
+  id: z.string(),
+  value_type: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "value_type": "valueType",
+  });
+});
+
+export function analyticsScopeEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsScopeEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsScopeEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsScopeEntry' from JSON`,
+  );
+}

package/src/models/components/analyticssummary.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";
+
+export type AnalyticsSummary = {
+  count: number;
+  max: number;
+  mean: number;
+  min: number;
+  p50: number;
+  p90: number;
+  p99: number;
+};
+
+/** @internal */
+export const AnalyticsSummary$inboundSchema: z.ZodType<
+  AnalyticsSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  max: z.number(),
+  mean: z.number(),
+  min: z.number(),
+  p50: z.number(),
+  p90: z.number(),
+  p99: z.number(),
+});
+
+export function analyticsSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsSummary' from JSON`,
+  );
+}

package/src/models/components/analyticstrend.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 {
+  AnalyticsTrendPoint,
+  AnalyticsTrendPoint$inboundSchema,
+} from "./analyticstrendpoint.js";
+
+export type AnalyticsTrend = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  points: Array<AnalyticsTrendPoint> | null;
+};
+
+/** @internal */
+export const AnalyticsTrend$inboundSchema: z.ZodType<
+  AnalyticsTrend,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  points: z.nullable(z.array(AnalyticsTrendPoint$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsTrendFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsTrend, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsTrend$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsTrend' from JSON`,
+  );
+}

package/src/models/components/analyticstrendpoint.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 AnalyticsTrendPoint = {
+  count: number;
+  date: string;
+  p50: number;
+  p90: number;
+  p99: number;
+};
+
+/** @internal */
+export const AnalyticsTrendPoint$inboundSchema: z.ZodType<
+  AnalyticsTrendPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  date: z.string(),
+  p50: z.number(),
+  p90: z.number(),
+  p99: z.number(),
+});
+
+export function analyticsTrendPointFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsTrendPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsTrendPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsTrendPoint' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -10,8 +10,28 @@ export * from "./accountsearch.js";
 export * from "./accountsubscribeheartbeat.js";
 export * from "./accountviewstats.js";
 export * from "./admincmsitem.js";
+export * from "./analyticsbin.js";
+export * from "./analyticsbivariate.js";
+export * from "./analyticsbivariatebucket.js";
+export * from "./analyticsdistribution.js";
+export * from "./analyticsdomainentry.js";
+export * from "./analyticsgetbivariaterequestbody.js";
+export * from "./analyticsgetdistributionrequestbody.js";
+export * from "./analyticsgetmetricbyscoperequestbody.js";
+export * from "./analyticsgetmypercentilesrequestbody.js";
+export * from "./analyticsgettrendrequestbody.js";
+export * from "./analyticslistmetricsresponsebody.js";
+export * from "./analyticsmetricbyscope.js";
+export * from "./analyticsmetricentry.js";
+export * from "./analyticsmypercentiles.js";
+export * from "./analyticspercentile.js";
+export * from "./analyticsscopebucket.js";
+export * from "./analyticsscopeentry.js";
+export * from "./analyticssummary.js";
 export * from "./analyticstrackeventrequestbody.js";
 export * from "./analyticstrackeventresponsebody.js";
+export * from "./analyticstrend.js";
+export * from "./analyticstrendpoint.js";
 export * from "./assetitem.js";
 export * from "./badge.js";
 export * from "./badgesuggesttags.js";

package/src/models/operations/analyticsgetbivariate.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetBivariateResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsBivariate?: components.AnalyticsBivariate | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetBivariateResponse$inboundSchema: z.ZodType<
+  AnalyticsGetBivariateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsBivariate: components.AnalyticsBivariate$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsBivariate": "analyticsBivariate",
+  });
+});
+
+export function analyticsGetBivariateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetBivariateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetBivariateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetBivariateResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticsgetdistribution.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetDistributionResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsDistribution?: components.AnalyticsDistribution | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetDistributionResponse$inboundSchema: z.ZodType<
+  AnalyticsGetDistributionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsDistribution: components.AnalyticsDistribution$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsDistribution": "analyticsDistribution",
+  });
+});
+
+export function analyticsGetDistributionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetDistributionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetDistributionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetDistributionResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticsgetmetricbyscope.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetMetricByScopeResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsMetricByScope?: components.AnalyticsMetricByScope | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetMetricByScopeResponse$inboundSchema: z.ZodType<
+  AnalyticsGetMetricByScopeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsMetricByScope: components.AnalyticsMetricByScope$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsMetricByScope": "analyticsMetricByScope",
+  });
+});
+
+export function analyticsGetMetricByScopeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetMetricByScopeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetMetricByScopeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetMetricByScopeResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticsgetmypercentiles.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetMyPercentilesResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsMyPercentiles?: components.AnalyticsMyPercentiles | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetMyPercentilesResponse$inboundSchema: z.ZodType<
+  AnalyticsGetMyPercentilesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsMyPercentiles: components.AnalyticsMyPercentiles$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsMyPercentiles": "analyticsMyPercentiles",
+  });
+});
+
+export function analyticsGetMyPercentilesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetMyPercentilesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetMyPercentilesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetMyPercentilesResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticsgettrend.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetTrendResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsTrend?: components.AnalyticsTrend | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetTrendResponse$inboundSchema: z.ZodType<
+  AnalyticsGetTrendResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsTrend: components.AnalyticsTrend$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsTrend": "analyticsTrend",
+  });
+});
+
+export function analyticsGetTrendResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetTrendResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetTrendResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetTrendResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticslistmetrics.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsListMetricsResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsListMetricsResponseBody?:
+    | components.AnalyticsListMetricsResponseBody
+    | undefined;
+};
+
+/** @internal */
+export const AnalyticsListMetricsResponse$inboundSchema: z.ZodType<
+  AnalyticsListMetricsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsListMetricsResponseBody: components
+    .AnalyticsListMetricsResponseBody$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsListMetricsResponseBody": "analyticsListMetricsResponseBody",
+  });
+});
+
+export function analyticsListMetricsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsListMetricsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsListMetricsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsListMetricsResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -58,6 +58,12 @@ export * from "./adminremovevanity.js";
 export * from "./adminupdateresources.js";
 export * from "./adminupdateroleoverride.js";
 export * from "./adminupdateroles.js";
+export * from "./analyticsgetbivariate.js";
+export * from "./analyticsgetdistribution.js";
+export * from "./analyticsgetmetricbyscope.js";
+export * from "./analyticsgetmypercentiles.js";
+export * from "./analyticsgettrend.js";
+export * from "./analyticslistmetrics.js";
 export * from "./applistbadges.js";
 export * from "./badgelisttags.js";
 export * from "./badgepricingsubscribe.js";

package/src/sdk/analytics.ts

@@ -2,12 +2,101 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { analyticsGetBivariate } from "../funcs/analyticsGetBivariate.js";
+import { analyticsGetDistribution } from "../funcs/analyticsGetDistribution.js";
+import { analyticsGetMetricByScope } from "../funcs/analyticsGetMetricByScope.js";
+import { analyticsGetMyPercentiles } from "../funcs/analyticsGetMyPercentiles.js";
+import { analyticsGetTrend } from "../funcs/analyticsGetTrend.js";
+import { analyticsListMetrics } from "../funcs/analyticsListMetrics.js";
 import { analyticsTrackEvent } from "../funcs/analyticsTrackEvent.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Analytics extends ClientSDK {
+  /**
+   * Bucket by X, aggregate Y, within a scope
+   */
+  async getBivariate(
+    request: components.AnalyticsGetBivariateRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetBivariateResponse> {
+    return unwrapAsync(analyticsGetBivariate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Histogram + summary stats for a metric in a scope
+   */
+  async getDistribution(
+    request: components.AnalyticsGetDistributionRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetDistributionResponse> {
+    return unwrapAsync(analyticsGetDistribution(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * One metric aggregated per country (or region) — worldmap source
+   */
+  async getMetricByScope(
+    request: components.AnalyticsGetMetricByScopeRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetMetricByScopeResponse> {
+    return unwrapAsync(analyticsGetMetricByScope(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Per-metric percentile rank for the logged-in user in the chosen scope
+   */
+  async getMyPercentiles(
+    request: components.AnalyticsGetMyPercentilesRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetMyPercentilesResponse> {
+    return unwrapAsync(analyticsGetMyPercentiles(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Daily quantiles over a window for a metric in a scope
+   */
+  async getTrend(
+    request: components.AnalyticsGetTrendRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetTrendResponse> {
+    return unwrapAsync(analyticsGetTrend(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List every analytics domain, metric, and scope the data-library can serve
+   */
+  async listMetrics(
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsListMetricsResponse> {
+    return unwrapAsync(analyticsListMetrics(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Track a frontend-only analytics event (profile view, search). Frontend API key + logged-in users only.
    */