@steamsets/client-ts 0.33.3 → 0.33.5

package/src/models/components/bucketleader.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 {
+  LeaderboardAccount,
+  LeaderboardAccount$inboundSchema,
+} from "./leaderboardaccount.js";
+
+export type BucketLeader = {
+  account?: LeaderboardAccount | null | undefined;
+  accountId?: number | undefined;
+  /**
+   * No account in this bucket within the scope
+   */
+  empty: boolean;
+  /**
+   * Inclusive bucket lower bound (level)
+   */
+  fromLevel: number;
+  /**
+   * XP required for fromLevel
+   */
+  fromXp: number;
+  rank?: number | undefined;
+  score?: number | undefined;
+  /**
+   * Inclusive bucket upper bound (level)
+   */
+  toLevel: number;
+  /**
+   * XP required for toLevel+1, minus 1 — i.e. the cap of this bucket
+   */
+  toXp: number;
+};
+
+/** @internal */
+export const BucketLeader$inboundSchema: z.ZodType<
+  BucketLeader,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  account: z.nullable(LeaderboardAccount$inboundSchema).optional(),
+  accountId: z.number().int().optional(),
+  empty: z.boolean(),
+  fromLevel: z.number().int(),
+  fromXp: z.number().int(),
+  rank: z.number().int().optional(),
+  score: z.number().int().optional(),
+  toLevel: z.number().int(),
+  toXp: z.number().int(),
+});
+
+export function bucketLeaderFromJSON(
+  jsonString: string,
+): SafeParseResult<BucketLeader, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BucketLeader$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BucketLeader' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -3,14 +3,20 @@
  */
 
 export * from "./accountbadgeinfo.js";
+export * from "./accountgettrendingrequestbody.js";
+export * from "./accountgettrendingresponsebody.js";
 export * from "./accountleaderboardhistory.js";
 export * from "./accountsearch.js";
+export * from "./accountviewstats.js";
 export * from "./admincmsitem.js";
+export * from "./analyticstrackeventrequestbody.js";
+export * from "./analyticstrackeventresponsebody.js";
 export * from "./assetitem.js";
 export * from "./badge.js";
 export * from "./badgesuggesttags.js";
 export * from "./badgevaluefilter.js";
 export * from "./bestleaderboardrank.js";
+export * from "./bucketleader.js";
 export * from "./card.js";
 export * from "./chosenrole.js";
 export * from "./city.js";
@@ -52,11 +58,15 @@ export * from "./requestbody.js";
 export * from "./resource.js";
 export * from "./responsebody.js";
 export * from "./role.js";
+export * from "./searchgettrendingrequestbody.js";
+export * from "./searchgettrendingresponsebody.js";
 export * from "./security.js";
 export * from "./session.js";
 export * from "./setremovecolortag.js";
 export * from "./setremovedesigntag.js";
 export * from "./state.js";
+export * from "./trendingaccount.js";
+export * from "./trendingsearch.js";
 export * from "./v1accountapp.js";
 export * from "./v1accountbadgebookmark.js";
 export * from "./v1accountbadgebookmarksresponsebody.js";
@@ -134,6 +144,7 @@ export * from "./v1activitylistaccountfeedresponsebody.js";
 export * from "./v1activitylistglobalfeedrequestbody.js";
 export * from "./v1activitylistglobalfeedresponsebody.js";
 export * from "./v1activitystreamfeedevent.js";
+export * from "./v1activitystreamheartbeat.js";
 export * from "./v1admincmsarchiverequestbody.js";
 export * from "./v1admincmscreaterequestbody.js";
 export * from "./v1admincmscreateresponsebody.js";
@@ -175,6 +186,7 @@ export * from "./v1leaderboardgetaccountleaderboardrequestbody.js";
 export * from "./v1leaderboardgetaccountleaderboardresponsebody.js";
 export * from "./v1leaderboardgetaccountsmetarequestbody.js";
 export * from "./v1leaderboardgetaccountsmetaresponsebody.js";
+export * from "./v1leaderboardgetbucketleadersrequestbody.js";
 export * from "./v1leaderboardgetgroupleaderboardrequestbody.js";
 export * from "./v1leaderboardgetgroupleaderboardresponsebody.js";
 export * from "./v1leaderboardgetgroupsmetarequestbody.js";

