@steamsets/client-ts 0.10.0 → 0.10.2

package/src/models/components/v1accountleaderboardaccount.ts

@@ -0,0 +1,310 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  LeaderboardBadgeInfo,
+  LeaderboardBadgeInfo$inboundSchema,
+  LeaderboardBadgeInfo$Outbound,
+  LeaderboardBadgeInfo$outboundSchema,
+} from "./leaderboardbadgeinfo.js";
+import {
+  Location,
+  Location$inboundSchema,
+  Location$Outbound,
+  Location$outboundSchema,
+} from "./location.js";
+import {
+  Role,
+  Role$inboundSchema,
+  Role$Outbound,
+  Role$outboundSchema,
+} from "./role.js";
+
+export type V1AccountLeaderboardAccount = {
+  /**
+   * The cost of an app
+   */
+  appCost: number;
+  /**
+   * The playtime of the account, incase of an app leaderboard
+   */
+  appPlaytime?: number | null | undefined;
+  /**
+   * The number of apps the account has
+   */
+  apps: number;
+  /**
+   * The avatar hash of the account
+   */
+  avatar: string;
+  /**
+   * The average playtime of the account
+   */
+  averagePlaytime: number;
+  /**
+   * The number of awards the account has
+   */
+  awardsGiven: number;
+  /**
+   * The number of awards the account has
+   */
+  awardsReceived: number;
+  badgeInfo?: LeaderboardBadgeInfo | undefined;
+  /**
+   * The number of badges the account has
+   */
+  badges: number;
+  /**
+   * The number of bans
+   */
+  bans: number;
+  city?: Location | undefined;
+  country?: Location | undefined;
+  /**
+   * The time the account was created
+   */
+  createdAt: Date;
+  /**
+   * The economy ban of the account
+   */
+  economyBan: string;
+  /**
+   * The cost of a foil badge
+   */
+  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;
+  /**
+   * Whether the account is hidden in the leaderboards
+   */
+  hidden: boolean;
+  /**
+   * The level of the account
+   */
+  level: number;
+  /**
+   * The number of limited apps the account has
+   */
+  limitedApps: number;
+  /**
+   * The name of the account
+   */
+  name: string;
+  /**
+   * The cost of a normal badge
+   */
+  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: string;
+  /**
+   * The rank of the account
+   */
+  rank: number;
+  region?: Location | undefined;
+  /**
+   * The roles of the account
+   */
+  roles: Array<Role> | null;
+  state?: Location | 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 V1AccountLeaderboardAccount$inboundSchema: z.ZodType<
+  V1AccountLeaderboardAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appCost: z.number().int(),
+  appPlaytime: z.nullable(z.number().int()).optional(),
+  apps: z.number().int(),
+  avatar: z.string(),
+  averagePlaytime: z.number().int(),
+  awardsGiven: z.number().int(),
+  awardsReceived: z.number().int(),
+  badgeInfo: LeaderboardBadgeInfo$inboundSchema.optional(),
+  badges: z.number().int(),
+  bans: z.number().int(),
+  city: Location$inboundSchema.optional(),
+  country: Location$inboundSchema.optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  economyBan: z.string(),
+  foilBadgeCost: z.number().int(),
+  foilBadges: z.number().int(),
+  friends: z.number().int(),
+  gameBans: z.number().int(),
+  hidden: z.boolean(),
+  level: z.number().int(),
+  limitedApps: z.number().int(),
+  name: z.string(),
+  normalBadgeCost: z.number().int(),
+  normalBadges: z.number().int(),
+  playtime: z.number().int(),
+  pointsGiven: z.number().int(),
+  pointsReceived: z.number().int(),
+  privacy: z.string(),
+  rank: z.number().int(),
+  region: Location$inboundSchema.optional(),
+  roles: z.nullable(z.array(Role$inboundSchema)),
+  state: Location$inboundSchema.optional(),
+  steamId: z.string(),
+  steamSetsScore: z.number().int(),
+  steamSetsVanity: z.string(),
+  steamVanity: z.string(),
+  vacBans: z.number().int(),
+  xp: z.number().int(),
+});
+
+/** @internal */
+export type V1AccountLeaderboardAccount$Outbound = {
+  appCost: number;
+  appPlaytime?: number | null | undefined;
+  apps: number;
+  avatar: string;
+  averagePlaytime: number;
+  awardsGiven: number;
+  awardsReceived: number;
+  badgeInfo?: LeaderboardBadgeInfo$Outbound | undefined;
+  badges: number;
+  bans: number;
+  city?: Location$Outbound | undefined;
+  country?: Location$Outbound | undefined;
+  createdAt: string;
+  economyBan: string;
+  foilBadgeCost: number;
+  foilBadges: number;
+  friends: number;
+  gameBans: number;
+  hidden: boolean;
+  level: number;
+  limitedApps: number;
+  name: string;
+  normalBadgeCost: number;
+  normalBadges: number;
+  playtime: number;
+  pointsGiven: number;
+  pointsReceived: number;
+  privacy: string;
+  rank: number;
+  region?: Location$Outbound | undefined;
+  roles: Array<Role$Outbound> | null;
+  state?: Location$Outbound | undefined;
+  steamId: string;
+  steamSetsScore: number;
+  steamSetsVanity: string;
+  steamVanity: string;
+  vacBans: number;
+  xp: number;
+};
+
+/** @internal */
+export const V1AccountLeaderboardAccount$outboundSchema: z.ZodType<
+  V1AccountLeaderboardAccount$Outbound,
+  z.ZodTypeDef,
+  V1AccountLeaderboardAccount
+> = z.object({
+  appCost: z.number().int(),
+  appPlaytime: z.nullable(z.number().int()).optional(),
+  apps: z.number().int(),
+  avatar: z.string(),
+  averagePlaytime: z.number().int(),
+  awardsGiven: z.number().int(),
+  awardsReceived: z.number().int(),
+  badgeInfo: LeaderboardBadgeInfo$outboundSchema.optional(),
+  badges: z.number().int(),
+  bans: z.number().int(),
+  city: Location$outboundSchema.optional(),
+  country: Location$outboundSchema.optional(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  economyBan: z.string(),
+  foilBadgeCost: z.number().int(),
+  foilBadges: z.number().int(),
+  friends: z.number().int(),
+  gameBans: z.number().int(),
+  hidden: z.boolean(),
+  level: z.number().int(),
+  limitedApps: z.number().int(),
+  name: z.string(),
+  normalBadgeCost: z.number().int(),
+  normalBadges: z.number().int(),
+  playtime: z.number().int(),
+  pointsGiven: z.number().int(),
+  pointsReceived: z.number().int(),
+  privacy: z.string(),
+  rank: z.number().int(),
+  region: Location$outboundSchema.optional(),
+  roles: z.nullable(z.array(Role$outboundSchema)),
+  state: Location$outboundSchema.optional(),
+  steamId: z.string(),
+  steamSetsScore: z.number().int(),
+  steamSetsVanity: z.string(),
+  steamVanity: z.string(),
+  vacBans: z.number().int(),
+  xp: 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 V1AccountLeaderboardAccount$ {
+  /** @deprecated use `V1AccountLeaderboardAccount$inboundSchema` instead. */
+  export const inboundSchema = V1AccountLeaderboardAccount$inboundSchema;
+  /** @deprecated use `V1AccountLeaderboardAccount$outboundSchema` instead. */
+  export const outboundSchema = V1AccountLeaderboardAccount$outboundSchema;
+  /** @deprecated use `V1AccountLeaderboardAccount$Outbound` instead. */
+  export type Outbound = V1AccountLeaderboardAccount$Outbound;
+}

package/src/models/components/v1accountleaderboardbadgeinfo.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type V1AccountLeaderboardBadgeInfo = {};
+
+/** @internal */
+export const V1AccountLeaderboardBadgeInfo$inboundSchema: z.ZodType<
+  V1AccountLeaderboardBadgeInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type V1AccountLeaderboardBadgeInfo$Outbound = {};
+
+/** @internal */
+export const V1AccountLeaderboardBadgeInfo$outboundSchema: z.ZodType<
+  V1AccountLeaderboardBadgeInfo$Outbound,
+  z.ZodTypeDef,
+  V1AccountLeaderboardBadgeInfo
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountLeaderboardBadgeInfo$ {
+  /** @deprecated use `V1AccountLeaderboardBadgeInfo$inboundSchema` instead. */
+  export const inboundSchema = V1AccountLeaderboardBadgeInfo$inboundSchema;
+  /** @deprecated use `V1AccountLeaderboardBadgeInfo$outboundSchema` instead. */
+  export const outboundSchema = V1AccountLeaderboardBadgeInfo$outboundSchema;
+  /** @deprecated use `V1AccountLeaderboardBadgeInfo$Outbound` instead. */
+  export type Outbound = V1AccountLeaderboardBadgeInfo$Outbound;
+}

package/src/models/components/v1accountleaderboardrequestbody.ts

@@ -0,0 +1,148 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  V1LeaderboardLocation,
+  V1LeaderboardLocation$inboundSchema,
+  V1LeaderboardLocation$Outbound,
+  V1LeaderboardLocation$outboundSchema,
+} from "./v1leaderboardlocation.js";
+
+/**
+ * The leaderboard to get
+ */
+export const V1AccountLeaderboardRequestBodyLeaderboard = {
+  Apps: "apps",
+  LimitedApps: "limited_apps",
+  AppPlaytime: "app_playtime",
+  AwardsGiven: "awards_given",
+  AwardsReceived: "awards_received",
+  Bans: "bans",
+  GameBans: "game_bans",
+  VacBans: "vac_bans",
+  Donations: "donations",
+  FoilBadges: "foil_badges",
+  NormalBadges: "normal_badges",
+  Badges: "badges",
+  Playtime: "playtime",
+  PointsGiven: "points_given",
+  PointsReceived: "points_received",
+  SteamSets: "steam_sets",
+  Xp: "xp",
+  BadgeCompletionTime: "badge_completion_time",
+  BadgeHighestLevel: "badge_highest_level",
+} as const;
+/**
+ * The leaderboard to get
+ */
+export type V1AccountLeaderboardRequestBodyLeaderboard = ClosedEnum<
+  typeof V1AccountLeaderboardRequestBodyLeaderboard
+>;
+
+export type V1AccountLeaderboardRequestBody = {
+  /**
+   * For a given app leaderboard, the app id
+   */
+  appId?: number | null | undefined;
+  /**
+   * For a given badge leaderboard, the steam badge id
+   */
+  badgeId?: string | null | undefined;
+  /**
+   * For a given badge leaderboard, whether the badge is foil or not
+   */
+  badgeIsFoil?: boolean | null | undefined;
+  /**
+   * The end index
+   */
+  end?: number | null | undefined;
+  /**
+   * The leaderboard to get
+   */
+  leaderboard: V1AccountLeaderboardRequestBodyLeaderboard;
+  location?: V1LeaderboardLocation | undefined;
+  /**
+   * The start index
+   */
+  start?: number | null | undefined;
+};
+
+/** @internal */
+export const V1AccountLeaderboardRequestBodyLeaderboard$inboundSchema:
+  z.ZodNativeEnum<typeof V1AccountLeaderboardRequestBodyLeaderboard> = z
+    .nativeEnum(V1AccountLeaderboardRequestBodyLeaderboard);
+
+/** @internal */
+export const V1AccountLeaderboardRequestBodyLeaderboard$outboundSchema:
+  z.ZodNativeEnum<typeof V1AccountLeaderboardRequestBodyLeaderboard> =
+    V1AccountLeaderboardRequestBodyLeaderboard$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountLeaderboardRequestBodyLeaderboard$ {
+  /** @deprecated use `V1AccountLeaderboardRequestBodyLeaderboard$inboundSchema` instead. */
+  export const inboundSchema =
+    V1AccountLeaderboardRequestBodyLeaderboard$inboundSchema;
+  /** @deprecated use `V1AccountLeaderboardRequestBodyLeaderboard$outboundSchema` instead. */
+  export const outboundSchema =
+    V1AccountLeaderboardRequestBodyLeaderboard$outboundSchema;
+}
+
+/** @internal */
+export const V1AccountLeaderboardRequestBody$inboundSchema: z.ZodType<
+  V1AccountLeaderboardRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appId: z.nullable(z.number().int()).optional(),
+  badgeId: z.nullable(z.string()).optional(),
+  badgeIsFoil: z.nullable(z.boolean()).optional(),
+  end: z.nullable(z.number().int()).optional(),
+  leaderboard: V1AccountLeaderboardRequestBodyLeaderboard$inboundSchema,
+  location: V1LeaderboardLocation$inboundSchema.optional(),
+  start: z.nullable(z.number().int()).optional(),
+});
+
+/** @internal */
+export type V1AccountLeaderboardRequestBody$Outbound = {
+  appId?: number | null | undefined;
+  badgeId?: string | null | undefined;
+  badgeIsFoil?: boolean | null | undefined;
+  end?: number | null | undefined;
+  leaderboard: string;
+  location?: V1LeaderboardLocation$Outbound | undefined;
+  start?: number | null | undefined;
+};
+
+/** @internal */
+export const V1AccountLeaderboardRequestBody$outboundSchema: z.ZodType<
+  V1AccountLeaderboardRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1AccountLeaderboardRequestBody
+> = z.object({
+  appId: z.nullable(z.number().int()).optional(),
+  badgeId: z.nullable(z.string()).optional(),
+  badgeIsFoil: z.nullable(z.boolean()).optional(),
+  end: z.nullable(z.number().int()).optional(),
+  leaderboard: V1AccountLeaderboardRequestBodyLeaderboard$outboundSchema,
+  location: V1LeaderboardLocation$outboundSchema.optional(),
+  start: z.nullable(z.number().int()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1AccountLeaderboardRequestBody$ {
+  /** @deprecated use `V1AccountLeaderboardRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V1AccountLeaderboardRequestBody$inboundSchema;
+  /** @deprecated use `V1AccountLeaderboardRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V1AccountLeaderboardRequestBody$outboundSchema;
+  /** @deprecated use `V1AccountLeaderboardRequestBody$Outbound` instead. */
+  export type Outbound = V1AccountLeaderboardRequestBody$Outbound;
+}

package/src/models/components/v1accountleaderboardresponsebody.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  LeaderboardAccount,
+  LeaderboardAccount$inboundSchema,
+  LeaderboardAccount$Outbound,
+  LeaderboardAccount$outboundSchema,
+} from "./leaderboardaccount.js";
+import {
+  V1AccountLeaderboardAccount,
+  V1AccountLeaderboardAccount$inboundSchema,
+  V1AccountLeaderboardAccount$Outbound,
+  V1AccountLeaderboardAccount$outboundSchema,
+} from "./v1accountleaderboardaccount.js";
+import {
+  V1AccountLeaderboardBadgeInfo,
+  V1AccountLeaderboardBadgeInfo$inboundSchema,
+  V1AccountLeaderboardBadgeInfo$Outbound,
+  V1AccountLeaderboardBadgeInfo$outboundSchema,
+} from "./v1accountleaderboardbadgeinfo.js";
+import {
+  V1LeaderboardLocation,
+  V1LeaderboardLocation$inboundSchema,
+  V1LeaderboardLocation$Outbound,
+  V1LeaderboardLocation$outboundSchema,
+} from "./v1leaderboardlocation.js";
+
+export type V1AccountLeaderboardResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  accounts: Array<V1AccountLeaderboardAccount> | null;
+  app?: LeaderboardAccount | undefined;
+  badgeInfo?: V1AccountLeaderboardBadgeInfo | undefined;
+  location?: V1LeaderboardLocation | undefined;
+};
+
+/** @internal */
+export const V1AccountLeaderboardResponseBody$inboundSchema: z.ZodType<
+  V1AccountLeaderboardResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  accounts: z.nullable(z.array(V1AccountLeaderboardAccount$inboundSchema)),
+  app: LeaderboardAccount$inboundSchema.optional(),
+  badgeInfo: V1AccountLeaderboardBadgeInfo$inboundSchema.optional(),
+  location: V1LeaderboardLocation$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+/** @internal */
+export type V1AccountLeaderboardResponseBody$Outbound = {
+  $schema?: string | undefined;
+  accounts: Array<V1AccountLeaderboardAccount$Outbound> | null;
+  app?: LeaderboardAccount$Outbound | undefined;
+  badgeInfo?: V1AccountLeaderboardBadgeInfo$Outbound | undefined;
+  location?: V1LeaderboardLocation$Outbound | undefined;
+};
+
+/** @internal */
+export const V1AccountLeaderboardResponseBody$outboundSchema: z.ZodType<
+  V1AccountLeaderboardResponseBody$Outbound,
+  z.ZodTypeDef,
+  V1AccountLeaderboardResponseBody
+> = z.object({
+  dollarSchema: z.string().optional(),
+  accounts: z.nullable(z.array(V1AccountLeaderboardAccount$outboundSchema)),
+  app: LeaderboardAccount$outboundSchema.optional(),
+  badgeInfo: V1AccountLeaderboardBadgeInfo$outboundSchema.optional(),
+  location: V1LeaderboardLocation$outboundSchema.optional(),
+}).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 V1AccountLeaderboardResponseBody$ {
+  /** @deprecated use `V1AccountLeaderboardResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V1AccountLeaderboardResponseBody$inboundSchema;
+  /** @deprecated use `V1AccountLeaderboardResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V1AccountLeaderboardResponseBody$outboundSchema;
+  /** @deprecated use `V1AccountLeaderboardResponseBody$Outbound` instead. */
+  export type Outbound = V1AccountLeaderboardResponseBody$Outbound;
+}

package/src/models/components/v1leaderboardlocation.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type V1LeaderboardLocation = {
+  /**
+   * The city to get the leaderboard for, otherwise global
+   */
+  city?: string | null | undefined;
+  /**
+   * The country to get the leaderboard for, otherwise global
+   */
+  country?: string | null | undefined;
+  /**
+   * The region to get the leaderboard for, otherwise global
+   */
+  region?: string | null | undefined;
+  /**
+   * The state to get the leaderboard for, otherwise global
+   */
+  state?: string | null | undefined;
+};
+
+/** @internal */
+export const V1LeaderboardLocation$inboundSchema: z.ZodType<
+  V1LeaderboardLocation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  city: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+  state: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type V1LeaderboardLocation$Outbound = {
+  city?: string | null | undefined;
+  country?: string | null | undefined;
+  region?: string | null | undefined;
+  state?: string | null | undefined;
+};
+
+/** @internal */
+export const V1LeaderboardLocation$outboundSchema: z.ZodType<
+  V1LeaderboardLocation$Outbound,
+  z.ZodTypeDef,
+  V1LeaderboardLocation
+> = z.object({
+  city: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+  state: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V1LeaderboardLocation$ {
+  /** @deprecated use `V1LeaderboardLocation$inboundSchema` instead. */
+  export const inboundSchema = V1LeaderboardLocation$inboundSchema;
+  /** @deprecated use `V1LeaderboardLocation$outboundSchema` instead. */
+  export const outboundSchema = V1LeaderboardLocation$outboundSchema;
+  /** @deprecated use `V1LeaderboardLocation$Outbound` instead. */
+  export type Outbound = V1LeaderboardLocation$Outbound;
+}