@steamsets/client-ts 0.25.8 → 0.25.10

package/src/funcs/leaderboardLeaderboardGetLowestRanks.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SteamSetsCore } from "../core.js";
+import { encodeJSON } 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,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function leaderboardLeaderboardGetLowestRanks(
+  client: SteamSetsCore,
+  request: components.V1LeaderboardGetLowestRanksRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LeaderboardGetLowestRanksResponse,
+    | errors.ErrorModel
+    | errors.ErrorModel
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.V1LeaderboardGetLowestRanksRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LeaderboardGetLowestRanksResponse,
+      | errors.ErrorModel
+      | errors.ErrorModel
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.V1LeaderboardGetLowestRanksRequestBody$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.getLowestRanks")();
+
+  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 = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "leaderboard.getLowestRanks",
+    oAuth2Scopes: [],
+
+    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",
+    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,
+    errorCodes: ["404", "422", "4XX", "500", "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.LeaderboardGetLowestRanksResponse,
+    | errors.ErrorModel
+    | errors.ErrorModel
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.LeaderboardGetLowestRanksResponse$inboundSchema, {
+      key: "object",
+    }),
+    M.jsonErr([404, 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

@@ -55,8 +55,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.25.8",
-  genVersion: "2.570.0",
+  sdkVersion: "0.25.10",
+  genVersion: "2.570.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.25.8 2.570.0 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.25.10 2.570.4 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/index.ts

@@ -45,6 +45,9 @@ export * from "./v1accountbadgeownedbadge.js";
 export * from "./v1accountbadgeownedbadgesresponsebody.js";
 export * from "./v1accountbookmarkbadgerequestbody.js";
 export * from "./v1accountbookmarkbadgeresponsebody.js";
+export * from "./v1accountcomparebadgesrequestbody.js";
+export * from "./v1accountcomparebadgesresponsebody.js";
+export * from "./v1accountcomparedappbadge.js";
 export * from "./v1accountcreateconnectionrequestbody.js";
 export * from "./v1accountcreateconnectionresponsebody.js";
 export * from "./v1accountcreatedeveloperapprequestbody.js";
@@ -128,6 +131,7 @@ export * from "./v1leaderboardgetgroupleaderboardrequestbody.js";
 export * from "./v1leaderboardgetgroupleaderboardresponsebody.js";
 export * from "./v1leaderboardgetgroupsmetarequestbody.js";
 export * from "./v1leaderboardgetgroupsmetaresponsebody.js";
+export * from "./v1leaderboardgetlowestranksrequestbody.js";
 export * from "./v1leaderboardlistbadgesresponsebody.js";
 export * from "./v1leaderboardlocation.js";
 export * from "./v1leaderboardlocationinfo.js";

package/src/models/components/v1accountcomparebadgesrequestbody.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  AccountSearch,
+  AccountSearch$inboundSchema,
+  AccountSearch$Outbound,
+  AccountSearch$outboundSchema,
+} from "./accountsearch.js";
+
+export type V1AccountCompareBadgesRequestBody = {
+  comparing: Array<AccountSearch> | null;
+};
+
+/** @internal */
+export const V1AccountCompareBadgesRequestBody$inboundSchema: z.ZodType<
+  V1AccountCompareBadgesRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Comparing: z.nullable(z.array(AccountSearch$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "Comparing": "comparing",
+  });
+});
+
+/** @internal */
+export type V1AccountCompareBadgesRequestBody$Outbound = {
+  Comparing: Array<AccountSearch$Outbound> | null;
+};
+
+/** @internal */
+export const V1AccountCompareBadgesRequestBody$outboundSchema: z.ZodType<
+  V1AccountCompareBadgesRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1AccountCompareBadgesRequestBody
+> = z.object({
+  comparing: z.nullable(z.array(AccountSearch$outboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    comparing: "Comparing",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountCompareBadgesRequestBody$ {
+  /** @deprecated use `V1AccountCompareBadgesRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V1AccountCompareBadgesRequestBody$inboundSchema;
+  /** @deprecated use `V1AccountCompareBadgesRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V1AccountCompareBadgesRequestBody$outboundSchema;
+  /** @deprecated use `V1AccountCompareBadgesRequestBody$Outbound` instead. */
+  export type Outbound = V1AccountCompareBadgesRequestBody$Outbound;
+}
+
+export function v1AccountCompareBadgesRequestBodyToJSON(
+  v1AccountCompareBadgesRequestBody: V1AccountCompareBadgesRequestBody,
+): string {
+  return JSON.stringify(
+    V1AccountCompareBadgesRequestBody$outboundSchema.parse(
+      v1AccountCompareBadgesRequestBody,
+    ),
+  );
+}
+
+export function v1AccountCompareBadgesRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountCompareBadgesRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V1AccountCompareBadgesRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountCompareBadgesRequestBody' from JSON`,
+  );
+}

package/src/models/components/v1accountcomparebadgesresponsebody.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  V1AccountComparedAppBadge,
+  V1AccountComparedAppBadge$inboundSchema,
+  V1AccountComparedAppBadge$Outbound,
+  V1AccountComparedAppBadge$outboundSchema,
+} from "./v1accountcomparedappbadge.js";
+
+export type V1AccountCompareBadgesResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  appBadges: Array<V1AccountComparedAppBadge> | null;
+};
+
+/** @internal */
+export const V1AccountCompareBadgesResponseBody$inboundSchema: z.ZodType<
+  V1AccountCompareBadgesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  appBadges: z.nullable(z.array(V1AccountComparedAppBadge$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+/** @internal */
+export type V1AccountCompareBadgesResponseBody$Outbound = {
+  $schema?: string | undefined;
+  appBadges: Array<V1AccountComparedAppBadge$Outbound> | null;
+};
+
+/** @internal */
+export const V1AccountCompareBadgesResponseBody$outboundSchema: z.ZodType<
+  V1AccountCompareBadgesResponseBody$Outbound,
+  z.ZodTypeDef,
+  V1AccountCompareBadgesResponseBody
+> = z.object({
+  dollarSchema: z.string().optional(),
+  appBadges: z.nullable(z.array(V1AccountComparedAppBadge$outboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    dollarSchema: "$schema",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountCompareBadgesResponseBody$ {
+  /** @deprecated use `V1AccountCompareBadgesResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V1AccountCompareBadgesResponseBody$inboundSchema;
+  /** @deprecated use `V1AccountCompareBadgesResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V1AccountCompareBadgesResponseBody$outboundSchema;
+  /** @deprecated use `V1AccountCompareBadgesResponseBody$Outbound` instead. */
+  export type Outbound = V1AccountCompareBadgesResponseBody$Outbound;
+}
+
+export function v1AccountCompareBadgesResponseBodyToJSON(
+  v1AccountCompareBadgesResponseBody: V1AccountCompareBadgesResponseBody,
+): string {
+  return JSON.stringify(
+    V1AccountCompareBadgesResponseBody$outboundSchema.parse(
+      v1AccountCompareBadgesResponseBody,
+    ),
+  );
+}
+
+export function v1AccountCompareBadgesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountCompareBadgesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V1AccountCompareBadgesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountCompareBadgesResponseBody' from JSON`,
+  );
+}

package/src/models/components/v1accountcomparedappbadge.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V1AccountComparedAppBadge = {
+  appId: number;
+  appImage: string;
+  appName: string;
+  /**
+   * Image URL of the highest badge
+   */
+  badgeImage: string;
+  /**
+   * Name of the highest badge
+   */
+  badgeName: string;
+  /**
+   * List of steamId and if they own the badge
+   */
+  foil?: { [k: string]: boolean } | undefined;
+  foilScarcity: number;
+  hasFoil: boolean;
+  isEvent: boolean;
+  isSale: boolean;
+  /**
+   * A map of steamId to the badge level they own
+   */
+  normal?: { [k: string]: number } | undefined;
+  normalScarcity: number;
+  steamId: number;
+};
+
+/** @internal */
+export const V1AccountComparedAppBadge$inboundSchema: z.ZodType<
+  V1AccountComparedAppBadge,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appId: z.number().int(),
+  appImage: z.string(),
+  appName: z.string(),
+  badgeImage: z.string(),
+  badgeName: z.string(),
+  foil: z.record(z.boolean()).optional(),
+  foilScarcity: z.number().int(),
+  hasFoil: z.boolean(),
+  isEvent: z.boolean(),
+  isSale: z.boolean(),
+  normal: z.record(z.number().int()).optional(),
+  normalScarcity: z.number().int(),
+  steamId: z.number().int(),
+});
+
+/** @internal */
+export type V1AccountComparedAppBadge$Outbound = {
+  appId: number;
+  appImage: string;
+  appName: string;
+  badgeImage: string;
+  badgeName: string;
+  foil?: { [k: string]: boolean } | undefined;
+  foilScarcity: number;
+  hasFoil: boolean;
+  isEvent: boolean;
+  isSale: boolean;
+  normal?: { [k: string]: number } | undefined;
+  normalScarcity: number;
+  steamId: number;
+};
+
+/** @internal */
+export const V1AccountComparedAppBadge$outboundSchema: z.ZodType<
+  V1AccountComparedAppBadge$Outbound,
+  z.ZodTypeDef,
+  V1AccountComparedAppBadge
+> = z.object({
+  appId: z.number().int(),
+  appImage: z.string(),
+  appName: z.string(),
+  badgeImage: z.string(),
+  badgeName: z.string(),
+  foil: z.record(z.boolean()).optional(),
+  foilScarcity: z.number().int(),
+  hasFoil: z.boolean(),
+  isEvent: z.boolean(),
+  isSale: z.boolean(),
+  normal: z.record(z.number().int()).optional(),
+  normalScarcity: z.number().int(),
+  steamId: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountComparedAppBadge$ {
+  /** @deprecated use `V1AccountComparedAppBadge$inboundSchema` instead. */
+  export const inboundSchema = V1AccountComparedAppBadge$inboundSchema;
+  /** @deprecated use `V1AccountComparedAppBadge$outboundSchema` instead. */
+  export const outboundSchema = V1AccountComparedAppBadge$outboundSchema;
+  /** @deprecated use `V1AccountComparedAppBadge$Outbound` instead. */
+  export type Outbound = V1AccountComparedAppBadge$Outbound;
+}
+
+export function v1AccountComparedAppBadgeToJSON(
+  v1AccountComparedAppBadge: V1AccountComparedAppBadge,
+): string {
+  return JSON.stringify(
+    V1AccountComparedAppBadge$outboundSchema.parse(v1AccountComparedAppBadge),
+  );
+}
+
+export function v1AccountComparedAppBadgeFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountComparedAppBadge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V1AccountComparedAppBadge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountComparedAppBadge' from JSON`,
+  );
+}

package/src/models/components/v1leaderboardgetlowestranksrequestbody.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The leaderboard to get. Currently only supports XP and apps
+ */
+export const V1LeaderboardGetLowestRanksRequestBodyLeaderboard = {
+  Apps: "apps",
+  Xp: "xp",
+} as const;
+/**
+ * The leaderboard to get. Currently only supports XP and apps
+ */
+export type V1LeaderboardGetLowestRanksRequestBodyLeaderboard = ClosedEnum<
+  typeof V1LeaderboardGetLowestRanksRequestBodyLeaderboard
+>;
+
+export type V1LeaderboardGetLowestRanksRequestBody = {
+  /**
+   * The leaderboard to get. Currently only supports XP and apps
+   */
+  leaderboard: V1LeaderboardGetLowestRanksRequestBodyLeaderboard;
+};
+
+/** @internal */
+export const V1LeaderboardGetLowestRanksRequestBodyLeaderboard$inboundSchema:
+  z.ZodNativeEnum<typeof V1LeaderboardGetLowestRanksRequestBodyLeaderboard> = z
+    .nativeEnum(V1LeaderboardGetLowestRanksRequestBodyLeaderboard);
+
+/** @internal */
+export const V1LeaderboardGetLowestRanksRequestBodyLeaderboard$outboundSchema:
+  z.ZodNativeEnum<typeof V1LeaderboardGetLowestRanksRequestBodyLeaderboard> =
+    V1LeaderboardGetLowestRanksRequestBodyLeaderboard$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1LeaderboardGetLowestRanksRequestBodyLeaderboard$ {
+  /** @deprecated use `V1LeaderboardGetLowestRanksRequestBodyLeaderboard$inboundSchema` instead. */
+  export const inboundSchema =
+    V1LeaderboardGetLowestRanksRequestBodyLeaderboard$inboundSchema;
+  /** @deprecated use `V1LeaderboardGetLowestRanksRequestBodyLeaderboard$outboundSchema` instead. */
+  export const outboundSchema =
+    V1LeaderboardGetLowestRanksRequestBodyLeaderboard$outboundSchema;
+}
+
+/** @internal */
+export const V1LeaderboardGetLowestRanksRequestBody$inboundSchema: z.ZodType<
+  V1LeaderboardGetLowestRanksRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  leaderboard: V1LeaderboardGetLowestRanksRequestBodyLeaderboard$inboundSchema,
+});
+
+/** @internal */
+export type V1LeaderboardGetLowestRanksRequestBody$Outbound = {
+  leaderboard: string;
+};
+
+/** @internal */
+export const V1LeaderboardGetLowestRanksRequestBody$outboundSchema: z.ZodType<
+  V1LeaderboardGetLowestRanksRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1LeaderboardGetLowestRanksRequestBody
+> = z.object({
+  leaderboard: V1LeaderboardGetLowestRanksRequestBodyLeaderboard$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1LeaderboardGetLowestRanksRequestBody$ {
+  /** @deprecated use `V1LeaderboardGetLowestRanksRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    V1LeaderboardGetLowestRanksRequestBody$inboundSchema;
+  /** @deprecated use `V1LeaderboardGetLowestRanksRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    V1LeaderboardGetLowestRanksRequestBody$outboundSchema;
+  /** @deprecated use `V1LeaderboardGetLowestRanksRequestBody$Outbound` instead. */
+  export type Outbound = V1LeaderboardGetLowestRanksRequestBody$Outbound;
+}
+
+export function v1LeaderboardGetLowestRanksRequestBodyToJSON(
+  v1LeaderboardGetLowestRanksRequestBody:
+    V1LeaderboardGetLowestRanksRequestBody,
+): string {
+  return JSON.stringify(
+    V1LeaderboardGetLowestRanksRequestBody$outboundSchema.parse(
+      v1LeaderboardGetLowestRanksRequestBody,
+    ),
+  );
+}
+
+export function v1LeaderboardGetLowestRanksRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1LeaderboardGetLowestRanksRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V1LeaderboardGetLowestRanksRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1LeaderboardGetLowestRanksRequestBody' from JSON`,
+  );
+}