@steamsets/client-ts 0.27.10 → 0.28.0

package/src/funcs/livenessCheck.ts

@@ -1,188 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { SteamSetsCore } from "../core.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.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";
-
-/**
- * Service Health Check
- *
- * @remarks
- * This endpoint provides a simple health check to verify that the Steamsets API is operational and ready to serve requests.
- *
- * <Info>
- * This endpoint is commonly used by load balancers, monitoring systems, and container orchestrators to check service availability.
- * </Info>
- *
- * <Tip>
- * Use this endpoint for automated health monitoring - it has minimal overhead and responds quickly.
- * </Tip>
- *
- * ## Use Cases
- *
- * - **Load Balancer Health Checks**: Configure your load balancer to ping this endpoint
- * - **Monitoring Systems**: Set up alerts when this endpoint becomes unavailable
- * - **Container Health Checks**: Use in Docker/Kubernetes health check configurations
- * - **API Status Verification**: Quick way to verify the service is responding
- *
- * ## Response Format
- *
- * The endpoint returns a simple JSON object with a status message confirming the service is alive and operational.
- */
-export function livenessCheck(
-  client: SteamSetsCore,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.LivenessResponse,
-    | errors.ErrorModel
-    | SteamSetsError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    options,
-  ));
-}
-
-async function $do(
-  client: SteamSetsCore,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      operations.LivenessResponse,
-      | errors.ErrorModel
-      | SteamSetsError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const path = pathToFunc("/v1/liveness")();
-
-  const headers = new Headers(compactMap({
-    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: "liveness",
-    oAuth2Scopes: [],
-
-    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: "GET",
-    baseURL: options?.serverURL,
-    path: path,
-    headers: headers,
-    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,
-    errorCodes: ["400", "401", "4XX", "500", "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.LivenessResponse,
-    | errors.ErrorModel
-    | SteamSetsError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, operations.LivenessResponse$inboundSchema, {
-      key: "V1LivenessResponseBody",
-    }),
-    M.jsonErr([400, 401], 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/models/components/historyvalue.ts

@@ -1,72 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type HistoryValue = {
-  /**
-   * The new value of the history entry
-   */
-  new: string | null;
-  /**
-   * The old value of the history entry
-   */
-  old: string | null;
-};
-
-/** @internal */
-export const HistoryValue$inboundSchema: z.ZodType<
-  HistoryValue,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  new: z.nullable(z.string()),
-  old: z.nullable(z.string()),
-});
-
-/** @internal */
-export type HistoryValue$Outbound = {
-  new: string | null;
-  old: string | null;
-};
-
-/** @internal */
-export const HistoryValue$outboundSchema: z.ZodType<
-  HistoryValue$Outbound,
-  z.ZodTypeDef,
-  HistoryValue
-> = z.object({
-  new: z.nullable(z.string()),
-  old: z.nullable(z.string()),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace HistoryValue$ {
-  /** @deprecated use `HistoryValue$inboundSchema` instead. */
-  export const inboundSchema = HistoryValue$inboundSchema;
-  /** @deprecated use `HistoryValue$outboundSchema` instead. */
-  export const outboundSchema = HistoryValue$outboundSchema;
-  /** @deprecated use `HistoryValue$Outbound` instead. */
-  export type Outbound = HistoryValue$Outbound;
-}
-
-export function historyValueToJSON(historyValue: HistoryValue): string {
-  return JSON.stringify(HistoryValue$outboundSchema.parse(historyValue));
-}
-
-export function historyValueFromJSON(
-  jsonString: string,
-): SafeParseResult<HistoryValue, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => HistoryValue$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'HistoryValue' from JSON`,
-  );
-}

package/src/models/components/v1accountcompare.ts

@@ -1,104 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export const Mode = {
-  All: "all",
-  Missing: "missing",
-  Owned: "owned",
-  ReverseOwned: "reverse_owned",
-  BothMissing: "both_missing",
-  BothOwned: "both_owned",
-} as const;
-export type Mode = ClosedEnum<typeof Mode>;
-
-export type V1AccountCompare = {
-  /**
-   * The SteamID to compare against
-   */
-  against: string;
-  mode?: Mode | undefined;
-};
-
-/** @internal */
-export const Mode$inboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
-  Mode,
-);
-
-/** @internal */
-export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> =
-  Mode$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Mode$ {
-  /** @deprecated use `Mode$inboundSchema` instead. */
-  export const inboundSchema = Mode$inboundSchema;
-  /** @deprecated use `Mode$outboundSchema` instead. */
-  export const outboundSchema = Mode$outboundSchema;
-}
-
-/** @internal */
-export const V1AccountCompare$inboundSchema: z.ZodType<
-  V1AccountCompare,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  against: z.string(),
-  mode: Mode$inboundSchema.default("missing"),
-});
-
-/** @internal */
-export type V1AccountCompare$Outbound = {
-  against: string;
-  mode: string;
-};
-
-/** @internal */
-export const V1AccountCompare$outboundSchema: z.ZodType<
-  V1AccountCompare$Outbound,
-  z.ZodTypeDef,
-  V1AccountCompare
-> = z.object({
-  against: z.string(),
-  mode: Mode$outboundSchema.default("missing"),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace V1AccountCompare$ {
-  /** @deprecated use `V1AccountCompare$inboundSchema` instead. */
-  export const inboundSchema = V1AccountCompare$inboundSchema;
-  /** @deprecated use `V1AccountCompare$outboundSchema` instead. */
-  export const outboundSchema = V1AccountCompare$outboundSchema;
-  /** @deprecated use `V1AccountCompare$Outbound` instead. */
-  export type Outbound = V1AccountCompare$Outbound;
-}
-
-export function v1AccountCompareToJSON(
-  v1AccountCompare: V1AccountCompare,
-): string {
-  return JSON.stringify(
-    V1AccountCompare$outboundSchema.parse(v1AccountCompare),
-  );
-}
-
-export function v1AccountCompareFromJSON(
-  jsonString: string,
-): SafeParseResult<V1AccountCompare, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => V1AccountCompare$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'V1AccountCompare' from JSON`,
-  );
-}

package/src/models/components/v1accountcomparebadgeorder.ts

@@ -1,121 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export const By = {
-  Xp: "xp",
-  Level: "level",
-  Scarcity: "scarcity",
-  Name: "name",
-} 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 V1AccountCompareBadgeOrder = {
-  by?: By | undefined;
-  direction?: Direction | undefined;
-};
-
-/** @internal */
-export const By$inboundSchema: z.ZodNativeEnum<typeof By> = z.nativeEnum(By);
-
-/** @internal */
-export const By$outboundSchema: z.ZodNativeEnum<typeof By> = By$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace By$ {
-  /** @deprecated use `By$inboundSchema` instead. */
-  export const inboundSchema = By$inboundSchema;
-  /** @deprecated use `By$outboundSchema` instead. */
-  export const outboundSchema = By$outboundSchema;
-}
-
-/** @internal */
-export const Direction$inboundSchema: z.ZodNativeEnum<typeof Direction> = z
-  .nativeEnum(Direction);
-
-/** @internal */
-export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> =
-  Direction$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Direction$ {
-  /** @deprecated use `Direction$inboundSchema` instead. */
-  export const inboundSchema = Direction$inboundSchema;
-  /** @deprecated use `Direction$outboundSchema` instead. */
-  export const outboundSchema = Direction$outboundSchema;
-}
-
-/** @internal */
-export const V1AccountCompareBadgeOrder$inboundSchema: z.ZodType<
-  V1AccountCompareBadgeOrder,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  by: By$inboundSchema.default("xp"),
-  direction: Direction$inboundSchema.default("desc"),
-});
-
-/** @internal */
-export type V1AccountCompareBadgeOrder$Outbound = {
-  by: string;
-  direction: string;
-};
-
-/** @internal */
-export const V1AccountCompareBadgeOrder$outboundSchema: z.ZodType<
-  V1AccountCompareBadgeOrder$Outbound,
-  z.ZodTypeDef,
-  V1AccountCompareBadgeOrder
-> = z.object({
-  by: By$outboundSchema.default("xp"),
-  direction: Direction$outboundSchema.default("desc"),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace V1AccountCompareBadgeOrder$ {
-  /** @deprecated use `V1AccountCompareBadgeOrder$inboundSchema` instead. */
-  export const inboundSchema = V1AccountCompareBadgeOrder$inboundSchema;
-  /** @deprecated use `V1AccountCompareBadgeOrder$outboundSchema` instead. */
-  export const outboundSchema = V1AccountCompareBadgeOrder$outboundSchema;
-  /** @deprecated use `V1AccountCompareBadgeOrder$Outbound` instead. */
-  export type Outbound = V1AccountCompareBadgeOrder$Outbound;
-}
-
-export function v1AccountCompareBadgeOrderToJSON(
-  v1AccountCompareBadgeOrder: V1AccountCompareBadgeOrder,
-): string {
-  return JSON.stringify(
-    V1AccountCompareBadgeOrder$outboundSchema.parse(v1AccountCompareBadgeOrder),
-  );
-}
-
-export function v1AccountCompareBadgeOrderFromJSON(
-  jsonString: string,
-): SafeParseResult<V1AccountCompareBadgeOrder, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => V1AccountCompareBadgeOrder$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'V1AccountCompareBadgeOrder' from JSON`,
-  );
-}

package/src/models/components/v1accountcomparebadgesrequestbody.ts

@@ -1,169 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AccountSearch,
-  AccountSearch$inboundSchema,
-  AccountSearch$Outbound,
-  AccountSearch$outboundSchema,
-} from "./accountsearch.js";
-import {
-  V1AccountCompare,
-  V1AccountCompare$inboundSchema,
-  V1AccountCompare$Outbound,
-  V1AccountCompare$outboundSchema,
-} from "./v1accountcompare.js";
-import {
-  V1AccountCompareBadgeOrder,
-  V1AccountCompareBadgeOrder$inboundSchema,
-  V1AccountCompareBadgeOrder$Outbound,
-  V1AccountCompareBadgeOrder$outboundSchema,
-} from "./v1accountcomparebadgeorder.js";
-
-export const Filter = {
-  All: "all",
-  Normal: "normal",
-  Foil: "foil",
-} as const;
-export type Filter = ClosedEnum<typeof Filter>;
-
-export const Ignore = {
-  Event: "event",
-  Sale: "sale",
-  Steam: "steam",
-} as const;
-export type Ignore = ClosedEnum<typeof Ignore>;
-
-export type V1AccountCompareBadgesRequestBody = {
-  comparing: Array<AccountSearch> | null;
-  compare: V1AccountCompare | null;
-  filter?: Filter | undefined;
-  ignore: Array<Ignore> | null;
-  order: V1AccountCompareBadgeOrder | null;
-  page?: number | undefined;
-};
-
-/** @internal */
-export const Filter$inboundSchema: z.ZodNativeEnum<typeof Filter> = z
-  .nativeEnum(Filter);
-
-/** @internal */
-export const Filter$outboundSchema: z.ZodNativeEnum<typeof Filter> =
-  Filter$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Filter$ {
-  /** @deprecated use `Filter$inboundSchema` instead. */
-  export const inboundSchema = Filter$inboundSchema;
-  /** @deprecated use `Filter$outboundSchema` instead. */
-  export const outboundSchema = Filter$outboundSchema;
-}
-
-/** @internal */
-export const Ignore$inboundSchema: z.ZodNativeEnum<typeof Ignore> = z
-  .nativeEnum(Ignore);
-
-/** @internal */
-export const Ignore$outboundSchema: z.ZodNativeEnum<typeof Ignore> =
-  Ignore$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Ignore$ {
-  /** @deprecated use `Ignore$inboundSchema` instead. */
-  export const inboundSchema = Ignore$inboundSchema;
-  /** @deprecated use `Ignore$outboundSchema` instead. */
-  export const outboundSchema = Ignore$outboundSchema;
-}
-
-/** @internal */
-export const V1AccountCompareBadgesRequestBody$inboundSchema: z.ZodType<
-  V1AccountCompareBadgesRequestBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  Comparing: z.nullable(z.array(AccountSearch$inboundSchema)),
-  compare: z.nullable(V1AccountCompare$inboundSchema),
-  filter: Filter$inboundSchema.default("all"),
-  ignore: z.nullable(z.array(Ignore$inboundSchema)),
-  order: z.nullable(V1AccountCompareBadgeOrder$inboundSchema),
-  page: z.number().int().default(1),
-}).transform((v) => {
-  return remap$(v, {
-    "Comparing": "comparing",
-  });
-});
-
-/** @internal */
-export type V1AccountCompareBadgesRequestBody$Outbound = {
-  Comparing: Array<AccountSearch$Outbound> | null;
-  compare: V1AccountCompare$Outbound | null;
-  filter: string;
-  ignore: Array<string> | null;
-  order: V1AccountCompareBadgeOrder$Outbound | null;
-  page: number;
-};
-
-/** @internal */
-export const V1AccountCompareBadgesRequestBody$outboundSchema: z.ZodType<
-  V1AccountCompareBadgesRequestBody$Outbound,
-  z.ZodTypeDef,
-  V1AccountCompareBadgesRequestBody
-> = z.object({
-  comparing: z.nullable(z.array(AccountSearch$outboundSchema)),
-  compare: z.nullable(V1AccountCompare$outboundSchema),
-  filter: Filter$outboundSchema.default("all"),
-  ignore: z.nullable(z.array(Ignore$outboundSchema)),
-  order: z.nullable(V1AccountCompareBadgeOrder$outboundSchema),
-  page: z.number().int().default(1),
-}).transform((v) => {
-  return remap$(v, {
-    comparing: "Comparing",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace V1AccountCompareBadgesRequestBody$ {
-  /** @deprecated use `V1AccountCompareBadgesRequestBody$inboundSchema` instead. */
-  export const inboundSchema = V1AccountCompareBadgesRequestBody$inboundSchema;
-  /** @deprecated use `V1AccountCompareBadgesRequestBody$outboundSchema` instead. */
-  export const outboundSchema =
-    V1AccountCompareBadgesRequestBody$outboundSchema;
-  /** @deprecated use `V1AccountCompareBadgesRequestBody$Outbound` instead. */
-  export type Outbound = V1AccountCompareBadgesRequestBody$Outbound;
-}
-
-export function v1AccountCompareBadgesRequestBodyToJSON(
-  v1AccountCompareBadgesRequestBody: V1AccountCompareBadgesRequestBody,
-): string {
-  return JSON.stringify(
-    V1AccountCompareBadgesRequestBody$outboundSchema.parse(
-      v1AccountCompareBadgesRequestBody,
-    ),
-  );
-}
-
-export function v1AccountCompareBadgesRequestBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<V1AccountCompareBadgesRequestBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => V1AccountCompareBadgesRequestBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'V1AccountCompareBadgesRequestBody' from JSON`,
-  );
-}