@steamsets/client-ts 0.32.3 → 0.32.5

package/src/models/components/friendpath.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 FriendPath = {
+  /**
+   * Number of hops in this path
+   */
+  distance: number;
+  /**
+   * Ordered accounts from source to target
+   */
+  path: Array<LeaderboardAccount | null> | null;
+};
+
+/** @internal */
+export const FriendPath$inboundSchema: z.ZodType<
+  FriendPath,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  distance: z.number().int(),
+  path: z.nullable(z.array(z.nullable(LeaderboardAccount$inboundSchema))),
+});
+
+export function friendPathFromJSON(
+  jsonString: string,
+): SafeParseResult<FriendPath, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FriendPath$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FriendPath' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -24,6 +24,7 @@ export * from "./developerappanalyticsoutcome.js";
 export * from "./developerappanalyticstimeseries.js";
 export * from "./developerappanalyticstimeseriespoint.js";
 export * from "./errordetail.js";
+export * from "./friendpath.js";
 export * from "./historyvalue.js";
 export * from "./httpmetadata.js";
 export * from "./idsearch.js";
@@ -69,6 +70,8 @@ export * from "./v1accountdeletesessionrequestbody.js";
 export * from "./v1accountdeletesessionresponsebody.js";
 export * from "./v1accountdeveloperappupdaterequestbody.js";
 export * from "./v1accountdeveloperappupdateresponsebody.js";
+export * from "./v1accountfindfriendpathrequestbody.js";
+export * from "./v1accountfindfriendpathresponsebody.js";
 export * from "./v1accountfriend.js";
 export * from "./v1accountgetdatapointsresponsebody.js";
 export * from "./v1accountgetinforesponsebody.js";

package/src/models/components/leaderboardaccount.ts

@@ -30,7 +30,7 @@ import { Role, Role$inboundSchema } from "./role.js";
 /**
  * The privacy of the account
  */
