@steamsets/client-ts 0.33.1 → 0.33.3

package/src/funcs/adminCmsDelete.ts

@@ -0,0 +1,189 @@
+/*
+ * 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";
+
+/**
+ * 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.
+ */
+export function adminCmsDelete(
+  client: SteamSetsCore,
+  request: components.V1AdminCmsDeleteRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CmsDeleteResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.V1AdminCmsDeleteRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.CmsDeleteResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.V1AdminCmsDeleteRequestBody$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/admin.cms.delete")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/problem+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: "cms.delete",
+    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.CmsDeleteResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.nil(204, operations.CmsDeleteResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 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/funcs/leaderboardLeaderboardGetChanges.ts

@@ -0,0 +1,188 @@
+/*
+ * 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";
+
+/**
+ * Top movers in a windowed delta on a leaderboard
+ */
+export function leaderboardLeaderboardGetChanges(
+  client: SteamSetsCore,
+  request: components.LeaderboardGetChangesRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LeaderboardGetChangesResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SteamSetsCore,
+  request: components.LeaderboardGetChangesRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LeaderboardGetChangesResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.LeaderboardGetChangesRequestBody$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.getChanges")();
+
+  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: "leaderboard.getChanges",
+    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.LeaderboardGetChangesResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.LeaderboardGetChangesResponse$inboundSchema, {
+      key: "LeaderboardGetChangesResponseBody",
+    }),
+    M.jsonErr([400, 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

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

package/src/models/components/index.ts

@@ -36,8 +36,11 @@ export * from "./idsearch.js";
 export * from "./image.js";
 export * from "./inventoryset.js";
 export * from "./leaderboardaccount.js";
+export * from "./leaderboardchange.js";
 export * from "./leaderboardcity.js";
 export * from "./leaderboardcountry.js";
+export * from "./leaderboardgetchangesrequestbody.js";
+export * from "./leaderboardgetchangesresponsebody.js";
 export * from "./leaderboardregion.js";
 export * from "./leaderboardstate.js";
 export * from "./loginrequestbody.js";
@@ -134,6 +137,7 @@ export * from "./v1activitystreamfeedevent.js";
 export * from "./v1admincmsarchiverequestbody.js";
 export * from "./v1admincmscreaterequestbody.js";
 export * from "./v1admincmscreateresponsebody.js";
+export * from "./v1admincmsdeleterequestbody.js";
 export * from "./v1admincmslistassetsresponsebody.js";
 export * from "./v1admincmslistresponsebody.js";
 export * from "./v1admincmspreviewtokenrequestbody.js";

package/src/models/components/leaderboardchange.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 LeaderboardChange = {
+  account?: LeaderboardAccount | null | undefined;
+  accountId: number;
+  latestDate: Date;
+  newRank: number;
+  newScore: number;
+  oldRank: number;
+  oldScore: number;
+  rankDelta: number;
+  scoreDelta: number;
+};
+
+/** @internal */
+export const LeaderboardChange$inboundSchema: z.ZodType<
+  LeaderboardChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  account: z.nullable(LeaderboardAccount$inboundSchema).optional(),
+  accountId: z.number().int(),
+  latestDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  newRank: z.number().int(),
+  newScore: z.number().int(),
+  oldRank: z.number().int(),
+  oldScore: z.number().int(),
+  rankDelta: z.number().int(),
+  scoreDelta: z.number().int(),
+});
+
+export function leaderboardChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<LeaderboardChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LeaderboardChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LeaderboardChange' from JSON`,
+  );
+}

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/v1admincmscreaterequestbody.ts

@@ -4,22 +4,6 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const V1AdminCmsCreateRequestBodyType = {
-  NavItem: "nav_item",
-  Faq: "faq",
-  Partner: "partner",
-  FooterCategory: "footer_category",
-  FooterLink: "footer_link",
-  DonateFeature: "donate_feature",
-  RoleMeta: "role_meta",
-  StaffText: "staff_text",
-  Page: "page",
-} as const;
-export type V1AdminCmsCreateRequestBodyType = ClosedEnum<
-  typeof V1AdminCmsCreateRequestBodyType
->;
 
 export type V1AdminCmsCreateRequestBody = {
   /**
@@ -33,14 +17,9 @@ export type V1AdminCmsCreateRequestBody = {
    */
   payload?: any | undefined;
   sortOrder: number;
-  type: V1AdminCmsCreateRequestBodyType;
+  type: string;
 };
 
-/** @internal */
-export const V1AdminCmsCreateRequestBodyType$outboundSchema: z.ZodNativeEnum<
-  typeof V1AdminCmsCreateRequestBodyType
-> = z.nativeEnum(V1AdminCmsCreateRequestBodyType);
-
 /** @internal */
 export type V1AdminCmsCreateRequestBody$Outbound = {
   doc_key: string;
@@ -62,7 +41,7 @@ export const V1AdminCmsCreateRequestBody$outboundSchema: z.ZodType<
   parentUid: z.string().optional(),
   payload: z.any().optional(),
   sortOrder: z.number().int(),
-  type: V1AdminCmsCreateRequestBodyType$outboundSchema,
+  type: z.string(),
 }).transform((v) => {
   return remap$(v, {
     docKey: "doc_key",