package/src/models/components/leaderboardgetchangesrequestbody.ts

@@ -61,7 +61,7 @@ export type Metric = ClosedEnum<typeof Metric>;
 /**
  * Lookback window for the delta.
  */
-export const Window = {
+export const LeaderboardGetChangesRequestBodyWindow = {
   TwentyFourh: "24h",
   Sevend: "7d",
   Thirtyd: "30d",
@@ -71,7 +71,9 @@ export const Window = {
 /**
  * Lookback window for the delta.
  */
-export type Window = ClosedEnum<typeof Window>;
+export type LeaderboardGetChangesRequestBodyWindow = ClosedEnum<
+  typeof LeaderboardGetChangesRequestBodyWindow
+>;
 
 export type LeaderboardGetChangesRequestBody = {
   /**
@@ -93,7 +95,7 @@ export type LeaderboardGetChangesRequestBody = {
   /**
    * Lookback window for the delta.
    */
-  window: Window;
+  window: LeaderboardGetChangesRequestBodyWindow;
 };
 
 /** @internal */
@@ -111,8 +113,10 @@ export const Metric$outboundSchema: z.ZodNativeEnum<typeof Metric> = z
   .nativeEnum(Metric);
 
 /** @internal */
-export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> = z
-  .nativeEnum(Window);
+export const LeaderboardGetChangesRequestBodyWindow$outboundSchema:
+  z.ZodNativeEnum<typeof LeaderboardGetChangesRequestBodyWindow> = z.nativeEnum(
+    LeaderboardGetChangesRequestBodyWindow,
+  );
 
 /** @internal */
 export type LeaderboardGetChangesRequestBody$Outbound = {
@@ -133,7 +137,7 @@ export const LeaderboardGetChangesRequestBody$outboundSchema: z.ZodType<
   leaderboard: LeaderboardGetChangesRequestBodyLeaderboard$outboundSchema,
   limit: z.number().int().optional(),
   metric: Metric$outboundSchema,
-  window: Window$outboundSchema,
+  window: LeaderboardGetChangesRequestBodyWindow$outboundSchema,
 });
 
 export function leaderboardGetChangesRequestBodyToJSON(

package/src/models/components/searchgettrendingrequestbody.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Which search surface to query.
+ */
+export const Source = {
+  Badge: "badge",
+  App: "app",
+  Account: "account",
+} as const;
+/**
+ * Which search surface to query.
+ */
+export type Source = ClosedEnum<typeof Source>;
+
+/**
+ * Lookback window for trending compute.
+ */
+export const SearchGetTrendingRequestBodyWindow = {
+  TwentyFourh: "24h",
+  Sevend: "7d",
+  Thirtyd: "30d",
+} as const;
+/**
+ * Lookback window for trending compute.
+ */
+export type SearchGetTrendingRequestBodyWindow = ClosedEnum<
+  typeof SearchGetTrendingRequestBodyWindow
+>;
+
+export type SearchGetTrendingRequestBody = {
+  /**
+   * Max queries returned. Default 100.
+   */
+  limit?: number | undefined;
+  /**
+   * Which search surface to query.
+   */
+  source: Source;
+  /**
+   * Lookback window for trending compute.
+   */
+  window: SearchGetTrendingRequestBodyWindow;
+};
+
+/** @internal */
+export const Source$outboundSchema: z.ZodNativeEnum<typeof Source> = z
+  .nativeEnum(Source);
+
+/** @internal */
+export const SearchGetTrendingRequestBodyWindow$outboundSchema: z.ZodNativeEnum<
+  typeof SearchGetTrendingRequestBodyWindow
+> = z.nativeEnum(SearchGetTrendingRequestBodyWindow);
+
+/** @internal */
+export type SearchGetTrendingRequestBody$Outbound = {
+  limit?: number | undefined;
+  source: string;
+  window: string;
+};
+
+/** @internal */
+export const SearchGetTrendingRequestBody$outboundSchema: z.ZodType<
+  SearchGetTrendingRequestBody$Outbound,
+  z.ZodTypeDef,
+  SearchGetTrendingRequestBody
+> = z.object({
+  limit: z.number().int().optional(),
+  source: Source$outboundSchema,
+  window: SearchGetTrendingRequestBodyWindow$outboundSchema,
+});
+
+export function searchGetTrendingRequestBodyToJSON(
+  searchGetTrendingRequestBody: SearchGetTrendingRequestBody,
+): string {
+  return JSON.stringify(
+    SearchGetTrendingRequestBody$outboundSchema.parse(
+      searchGetTrendingRequestBody,
+    ),
+  );
+}

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

package/src/models/components/trendingaccount.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 {
+  LeaderboardAccount,
+  LeaderboardAccount$inboundSchema,
+} from "./leaderboardaccount.js";
+
+export type TrendingAccount = {
+  account?: LeaderboardAccount | null | undefined;
+  accountId: number;
+  /**
+   * Total profile loads in the window
+   */
+  totalViews: number;
+  /**
+   * Distinct viewers in the window
+   */
+  uniqueViews: number;
+};
+
+/** @internal */
+export const TrendingAccount$inboundSchema: z.ZodType<
+  TrendingAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  account: z.nullable(LeaderboardAccount$inboundSchema).optional(),
+  accountId: z.number().int(),
+  totalViews: z.number().int(),
+  uniqueViews: z.number().int(),
+});
+
+export function trendingAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TrendingAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TrendingAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TrendingAccount' from JSON`,
+  );
+}

