@steamsets/client-ts 0.29.1 → 0.31.0

package/src/funcs/accountAccountRefreshInventory.ts

@@ -0,0 +1,169 @@
+/*
+ * 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";
+
+/**
+ * Refresh inventory
+ *
+ * @remarks
+ * Trigger a refresh of the authenticated user's Steam inventory. Rate limited based on account tier.
+ */
+export function accountAccountRefreshInventory(
+  client: SteamSetsCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.AccountRefreshInventoryResponse,
+    | 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.AccountRefreshInventoryResponse,
+      | errors.ErrorModel
+      | SteamSetsError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/account.refreshInventory")();
+
+  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: "account.refreshInventory",
+    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,
+    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", "404", "429", "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.AccountRefreshInventoryResponse,
+    | errors.ErrorModel
+    | SteamSetsError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.AccountRefreshInventoryResponse$inboundSchema, {
+      key: "V1AccountRefreshInventoryResponseBody",
+    }),
+    M.jsonErr([400, 401, 404, 429], 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.29.1",
-  genVersion: "2.755.0",
+  sdkVersion: "0.31.0",
+  genVersion: "2.788.15",
   userAgent:
-    "speakeasy-sdk/typescript 0.29.1 2.755.0 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.31.0 2.788.15 1.0.0 @steamsets/client-ts",
 } as const;

package/src/lib/encodings.ts

@@ -102,8 +102,9 @@ export function encodeLabel(
       });
       encValue = mapped?.join("").slice(1);
     } else {
-      const k =
-        options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
@@ -426,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 type QueryEncoderOptions = {
   explode?: boolean;
   charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
 };
 
 type QueryEncoder = (
@@ -440,7 +442,7 @@ type BulkQueryEncoder = (
 ) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = function (
+  const bulkEncode = function(
     values: Record<string, unknown>,
     options?: QueryEncoderOptions,
   ): string {
@@ -450,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
       charEncoding: options?.charEncoding ?? "percent",
     };
 
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
     const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
       return f(key, value, opts);
     });
     return queryJoin(...encoded);

package/src/models/components/card.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 Card = {
+  /**
+   * Owned amount
+   */
+  amount: number;
+  /**
+   * Card name
+   */
+  name: string;
+};
+
+/** @internal */
+export const Card$inboundSchema: z.ZodType<Card, z.ZodTypeDef, unknown> = z
+  .object({
+    amount: z.number().int(),
+    name: z.string(),
+  });
+
+export function cardFromJSON(
+  jsonString: string,
+): SafeParseResult<Card, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Card$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Card' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -9,6 +9,7 @@ export * from "./badge.js";
 export * from "./badgesuggesttags.js";
 export * from "./badgevaluefilter.js";
 export * from "./bestleaderboardrank.js";
+export * from "./card.js";
 export * from "./chosenrole.js";
 export * from "./city.js";
 export * from "./colortag.js";
@@ -23,10 +24,10 @@ export * from "./developerappanalyticsoutcome.js";
 export * from "./developerappanalyticstimeseries.js";
 export * from "./developerappanalyticstimeseriespoint.js";
 export * from "./errordetail.js";
-export * from "./errormodel.js";
 export * from "./httpmetadata.js";
 export * from "./idsearch.js";
 export * from "./image.js";
+export * from "./inventoryset.js";
 export * from "./leaderboardaccount.js";
 export * from "./leaderboardcity.js";
 export * from "./leaderboardcountry.js";
@@ -82,12 +83,14 @@ export * from "./v1accountlistbadgesrequestbody.js";
 export * from "./v1accountlistbadgesresponsebody.js";
 export * from "./v1accountlistfriendsresponsebody.js";
 export * from "./v1accountlistimagesresponsebody.js";
+export * from "./v1accountlistinventorysetsresponsebody.js";
 export * from "./v1accountlistleaderboardhistoryresponsebody.js";
 export * from "./v1accountloginresponsebody.js";
 export * from "./v1accountplaytimedatapoint.js";
 export * from "./v1accountqueueupdaterequestbody.js";
 export * from "./v1accountreconnectrequestbody.js";
 export * from "./v1accountreconnectresponsebody.js";
+export * from "./v1accountrefreshinventoryresponsebody.js";
 export * from "./v1accountrefreshsessionbody.js";
 export * from "./v1accountrefreshsessionrequestbody.js";
 export * from "./v1accountsubscribeemailrequestbody.js";
@@ -110,21 +113,13 @@ export * from "./v1appfilters.js";
 export * from "./v1applistbadgesrequestbody.js";
 export * from "./v1applistbadgesresponsebody.js";
 export * from "./v1apporder.js";
-export * from "./v1badgeapp.js";
 export * from "./v1badgefilters.js";
-export * from "./v1badgelevel.js";
-export * from "./v1badgelistbadgepricesrequestbody.js";
-export * from "./v1badgelistbadgepricesresponsebody.js";
 export * from "./v1badgelisttagsresponsebody.js";
 export * from "./v1badgeorder.js";
 export * from "./v1badgesearchbadgesresponsebody.js";
-export * from "./v1badgeset.js";
-export * from "./v1badgesetcount.js";
-export * from "./v1badgesetcounts.js";
 export * from "./v1badgesuggesttagsrequestbody.js";
 export * from "./v1badgetagbadgerequestbody.js";
 export * from "./v1badgetagbadgeresponsebody.js";
-export * from "./v1badgetypecount.js";
 export * from "./v1groupleaderboardgroup.js";
 export * from "./v1leaderboardappinfo.js";
 export * from "./v1leaderboardbadge.js";

package/src/models/components/inventoryset.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 { Card, Card$inboundSchema } from "./card.js";
+
+export type InventorySet = {
+  /**
+   * The app id
+   */
+  appId: number;
+  /**
+   * Foil cards with owned amounts
+   */
+  foil: Array<Card> | null;
+  /**
+   * Number of complete foil sets
+   */
+  foilSets: number;
+  /**
+   * Normal cards with owned amounts
+   */
+  normal: Array<Card> | null;
+  /**
+   * Number of complete normal sets
+   */
+  normalSets: number;
+};
+
+/** @internal */
+export const InventorySet$inboundSchema: z.ZodType<
+  InventorySet,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appId: z.number().int(),
+  foil: z.nullable(z.array(Card$inboundSchema)),
+  foilSets: z.number().int(),
+  normal: z.nullable(z.array(Card$inboundSchema)),
+  normalSets: z.number().int(),
+});
+
+export function inventorySetFromJSON(
+  jsonString: string,
+): SafeParseResult<InventorySet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InventorySet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InventorySet' from JSON`,
+  );
+}

