@steamsets/client-ts 0.34.4 → 0.34.6

package/src/models/operations/sitesubscribe.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { EventStream } from "../../lib/event-streams.js";
+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 EventMaintenanceChanged = {
+  data: components.MaintenanceChanged;
+  /**
+   * The event name.
+   */
+  event: "maintenance-changed";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+export type SiteSubscribeServerSentEventsEventHeartbeat = {
+  data: components.SiteSubscribeHeartbeat;
+  /**
+   * The event name.
+   */
+  event: "heartbeat";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+/**
+ * Each oneOf object in the array represents one possible Server Sent Events (SSE) message, serialized as UTF-8 text according to the SSE specification.
+ */
+export type SiteSubscribeServerSentEvents =
+  | SiteSubscribeServerSentEventsEventHeartbeat
+  | EventMaintenanceChanged;
+
+export type SiteSubscribeResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  serverSentEvents?:
+    | EventStream<
+      SiteSubscribeServerSentEventsEventHeartbeat | EventMaintenanceChanged
+    >
+    | undefined;
+  /**
+   * Error
+   */
+  errorModel?: components.ErrorModel | undefined;
+};
+
+/** @internal */
+export const EventMaintenanceChanged$inboundSchema: z.ZodType<
+  EventMaintenanceChanged,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.string().transform((v, ctx) => {
+    try {
+      return JSON.parse(v);
+    } catch (err) {
+      ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+      return z.NEVER;
+    }
+  }).pipe(components.MaintenanceChanged$inboundSchema),
+  event: z.literal("maintenance-changed"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventMaintenanceChangedFromJSON(
+  jsonString: string,
+): SafeParseResult<EventMaintenanceChanged, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventMaintenanceChanged$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventMaintenanceChanged' from JSON`,
+  );
+}
+
+/** @internal */
+export const SiteSubscribeServerSentEventsEventHeartbeat$inboundSchema:
+  z.ZodType<
+    SiteSubscribeServerSentEventsEventHeartbeat,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: z.string().transform((v, ctx) => {
+      try {
+        return JSON.parse(v);
+      } catch (err) {
+        ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+        return z.NEVER;
+      }
+    }).pipe(components.SiteSubscribeHeartbeat$inboundSchema),
+    event: z.literal("heartbeat"),
+    id: z.string().optional(),
+    retry: z.number().int().optional(),
+  });
+
+export function siteSubscribeServerSentEventsEventHeartbeatFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SiteSubscribeServerSentEventsEventHeartbeat,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SiteSubscribeServerSentEventsEventHeartbeat$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SiteSubscribeServerSentEventsEventHeartbeat' from JSON`,
+  );
+}
+
+/** @internal */
+export const SiteSubscribeServerSentEvents$inboundSchema: z.ZodType<
+  SiteSubscribeServerSentEvents,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => SiteSubscribeServerSentEventsEventHeartbeat$inboundSchema),
+  z.lazy(() => EventMaintenanceChanged$inboundSchema),
+]);
+
+export function siteSubscribeServerSentEventsFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteSubscribeServerSentEvents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteSubscribeServerSentEvents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteSubscribeServerSentEvents' from JSON`,
+  );
+}
+
+/** @internal */
+export const SiteSubscribeResponse$inboundSchema: z.ZodType<
+  SiteSubscribeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  "Server Sent Events": z.instanceof(ReadableStream<Uint8Array>)
+    .transform(stream => {
+      return new EventStream(stream, rawEvent => {
+        return {
+          done: false,
+          value: z.union([
+            z.lazy(() =>
+              SiteSubscribeServerSentEventsEventHeartbeat$inboundSchema
+            ),
+            z.lazy(() => EventMaintenanceChanged$inboundSchema),
+          ]).parse(rawEvent),
+        };
+      });
+    }).optional(),
+  ErrorModel: components.ErrorModel$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "Server Sent Events": "serverSentEvents",
+    "ErrorModel": "errorModel",
+  });
+});
+
+export function siteSubscribeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteSubscribeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteSubscribeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteSubscribeResponse' from JSON`,
+  );
+}

package/src/sdk/analytics.ts

@@ -2,12 +2,86 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { analyticsGetBivariate } from "../funcs/analyticsGetBivariate.js";
+import { analyticsGetDistribution } from "../funcs/analyticsGetDistribution.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,
+    ));
+  }
+
+  /**
+   * 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.
    */

package/src/sdk/sdk.ts

@@ -18,6 +18,7 @@ import { Leaderboards } from "./leaderboards.js";
 import { Location } from "./location.js";
 import { Maintenance } from "./maintenance.js";
 import { Search } from "./search.js";
+import { Site } from "./site.js";
 import { Staff } from "./staff.js";
 import { Stats } from "./stats.js";
 
@@ -97,6 +98,11 @@ export class SteamSets extends ClientSDK {
     return (this._search ??= new Search(this._options));
   }
 
+  private _site?: Site;
+  get site(): Site {
+    return (this._site ??= new Site(this._options));
+  }
+
   private _staff?: Staff;
   get staff(): Staff {
     return (this._staff ??= new Staff(this._options));

package/src/sdk/site.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { siteSubscribe, SubscribeAcceptEnum } from "../funcs/siteSubscribe.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export { SubscribeAcceptEnum } from "../funcs/siteSubscribe.js";
+
+export class Site extends ClientSDK {
+  /**
+   * Server-sent-events stream of site-wide broadcasts (maintenance, announcements, etc).
+   */
+  async subscribe(
+    options?: RequestOptions & { acceptHeaderOverride?: SubscribeAcceptEnum },
+  ): Promise<operations.SiteSubscribeResponse> {
+    return unwrapAsync(siteSubscribe(
+      this,
+      options,
+    ));
+  }
+}

package/models/components/heartbeat.d.ts

@@ -1,10 +0,0 @@
-import * as z from "zod/v3";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type Heartbeat = {
-    heartbeat: number;
-};
-/** @internal */
-export declare const Heartbeat$inboundSchema: z.ZodType<Heartbeat, z.ZodTypeDef, unknown>;
-export declare function heartbeatFromJSON(jsonString: string): SafeParseResult<Heartbeat, SDKValidationError>;
-//# sourceMappingURL=heartbeat.d.ts.map

package/models/components/heartbeat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"heartbeat.d.ts","sourceRoot":"","sources":["../../src/models/components/heartbeat.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD"}

package/models/components/heartbeat.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"heartbeat.js","sourceRoot":"","sources":["../../src/models/components/heartbeat.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBH,8CAQC;AA1BD,0CAA4B;AAC5B,qDAAiD;AAQjD,gBAAgB;AACH,QAAA,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC5B,CAAC,CAAC;AAEH,SAAgB,iBAAiB,CAC/B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+BAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AACJ,CAAC"}