@steamsets/client-ts 0.36.2 → 0.36.3

package/src/funcs/badgesListCrafters.ts

@@ -0,0 +1,249 @@
+/*
+ * 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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List accounts that own a badge (earliest completion first). Donator perk — page size scales with Patreon tier.
+ */
+export function badgesListCrafters(
+  client: SteamSetsCore,
+  request: components.BadgeListCraftersRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.BadgeListCraftersResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.BadgeListCraftersRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.BadgeListCraftersResponse,
+        | errors.ErrorModel
+        | SteamSetsError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.BadgeListCraftersRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/badge.listCrafters")();
+
+  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: "badge.listCrafters",
+    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 || ["429", "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 || 30000,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(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 [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.BadgeListCraftersResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.BadgeListCraftersResponse$inboundSchema, {
+      key: "BadgeListCraftersResponseBody",
+    }),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr([500, 503], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.BadgeListCraftersResponse,
+        | errors.ErrorModel
+        | SteamSetsError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = (responseData as { nextCursor?: unknown }).nextCursor;
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      badgesListCrafters(
+        client,
+        {
+          ...request,
+          cursor: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    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.36.2",
-  genVersion: "2.915.1",
+  sdkVersion: "0.36.3",
+  genVersion: "2.916.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.36.2 2.915.1 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.36.3 2.916.2 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/badgelistcraftersentry.ts

@@ -0,0 +1,262 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Image, Image$inboundSchema } from "./image.js";
+import {
+  LeaderboardCity,
+  LeaderboardCity$inboundSchema,
+} from "./leaderboardcity.js";
+import {
+  LeaderboardCountry,
+  LeaderboardCountry$inboundSchema,
+} from "./leaderboardcountry.js";
+import {
+  LeaderboardRegion,
+  LeaderboardRegion$inboundSchema,
+} from "./leaderboardregion.js";
+import {
+  LeaderboardState,
+  LeaderboardState$inboundSchema,
+} from "./leaderboardstate.js";
+import { Role, Role$inboundSchema } from "./role.js";
+
+/**
+ * The privacy of the account
+ */
+export const BadgeListCraftersEntryPrivacy = {
+  Public: "public",
+  Private: "private",
+  FriendsOnly: "friends_only",
+} as const;
+/**
+ * The privacy of the account
+ */
+export type BadgeListCraftersEntryPrivacy = OpenEnum<
+  typeof BadgeListCraftersEntryPrivacy
+>;
+
+export type BadgeListCraftersEntry = {
+  /**
+   * The animated avatar of the account
+   */
+  animatedAvatar: string;
+  /**
+   * The cost of an app
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  appCost: number;
+  /**
+   * The number of apps the account has
+   */
+  apps: number;
+  /**
+   * The avatar hash of the account
+   */
+  avatar: string;
+  /**
+   * The avatar frame of the account
+   */
+  avatarFrame: string;
+  /**
+   * The number of awards the account has
+   */
+  awardsGiven: number;
+  /**
+   * The number of awards the account has
+   */
+  awardsReceived: number;
+  /**
+   * The background of the account
+   */
+  background: string;
+  /**
+   * The number of badges the account has
+   */
+  badges: number;
+  /**
+   * The number of bans
+   */
+  bans: number;
+  city?: LeaderboardCity | null | undefined;
+  /**
+   * When this account completed the badge (UTC)
+   */
+  completedAt: Date;
+  country?: LeaderboardCountry | null | undefined;
+  /**
+   * The time the account was created
+   */
+  createdAt: Date;
+  /**
+   * The total of donations the account has
+   */
+  donated: number;
+  /**
+   * The economy ban of the account
+   */
+  economyBan: string;
+  /**
+   * The cost of a foil badge
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  foilBadgeCost: number;
+  /**
+   * The number of foil badges the account has
+   */
+  foilBadges: number;
+  /**
+   * The number of friends the account has
+   */
+  friends: number;
+  /**
+   * The number of game bans
+   */
+  gameBans: number;
+  /**
+   * The images of the account
+   */
+  images: Array<Image> | null;
+  /**
+   * The level of the account
+   */
+  level: number;
+  /**
+   * The mini background of the account
+   */
+  miniBackground: string;
+  /**
+   * The name of the account
+   */
+  name: string;
+  /**
+   * The cost of a normal badge
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  normalBadgeCost: number;
+  /**
+   * The number of normal badges the account has
+   */
+  normalBadges: number;
+  /**
+   * The playtime of the account
+   */
+  playtime: number;
+  /**
+   * The number of points the account has
+   */
+  pointsGiven: number;
+  /**
+   * The number of points the account has
+   */
+  pointsReceived: number;
+  /**
+   * The privacy of the account
+   */
+  privacy: BadgeListCraftersEntryPrivacy;
+  region?: LeaderboardRegion | null | undefined;
+  /**
+   * The roles of the account
+   */
+  roles: Array<Role> | null;
+  state?: LeaderboardState | null | undefined;
+  /**
+   * The steam id
+   */
+  steamId: string;
+  /**
+   * The steam sets score
+   */
+  steamSetsScore: number;
+  /**
+   * The vanity of the account
+   */
+  steamSetsVanity: string;
+  /**
+   * The vanity of the account
+   */
+  steamVanity: string;
+  /**
+   * The number of vac bans
+   */
+  vacBans: number;
+  /**
+   * The number of xp the account has
+   */
+  xp: number;
+};
+
+/** @internal */
+export const BadgeListCraftersEntryPrivacy$inboundSchema: z.ZodType<
+  BadgeListCraftersEntryPrivacy,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(BadgeListCraftersEntryPrivacy);
+
+/** @internal */
+export const BadgeListCraftersEntry$inboundSchema: z.ZodType<
+  BadgeListCraftersEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  animatedAvatar: z.string(),
+  appCost: z.number().int(),
+  apps: z.number().int(),
+  avatar: z.string(),
+  avatarFrame: z.string(),
+  awardsGiven: z.number().int(),
+  awardsReceived: z.number().int(),
+  background: z.string(),
+  badges: z.number().int(),
+  bans: z.number().int(),
+  city: z.nullable(LeaderboardCity$inboundSchema).optional(),
+  completedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  country: z.nullable(LeaderboardCountry$inboundSchema).optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  donated: z.number().int(),
+  economyBan: z.string(),
+  foilBadgeCost: z.number().int(),
+  foilBadges: z.number().int(),
+  friends: z.number().int(),
+  gameBans: z.number().int(),
+  images: z.nullable(z.array(Image$inboundSchema)),
+  level: z.number().int(),
+  miniBackground: z.string(),
+  name: z.string(),
+  normalBadgeCost: z.number().int(),
+  normalBadges: z.number().int(),
+  playtime: z.number().int(),
+  pointsGiven: z.number().int(),
+  pointsReceived: z.number().int(),
+  privacy: BadgeListCraftersEntryPrivacy$inboundSchema,
+  region: z.nullable(LeaderboardRegion$inboundSchema).optional(),
+  roles: z.nullable(z.array(Role$inboundSchema)),
+  state: z.nullable(LeaderboardState$inboundSchema).optional(),
+  steamId: z.string(),
+  steamSetsScore: z.number().int(),
+  steamSetsVanity: z.string(),
+  steamVanity: z.string(),
+  vacBans: z.number().int(),
+  xp: z.number().int(),
+});
+
+export function badgeListCraftersEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<BadgeListCraftersEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BadgeListCraftersEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BadgeListCraftersEntry' from JSON`,
+  );
+}

