@steamsets/client-ts 0.34.3 → 0.34.5

package/src/models/operations/accountsubscribe.ts

@@ -0,0 +1,251 @@
+/*
+ * 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 AccountSubscribeRequest = {
+  /**
+   * Account ID to subscribe to
+   */
+  accountId: number;
+};
+
+export type EventHeartbeat = {
+  data: components.AccountSubscribeHeartbeat;
+  /**
+   * The event name.
+   */
+  event: "heartbeat";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+export type EventAccountViewTick = {
+  data: components.EventAccountViewTickData;
+  /**
+   * The event name.
+   */
+  event: "account-view-tick";
+  /**
+   * The event ID.
+   */
+  id?: string | undefined;
+  /**
+   * The retry time in milliseconds.
+   */
+  retry?: number | undefined;
+};
+
+export type EventAccountUpdated = {
+  data: components.EventAccountUpdatedData;
+  /**
+   * The event name.
+   */
+  event: "account-updated";
+  /**
+   * 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 AccountSubscribeServerSentEvents =
+  | EventAccountUpdated
+  | EventAccountViewTick
+  | EventHeartbeat;
+
+export type AccountSubscribeResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  serverSentEvents?:
+    | EventStream<EventAccountUpdated | EventAccountViewTick | EventHeartbeat>
+    | undefined;
+};
+
+/** @internal */
+export type AccountSubscribeRequest$Outbound = {
+  accountId: number;
+};
+
+/** @internal */
+export const AccountSubscribeRequest$outboundSchema: z.ZodType<
+  AccountSubscribeRequest$Outbound,
+  z.ZodTypeDef,
+  AccountSubscribeRequest
+> = z.object({
+  accountId: z.number().int(),
+});
+
+export function accountSubscribeRequestToJSON(
+  accountSubscribeRequest: AccountSubscribeRequest,
+): string {
+  return JSON.stringify(
+    AccountSubscribeRequest$outboundSchema.parse(accountSubscribeRequest),
+  );
+}
+
+/** @internal */
+export const EventHeartbeat$inboundSchema: z.ZodType<
+  EventHeartbeat,
+  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.AccountSubscribeHeartbeat$inboundSchema),
+  event: z.literal("heartbeat"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventHeartbeatFromJSON(
+  jsonString: string,
+): SafeParseResult<EventHeartbeat, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventHeartbeat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventHeartbeat' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventAccountViewTick$inboundSchema: z.ZodType<
+  EventAccountViewTick,
+  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.EventAccountViewTickData$inboundSchema),
+  event: z.literal("account-view-tick"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventAccountViewTickFromJSON(
+  jsonString: string,
+): SafeParseResult<EventAccountViewTick, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventAccountViewTick$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventAccountViewTick' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventAccountUpdated$inboundSchema: z.ZodType<
+  EventAccountUpdated,
+  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.EventAccountUpdatedData$inboundSchema),
+  event: z.literal("account-updated"),
+  id: z.string().optional(),
+  retry: z.number().int().optional(),
+});
+
+export function eventAccountUpdatedFromJSON(
+  jsonString: string,
+): SafeParseResult<EventAccountUpdated, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventAccountUpdated$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventAccountUpdated' from JSON`,
+  );
+}
+
+/** @internal */
+export const AccountSubscribeServerSentEvents$inboundSchema: z.ZodType<
+  AccountSubscribeServerSentEvents,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => EventAccountUpdated$inboundSchema),
+  z.lazy(() => EventAccountViewTick$inboundSchema),
+  z.lazy(() => EventHeartbeat$inboundSchema),
+]);
+
+export function accountSubscribeServerSentEventsFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountSubscribeServerSentEvents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountSubscribeServerSentEvents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountSubscribeServerSentEvents' from JSON`,
+  );
+}
+
+/** @internal */
+export const AccountSubscribeResponse$inboundSchema: z.ZodType<
+  AccountSubscribeResponse,
+  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(() => EventAccountUpdated$inboundSchema),
+            z.lazy(() => EventAccountViewTick$inboundSchema),
+            z.lazy(() => EventHeartbeat$inboundSchema),
+          ]).parse(rawEvent),
+        };
+      });
+    }).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "Server Sent Events": "serverSentEvents",
+  });
+});
+
+export function accountSubscribeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountSubscribeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountSubscribeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountSubscribeResponse' from JSON`,
+  );
+}

package/src/models/operations/badgepricingsubscribe.ts