package/src/models/components/trendingsearch.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 TrendingSearch = {
+  /**
+   * The search query as first typed
+   */
+  query: string;
+  /**
+   * Total times this query was searched
+   */
+  totalSearches: number;
+  /**
+   * Distinct searchers in the window
+   */
+  uniqueSearchers: number;
+};
+
+/** @internal */
+export const TrendingSearch$inboundSchema: z.ZodType<
+  TrendingSearch,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  totalSearches: z.number().int(),
+  uniqueSearchers: z.number().int(),
+});
+
+export function trendingSearchFromJSON(
+  jsonString: string,
+): SafeParseResult<TrendingSearch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TrendingSearch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TrendingSearch' from JSON`,
+  );
+}

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

package/src/models/components/v1leaderboardgetbucketleadersrequestbody.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Currently only XP is supported.
+ */
+export const V1LeaderboardGetBucketLeadersRequestBodyLeaderboard = {
+  Xp: "xp",
+} as const;
+/**
+ * Currently only XP is supported.
+ */
+export type V1LeaderboardGetBucketLeadersRequestBodyLeaderboard = ClosedEnum<
+  typeof V1LeaderboardGetBucketLeadersRequestBodyLeaderboard
+>;
+
+export type V1LeaderboardGetBucketLeadersRequestBody = {
+  /**
+   * Levels per bucket. 0 defaults to 10.
+   */
+  bucketSize?: number | undefined;
+  /**
+   * Currently only XP is supported.
+   */
+  leaderboard: V1LeaderboardGetBucketLeadersRequestBodyLeaderboard;
+};
+
+/** @internal */
+export const V1LeaderboardGetBucketLeadersRequestBodyLeaderboard$outboundSchema:
+  z.ZodNativeEnum<typeof V1LeaderboardGetBucketLeadersRequestBodyLeaderboard> =
+    z.nativeEnum(V1LeaderboardGetBucketLeadersRequestBodyLeaderboard);
+
+/** @internal */
+export type V1LeaderboardGetBucketLeadersRequestBody$Outbound = {
+  bucketSize?: number | undefined;
+  leaderboard: string;
+};
+
+/** @internal */
+export const V1LeaderboardGetBucketLeadersRequestBody$outboundSchema: z.ZodType<
+  V1LeaderboardGetBucketLeadersRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1LeaderboardGetBucketLeadersRequestBody
+> = z.object({
+  bucketSize: z.number().int().optional(),
+  leaderboard:
+    V1LeaderboardGetBucketLeadersRequestBodyLeaderboard$outboundSchema,
+});
+
+export function v1LeaderboardGetBucketLeadersRequestBodyToJSON(
+  v1LeaderboardGetBucketLeadersRequestBody:
+    V1LeaderboardGetBucketLeadersRequestBody,
+): string {
+  return JSON.stringify(
+    V1LeaderboardGetBucketLeadersRequestBody$outboundSchema.parse(
+      v1LeaderboardGetBucketLeadersRequestBody,
+    ),
+  );
+}

package/src/models/operations/accountgetinfo.ts