package/src/models/components/badgelistcraftersrequestbody.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type BadgeListCraftersRequestBody = {
+  /**
+   * Badge id
+   */
+  badgeId: string;
+  /**
+   * Opaque pagination cursor from the previous page's nextCursor. Omit for the first page.
+   */
+  cursor?: string | undefined;
+  /**
+   * Page size (capped by donator tier)
+   */
+  limit?: number | undefined;
+};
+
+/** @internal */
+export type BadgeListCraftersRequestBody$Outbound = {
+  badgeId: string;
+  cursor?: string | undefined;
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const BadgeListCraftersRequestBody$outboundSchema: z.ZodType<
+  BadgeListCraftersRequestBody$Outbound,
+  z.ZodTypeDef,
+  BadgeListCraftersRequestBody
+> = z.object({
+  badgeId: z.string(),
+  cursor: z.string().optional(),
+  limit: z.number().int().optional(),
+});
+
+export function badgeListCraftersRequestBodyToJSON(
+  badgeListCraftersRequestBody: BadgeListCraftersRequestBody,
+): string {
+  return JSON.stringify(
+    BadgeListCraftersRequestBody$outboundSchema.parse(
+      badgeListCraftersRequestBody,
+    ),
+  );
+}

package/src/models/components/badgelistcraftersresponsebody.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 {
+  BadgeListCraftersEntry,
+  BadgeListCraftersEntry$inboundSchema,
+} from "./badgelistcraftersentry.js";
+
+export type BadgeListCraftersResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  crafters: Array<BadgeListCraftersEntry | null> | null;
+  /**
+   * Largest page size your donator tier allows
+   */
+  maxPageSize: number;
+  /**
+   * Pass as cursor to fetch the next page. Absent when there are no more crafters.
+   */
+  nextCursor?: string | undefined;
+  /**
+   * Holders steamsets tracks for this badge
+   */
+  trackedHolders: number;
+};
+
+/** @internal */
+export const BadgeListCraftersResponseBody$inboundSchema: z.ZodType<
+  BadgeListCraftersResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  crafters: z.nullable(
+    z.array(z.nullable(BadgeListCraftersEntry$inboundSchema)),
+  ),
+  maxPageSize: z.number().int(),
+  nextCursor: z.string().optional(),
+  trackedHolders: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function badgeListCraftersResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<BadgeListCraftersResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BadgeListCraftersResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BadgeListCraftersResponseBody' from JSON`,
+  );
+}

