@steamsets/client-ts 0.33.6 → 0.33.8

package/src/funcs/itemFindOwners.ts

@@ -0,0 +1,187 @@
+/*
+ * 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";
+
+/**
+ * Find owners of one or more trading cards or booster packs, with friend paths from the requester
+ */
+export function itemFindOwners(
+  client: SteamSetsCore,
+  request: components.FindOwnersRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ItemFindOwnersResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.FindOwnersRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ItemFindOwnersResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.FindOwnersRequestBody$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/item.findOwners")();
+
+  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: "item.findOwners",
+    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 || ["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 || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [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 [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ItemFindOwnersResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ItemFindOwnersResponse$inboundSchema, {
+      key: "FindOwnersResponseBody",
+    }),
+    M.jsonErr([400, 401, 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 [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { 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.33.6",
+  sdkVersion: "0.33.8",
   genVersion: "2.881.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.33.6 2.881.4 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.33.8 2.881.4 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/comparedtuple.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { TupleAccount, TupleAccount$inboundSchema } from "./tupleaccount.js";
+
+export type ComparedTuple = {
+  accounts: Array<TupleAccount> | null;
+  appId: number;
+  appImage: string;
+  appName: string;
+  appType: string;
+  badgeImage: string;
+  badgeName: string;
+  isEvent: boolean;
+  isFoil: boolean;
+  isSale: boolean;
+  maxLevel: number;
+  scarcity: number;
+  steamId: number;
+};
+
+/** @internal */
+export const ComparedTuple$inboundSchema: z.ZodType<
+  ComparedTuple,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accounts: z.nullable(z.array(TupleAccount$inboundSchema)),
+  appId: z.number().int(),
+  appImage: z.string(),
+  appName: z.string(),
+  appType: z.string(),
+  badgeImage: z.string(),
+  badgeName: z.string(),
+  isEvent: z.boolean(),
+  isFoil: z.boolean(),
+  isSale: z.boolean(),
+  maxLevel: z.number().int(),
+  scarcity: z.number().int(),
+  steamId: z.number().int(),
+});
+
+export function comparedTupleFromJSON(
+  jsonString: string,
+): SafeParseResult<ComparedTuple, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ComparedTuple$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ComparedTuple' from JSON`,
+  );
+}

package/src/models/components/findownersrequestbody.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type FindOwnersRequestBody = {
+  /**
+   * Trading item class IDs to look up
+   */
+  itemIds: Array<number> | null;
+  /**
+   * Friend-path depth limit (default 4, max 6)
+   */
+  maxDepth?: number | undefined;
+  /**
+   * Max owners returned per item (default 10, max 25)
+   */
+  ownersPerItem?: number | undefined;
+};
+
+/** @internal */
+export type FindOwnersRequestBody$Outbound = {
+  itemIds: Array<number> | null;
+  maxDepth?: number | undefined;
+  ownersPerItem?: number | undefined;
+};
+
+/** @internal */
+export const FindOwnersRequestBody$outboundSchema: z.ZodType<
+  FindOwnersRequestBody$Outbound,
+  z.ZodTypeDef,
+  FindOwnersRequestBody
+> = z.object({
+  itemIds: z.nullable(z.array(z.number().int())),
+  maxDepth: z.number().int().optional(),
+  ownersPerItem: z.number().int().optional(),
+});
+
+export function findOwnersRequestBodyToJSON(
+  findOwnersRequestBody: FindOwnersRequestBody,
+): string {
+  return JSON.stringify(
+    FindOwnersRequestBody$outboundSchema.parse(findOwnersRequestBody),
+  );
+}

