@steamsets/client-ts 0.34.3 → 0.34.5

package/src/funcs/accountSubscribe.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SteamSetsCore } from "../core.js";
+import { encodeFormQuery } 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 {
+  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";
+
+/**
+ * Server-sent-events stream of per-account updates (queue status, view ticks).
+ */
+export function accountSubscribe(
+  client: SteamSetsCore,
+  request: operations.AccountSubscribeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.AccountSubscribeResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: operations.AccountSubscribeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.AccountSubscribeResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.AccountSubscribeRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/account.subscribe")();
+
+  const query = encodeFormQuery({
+    "accountId": payload.accountId,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "text/event-stream",
+  }));
+
+  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: "account.subscribe",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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.AccountSubscribeResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.sse(200, operations.AccountSubscribeResponse$inboundSchema, {
+      key: "Server Sent Events",
+    }),
+    M.jsonErr([400, 401, 403, 404, 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/siteSubscribe.ts

@@ -0,0 +1,168 @@
+/*
+ * 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 { 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";
+
+export enum SubscribeAcceptEnum {
+  applicationProblemPlusJson = "application/problem+json",
+  textEventStream = "text/event-stream",
+}
+
+/**
+ * Server-sent-events stream of site-wide broadcasts (maintenance, announcements, etc).
+ */
+export function siteSubscribe(
+  client: SteamSetsCore,
+  options?: RequestOptions & { acceptHeaderOverride?: SubscribeAcceptEnum },
+): APIPromise<
+  Result<
+    operations.SiteSubscribeResponse,
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  options?: RequestOptions & { acceptHeaderOverride?: SubscribeAcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.SiteSubscribeResponse,
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/site.subscribe")();
+
+  const headers = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride
+      || "application/problem+json;q=1, text/event-stream;q=0",
+  }));
+
+  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: "site.subscribe",
+    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: "GET",
+    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.SiteSubscribeResponse,
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.sse(200, operations.SiteSubscribeResponse$inboundSchema, {
+      key: "Server Sent Events",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.json("default", operations.SiteSubscribeResponse$inboundSchema, {
+      ctype: "application/problem+json",
+      key: "ErrorModel",
+    }),
+  )(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.3",
-  genVersion: "2.881.17",
+  sdkVersion: "0.34.5",
+  genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.34.3 2.881.17 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.34.5 2.882.0 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/accountsubscribeheartbeat.ts

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

package/src/models/components/eventaccountupdateddata.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 EventAccountUpdatedData = {
+  accountId: number;
+  status: string;
+};
+
+/** @internal */
+export const EventAccountUpdatedData$inboundSchema: z.ZodType<
+  EventAccountUpdatedData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountId: z.number().int(),
+  status: z.string(),
+});
+
+export function eventAccountUpdatedDataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventAccountUpdatedData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventAccountUpdatedData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventAccountUpdatedData' from JSON`,
+  );
+}

package/src/models/components/eventaccountviewtickdata.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 EventAccountViewTickData = {
+  accountId: number;
+  totalDelta: number;
+};
+
+/** @internal */
+export const EventAccountViewTickData$inboundSchema: z.ZodType<
+  EventAccountViewTickData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountId: z.number().int(),
+  totalDelta: z.number().int(),
+});
+
+export function eventAccountViewTickDataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventAccountViewTickData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventAccountViewTickData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventAccountViewTickData' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -7,6 +7,7 @@ export * from "./accountgettrendingrequestbody.js";
 export * from "./accountgettrendingresponsebody.js";
 export * from "./accountleaderboardhistory.js";
 export * from "./accountsearch.js";
+export * from "./accountsubscribeheartbeat.js";
 export * from "./accountviewstats.js";
 export * from "./admincmsitem.js";
 export * from "./analyticstrackeventrequestbody.js";
@@ -41,6 +42,8 @@ export * from "./developerappanalyticstimeseries.js";
 export * from "./developerappanalyticstimeseriespoint.js";
 export * from "./errordetail.js";
 export * from "./errormodel.js";
+export * from "./eventaccountupdateddata.js";
+export * from "./eventaccountviewtickdata.js";
 export * from "./eventmarketpricetickdata.js";
 export * from "./eventstatsheartbeatdata.js";
 export * from "./eventstatsupdateddata.js";
@@ -64,6 +67,7 @@ export * from "./leaderboardstate.js";
 export * from "./listallresponsebody.js";
 export * from "./listresponsebody.js";
 export * from "./loginrequestbody.js";
+export * from "./maintenancechanged.js";
 export * from "./maintenanceevent.js";
 export * from "./order.js";
 export * from "./owner.js";
@@ -82,6 +86,7 @@ export * from "./security.js";
 export * from "./session.js";
 export * from "./setremovecolortag.js";
 export * from "./setremovedesigntag.js";
+export * from "./sitesubscribeheartbeat.js";
 export * from "./state.js";
 export * from "./trendingaccount.js";
 export * from "./trendingsearch.js";

package/src/models/components/maintenancechanged.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 {
+  MaintenanceEvent,
+  MaintenanceEvent$inboundSchema,
+} from "./maintenanceevent.js";
+
+export type MaintenanceChanged = {
+  items: Array<MaintenanceEvent | null> | null;
+};
+
+/** @internal */
+export const MaintenanceChanged$inboundSchema: z.ZodType<
+  MaintenanceChanged,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.nullable(z.array(z.nullable(MaintenanceEvent$inboundSchema))),
+});
+
+export function maintenanceChangedFromJSON(
+  jsonString: string,
+): SafeParseResult<MaintenanceChanged, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MaintenanceChanged$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MaintenanceChanged' from JSON`,
+  );
+}

package/src/models/components/sitesubscribeheartbeat.ts

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