@steamsets/client-ts 0.33.2 → 0.33.3

package/src/models/components/leaderboardgetchangesrequestbody.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * improvements = positive delta, declines = negative delta.
+ */
+export const LeaderboardGetChangesRequestBodyDirection = {
+  Improvements: "improvements",
+  Declines: "declines",
+} as const;
+/**
+ * improvements = positive delta, declines = negative delta.
+ */
+export type LeaderboardGetChangesRequestBodyDirection = ClosedEnum<
+  typeof LeaderboardGetChangesRequestBodyDirection
+>;
+
+/**
+ * Which leaderboard the delta is computed against.
+ */
+export const LeaderboardGetChangesRequestBodyLeaderboard = {
+  Apps: "apps",
+  AwardsGiven: "awards_given",
+  AwardsReceived: "awards_received",
+  Bans: "bans",
+  GameBans: "game_bans",
+  VacBans: "vac_bans",
+  FoilBadges: "foil_badges",
+  NormalBadges: "normal_badges",
+  Badges: "badges",
+  Playtime: "playtime",
+  PointsGiven: "points_given",
+  PointsReceived: "points_received",
+  SteamSets: "steam_sets",
+  Xp: "xp",
+  ValidPlaytime: "valid_playtime",
+} as const;
+/**
+ * Which leaderboard the delta is computed against.
+ */
+export type LeaderboardGetChangesRequestBodyLeaderboard = ClosedEnum<
+  typeof LeaderboardGetChangesRequestBodyLeaderboard
+>;
+
+/**
+ * What to sort by. score = XP/playtime/badges depending on leaderboard. rank = leaderboard position.
+ */
+export const Metric = {
+  Score: "score",
+  Rank: "rank",
+} as const;
+/**
+ * What to sort by. score = XP/playtime/badges depending on leaderboard. rank = leaderboard position.
+ */
+export type Metric = ClosedEnum<typeof Metric>;
+
+/**
+ * Lookback window for the delta.
+ */
+export const Window = {
+  TwentyFourh: "24h",
+  Sevend: "7d",
+  Thirtyd: "30d",
+  Ninetyd: "90d",
+  Oney: "1y",
+} as const;
+/**
+ * Lookback window for the delta.
+ */
+export type Window = ClosedEnum<typeof Window>;
+
+export type LeaderboardGetChangesRequestBody = {
+  /**
+   * improvements = positive delta, declines = negative delta.
+   */
+  direction: LeaderboardGetChangesRequestBodyDirection;
+  /**
+   * Which leaderboard the delta is computed against.
+   */
+  leaderboard: LeaderboardGetChangesRequestBodyLeaderboard;
+  /**
+   * Number of accounts returned. Default 100.
+   */
+  limit?: number | undefined;
+  /**
+   * What to sort by. score = XP/playtime/badges depending on leaderboard. rank = leaderboard position.
+   */
+  metric: Metric;
+  /**
+   * Lookback window for the delta.
+   */
+  window: Window;
+};
+
+/** @internal */
+export const LeaderboardGetChangesRequestBodyDirection$outboundSchema:
+  z.ZodNativeEnum<typeof LeaderboardGetChangesRequestBodyDirection> = z
+    .nativeEnum(LeaderboardGetChangesRequestBodyDirection);
+
+/** @internal */
+export const LeaderboardGetChangesRequestBodyLeaderboard$outboundSchema:
+  z.ZodNativeEnum<typeof LeaderboardGetChangesRequestBodyLeaderboard> = z
+    .nativeEnum(LeaderboardGetChangesRequestBodyLeaderboard);
+
+/** @internal */
+export const Metric$outboundSchema: z.ZodNativeEnum<typeof Metric> = z
+  .nativeEnum(Metric);
+
+/** @internal */
+export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> = z
+  .nativeEnum(Window);
+
+/** @internal */
+export type LeaderboardGetChangesRequestBody$Outbound = {
+  direction: string;
+  leaderboard: string;
+  limit?: number | undefined;
+  metric: string;
+  window: string;
+};
+
+/** @internal */
+export const LeaderboardGetChangesRequestBody$outboundSchema: z.ZodType<
+  LeaderboardGetChangesRequestBody$Outbound,
+  z.ZodTypeDef,
+  LeaderboardGetChangesRequestBody
+> = z.object({
+  direction: LeaderboardGetChangesRequestBodyDirection$outboundSchema,
+  leaderboard: LeaderboardGetChangesRequestBodyLeaderboard$outboundSchema,
+  limit: z.number().int().optional(),
+  metric: Metric$outboundSchema,
+  window: Window$outboundSchema,
+});
+
+export function leaderboardGetChangesRequestBodyToJSON(
+  leaderboardGetChangesRequestBody: LeaderboardGetChangesRequestBody,
+): string {
+  return JSON.stringify(
+    LeaderboardGetChangesRequestBody$outboundSchema.parse(
+      leaderboardGetChangesRequestBody,
+    ),
+  );
+}