@@ -26,7 +26,7 @@ export type EventMarketPriceTick = {
   retry?: number | undefined;
 };
 
-export type EventHeartbeat = {
+export type ServerSentEventsEventHeartbeat = {
   data: components.PricingHeartbeat;
   /**
    * The event name.
@@ -46,7 +46,7 @@ export type EventHeartbeat = {
  * 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 BadgePricingSubscribeServerSentEvents =
-  | EventHeartbeat
+  | ServerSentEventsEventHeartbeat
   | EventMarketPriceTick;
 
 export type BadgePricingSubscribeResponse = {
@@ -55,7 +55,7 @@ export type BadgePricingSubscribeResponse = {
    * OK
    */
   serverSentEvents?:
-    | EventStream<EventHeartbeat | EventMarketPriceTick>
+    | EventStream<ServerSentEventsEventHeartbeat | EventMarketPriceTick>
     | undefined;
   /**
    * Error
@@ -93,8 +93,8 @@ export function eventMarketPriceTickFromJSON(
 }
 
 /** @internal */
-export const EventHeartbeat$inboundSchema: z.ZodType<
-  EventHeartbeat,
+export const ServerSentEventsEventHeartbeat$inboundSchema: z.ZodType<
+  ServerSentEventsEventHeartbeat,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -111,13 +111,13 @@ export const EventHeartbeat$inboundSchema: z.ZodType<
   retry: z.number().int().optional(),
 });
 
-export function eventHeartbeatFromJSON(
+export function serverSentEventsEventHeartbeatFromJSON(
   jsonString: string,
-): SafeParseResult<EventHeartbeat, SDKValidationError> {
+): SafeParseResult<ServerSentEventsEventHeartbeat, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => EventHeartbeat$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'EventHeartbeat' from JSON`,
+    (x) => ServerSentEventsEventHeartbeat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServerSentEventsEventHeartbeat' from JSON`,
   );
 }
 
@@ -127,7 +127,7 @@ export const BadgePricingSubscribeServerSentEvents$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  z.lazy(() => EventHeartbeat$inboundSchema),
+  z.lazy(() => ServerSentEventsEventHeartbeat$inboundSchema),
   z.lazy(() => EventMarketPriceTick$inboundSchema),
 ]);
 
@@ -155,7 +155,7 @@ export const BadgePricingSubscribeResponse$inboundSchema: z.ZodType<
         return {
           done: false,
           value: z.union([
-            z.lazy(() => EventHeartbeat$inboundSchema),
+            z.lazy(() => ServerSentEventsEventHeartbeat$inboundSchema),
             z.lazy(() => EventMarketPriceTick$inboundSchema),
           ]).parse(rawEvent),
         };

package/src/models/operations/index.ts

@@ -34,6 +34,7 @@ export * from "./accountreconnectconnection.js";
 export * from "./accountrefreshinventory.js";
 export * from "./accountrefreshsession.js";
 export * from "./accountsendemailverification.js";
+export * from "./accountsubscribe.js";
 export * from "./accountsubscribeemail.js";
 export * from "./accountupdateconnection.js";
 export * from "./accountupdatedeveloperapp.js";
@@ -95,6 +96,7 @@ export * from "./listglobalfeed.js";
 export * from "./locationgetlocations.js";
 export * from "./maintenancelist.js";
 export * from "./searchgettrending.js";
+export * from "./sitesubscribe.js";
 export * from "./staffliststaff.js";
 export * from "./statsgetstats.js";
 export * from "./statssubscribe.js";

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/account.ts

@@ -36,6 +36,7 @@ import { accountReconnectConnection } from "../funcs/accountReconnectConnection.
 import { accountRefreshInventory } from "../funcs/accountRefreshInventory.js";
 import { accountRefreshSession } from "../funcs/accountRefreshSession.js";
 import { accountSendEmailVerification } from "../funcs/accountSendEmailVerification.js";
+import { accountSubscribe } from "../funcs/accountSubscribe.js";
 import { accountSubscribeEmail } from "../funcs/accountSubscribeEmail.js";
 import { accountUpdateConnection } from "../funcs/accountUpdateConnection.js";
 import { accountUpdateDeveloperApp } from "../funcs/accountUpdateDeveloperApp.js";
@@ -518,6 +519,20 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Server-sent-events stream of per-account updates (queue status, view ticks).
+   */
+  async subscribe(
+    request: operations.AccountSubscribeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.AccountSubscribeResponse> {
+    return unwrapAsync(accountSubscribe(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Subscribe to email notifications
    */

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