-export const LeaderboardAccountPrivacy = {
+export const Privacy = {
   Public: "public",
   Private: "private",
   FriendsOnly: "friends_only",
@@ -38,9 +38,7 @@ export const LeaderboardAccountPrivacy = {
 /**
  * The privacy of the account
  */
-export type LeaderboardAccountPrivacy = OpenEnum<
-  typeof LeaderboardAccountPrivacy
->;
+export type Privacy = OpenEnum<typeof Privacy>;
 
 export type LeaderboardAccount = {
   /**
@@ -158,7 +156,7 @@ export type LeaderboardAccount = {
   /**
    * The privacy of the account
    */
-  privacy: LeaderboardAccountPrivacy;
+  privacy: Privacy;
   region?: LeaderboardRegion | null | undefined;
   /**
    * The roles of the account
@@ -192,11 +190,8 @@ export type LeaderboardAccount = {
 };
 
 /** @internal */
-export const LeaderboardAccountPrivacy$inboundSchema: z.ZodType<
-  LeaderboardAccountPrivacy,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(LeaderboardAccountPrivacy);
+export const Privacy$inboundSchema: z.ZodType<Privacy, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Privacy);
 
 /** @internal */
 export const LeaderboardAccount$inboundSchema: z.ZodType<
@@ -232,7 +227,7 @@ export const LeaderboardAccount$inboundSchema: z.ZodType<
   playtime: z.number().int(),
   pointsGiven: z.number().int(),
   pointsReceived: z.number().int(),
-  privacy: LeaderboardAccountPrivacy$inboundSchema,
+  privacy: Privacy$inboundSchema,
   region: z.nullable(LeaderboardRegion$inboundSchema).optional(),
   roles: z.nullable(z.array(Role$inboundSchema)),
   state: z.nullable(LeaderboardState$inboundSchema).optional(),

package/src/models/components/v1accountfindfriendpathrequestbody.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AccountSearch,
+  AccountSearch$Outbound,
+  AccountSearch$outboundSchema,
+} from "./accountsearch.js";
+
+export type V1AccountFindFriendPathRequestBody = {
+  from: AccountSearch;
+  /**
+   * Max number of paths to return (default 10, capped at 50). A direct friendship always returns a single path regardless of this value.
+   */
+  maxPaths?: number | undefined;
+  to: AccountSearch;
+};
+
+/** @internal */
+export type V1AccountFindFriendPathRequestBody$Outbound = {
+  from: AccountSearch$Outbound;
+  maxPaths?: number | undefined;
+  to: AccountSearch$Outbound;
+};
+
+/** @internal */
+export const V1AccountFindFriendPathRequestBody$outboundSchema: z.ZodType<
+  V1AccountFindFriendPathRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1AccountFindFriendPathRequestBody
+> = z.object({
+  from: AccountSearch$outboundSchema,
+  maxPaths: z.number().int().optional(),
+  to: AccountSearch$outboundSchema,
+});
+
+export function v1AccountFindFriendPathRequestBodyToJSON(
+  v1AccountFindFriendPathRequestBody: V1AccountFindFriendPathRequestBody,
+): string {
+  return JSON.stringify(
+    V1AccountFindFriendPathRequestBody$outboundSchema.parse(
+      v1AccountFindFriendPathRequestBody,
+    ),
+  );
+}

package/src/models/components/v1accountfindfriendpathresponsebody.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 { FriendPath, FriendPath$inboundSchema } from "./friendpath.js";
+
+export type V1AccountFindFriendPathResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * Whether any path was found
+   */
+  found: boolean;
+  /**
+   * Paths sorted ascending by distance
+   */
+  paths: Array<FriendPath> | null;
+};
+
+/** @internal */
+export const V1AccountFindFriendPathResponseBody$inboundSchema: z.ZodType<
+  V1AccountFindFriendPathResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  found: z.boolean(),
+  paths: z.nullable(z.array(FriendPath$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function v1AccountFindFriendPathResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountFindFriendPathResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V1AccountFindFriendPathResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountFindFriendPathResponseBody' from JSON`,
+  );
+}

package/src/models/components/v1accountgetinforesponsebody.ts

@@ -70,7 +70,7 @@ export type LastQueueStatus = OpenEnum<typeof LastQueueStatus>;
 /**
  * The privacy of the account
  */
-export const Privacy = {
+export const V1AccountGetInfoResponseBodyPrivacy = {
   Private: "private",
   Public: "public",
   FriendsOnly: "friends_only",
@@ -78,7 +78,9 @@ export const Privacy = {
 /**
  * The privacy of the account
  */
-export type Privacy = OpenEnum<typeof Privacy>;
+export type V1AccountGetInfoResponseBodyPrivacy = OpenEnum<
+  typeof V1AccountGetInfoResponseBodyPrivacy
+>;
 
 export type V1AccountGetInfoResponseBody = {
   /**
@@ -237,7 +239,7 @@ export type V1AccountGetInfoResponseBody = {
   /**
    * The privacy of the account
    */
-  privacy: Privacy;
+  privacy: V1AccountGetInfoResponseBodyPrivacy;
   region?: LeaderboardRegion | null | undefined;
   /**
    * The roles of the account
@@ -304,8 +306,11 @@ export const LastQueueStatus$inboundSchema: z.ZodType<
 > = openEnums.inboundSchema(LastQueueStatus);
 
 /** @internal */
-export const Privacy$inboundSchema: z.ZodType<Privacy, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Privacy);
+export const V1AccountGetInfoResponseBodyPrivacy$inboundSchema: z.ZodType<
+  V1AccountGetInfoResponseBodyPrivacy,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(V1AccountGetInfoResponseBodyPrivacy);
 
 /** @internal */
 export const V1AccountGetInfoResponseBody$inboundSchema: z.ZodType<
@@ -358,7 +363,7 @@ export const V1AccountGetInfoResponseBody$inboundSchema: z.ZodType<
   playtime: z.number().int(),
   pointsGiven: z.number().int(),
   pointsReceived: z.number().int(),
-  privacy: Privacy$inboundSchema,
+  privacy: V1AccountGetInfoResponseBodyPrivacy$inboundSchema,
   region: z.nullable(LeaderboardRegion$inboundSchema).optional(),
   roles: z.nullable(z.array(Role$inboundSchema)),
   shortlinkDomain: z.nullable(z.string()),

package/src/models/operations/accountfindfriendpath.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 AccountFindFriendPathResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  v1AccountFindFriendPathResponseBody?:
+    | components.V1AccountFindFriendPathResponseBody
+    | undefined;
+};
+
+/** @internal */
+export const AccountFindFriendPathResponse$inboundSchema: z.ZodType<
+  AccountFindFriendPathResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  V1AccountFindFriendPathResponseBody: components
+    .V1AccountFindFriendPathResponseBody$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "V1AccountFindFriendPathResponseBody":
+      "v1AccountFindFriendPathResponseBody",
+  });
+});
+
+export function accountFindFriendPathResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountFindFriendPathResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountFindFriendPathResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountFindFriendPathResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -9,6 +9,7 @@ export * from "./accountdeleteconnection.js";
 export * from "./accountdeletedeveloperapp.js";
 export * from "./accountdeleteimages.js";
 export * from "./accountdeletesession.js";
+export * from "./accountfindfriendpath.js";
 export * from "./accountgetbadgeheatmap.js";
 export * from "./accountgetbadgestats.js";
 export * from "./accountgetdatapoints.js";

package/src/sdk/account.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { accountAccountFindFriendPath } from "../funcs/accountAccountFindFriendPath.js";
 import { accountAccountGetBadgeHeatmap } from "../funcs/accountAccountGetBadgeHeatmap.js";
 import { accountAccountListOwnedGroups } from "../funcs/accountAccountListOwnedGroups.js";
 import { accountBookmarkBadge } from "../funcs/accountBookmarkBadge.js";
@@ -146,6 +147,20 @@ export class Account extends ClientSDK {
     ));
   }
 
+  /**
+   * Find up to N shortest friend paths between two accounts
+   */
+  async accountFindFriendPath(
+    request: components.V1AccountFindFriendPathRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AccountFindFriendPathResponse> {
+    return unwrapAsync(accountAccountFindFriendPath(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get monthly badge crafting counts for an account
    */