@steamsets/client-ts 0.11.25 → 0.11.26

package/docs/sdks/account/README.md

@@ -7,36 +7,35 @@ Account related operations
 
 ### Available Operations
 
-* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
-* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
-* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
-* [accountV1SettingsDeleteImages](#accountv1settingsdeleteimages) - Delete mulitple imagest
-* [accountV1SessionDelete](#accountv1sessiondelete) - Deletes a session, can also be used to logout
-* [accountV1GetApps](#accountv1getapps) - Get Account Apps
-* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
-* [accountV1GetDataPoints](#accountv1getdatapoints) - Get Account DataPoints
-* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
-* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
-* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
-* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
-* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
-* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
-* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
-* [accountV1Queue](#accountv1queue) - Queue an account for processing
-* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification) - Resend the verification code for an email
-* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
-* [accountV1SettingsUpdateImage](#accountv1settingsupdateimage) - Update one of the uploaded images
-* [accountV1SettingsUpdate](#accountv1settingsupdate) - Update settings for the logged in account
-* [accountV1SettingsUploadImages](#accountv1settingsuploadimages) - Multi Upload Endpoint for images
-* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
-* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
-* [leaderboardV1GetAccount](#leaderboardv1getaccount) - Get a leaderboard for accounts
-* [leaderboardV1GetBadges](#leaderboardv1getbadges) - Get all available badges for leaderboards
+* [accountV1ConnectionConnect](#accountv1connectionconnect)
+* [accountV1SessionCreate](#accountv1sessioncreate)
+* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection)
+* [accountV1SettingsDeleteImages](#accountv1settingsdeleteimages)
+* [accountV1SessionDelete](#accountv1sessiondelete)
+* [accountV1GetApps](#accountv1getapps)
+* [accountV1GetBadges](#accountv1getbadges)
+* [accountV1GetDataPoints](#accountv1getdatapoints)
+* [accountV1GetFriends](#accountv1getfriends)
+* [accountV1GetInfo](#accountv1getinfo)
+* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory)
+* [accountV1SessionGet](#accountv1sessionget)
+* [accountV1SettingsGet](#accountv1settingsget)
+* [accountV1GetStaff](#accountv1getstaff)
+* [accountV1SessionLogin](#accountv1sessionlogin)
+* [accountV1Queue](#accountv1queue)
+* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification)
+* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection)
+* [accountV1SettingsUpdateImage](#accountv1settingsupdateimage)
+* [accountV1SettingsUpdate](#accountv1settingsupdate)
+* [accountV1SettingsUploadImages](#accountv1settingsuploadimages)
+* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection)
+* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail)
+* [leaderboardV1GetAccount](#leaderboardv1getaccount)
+* [leaderboardV1GetBadges](#leaderboardv1getbadges)
+* [leaderboardV1GetGroup](#leaderboardv1getgroup)
 
 ## accountV1ConnectionConnect
 
-Connect a new Social Provider
-
 ### Example Usage
 
 ```typescript
@@ -114,8 +113,6 @@ run();
 
 ## accountV1SessionCreate
 
-Create a new session for non logged in users
-
 ### Example Usage
 
 ```typescript
@@ -187,8 +184,6 @@ run();
 
 ## accountV1ConnectionDeleteConnection
 
-Remove a connection
-
 ### Example Usage
 
 ```typescript
@@ -264,8 +259,6 @@ run();
 
 ## accountV1SettingsDeleteImages
 
-Delete mulitple imagest
-
 ### Example Usage
 
 ```typescript
@@ -345,8 +338,6 @@ run();
 
 ## accountV1SessionDelete
 
-Deletes a session, can also be used to logout
-
 ### Example Usage
 
 ```typescript
@@ -422,8 +413,6 @@ run();
 
 ## accountV1GetApps
 
-Get Account Apps
-
 ### Example Usage
 
 ```typescript
@@ -495,8 +484,6 @@ run();
 
 ## accountV1GetBadges
 
-Get Account Badges
-
 ### Example Usage
 
 ```typescript
@@ -568,8 +555,6 @@ run();
 
 ## accountV1GetDataPoints
 
-Get Account DataPoints
-
 ### Example Usage
 
 ```typescript
@@ -641,8 +626,6 @@ run();
 
 ## accountV1GetFriends
 
-Get Account Friends
-
 ### Example Usage
 
 ```typescript
@@ -714,8 +697,6 @@ run();
 
 ## accountV1GetInfo
 
-Get Account Info
-
 ### Example Usage
 
 ```typescript
@@ -787,8 +768,6 @@ run();
 
 ## accountV1GetLeaderboardHistory
 
-Get Account Leaderboard History
-
 ### Example Usage
 
 ```typescript
@@ -860,8 +839,6 @@ run();
 
 ## accountV1SessionGet
 
-Gets all session data
-
 ### Example Usage
 
 ```typescript
@@ -932,8 +909,6 @@ run();
 
 ## accountV1SettingsGet
 
-Gets all settings for the account
-
 ### Example Usage
 
 ```typescript
@@ -1004,8 +979,6 @@ run();
 
 ## accountV1GetStaff
 
-Get Staff Members and their info
-
 ### Example Usage
 
 ```typescript
@@ -1076,8 +1049,6 @@ run();
 
 ## accountV1SessionLogin
 
-Logs a user in and creates a new session
-
 ### Example Usage
 
 ```typescript
@@ -1175,8 +1146,6 @@ run();
 
 ## accountV1Queue
 
-Queue an account for processing
-
 ### Example Usage
 
 ```typescript
@@ -1254,8 +1223,6 @@ run();
 
 ## accountV1SettingsSendEmailVerification
 
-Resend the verification code for an email
-
 ### Example Usage
 
 ```typescript
@@ -1327,8 +1294,6 @@ run();
 
 ## accountV1ConnectionUpdateConnection
 
-Make a connection visible/invisible
-
 ### Example Usage
 
 ```typescript
@@ -1406,8 +1371,6 @@ run();
 
 ## accountV1SettingsUpdateImage
 
-Update one of the uploaded images
-
 ### Example Usage
 
 ```typescript
@@ -1485,8 +1448,6 @@ run();
 
 ## accountV1SettingsUpdate
 
-Update settings for the logged in account
-
 ### Example Usage
 
 ```typescript
@@ -1592,8 +1553,6 @@ run();
 
 ## accountV1SettingsUploadImages
 
-Multi Upload Endpoint for images
-
 ### Example Usage
 
 ```typescript
@@ -1679,8 +1638,6 @@ run();
 
 ## accountV1ConnectionVerifyConnection
 
-Verify a domain connection only atm
-
 ### Example Usage
 
 ```typescript
@@ -1756,8 +1713,6 @@ run();
 
 ## accountV1SettingsVerfyEmail
 
-Verify the email by passing in the code the user should've gotten
-
 ### Example Usage
 
 ```typescript
@@ -1833,8 +1788,6 @@ run();
 
 ## leaderboardV1GetAccount
 
-Get a leaderboard for accounts
-
 ### Example Usage
 
 ```typescript
@@ -1946,8 +1899,6 @@ run();
 
 ## leaderboardV1GetBadges
 
-Get all available badges for leaderboards
-
 ### Example Usage
 
 ```typescript
@@ -2014,4 +1965,85 @@ run();
 | Error Type               | Status Code              | Content Type             |
 | ------------------------ | ------------------------ | ------------------------ |
 | errors.ErrorModel        | 404, 500                 | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
+## leaderboardV1GetGroup
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.account.leaderboardV1GetGroup({
+    end: 10,
+    goToLeaderboardRank: 1,
+    leaderboard: "most_members",
+    start: 1,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { accountLeaderboardV1GetGroup } from "@steamsets/client-ts/funcs/accountLeaderboardV1GetGroup.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await accountLeaderboardV1GetGroup(steamSets, {
+    end: 10,
+    goToLeaderboardRank: 1,
+    leaderboard: "most_members",
+    start: 1,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1GroupLeaderboardRequestBody](../../models/components/v1groupleaderboardrequestbody.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.LeaderboardV1GetGroupResponse](../../models/operations/leaderboardv1getgroupresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 404, 422, 500            | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |

package/docs/sdks/app/README.md

@@ -7,13 +7,11 @@ App related operations
 
 ### Available Operations
 
-* [appV1Get](#appv1get) - Get details about an app
-* [appV1Queue](#appv1queue) - Queue a app for processing
+* [appV1Get](#appv1get)
+* [appV1Queue](#appv1queue)
 
 ## appV1Get
 
-Get details about an app
-
 ### Example Usage
 
 ```typescript
@@ -89,8 +87,6 @@ run();
 
 ## appV1Queue
 
-Queue a app for processing
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/badge/README.md

@@ -5,13 +5,11 @@
 
 ### Available Operations
 
-* [badgeV1Tags](#badgev1tags) - Get all available badge tags
-* [badgeV1Tag](#badgev1tag) - Tag a badge
+* [badgeV1Tags](#badgev1tags)
+* [badgeV1Tag](#badgev1tag)
 
 ## badgeV1Tags
 
-Get all available badge tags
-
 ### Example Usage
 
 ```typescript
@@ -83,8 +81,6 @@ run();
 
 ## badgeV1Tag
 
-Tag a badge
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/connection/README.md

@@ -7,15 +7,13 @@ Operations related to oauth2/custom connections.
 
 ### Available Operations
 
-* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
-* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
-* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
-* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
+* [accountV1ConnectionConnect](#accountv1connectionconnect)
+* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection)
+* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection)
+* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection)
 
 ## accountV1ConnectionConnect
 
-Connect a new Social Provider
-
 ### Example Usage
 
 ```typescript
@@ -93,8 +91,6 @@ run();
 
 ## accountV1ConnectionDeleteConnection
 
-Remove a connection
-
 ### Example Usage
 
 ```typescript
@@ -170,8 +166,6 @@ run();
 
 ## accountV1ConnectionUpdateConnection
 
-Make a connection visible/invisible
-
 ### Example Usage
 
 ```typescript
@@ -249,8 +243,6 @@ run();
 
 ## accountV1ConnectionVerifyConnection
 
-Verify a domain connection only atm
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/data/README.md

@@ -7,18 +7,16 @@ This is actual data seen by others then yourself
 
 ### Available Operations
 
-* [accountV1GetApps](#accountv1getapps) - Get Account Apps
-* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
-* [accountV1GetDataPoints](#accountv1getdatapoints) - Get Account DataPoints
-* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
-* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
-* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
-* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
+* [accountV1GetApps](#accountv1getapps)
+* [accountV1GetBadges](#accountv1getbadges)
+* [accountV1GetDataPoints](#accountv1getdatapoints)
+* [accountV1GetFriends](#accountv1getfriends)
+* [accountV1GetInfo](#accountv1getinfo)
+* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory)
+* [accountV1GetStaff](#accountv1getstaff)
 
 ## accountV1GetApps
 
-Get Account Apps
-
 ### Example Usage
 
 ```typescript
@@ -90,8 +88,6 @@ run();
 
 ## accountV1GetBadges
 
-Get Account Badges
-
 ### Example Usage
 
 ```typescript
@@ -163,8 +159,6 @@ run();
 
 ## accountV1GetDataPoints
 
-Get Account DataPoints
-
 ### Example Usage
 
 ```typescript
@@ -236,8 +230,6 @@ run();
 
 ## accountV1GetFriends
 
-Get Account Friends
-
 ### Example Usage
 
 ```typescript
@@ -309,8 +301,6 @@ run();
 
 ## accountV1GetInfo
 
-Get Account Info
-
 ### Example Usage
 
 ```typescript
@@ -382,8 +372,6 @@ run();
 
 ## accountV1GetLeaderboardHistory
 
-Get Account Leaderboard History
-
 ### Example Usage
 
 ```typescript
@@ -455,8 +443,6 @@ run();
 
 ## accountV1GetStaff
 
-Get Staff Members and their info
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/developer/README.md

@@ -7,14 +7,12 @@ Developer App related operations
 
 ### Available Operations
 
-* [accountV1SettingsDeveloperAppCreate](#accountv1settingsdeveloperappcreate) - Add a new Developer App to the account
-* [accountV1SettingsDeveloperAppDelete](#accountv1settingsdeveloperappdelete) - Delete a developer app from the account
-* [accountV1SettingsDeveloperAppUpdate](#accountv1settingsdeveloperappupdate) - Update the developer app/re-generate the api key
+* [accountV1SettingsDeveloperAppCreate](#accountv1settingsdeveloperappcreate)
+* [accountV1SettingsDeveloperAppDelete](#accountv1settingsdeveloperappdelete)
+* [accountV1SettingsDeveloperAppUpdate](#accountv1settingsdeveloperappupdate)
 
 ## accountV1SettingsDeveloperAppCreate
 
-Add a new Developer App to the account
-
 ### Example Usage
 
 ```typescript
@@ -98,8 +96,6 @@ run();
 
 ## accountV1SettingsDeveloperAppDelete
 
-Delete a developer app from the account
-
 ### Example Usage
 
 ```typescript
@@ -175,8 +171,6 @@ run();
 
 ## accountV1SettingsDeveloperAppUpdate
 
-Update the developer app/re-generate the api key
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/group/README.md

@@ -0,0 +1,91 @@
+# Group
+(*group*)
+
+## Overview
+
+Group related operations
+
+### Available Operations
+
+* [leaderboardV1GetGroup](#leaderboardv1getgroup)
+
+## leaderboardV1GetGroup
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.group.leaderboardV1GetGroup({
+    end: 10,
+    goToLeaderboardRank: 1,
+    leaderboard: "most_members",
+    start: 1,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { groupLeaderboardV1GetGroup } from "@steamsets/client-ts/funcs/groupLeaderboardV1GetGroup.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await groupLeaderboardV1GetGroup(steamSets, {
+    end: 10,
+    goToLeaderboardRank: 1,
+    leaderboard: "most_members",
+    start: 1,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1GroupLeaderboardRequestBody](../../models/components/v1groupleaderboardrequestbody.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.LeaderboardV1GetGroupResponse](../../models/operations/leaderboardv1getgroupresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 404, 422, 500            | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |