@steamsets/client-ts 0.27.8 → 0.27.10

package/src/funcs/accountLogout.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Logout from session
+ */
 export function accountLogout(
   client: SteamSetsCore,
   options?: RequestOptions,

package/src/funcs/accountQueueUpdate.ts

@@ -3,14 +3,13 @@
  */
 
 import { SteamSetsCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.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,
@@ -26,9 +25,12 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Queue account update
+ */
 export function accountQueueUpdate(
   client: SteamSetsCore,
-  request: components.V1AccountQueueUpdateRequestBody,
+  request: operations.AccountQueueUpdateRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -53,7 +55,7 @@ export function accountQueueUpdate(
 
 async function $do(
   client: SteamSetsCore,
-  request: components.V1AccountQueueUpdateRequestBody,
+  request: operations.AccountQueueUpdateRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -74,21 +76,27 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      components.V1AccountQueueUpdateRequestBody$outboundSchema.parse(value),
+    (value) => operations.AccountQueueUpdateRequest$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 body = encodeJSON("body", payload.V1AccountQueueUpdateRequestBody, {
+    explode: true,
+  });
 
   const path = pathToFunc("/v1/account.queueUpdate")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/problem+json",
+    "X-Forwarded-For": encodeSimple(
+      "X-Forwarded-For",
+      payload["X-Forwarded-For"],
+      { explode: false, charEncoding: "none" },
+    ),
   }));
 
   const secConfig = await extractSecurity(client._options.token);

package/src/funcs/accountReconnectConnection.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Reconnect OAuth connection
+ */
 export function accountReconnectConnection(
   client: SteamSetsCore,
   request: components.V1AccountReconnectRequestBody,

package/src/funcs/accountRefreshSession.ts

@@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Refresh session token
+ */
 export function accountRefreshSession(
   client: SteamSetsCore,
   request: operations.AccountRefreshSessionRequest,

package/src/funcs/accountSendEmailVerification.ts

@@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Send email verification
+ */
 export function accountSendEmailVerification(
   client: SteamSetsCore,
   request: operations.AccountSendEmailVerificationRequest,

package/src/funcs/accountSubscribeEmail.ts

@@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Subscribe to email notifications
+ */
 export function accountSubscribeEmail(
   client: SteamSetsCore,
   request: operations.AccountSubscribeEmailRequest,

package/src/funcs/accountUpdateConnection.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update OAuth connection
+ */
 export function accountUpdateConnection(
   client: SteamSetsCore,
   request: components.V1AccountUpdateConnectionRequestBody,

package/src/funcs/accountUpdateDeveloperApp.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update developer application
+ */
 export function accountUpdateDeveloperApp(
   client: SteamSetsCore,
   request: components.V1AccountDeveloperAppUpdateRequestBody,

package/src/funcs/accountUpdateImages.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account images
+ */
 export function accountUpdateImages(
   client: SteamSetsCore,
   request: components.V1AccountUpdateImageRequestBody,

package/src/funcs/accountUpdateRole.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account role
+ */
 export function accountUpdateRole(
   client: SteamSetsCore,
   request: components.V1AccountUpdateRoleRequestBody,

package/src/funcs/accountUpdateSettings.ts

@@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account settings
+ */
 export function accountUpdateSettings(
   client: SteamSetsCore,
   request: operations.AccountUpdateSettingsRequest,

package/src/funcs/accountUpdateVanity.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account vanity URL
+ */
 export function accountUpdateVanity(
   client: SteamSetsCore,
   request: components.V1AccountUpdateVanityRequestBody,

package/src/funcs/accountUploadImages.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Upload images
+ */
 export function accountUploadImages(
   client: SteamSetsCore,
   request: components.V1AccountUploadImagesRequestBody,

package/src/funcs/accountVerifyConnection.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Verify OAuth connection
+ */
 export function accountVerifyConnection(
   client: SteamSetsCore,
   request: components.V1AccountVerifyConnectionRequestBody,

package/src/funcs/accountVerifyEmail.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Verify email address
+ */
 export function accountVerifyEmail(
   client: SteamSetsCore,
   request: components.V1AccountVerifyEmailRequestBody,

package/src/funcs/adminGetAccount.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get account for admin
+ */
 export function adminGetAccount(
   client: SteamSetsCore,
   request: components.AccountSearch,

package/src/funcs/adminRemoveVanity.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Remove vanity URL
+ */
 export function adminRemoveVanity(
   client: SteamSetsCore,
   request: components.AccountSearch,

package/src/funcs/adminUpdateResources.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account resources
+ */
 export function adminUpdateResources(
   client: SteamSetsCore,
   request: components.V1AdminUpdateResourcesRequestBody,

package/src/funcs/adminUpdateRoles.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Update account roles
+ */
 export function adminUpdateRoles(
   client: SteamSetsCore,
   request: components.V1AdminUpdateRolesRequestBody,

package/src/funcs/appsListBadges.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List app badges
+ */
 export function appsListBadges(
   client: SteamSetsCore,
   request: components.V1AppListBadgesRequestBody,

package/src/funcs/badgeBadgeListAccounts.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List accounts for badge
+ */
 export function badgeBadgeListAccounts(
   client: SteamSetsCore,
   request: components.V1BadgeListAccountsRequestBody,

package/src/funcs/badgeSearch.ts

@@ -3,14 +3,13 @@
  */
 
 import { SteamSetsCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.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,
@@ -26,9 +25,12 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Search badges
+ */
 export function badgeSearch(
   client: SteamSetsCore,
-  request: components.V1SearchRequest,
+  request: operations.BadgeSearchBadgesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -53,7 +55,7 @@ export function badgeSearch(
 
 async function $do(
   client: SteamSetsCore,
-  request: components.V1SearchRequest,
+  request: operations.BadgeSearchBadgesRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -74,20 +76,25 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.V1SearchRequest$outboundSchema.parse(value),
+    (value) => operations.BadgeSearchBadgesRequest$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 body = encodeJSON("body", payload.V1SearchRequest, { explode: true });
 
   const path = pathToFunc("/v1/badge.searchBadges")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
+    "X-Forwarded-For": encodeSimple(
+      "X-Forwarded-For",
+      payload["X-Forwarded-For"],
+      { explode: false, charEncoding: "none" },
+    ),
   }));
 
   const secConfig = await extractSecurity(client._options.token);

package/src/funcs/badgeSuggestTags.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Suggest badge tag
+ */
 export function badgeSuggestTags(
   client: SteamSetsCore,
   request: components.V1BadgeSuggestTagsRequestBody,

package/src/funcs/badgesListTags.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List badge tags
+ */
 export function badgesListTags(
   client: SteamSetsCore,
   options?: RequestOptions,

package/src/funcs/badgesTag.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Tag a badge
+ */
 export function badgesTag(
   client: SteamSetsCore,
   request: components.V1BadgeTagBadgeRequestBody,

package/src/funcs/leaderboardGetAccount.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get account leaderboard
+ */
 export function leaderboardGetAccount(
   client: SteamSetsCore,
   request: components.V1LeaderboardGetAccountLeaderboardRequestBody,

package/src/funcs/leaderboardGetAccountsMeta.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get accounts leaderboard metadata
+ */
 export function leaderboardGetAccountsMeta(
   client: SteamSetsCore,
   request: components.V1LeaderboardGetAccountsMetaRequestBody,

package/src/funcs/leaderboardGetGroup.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get group leaderboard
+ */
 export function leaderboardGetGroup(
   client: SteamSetsCore,
   request: components.V1LeaderboardGetGroupLeaderboardRequestBody,

package/src/funcs/leaderboardGetGroupsMeta.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get groups leaderboard metadata
+ */
 export function leaderboardGetGroupsMeta(
   client: SteamSetsCore,
   request: components.V1LeaderboardGetGroupsMetaRequestBody,

package/src/funcs/leaderboardGetLowestRanks.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get lowest ranked accounts
+ */
 export function leaderboardGetLowestRanks(
   client: SteamSetsCore,
   request: components.V1LeaderboardGetLowestRanksRequestBody,

package/src/funcs/leaderboardPreviewAccountRank.ts

@@ -26,6 +26,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Preview account rank
+ */
 export function leaderboardPreviewAccountRank(
   client: SteamSetsCore,
   request: components.V1LeaderboardPreviewAccountRankRequestBody,

package/src/funcs/leaderboardsList.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List leaderboard badges
+ */
 export function leaderboardsList(
   client: SteamSetsCore,
   options?: RequestOptions,

package/src/funcs/livenessCheck.ts

@@ -24,10 +24,29 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Liveness check
+ * Service Health Check
  *
  * @remarks
- * This endpoint checks if the service is alive.
+ * This endpoint provides a simple health check to verify that the Steamsets API is operational and ready to serve requests.
+ *
+ * <Info>
+ * This endpoint is commonly used by load balancers, monitoring systems, and container orchestrators to check service availability.
+ * </Info>
+ *
+ * <Tip>
+ * Use this endpoint for automated health monitoring - it has minimal overhead and responds quickly.
+ * </Tip>
+ *
+ * ## Use Cases
+ *
+ * - **Load Balancer Health Checks**: Configure your load balancer to ping this endpoint
+ * - **Monitoring Systems**: Set up alerts when this endpoint becomes unavailable
+ * - **Container Health Checks**: Use in Docker/Kubernetes health check configurations
+ * - **API Status Verification**: Quick way to verify the service is responding
+ *
+ * ## Response Format
+ *
+ * The endpoint returns a simple JSON object with a status message confirming the service is alive and operational.
  */
 export function livenessCheck(
   client: SteamSetsCore,

package/src/funcs/locationGet.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List available locations
+ */
 export function locationGet(
   client: SteamSetsCore,
   options?: RequestOptions,

package/src/funcs/staffList.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * List staff members
+ */
 export function staffList(
   client: SteamSetsCore,
   options?: RequestOptions,

package/src/funcs/statsGet.ts

@@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
+/**
+ * Get platform statistics
+ */
 export function statsGet(
   client: SteamSetsCore,
   options?: RequestOptions,

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.27.8",
-  genVersion: "2.687.13",
+  sdkVersion: "0.27.10",
+  genVersion: "2.694.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.27.8 2.687.13 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.27.10 2.694.1 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/accountsearch.ts

@@ -7,21 +7,21 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  AccountSearchIDStruct,
-  AccountSearchIDStruct$inboundSchema,
-  AccountSearchIDStruct$Outbound,
-  AccountSearchIDStruct$outboundSchema,
-} from "./accountsearchidstruct.js";
+  IDSearch,
+  IDSearch$inboundSchema,
+  IDSearch$Outbound,
+  IDSearch$outboundSchema,
+} from "./idsearch.js";
 import {
-  AccountSearchVanityStruct,
-  AccountSearchVanityStruct$inboundSchema,
-  AccountSearchVanityStruct$Outbound,
-  AccountSearchVanityStruct$outboundSchema,
-} from "./accountsearchvanitystruct.js";
+  VanitySearch,
+  VanitySearch$inboundSchema,
+  VanitySearch$Outbound,
+  VanitySearch$outboundSchema,
+} from "./vanitysearch.js";
 
 export type AccountSearch = {
-  id?: AccountSearchIDStruct | undefined;
-  vanity?: AccountSearchVanityStruct | undefined;
+  id?: IDSearch | undefined;
+  vanity?: VanitySearch | undefined;
 };
 
 /** @internal */
@@ -30,14 +30,14 @@ export const AccountSearch$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: AccountSearchIDStruct$inboundSchema.optional(),
-  vanity: AccountSearchVanityStruct$inboundSchema.optional(),
+  id: IDSearch$inboundSchema.optional(),
+  vanity: VanitySearch$inboundSchema.optional(),
 });
 
 /** @internal */
 export type AccountSearch$Outbound = {
-  id?: AccountSearchIDStruct$Outbound | undefined;
-  vanity?: AccountSearchVanityStruct$Outbound | undefined;
+  id?: IDSearch$Outbound | undefined;
+  vanity?: VanitySearch$Outbound | undefined;
 };
 
 /** @internal */
@@ -46,8 +46,8 @@ export const AccountSearch$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AccountSearch
 > = z.object({
-  id: AccountSearchIDStruct$outboundSchema.optional(),
-  vanity: AccountSearchVanityStruct$outboundSchema.optional(),
+  id: IDSearch$outboundSchema.optional(),
+  vanity: VanitySearch$outboundSchema.optional(),
 });
 
 /**