package/src/models/components/findownersresponsebody.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { ItemOwners, ItemOwners$inboundSchema } from "./itemowners.js";
+
+export type FindOwnersResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  items: Array<ItemOwners> | null;
+};
+
+/** @internal */
+export const FindOwnersResponseBody$inboundSchema: z.ZodType<
+  FindOwnersResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  items: z.nullable(z.array(ItemOwners$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function findOwnersResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<FindOwnersResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindOwnersResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindOwnersResponseBody' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -23,6 +23,7 @@ export * from "./city.js";
 export * from "./cmslistitem.js";
 export * from "./cmsversionitem.js";
 export * from "./colortag.js";
+export * from "./comparedtuple.js";
 export * from "./connection.js";
 export * from "./country.js";
 export * from "./currentcolortag.js";
@@ -35,12 +36,15 @@ export * from "./developerappanalyticstimeseries.js";
 export * from "./developerappanalyticstimeseriespoint.js";
 export * from "./errordetail.js";
 export * from "./errormodel.js";
+export * from "./findownersrequestbody.js";
+export * from "./findownersresponsebody.js";
 export * from "./friendpath.js";
 export * from "./historyvalue.js";
 export * from "./httpmetadata.js";
 export * from "./idsearch.js";
 export * from "./image.js";
 export * from "./inventoryset.js";
+export * from "./itemowners.js";
 export * from "./leaderboardaccount.js";
 export * from "./leaderboardchange.js";
 export * from "./leaderboardcity.js";
@@ -50,11 +54,15 @@ export * from "./leaderboardgetchangesresponsebody.js";
 export * from "./leaderboardregion.js";
 export * from "./leaderboardstate.js";
 export * from "./loginrequestbody.js";
+export * from "./order.js";
+export * from "./owner.js";
 export * from "./previewaccount.js";
 export * from "./range.js";
+export * from "./rangefilter.js";
 export * from "./region.js";
 export * from "./reorderitemreq.js";
 export * from "./requestbody.js";
+export * from "./resolvedaccount.js";
 export * from "./resource.js";
 export * from "./responsebody.js";
 export * from "./role.js";
@@ -67,6 +75,7 @@ export * from "./setremovedesigntag.js";
 export * from "./state.js";
 export * from "./trendingaccount.js";
 export * from "./trendingsearch.js";
+export * from "./tupleaccount.js";
 export * from "./v1accountapp.js";
 export * from "./v1accountbadgebookmark.js";
 export * from "./v1accountbadgebookmarksresponsebody.js";
@@ -77,6 +86,8 @@ export * from "./v1accountbadgestats.js";
 export * from "./v1accountbadgexpstats.js";
 export * from "./v1accountbookmarkbadgerequestbody.js";
 export * from "./v1accountbookmarkbadgeresponsebody.js";
+export * from "./v1accountcomparebadgesrequestbody.js";
+export * from "./v1accountcomparebadgesresponsebody.js";
 export * from "./v1accountcreateconnectionrequestbody.js";
 export * from "./v1accountcreateconnectionresponsebody.js";
 export * from "./v1accountcreatedeveloperapprequestbody.js";

package/src/models/components/itemowners.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { Owner, Owner$inboundSchema } from "./owner.js";
+
+export type ItemOwners = {
+  classId: number;
+  owners: Array<Owner> | null;
+};
+
+/** @internal */
+export const ItemOwners$inboundSchema: z.ZodType<
+  ItemOwners,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classId: z.number().int(),
+  owners: z.nullable(z.array(Owner$inboundSchema)),
+});
+
+export function itemOwnersFromJSON(
+  jsonString: string,
+): SafeParseResult<ItemOwners, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ItemOwners$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ItemOwners' from JSON`,
+  );
+}

package/src/models/components/order.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const By = {
+  Scarcity: "scarcity",
+  Level: "level",
+  Name: "name",
+  Xp: "xp",
+  CompletedAt: "completedAt",
+} as const;
+export type By = ClosedEnum<typeof By>;
+
+export const Direction = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type Direction = ClosedEnum<typeof Direction>;
+
+export type Order = {
+  by?: By | undefined;
+  direction?: Direction | undefined;
+};
+
+/** @internal */
+export const By$outboundSchema: z.ZodNativeEnum<typeof By> = z.nativeEnum(By);
+
+/** @internal */
+export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> = z
+  .nativeEnum(Direction);
+
+/** @internal */
+export type Order$Outbound = {
+  by: string;
+  direction: string;
+};
+
+/** @internal */
+export const Order$outboundSchema: z.ZodType<
+  Order$Outbound,
+  z.ZodTypeDef,
+  Order
+> = z.object({
+  by: By$outboundSchema.default("scarcity"),
+  direction: Direction$outboundSchema.default("desc"),
+});
+
+export function orderToJSON(order: Order): string {
+  return JSON.stringify(Order$outboundSchema.parse(order));
+}