package/src/models/components/resource.ts

@@ -17,6 +17,7 @@ export const ResourceResource = {
   MaxLeaderboardEntries: "max_leaderboard_entries",
   MiniBackground: "mini_background",
   AccountRefreshRate: "account_refresh_rate",
+  InventoryRefreshRate: "inventory_refresh_rate",
   SocialLinks: "social_links",
   Vanity: "vanity",
   DeveloperApps: "developer_apps",

package/src/models/components/v1accountlistinventorysetsresponsebody.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { InventorySet, InventorySet$inboundSchema } from "./inventoryset.js";
+
+export type V1AccountListInventorySetsResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * When inventory was last updated (unix millis)
+   */
+  inventoryUpdatedAt?: number | undefined;
+  /**
+   * When next refresh is allowed (unix seconds)
+   */
+  nextRefreshAt?: number | undefined;
+  /**
+   * Inventory sets with ownership info
+   */
+  sets: Array<InventorySet> | null;
+};
+
+/** @internal */
+export const V1AccountListInventorySetsResponseBody$inboundSchema: z.ZodType<
+  V1AccountListInventorySetsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  inventoryUpdatedAt: z.number().int().optional(),
+  nextRefreshAt: z.number().int().optional(),
+  sets: z.nullable(z.array(InventorySet$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function v1AccountListInventorySetsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountListInventorySetsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V1AccountListInventorySetsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountListInventorySetsResponseBody' from JSON`,
+  );
+}

package/src/models/components/v1accountrefreshinventoryresponsebody.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";
+
+export type V1AccountRefreshInventoryResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * Unix timestamp (seconds) when next refresh is allowed
+   */
+  nextRefreshAt: number;
+};
+
+/** @internal */
+export const V1AccountRefreshInventoryResponseBody$inboundSchema: z.ZodType<
+  V1AccountRefreshInventoryResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  nextRefreshAt: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function v1AccountRefreshInventoryResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V1AccountRefreshInventoryResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V1AccountRefreshInventoryResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V1AccountRefreshInventoryResponseBody' from JSON`,
+  );
+}

package/src/models/components/v1leaderboardgetaccountleaderboardresponsebody.ts

@@ -41,7 +41,7 @@ export type V1LeaderboardGetAccountLeaderboardResponseBody = {
   /**
    * The number of accounts that are ranked in the leaderboard
    */
-  rankedOutOf?: number | undefined;
+  rankedOutOf: number;
 };
 
 /** @internal */

package/src/models/components/v1leaderboardgetgroupleaderboardresponsebody.ts

@@ -21,7 +21,7 @@ export type V1LeaderboardGetGroupLeaderboardResponseBody = {
   /**
    * The number of accounts that are ranked in the leaderboard
    */
-  rankedOutOf?: number | undefined;
+  rankedOutOf: number;
   steamSetsGroup: V1GroupLeaderboardGroup;
 };
 

package/src/models/components/v1leaderboardpreviewaccountrankresponsebody.ts

@@ -23,7 +23,7 @@ export type V1LeaderboardPreviewAccountRankResponseBody = {
   /**
    * The number of accounts that are ranked in the leaderboard
    */
-  rankedOutOf?: number | undefined;
+  rankedOutOf: number;
 };
 
 /** @internal */

package/src/models/operations/accountlistinventorysets.ts

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

package/src/models/operations/accountrefreshinventory.ts

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

package/src/models/operations/index.ts

@@ -20,12 +20,14 @@ export * from "./accountlistbadgebookmarks.js";
 export * from "./accountlistbadges.js";
 export * from "./accountlistfriends.js";
 export * from "./accountlistimages.js";
+export * from "./accountlistinventorysets.js";
 export * from "./accountlistleaderboardhistory.js";
 export * from "./accountlistownedbadges.js";
 export * from "./accountlogin.js";
 export * from "./accountlogout.js";
 export * from "./accountqueueupdate.js";
 export * from "./accountreconnectconnection.js";
+export * from "./accountrefreshinventory.js";
 export * from "./accountrefreshsession.js";
 export * from "./accountsendemailverification.js";
 export * from "./accountsubscribeemail.js";
@@ -39,7 +41,6 @@ export * from "./accountuploadimages.js";
 export * from "./accountverifyconnection.js";
 export * from "./accountverifyemail.js";
 export * from "./applistbadges.js";
-export * from "./badgelistbadgeprices.js";
 export * from "./badgelisttags.js";
 export * from "./badgesearchbadges.js";
 export * from "./badgesuggesttags.js";