@@ -9,6 +9,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type AccountGetInfoRequest = {
+  xForwardedFor?: string | undefined;
+  userAgent?: string | undefined;
+  xVisitorId?: string | undefined;
+  accountSearch: components.AccountSearch;
+};
+
 export type AccountGetInfoResponse = {
   httpMeta: components.HTTPMetadata;
   /**
@@ -19,6 +26,41 @@ export type AccountGetInfoResponse = {
     | undefined;
 };
 
+/** @internal */
+export type AccountGetInfoRequest$Outbound = {
+  "X-Forwarded-For"?: string | undefined;
+  "User-Agent"?: string | undefined;
+  "X-Visitor-Id"?: string | undefined;
+  AccountSearch: components.AccountSearch$Outbound;
+};
+
+/** @internal */
+export const AccountGetInfoRequest$outboundSchema: z.ZodType<
+  AccountGetInfoRequest$Outbound,
+  z.ZodTypeDef,
+  AccountGetInfoRequest
+> = z.object({
+  xForwardedFor: z.string().optional(),
+  userAgent: z.string().optional(),
+  xVisitorId: z.string().optional(),
+  accountSearch: components.AccountSearch$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    xForwardedFor: "X-Forwarded-For",
+    userAgent: "User-Agent",
+    xVisitorId: "X-Visitor-Id",
+    accountSearch: "AccountSearch",
+  });
+});
+
+export function accountGetInfoRequestToJSON(
+  accountGetInfoRequest: AccountGetInfoRequest,
+): string {
+  return JSON.stringify(
+    AccountGetInfoRequest$outboundSchema.parse(accountGetInfoRequest),
+  );
+}
+
 /** @internal */
 export const AccountGetInfoResponse$inboundSchema: z.ZodType<
   AccountGetInfoResponse,

package/src/models/operations/accountgettrending.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 AccountGetTrendingResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  accountGetTrendingResponseBody?:
+    | components.AccountGetTrendingResponseBody
+    | undefined;
+};
+
+/** @internal */
+export const AccountGetTrendingResponse$inboundSchema: z.ZodType<
+  AccountGetTrendingResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AccountGetTrendingResponseBody: components
+    .AccountGetTrendingResponseBody$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AccountGetTrendingResponseBody": "accountGetTrendingResponseBody",
+  });
+});
+
+export function accountGetTrendingResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountGetTrendingResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountGetTrendingResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountGetTrendingResponse' from JSON`,
+  );
+}

package/src/models/operations/accountgetviewstats.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 AccountGetViewStatsResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  accountViewStats?: components.AccountViewStats | undefined;
+};
+
+/** @internal */
+export const AccountGetViewStatsResponse$inboundSchema: z.ZodType<
+  AccountGetViewStatsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AccountViewStats: components.AccountViewStats$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AccountViewStats": "accountViewStats",
+  });
+});
+
+export function accountGetViewStatsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountGetViewStatsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountGetViewStatsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountGetViewStatsResponse' from JSON`,
+  );
+}

package/src/models/operations/badgesearchbadges.ts

@@ -11,6 +11,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type BadgeSearchBadgesRequest = {
   xForwardedFor?: string | undefined;
+  userAgent?: string | undefined;
+  xVisitorId?: string | undefined;
   v1SearchRequest: components.V1SearchRequest;
 };
 
@@ -27,6 +29,8 @@ export type BadgeSearchBadgesResponse = {
 /** @internal */
 export type BadgeSearchBadgesRequest$Outbound = {
   "X-Forwarded-For"?: string | undefined;
+  "User-Agent"?: string | undefined;
+  "X-Visitor-Id"?: string | undefined;
   V1SearchRequest: components.V1SearchRequest$Outbound;
 };
 
@@ -37,10 +41,14 @@ export const BadgeSearchBadgesRequest$outboundSchema: z.ZodType<
   BadgeSearchBadgesRequest
 > = z.object({
   xForwardedFor: z.string().optional(),
+  userAgent: z.string().optional(),
+  xVisitorId: z.string().optional(),
   v1SearchRequest: components.V1SearchRequest$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     xForwardedFor: "X-Forwarded-For",
+    userAgent: "User-Agent",
+    xVisitorId: "X-Visitor-Id",
     v1SearchRequest: "V1SearchRequest",
   });
 });