package/src/models/components/owner.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 Owner = {
+  account: LeaderboardAccount | null;
+  /**
+   * Number of copies owned
+   */
+  amount: number;
+  /**
+   * Number of hops from requester to owner
+   */
+  distance?: number | undefined;
+  /**
+   * Accounts from requester (first) to owner (last), inclusive
+   */
+  path?: Array<LeaderboardAccount | null> | null | undefined;
+  /**
+   * Whether a friend path was found within maxDepth
+   */
+  pathFound: boolean;
+};
+
+/** @internal */
+export const Owner$inboundSchema: z.ZodType<Owner, z.ZodTypeDef, unknown> = z
+  .object({
+    account: z.nullable(LeaderboardAccount$inboundSchema),
+    amount: z.number().int(),
+    distance: z.number().int().optional(),
+    path: z.nullable(z.array(z.nullable(LeaderboardAccount$inboundSchema)))
+      .optional(),
+    pathFound: z.boolean(),
+  });
+
+export function ownerFromJSON(
+  jsonString: string,
+): SafeParseResult<Owner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Owner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Owner' from JSON`,
+  );
+}

package/src/models/components/rangefilter.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RangeFilterType = {
+  Scarcity: "scarcity",
+} as const;
+export type RangeFilterType = ClosedEnum<typeof RangeFilterType>;
+
+export type RangeFilter = {
+  max?: number | undefined;
+  min?: number | undefined;
+  type: RangeFilterType;
+};
+
+/** @internal */
+export const RangeFilterType$outboundSchema: z.ZodNativeEnum<
+  typeof RangeFilterType
+> = z.nativeEnum(RangeFilterType);
+
+/** @internal */
+export type RangeFilter$Outbound = {
+  max?: number | undefined;
+  min?: number | undefined;
+  type: string;
+};
+
+/** @internal */
+export const RangeFilter$outboundSchema: z.ZodType<
+  RangeFilter$Outbound,
+  z.ZodTypeDef,
+  RangeFilter
+> = z.object({
+  max: z.number().int().optional(),
+  min: z.number().int().optional(),
+  type: RangeFilterType$outboundSchema,
+});
+
+export function rangeFilterToJSON(rangeFilter: RangeFilter): string {
+  return JSON.stringify(RangeFilter$outboundSchema.parse(rangeFilter));
+}

package/src/models/components/resolvedaccount.ts

@@ -0,0 +1,37 @@
+/*
+ * 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";
+
+export type ResolvedAccount = {
+  accountId: number;
+  avatar: string;
+  steamId: string;
+  vanity?: string | undefined;
+};
+
+/** @internal */
+export const ResolvedAccount$inboundSchema: z.ZodType<
+  ResolvedAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountId: z.number().int(),
+  avatar: z.string(),
+  steamId: z.string(),
+  vanity: z.string().optional(),
+});
+
+export function resolvedAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<ResolvedAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResolvedAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResolvedAccount' from JSON`,
+  );
+}

package/src/models/components/tupleaccount.ts

@@ -0,0 +1,38 @@
+/*
+ * 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";
+
+export type TupleAccount = {
+  completedAt?: Date | undefined;
+  level: number;
+  steamId: string;
+  xp: number;
+};
+
+/** @internal */
+export const TupleAccount$inboundSchema: z.ZodType<
+  TupleAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  level: z.number().int(),
+  steamId: z.string(),
+  xp: z.number().int(),
+});
+
+export function tupleAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TupleAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TupleAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TupleAccount' from JSON`,
+  );
+}