@steamsets/client-ts 0.33.4 → 0.33.5

package/src/funcs/leaderboardLeaderboardGetBucketLeaders.ts

@@ -0,0 +1,190 @@
+/*
+ * 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";
+
+/**
+ * Get the top account in each level bucket
+ */
+export function leaderboardLeaderboardGetBucketLeaders(
+  client: SteamSetsCore,
+  request: components.V1LeaderboardGetBucketLeadersRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LeaderboardGetBucketLeadersResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.V1LeaderboardGetBucketLeadersRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LeaderboardGetBucketLeadersResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.V1LeaderboardGetBucketLeadersRequestBody$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/leaderboard.getBucketLeaders")();
+
+  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: "leaderboard.getBucketLeaders",
+    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.LeaderboardGetBucketLeadersResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.LeaderboardGetBucketLeadersResponse$inboundSchema, {
+      key: "BucketLeaders",
+    }),
+    M.jsonErr([400, 401, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr([500, 501], 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/searchSearchGetTrending.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";
+
+/**
+ * Top search queries in a window, by unique searcher count
+ */
+export function searchSearchGetTrending(
+  client: SteamSetsCore,
+  request: components.SearchGetTrendingRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SearchGetTrendingResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.SearchGetTrendingRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SearchGetTrendingResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.SearchGetTrendingRequestBody$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/search.getTrending")();
+
+  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: "search.getTrending",
+    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.SearchGetTrendingResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.SearchGetTrendingResponse$inboundSchema, {
+      key: "SearchGetTrendingResponseBody",
+    }),
+    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/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.33.4",
+  sdkVersion: "0.33.5",
   genVersion: "2.881.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.33.4 2.881.4 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.33.5 2.881.4 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/accountgettrendingrequestbody.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Lookback window for trending compute. 24h is high-volatility (small samples); 7d is the default surface.
+ */
+export const Window = {
+  TwentyFourh: "24h",
+  Sevend: "7d",
+  Thirtyd: "30d",
+} as const;
+/**
+ * Lookback window for trending compute. 24h is high-volatility (small samples); 7d is the default surface.
+ */
+export type Window = ClosedEnum<typeof Window>;
+
+export type AccountGetTrendingRequestBody = {
+  /**
+   * Max accounts returned. Default 100.
+   */
+  limit?: number | undefined;
+  /**
+   * Lookback window for trending compute. 24h is high-volatility (small samples); 7d is the default surface.
+   */
+  window: Window;
+};
+
+/** @internal */
+export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> = z
+  .nativeEnum(Window);
+
+/** @internal */
+export type AccountGetTrendingRequestBody$Outbound = {
+  limit?: number | undefined;
+  window: string;
+};
+
+/** @internal */
+export const AccountGetTrendingRequestBody$outboundSchema: z.ZodType<
+  AccountGetTrendingRequestBody$Outbound,
+  z.ZodTypeDef,
+  AccountGetTrendingRequestBody
+> = z.object({
+  limit: z.number().int().optional(),
+  window: Window$outboundSchema,
+});
+
+export function accountGetTrendingRequestBodyToJSON(
+  accountGetTrendingRequestBody: AccountGetTrendingRequestBody,
+): string {
+  return JSON.stringify(
+    AccountGetTrendingRequestBody$outboundSchema.parse(
+      accountGetTrendingRequestBody,
+    ),
+  );
+}

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

package/src/models/components/accountviewstats.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 AccountViewStats = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * Total profile loads in the last 24 hours
+   */
+  total24h: number;
+  /**
+   * Total profile loads in the last 30 days
+   */
+  total30d: number;
+  /**
+   * Total profile loads in the last 7 days
+   */
+  total7d: number;
+  /**
+   * Distinct viewers in the last 24 hours
+   */
+  unique24h: number;
+  /**
+   * Distinct viewers in the last 30 days
+   */
+  unique30d: number;
+  /**
+   * Distinct viewers in the last 7 days
+   */
+  unique7d: number;
+};
+
+/** @internal */
+export const AccountViewStats$inboundSchema: z.ZodType<
+  AccountViewStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  total24h: z.number().int(),
+  total30d: z.number().int(),
+  total7d: z.number().int(),
+  unique24h: z.number().int(),
+  unique30d: z.number().int(),
+  unique7d: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function accountViewStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountViewStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountViewStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountViewStats' from JSON`,
+  );
+}

package/src/models/components/analyticstrackeventrequestbody.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Event class. profile_view is normally emitted server-side; this lets the frontend top it up for client-only flows. search captures account/app searches that bypass the backend.
+ */
+export const AnalyticsTrackEventRequestBodyType = {
+  ProfileView: "profile_view",
+  Search: "search",
+} as const;
+/**
+ * Event class. profile_view is normally emitted server-side; this lets the frontend top it up for client-only flows. search captures account/app searches that bypass the backend.
+ */
+export type AnalyticsTrackEventRequestBodyType = ClosedEnum<
+  typeof AnalyticsTrackEventRequestBodyType
+>;
+
+export type AnalyticsTrackEventRequestBody = {
+  /**
+   * Per-type fields. profile_view: {accountId}. search: {source, query, resultCount}.
+   */
+  payload: { [k: string]: any };
+  /**
+   * Event class. profile_view is normally emitted server-side; this lets the frontend top it up for client-only flows. search captures account/app searches that bypass the backend.
+   */
+  type: AnalyticsTrackEventRequestBodyType;
+};
+
+/** @internal */
+export const AnalyticsTrackEventRequestBodyType$outboundSchema: z.ZodNativeEnum<
+  typeof AnalyticsTrackEventRequestBodyType
+> = z.nativeEnum(AnalyticsTrackEventRequestBodyType);
+
+/** @internal */
+export type AnalyticsTrackEventRequestBody$Outbound = {
+  payload: { [k: string]: any };
+  type: string;
+};
+
+/** @internal */
+export const AnalyticsTrackEventRequestBody$outboundSchema: z.ZodType<
+  AnalyticsTrackEventRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsTrackEventRequestBody
+> = z.object({
+  payload: z.record(z.any()),
+  type: AnalyticsTrackEventRequestBodyType$outboundSchema,
+});
+
+export function analyticsTrackEventRequestBodyToJSON(
+  analyticsTrackEventRequestBody: AnalyticsTrackEventRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsTrackEventRequestBody$outboundSchema.parse(
+      analyticsTrackEventRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticstrackeventresponsebody.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 AnalyticsTrackEventResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  ok: boolean;
+};
+
+/** @internal */
+export const AnalyticsTrackEventResponseBody$inboundSchema: z.ZodType<
+  AnalyticsTrackEventResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  ok: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsTrackEventResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsTrackEventResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsTrackEventResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsTrackEventResponseBody' from JSON`,
+  );
+}