@steamsets/client-ts 0.27.8 → 0.27.10

package/src/models/operations/accountqueueupdate.ts

@@ -9,10 +9,85 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type AccountQueueUpdateRequest = {
+  xForwardedFor?: string | undefined;
+  v1AccountQueueUpdateRequestBody: components.V1AccountQueueUpdateRequestBody;
+};
+
 export type AccountQueueUpdateResponse = {
   httpMeta: components.HTTPMetadata;
 };
 
+/** @internal */
+export const AccountQueueUpdateRequest$inboundSchema: z.ZodType<
+  AccountQueueUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Forwarded-For": z.string().optional(),
+  V1AccountQueueUpdateRequestBody:
+    components.V1AccountQueueUpdateRequestBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "X-Forwarded-For": "xForwardedFor",
+    "V1AccountQueueUpdateRequestBody": "v1AccountQueueUpdateRequestBody",
+  });
+});
+
+/** @internal */
+export type AccountQueueUpdateRequest$Outbound = {
+  "X-Forwarded-For"?: string | undefined;
+  V1AccountQueueUpdateRequestBody:
+    components.V1AccountQueueUpdateRequestBody$Outbound;
+};
+
+/** @internal */
+export const AccountQueueUpdateRequest$outboundSchema: z.ZodType<
+  AccountQueueUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  AccountQueueUpdateRequest
+> = z.object({
+  xForwardedFor: z.string().optional(),
+  v1AccountQueueUpdateRequestBody:
+    components.V1AccountQueueUpdateRequestBody$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    xForwardedFor: "X-Forwarded-For",
+    v1AccountQueueUpdateRequestBody: "V1AccountQueueUpdateRequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AccountQueueUpdateRequest$ {
+  /** @deprecated use `AccountQueueUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = AccountQueueUpdateRequest$inboundSchema;
+  /** @deprecated use `AccountQueueUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = AccountQueueUpdateRequest$outboundSchema;
+  /** @deprecated use `AccountQueueUpdateRequest$Outbound` instead. */
+  export type Outbound = AccountQueueUpdateRequest$Outbound;
+}
+
+export function accountQueueUpdateRequestToJSON(
+  accountQueueUpdateRequest: AccountQueueUpdateRequest,
+): string {
+  return JSON.stringify(
+    AccountQueueUpdateRequest$outboundSchema.parse(accountQueueUpdateRequest),
+  );
+}
+
+export function accountQueueUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountQueueUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountQueueUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountQueueUpdateRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const AccountQueueUpdateResponse$inboundSchema: z.ZodType<
   AccountQueueUpdateResponse,

package/src/models/operations/badgesearchbadges.ts

@@ -9,6 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type BadgeSearchBadgesRequest = {
+  xForwardedFor?: string | undefined;
+  v1SearchRequest: components.V1SearchRequest;
+};
+
 export type BadgeSearchBadgesResponse = {
   httpMeta: components.HTTPMetadata;
   /**
@@ -19,6 +24,73 @@ export type BadgeSearchBadgesResponse = {
     | undefined;
 };
 
+/** @internal */
+export const BadgeSearchBadgesRequest$inboundSchema: z.ZodType<
+  BadgeSearchBadgesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Forwarded-For": z.string().optional(),
+  V1SearchRequest: components.V1SearchRequest$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "X-Forwarded-For": "xForwardedFor",
+    "V1SearchRequest": "v1SearchRequest",
+  });
+});
+
+/** @internal */
+export type BadgeSearchBadgesRequest$Outbound = {
+  "X-Forwarded-For"?: string | undefined;
+  V1SearchRequest: components.V1SearchRequest$Outbound;
+};
+
+/** @internal */
+export const BadgeSearchBadgesRequest$outboundSchema: z.ZodType<
+  BadgeSearchBadgesRequest$Outbound,
+  z.ZodTypeDef,
+  BadgeSearchBadgesRequest
+> = z.object({
+  xForwardedFor: z.string().optional(),
+  v1SearchRequest: components.V1SearchRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    xForwardedFor: "X-Forwarded-For",
+    v1SearchRequest: "V1SearchRequest",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadgeSearchBadgesRequest$ {
+  /** @deprecated use `BadgeSearchBadgesRequest$inboundSchema` instead. */
+  export const inboundSchema = BadgeSearchBadgesRequest$inboundSchema;
+  /** @deprecated use `BadgeSearchBadgesRequest$outboundSchema` instead. */
+  export const outboundSchema = BadgeSearchBadgesRequest$outboundSchema;
+  /** @deprecated use `BadgeSearchBadgesRequest$Outbound` instead. */
+  export type Outbound = BadgeSearchBadgesRequest$Outbound;
+}
+
+export function badgeSearchBadgesRequestToJSON(
+  badgeSearchBadgesRequest: BadgeSearchBadgesRequest,
+): string {
+  return JSON.stringify(
+    BadgeSearchBadgesRequest$outboundSchema.parse(badgeSearchBadgesRequest),
+  );
+}
+
+export function badgeSearchBadgesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<BadgeSearchBadgesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BadgeSearchBadgesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BadgeSearchBadgesRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const BadgeSearchBadgesResponse$inboundSchema: z.ZodType<
   BadgeSearchBadgesResponse,

package/src/sdk/account.ts

@@ -45,6 +45,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Account extends ClientSDK {
+  /**
+   * Bookmark or unbookmark a badge
+   */
   async bookmarkBadge(
     request: components.V1AccountBookmarkBadgeRequestBody,
     options?: RequestOptions,
@@ -56,6 +59,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Compare badge collections between accounts
+   */
   async compareBadges(
     request: components.V1AccountCompareBadgesRequestBody,
     options?: RequestOptions,
@@ -67,6 +73,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Create OAuth or domain connection
+   */
   async createConnection(
     request: components.V1AccountCreateConnectionRequestBody,
     options?: RequestOptions,
@@ -78,6 +87,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Create developer application
+   */
   async createDeveloperApp(
     request: components.V1AccountCreateDeveloperAppRequestBody,
     options?: RequestOptions,
@@ -89,6 +101,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete OAuth or domain connection
+   */
   async deleteConnection(
     request: components.V1AccountDeleteConnectionRequestBody,
     options?: RequestOptions,
@@ -100,6 +115,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete developer application
+   */
   async deleteDeveloperApp(
     request: components.V1AccountDeleteDeveloperAppRequestBody,
     options?: RequestOptions,
@@ -111,6 +129,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete uploaded images
+   */
   async deleteImages(
     request: components.V1AccountDeleteImagesRequestBody,
     options?: RequestOptions,
@@ -122,6 +143,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete user session
+   */
   async deleteSession(
     request: components.V1AccountDeleteSessionRequestBody,
     options?: RequestOptions,
@@ -133,6 +157,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get account badge statistics
+   */
   async getBadgeStats(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -144,6 +171,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get account data points for charts
+   */
   async getDataPoints(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -155,6 +185,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get account profile information
+   */
   async getInfo(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -166,6 +199,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get account metadata
+   */
   async getMeta(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -177,6 +213,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get user session information
+   */
   async getSession(
     options?: RequestOptions,
   ): Promise<operations.AccountGetSessionResponse> {
@@ -186,6 +225,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get account settings
+   */
   async getSettings(
     options?: RequestOptions,
   ): Promise<operations.AccountGetSettingsResponse> {
@@ -195,6 +237,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List account owned apps
+   */
   async listApps(
     request: components.V1AccountListAppsRequestBody,
     options?: RequestOptions,
@@ -206,6 +251,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List bookmarked badges
+   */
   async listBadgeBookmarks(
     options?: RequestOptions,
   ): Promise<operations.AccountListBadgeBookmarksResponse> {
@@ -215,6 +263,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List account badges
+   */
   async listBadges(
     request: components.V1AccountListBadgesRequestBody,
     options?: RequestOptions,
@@ -226,6 +277,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List account friends
+   */
   async listFriends(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -237,6 +291,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List uploaded images
+   */
   async listImages(
     options?: RequestOptions,
   ): Promise<operations.AccountListImagesResponse> {
@@ -246,6 +303,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Get leaderboard history
+   */
   async listLeaderboardHistory(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -257,6 +317,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * List owned badges
+   */
   async listOwnedBadges(
     options?: RequestOptions,
   ): Promise<operations.AccountListOwnedBadgesResponse> {
@@ -266,6 +329,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Login with Steam
+   */
   async login(
     request: operations.AccountLoginRequest,
     options?: RequestOptions,
@@ -277,6 +343,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Logout from session
+   */
   async logout(
     options?: RequestOptions,
   ): Promise<operations.AccountLogoutResponse> {
@@ -286,8 +355,11 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Queue account update
+   */
   async queueUpdate(
-    request: components.V1AccountQueueUpdateRequestBody,
+    request: operations.AccountQueueUpdateRequest,
     options?: RequestOptions,
   ): Promise<operations.AccountQueueUpdateResponse> {
     return unwrapAsync(accountQueueUpdate(
@@ -297,6 +369,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Reconnect OAuth connection
+   */
   async reconnectConnection(
     request: components.V1AccountReconnectRequestBody,
     options?: RequestOptions,
@@ -308,6 +383,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Refresh session token
+   */
   async refreshSession(
     request: operations.AccountRefreshSessionRequest,
     options?: RequestOptions,
@@ -319,6 +397,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Send email verification
+   */
   async sendEmailVerification(
     request: operations.AccountSendEmailVerificationRequest,
     options?: RequestOptions,
@@ -330,6 +411,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Subscribe to email notifications
+   */
   async subscribeEmail(
     request: operations.AccountSubscribeEmailRequest,
     options?: RequestOptions,
@@ -341,6 +425,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update OAuth connection
+   */
   async updateConnection(
     request: components.V1AccountUpdateConnectionRequestBody,
     options?: RequestOptions,
@@ -352,6 +439,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update developer application
+   */
   async updateDeveloperApp(
     request: components.V1AccountDeveloperAppUpdateRequestBody,
     options?: RequestOptions,
@@ -363,6 +453,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account images
+   */
   async updateImages(
     request: components.V1AccountUpdateImageRequestBody,
     options?: RequestOptions,
@@ -374,6 +467,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account role
+   */
   async updateRole(
     request: components.V1AccountUpdateRoleRequestBody,
     options?: RequestOptions,
@@ -385,6 +481,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account settings
+   */
   async updateSettings(
     request: operations.AccountUpdateSettingsRequest,
     options?: RequestOptions,
@@ -396,6 +495,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account vanity URL
+   */
   async updateVanity(
     request: components.V1AccountUpdateVanityRequestBody,
     options?: RequestOptions,
@@ -407,6 +509,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Upload images
+   */
   async uploadImages(
     request: components.V1AccountUploadImagesRequestBody,
     options?: RequestOptions,
@@ -418,6 +523,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Verify OAuth connection
+   */
   async verifyConnection(
     request: components.V1AccountVerifyConnectionRequestBody,
     options?: RequestOptions,
@@ -429,6 +537,9 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Verify email address
+   */
   async verifyEmail(
     request: components.V1AccountVerifyEmailRequestBody,
     options?: RequestOptions,

package/src/sdk/admin.ts

@@ -12,6 +12,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Admin extends ClientSDK {
+  /**
+   * Get account for admin
+   */
   async getAccount(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -23,6 +26,9 @@ export class Admin extends ClientSDK {
     ));
   }
 
+  /**
+   * Remove vanity URL
+   */
   async removeVanity(
     request: components.AccountSearch,
     options?: RequestOptions,
@@ -34,6 +40,9 @@ export class Admin extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account resources
+   */
   async updateResources(
     request: components.V1AdminUpdateResourcesRequestBody,
     options?: RequestOptions,
@@ -45,6 +54,9 @@ export class Admin extends ClientSDK {
     ));
   }
 
+  /**
+   * Update account roles
+   */
   async updateRoles(
     request: components.V1AdminUpdateRolesRequestBody,
     options?: RequestOptions,

package/src/sdk/apps.ts

@@ -9,6 +9,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Apps extends ClientSDK {
+  /**
+   * List app badges
+   */
   async listBadges(
     request: components.V1AppListBadgesRequestBody,
     options?: RequestOptions,

package/src/sdk/badge.ts

@@ -11,6 +11,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Badge extends ClientSDK {
+  /**
+   * List accounts for badge
+   */
   async badgeListAccounts(
     request: components.V1BadgeListAccountsRequestBody,
     options?: RequestOptions,
@@ -22,8 +25,11 @@ export class Badge extends ClientSDK {
     ));
   }
 
+  /**
+   * Search badges
+   */
   async search(
-    request: components.V1SearchRequest,
+    request: operations.BadgeSearchBadgesRequest,
     options?: RequestOptions,
   ): Promise<operations.BadgeSearchBadgesResponse> {
     return unwrapAsync(badgeSearch(
@@ -33,6 +39,9 @@ export class Badge extends ClientSDK {
     ));
   }
 
+  /**
+   * Suggest badge tag
+   */
   async suggestTags(
     request: components.V1BadgeSuggestTagsRequestBody,
     options?: RequestOptions,

package/src/sdk/badges.ts

@@ -33,6 +33,9 @@ export class Badges extends ClientSDK {
     ));
   }
 
+  /**
+   * List badge tags
+   */
   async listTags(
     options?: RequestOptions,
   ): Promise<operations.BadgeListTagsResponse> {
@@ -42,6 +45,9 @@ export class Badges extends ClientSDK {
     ));
   }
 
+  /**
+   * Tag a badge
+   */
   async tag(
     request: components.V1BadgeTagBadgeRequestBody,
     options?: RequestOptions,

package/src/sdk/leaderboard.ts

@@ -14,6 +14,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Leaderboard extends ClientSDK {
+  /**
+   * Get account leaderboard
+   */
   async getAccount(
     request: components.V1LeaderboardGetAccountLeaderboardRequestBody,
     options?: RequestOptions,
@@ -25,6 +28,9 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Get accounts leaderboard metadata
+   */
   async getAccountsMeta(
     request: components.V1LeaderboardGetAccountsMetaRequestBody,
     options?: RequestOptions,
@@ -36,6 +42,9 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Get group leaderboard
+   */
   async getGroup(
     request: components.V1LeaderboardGetGroupLeaderboardRequestBody,
     options?: RequestOptions,
@@ -47,6 +56,9 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Get groups leaderboard metadata
+   */
   async getGroupsMeta(
     request: components.V1LeaderboardGetGroupsMetaRequestBody,
     options?: RequestOptions,
@@ -58,6 +70,9 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Get lowest ranked accounts
+   */
   async getLowestRanks(
     request: components.V1LeaderboardGetLowestRanksRequestBody,
     options?: RequestOptions,
@@ -69,6 +84,9 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Preview account rank
+   */
   async previewAccountRank(
     request: components.V1LeaderboardPreviewAccountRankRequestBody,
     options?: RequestOptions,

package/src/sdk/leaderboards.ts

@@ -8,6 +8,9 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Leaderboards extends ClientSDK {
+  /**
+   * List leaderboard badges
+   */
   async list(
     options?: RequestOptions,
   ): Promise<operations.LeaderboardListBadgesResponse> {