package/src/models/components/leaderboardgetchangesresponsebody.ts

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

package/src/models/components/v1admincmsdeleterequestbody.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type V1AdminCmsDeleteRequestBody = {
+  documentUid: string;
+};
+
+/** @internal */
+export type V1AdminCmsDeleteRequestBody$Outbound = {
+  document_uid: string;
+};
+
+/** @internal */
+export const V1AdminCmsDeleteRequestBody$outboundSchema: z.ZodType<
+  V1AdminCmsDeleteRequestBody$Outbound,
+  z.ZodTypeDef,
+  V1AdminCmsDeleteRequestBody
+> = z.object({
+  documentUid: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    documentUid: "document_uid",
+  });
+});
+
+export function v1AdminCmsDeleteRequestBodyToJSON(
+  v1AdminCmsDeleteRequestBody: V1AdminCmsDeleteRequestBody,
+): string {
+  return JSON.stringify(
+    V1AdminCmsDeleteRequestBody$outboundSchema.parse(
+      v1AdminCmsDeleteRequestBody,
+    ),
+  );
+}

package/src/models/operations/cmsdelete.ts

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

package/src/models/operations/index.ts

@@ -58,6 +58,7 @@ export * from "./badgesuggesttags.js";
 export * from "./badgetagbadge.js";
 export * from "./cmsarchive.js";
 export * from "./cmscreate.js";
+export * from "./cmsdelete.js";
 export * from "./cmslist.js";
 export * from "./cmslistassets.js";
 export * from "./cmspreviewtoken.js";
@@ -68,6 +69,7 @@ export * from "./cmsuploadimage.js";
 export * from "./cmsversions.js";
 export * from "./leaderboardgetaccountleaderboard.js";
 export * from "./leaderboardgetaccountsmeta.js";
+export * from "./leaderboardgetchanges.js";
 export * from "./leaderboardgetgroupleaderboard.js";
 export * from "./leaderboardgetgroupsmeta.js";
 export * from "./leaderboardgetlowestranks.js";

package/src/models/operations/leaderboardgetchanges.ts

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

package/src/sdk/admin.ts

@@ -5,6 +5,7 @@
 import { adminAdminUpdateRoleOverride } from "../funcs/adminAdminUpdateRoleOverride.js";
 import { adminCmsArchive } from "../funcs/adminCmsArchive.js";
 import { adminCmsCreate } from "../funcs/adminCmsCreate.js";
+import { adminCmsDelete } from "../funcs/adminCmsDelete.js";
 import { adminCmsList } from "../funcs/adminCmsList.js";
 import { adminCmsListAssets } from "../funcs/adminCmsListAssets.js";
 import { adminCmsPreviewToken } from "../funcs/adminCmsPreviewToken.js";
@@ -51,6 +52,23 @@ export class Admin extends ClientSDK {
     ));
   }
 
+  /**
+   * Permanently delete a CMS document and all its versions
+   *
+   * @remarks
+   * Hard delete: removes the cms_document row + every cms_document_version row pointing at it. Irreversible. Public reads stay correct because the type cache is invalidated. The CMS admin UI should restrict this to archived documents to give staff one extra step before destruction.
+   */
+  async cmsDelete(
+    request: components.V1AdminCmsDeleteRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CmsDeleteResponse> {
+    return unwrapAsync(adminCmsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List CMS documents (drafts + published) for editor
    */

package/src/sdk/leaderboard.ts

@@ -7,6 +7,7 @@ import { leaderboardGetAccountsMeta } from "../funcs/leaderboardGetAccountsMeta.
 import { leaderboardGetGroup } from "../funcs/leaderboardGetGroup.js";
 import { leaderboardGetGroupsMeta } from "../funcs/leaderboardGetGroupsMeta.js";
 import { leaderboardGetLowestRanks } from "../funcs/leaderboardGetLowestRanks.js";
+import { leaderboardLeaderboardGetChanges } from "../funcs/leaderboardLeaderboardGetChanges.js";
 import { leaderboardPreviewAccountRank } from "../funcs/leaderboardPreviewAccountRank.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -42,6 +43,20 @@ export class Leaderboard extends ClientSDK {
     ));
   }
 
+  /**
+   * Top movers in a windowed delta on a leaderboard
+   */
+  async leaderboardGetChanges(
+    request: components.LeaderboardGetChangesRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.LeaderboardGetChangesResponse> {
+    return unwrapAsync(leaderboardLeaderboardGetChanges(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get group leaderboard
    */