package/src/models/components/comparedtuple.ts

@@ -22,6 +22,7 @@ export type ComparedTuple = {
   maxLevel: number;
   scarcity: number;
   steamId: number;
+  trackedHolders: number;
 };
 
 /** @internal */
@@ -43,6 +44,7 @@ export const ComparedTuple$inboundSchema: z.ZodType<
   maxLevel: z.number().int(),
   scarcity: z.number().int(),
   steamId: z.number().int(),
+  trackedHolders: z.number().int(),
 });
 
 export function comparedTupleFromJSON(

package/src/models/components/index.ts

@@ -34,6 +34,9 @@ export * from "./analyticstrackeventrequestbody.js";
 export * from "./analyticstrackeventresponsebody.js";
 export * from "./analyticstrend.js";
 export * from "./analyticstrendpoint.js";
+export * from "./badgelistcraftersentry.js";
+export * from "./badgelistcraftersrequestbody.js";
+export * from "./badgelistcraftersresponsebody.js";
 export * from "./badgesuggesttags.js";
 export * from "./badgevaluefilter.js";
 export * from "./bestleaderboardrank.js";

package/src/models/components/resource.ts

@@ -25,6 +25,7 @@ export const ResourceResource = {
   AccountQueues: "account_queues",
   ShortLinkDomain: "short_link_domain",
   MaxFindOwners: "max_find_owners",
+  MaxBadgeCrafters: "max_badge_crafters",
 } as const;
 export type ResourceResource = OpenEnum<typeof ResourceResource>;
 

package/src/models/components/v1appbadge.ts

@@ -51,6 +51,7 @@ export type V1AppBadge = {
   price: number;
   scarcity: number;
   steamId: number;
+  trackedHolders: number;
 };
 
 /** @internal */
@@ -84,6 +85,7 @@ export const V1AppBadge$inboundSchema: z.ZodType<
   price: z.number().int(),
   scarcity: z.number().int(),
   steamId: z.number().int(),
+  trackedHolders: z.number().int(),
 });
 
 export function v1AppBadgeFromJSON(

package/src/models/components/v1leaderboardbadge.ts

@@ -74,6 +74,10 @@ export type V1LeaderboardBadge = {
    * The steam id
    */
   steamId: number;
+  /**
+   * The number of holders steamsets tracks for the badge
+   */
+  trackedHolders: number | null;
   /**
    * The xp of the badge
    */
@@ -106,6 +110,7 @@ export const V1LeaderboardBadge$inboundSchema: z.ZodType<
   price: z.number().int(),
   scarcity: z.nullable(z.number().int()),
   steamId: z.number().int(),
+  trackedHolders: z.nullable(z.number().int()),
   xp: z.number().int(),
 });