@steamsets/client-ts
v0.13.5
Published
<div align="left"> <a href="https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=go"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454"
Downloads
1,534
Readme
openapi
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @steamsets/client-tsPNPM
pnpm add @steamsets/client-tsBun
bun add @steamsets/client-tsYarn
yarn add @steamsets/client-ts zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.SDK Example Usage
Example
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
account
- deleteImages
- getApps
- getBadges
- getDataPoints
- getFriends
- getInfo
- getLeaderboardHistory
- getStaff
- sendEmailVerification
- updateImage
- uploadImages
- verifyEmail
accounts
admin
badge
badges
connection
connections
data
developer
leaderboard
liveness
- check - Liveness check
locations
meta
public
session
sessions
settings
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
}
run();
Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.
If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the connect method may throw the following errors:
| Error Type | Status Code | Content Type | | ----------------- | ------------- | ------------------------ | | errors.ErrorModel | 400, 422, 500 | application/problem+json | | errors.SDKError | 4XX, 5XX | */* |
import { SteamSets } from "@steamsets/client-ts";
import {
ErrorModel,
SDKValidationError,
} from "@steamsets/client-ts/models/errors";
const steamSets = new SteamSets({
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
let result;
try {
result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorModel): {
// Handle err.data$: ErrorModelData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server |
| --- | --------------------------- |
| 0 | https://api.steamsets.com |
| 1 | http://localhost:8080 |
Example
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
serverIdx: 1,
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
serverURL: "https://api.steamsets.com",
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { SteamSets } from "@steamsets/client-ts";
import { HTTPClient } from "@steamsets/client-ts/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new SteamSets({ httpClient });Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------- | ---- | ----------- |
| token | http | HTTP Bearer |
To authenticate with the API the token parameter must be set when initializing the SDK client instance. For example:
import { SteamSets } from "@steamsets/client-ts";
const steamSets = new SteamSets({
token: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await steamSets.connections.connect({
code: "123456",
provider: "discord",
});
// Handle the result
console.log(result);
}
run();
Special Types
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @steamsets/client-tsPNPM
pnpm add @steamsets/client-tsBun
bun add @steamsets/client-tsYarn
yarn add @steamsets/client-ts zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
accountDeleteImagesaccountGetAppsaccountGetBadgesaccountGetDataPointsaccountGetFriendsaccountGetInfoaccountGetLeaderboardHistoryaccountGetStaffaccountSendEmailVerificationaccountsQueueaccountUpdateImageaccountUploadImagesaccountVerifyEmailadminAdminV1UpdateEventadminAdminV1UpdateResourcesadminAdminV1UpdateRolesadminGetAccountbadgeBadgeV1BookmarkbadgeBadgeV1GetBookmarksbadgeGetTagsbadgesTagconnectionDeleteconnectionsConnectconnectionUpdateconnectionVerifydataGetAppsdataGetBadgesdataGetDataPointsdataGetFriendsdataGetInfodataGetLeaderboardHistorydataGetStaffdeveloperCreateDeveloperAppdeveloperDeleteDeveloperAppdeveloperUpdateAppleaderboardGetAccountleaderboardGetBadgesleaderboardGetGrouplivenessCheck- Liveness checklocationsGetmetaAccountV1GetEmbedmetaAccountV1GetMetapublicGetAppspublicGetBadgespublicGetDataPointspublicGetFriendspublicGetInfopublicGetLeaderboardHistorysessionCreatesessionLoginsessionsDeletesessionsGetsettingsDeleteImagessettingsGetsettingsSendEmailVerificationsettingsUpdatesettingsUpdateImagesettingsUploadImagessettingsVerifyEmail
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { SteamSets } from "@steamsets/client-ts";
const sdk = new SteamSets({ debugLogger: console });Summary
Table of Contents
- SDK Installation
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.