npm - @steamsets/client-ts - Versions diffs - 0.4.0 → 0.5.0 - Mend

@steamsets/client-ts 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (341) hide show

package/README.md CHANGED Viewed

@@ -96,6 +96,7 @@ run();
 * [accountV1SettingsUploadImages](docs/sdks/account/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
 * [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
 * [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
+* [accountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate) - Create a new session for non logged in users
 ### [connection](docs/sdks/connection/README.md)
@@ -120,6 +121,7 @@ run();
 * [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
 * [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
 * [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
+* [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
 ### [liveness](docs/sdks/liveness/README.md)
@@ -398,43 +400,6 @@ async function run() {
 run();
-```
-### Per-Operation Security Schemes
-Some operations in this SDK require the security scheme to be specified at the request level. For example:
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets();
-async function run() {
-    const result = await steamSets.account.accountV1SessionLogin(
-        {
-            loginRequestBody: {
-                openidAssocHandle: "123456",
-                openidClaimedId: "76561198842603734",
-                openidIdentity: "https://steamsets.com/api/v1/openid/login",
-                openidMode: "checkid_setup",
-                openidNs: "http://specs.openid.net/auth/2.0",
-                openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
-                openidResponseNonce: "123456",
-                openidReturnTo: "https://steamsets.com/api/v1/openid/login",
-                openidSig: "123456",
-                openidSigned: "123456",
-            },
-        },
-        {
-            anonymous: "<YOUR_BEARER_TOKEN_HERE>",
-        }
-    );
-    // Handle the result
-    console.log(result);
-}
-run();
 ```
 <!-- End Authentication [security] -->
@@ -471,6 +436,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [accountAccountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection)
 - [accountAccountV1GetApps](docs/sdks/account/README.md#accountv1getapps)
 - [accountAccountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges)
+- [accountAccountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate)
 - [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
 - [accountAccountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget)
 - [accountAccountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin)
@@ -487,6 +453,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [connectionAccountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection)
 - [connectionAccountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection)
 - [livenessLiveness](docs/sdks/liveness/README.md#liveness)
+- [sessionAccountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate)
 - [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
 - [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
 - [sessionAccountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin)

package/docs/sdks/account/README.md CHANGED Viewed

@@ -24,6 +24,7 @@ Account related operations
 * [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
+* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
 ## accountV1ConnectionConnect
@@ -95,7 +96,7 @@ run();
 ### Response
-**Promise\<[components.V1ConnectResponseBody](../../models/components/v1connectresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionConnectResponse](../../models/operations/accountv1connectionconnectresponse.md)\>**
 ### Errors
@@ -173,7 +174,7 @@ run();
 ### Response
-**Promise\<[components.V1DeleteConnectionResponseBody](../../models/components/v1deleteconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionDeleteConnectionResponse](../../models/operations/accountv1connectiondeleteconnectionresponse.md)\>**
 ### Errors
@@ -261,7 +262,7 @@ run();
 ### Response
-**Promise\<[components.V1DeleteImagesResponseBody](../../models/components/v1deleteimagesresponsebody.md)\>**
+**Promise\<[operations.AccountV1SettingsDeleteImagesResponse](../../models/operations/accountv1settingsdeleteimagesresponse.md)\>**
 ### Errors
@@ -339,7 +340,7 @@ run();
 ### Response
-**Promise\<[components.V1DeleteSessionResponseBody](../../models/components/v1deletesessionresponsebody.md)\>**
+**Promise\<[operations.AccountV1SessionDeleteResponse](../../models/operations/accountv1sessiondeleteresponse.md)\>**
 ### Errors
@@ -412,7 +413,7 @@ run();
 ### Response
-**Promise\<[components.V1GenerateApiKeyResponseBody](../../models/components/v1generateapikeyresponsebody.md)\>**
+**Promise\<[operations.AccountV1SettingsGenerateApiKeyResponse](../../models/operations/accountv1settingsgenerateapikeyresponse.md)\>**
 ### Errors
@@ -436,7 +437,9 @@ const steamSets = new SteamSets({
 });
 async function run() {
-  const result = await steamSets.account.accountV1GetApps({});
+  const result = await steamSets.account.accountV1GetApps({
+    accountSearch: {},
+  });
   // Handle the result
   console.log(result)
@@ -460,7 +463,9 @@ const steamSets = new SteamSetsCore({
 });
 async function run() {
-  const res = await accountAccountV1GetApps(steamSets, {});
+  const res = await accountAccountV1GetApps(steamSets, {
+    accountSearch: {},
+  });
   if (!res.ok) {
     throw res.error;
@@ -479,14 +484,14 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.AccountSearch](../../models/components/accountsearch.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AccountV1GetAppsRequest](../../models/operations/accountv1getappsrequest.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\<[components.V1AccountsAppsResponseBody](../../models/components/v1accountsappsresponsebody.md)\>**
+**Promise\<[operations.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
 ### Errors
@@ -510,7 +515,9 @@ const steamSets = new SteamSets({
 });
 async function run() {
-  const result = await steamSets.account.accountV1GetBadges({});
+  const result = await steamSets.account.accountV1GetBadges({
+    accountSearch: {},
+  });
   // Handle the result
   console.log(result)
@@ -534,7 +541,9 @@ const steamSets = new SteamSetsCore({
 });
 async function run() {
-  const res = await accountAccountV1GetBadges(steamSets, {});
+  const res = await accountAccountV1GetBadges(steamSets, {
+    accountSearch: {},
+  });
   if (!res.ok) {
     throw res.error;
@@ -553,14 +562,14 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.AccountSearch](../../models/components/accountsearch.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AccountV1GetBadgesRequest](../../models/operations/accountv1getbadgesrequest.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\<[components.V1BadgesResponseBody](../../models/components/v1badgesresponsebody.md)\>**
+**Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
 ### Errors
@@ -633,7 +642,7 @@ run();
 ### Response
-**Promise\<[components.V1GetSessionBody](../../models/components/v1getsessionbody.md)\>**
+**Promise\<[operations.AccountV1SessionGetResponse](../../models/operations/accountv1sessiongetresponse.md)\>**
 ### Errors
@@ -706,7 +715,7 @@ run();
 ### Response
-**Promise\<[components.V1GetSettingsBody](../../models/components/v1getsettingsbody.md)\>**
+**Promise\<[operations.AccountV1SettingsGetResponse](../../models/operations/accountv1settingsgetresponse.md)\>**
 ### Errors
@@ -725,7 +734,9 @@ Logs a user in and creates a new session
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets();
+const steamSets = new SteamSets({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
 async function run() {
   const result = await steamSets.account.accountV1SessionLogin({
@@ -741,8 +752,6 @@ async function run() {
       openidSig: "123456",
       openidSigned: "123456",
     },
-  }, {
-    anonymous: "<YOUR_BEARER_TOKEN_HERE>",
   });
   // Handle the result
@@ -762,7 +771,9 @@ import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/account
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const steamSets = new SteamSetsCore();
+const steamSets = new SteamSetsCore({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
 async function run() {
   const res = await accountAccountV1SessionLogin(steamSets, {
@@ -778,8 +789,6 @@ async function run() {
       openidSig: "123456",
       openidSigned: "123456",
     },
-  }, {
-    anonymous: "<YOUR_BEARER_TOKEN_HERE>",
   });
   if (!res.ok) {
@@ -800,14 +809,13 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `request`                                                                                                                                                                      | [operations.AccountV1SessionLoginRequest](../../models/operations/accountv1sessionloginrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `security`                                                                                                                                                                     | [operations.AccountV1SessionLoginSecurity](../../models/operations/accountv1sessionloginsecurity.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The security requirements 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\<[components.V1LoginResponseBody](../../models/components/v1loginresponsebody.md)\>**
+**Promise\<[operations.AccountV1SessionLoginResponse](../../models/operations/accountv1sessionloginresponse.md)\>**
 ### Errors
@@ -831,9 +839,10 @@ const steamSets = new SteamSets({
 });
 async function run() {
-  await steamSets.account.accountV1SettingsSendEmailVerification({});
+  const result = await steamSets.account.accountV1SettingsSendEmailVerification({});
+  // Handle the result
+  console.log(result)
 }
 run();
@@ -862,7 +871,8 @@ async function run() {
   const { value: result } = res;
+  // Handle the result
+  console.log(result)
 }
 run();
@@ -879,7 +889,7 @@ run();
 ### Response
-**Promise\<void\>**
+**Promise\<[operations.AccountV1SettingsSendEmailVerificationResponse](../../models/operations/accountv1settingssendemailverificationresponse.md)\>**
 ### Errors
@@ -959,7 +969,7 @@ run();
 ### Response
-**Promise\<[components.V1UpdateConnectionResponseBody](../../models/components/v1updateconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionUpdateConnectionResponse](../../models/operations/accountv1connectionupdateconnectionresponse.md)\>**
 ### Errors
@@ -1039,7 +1049,7 @@ run();
 ### Response
-**Promise\<[components.V1UpdateImageResponseBody](../../models/components/v1updateimageresponsebody.md)\>**
+**Promise\<[operations.AccountV1SettingsUpdateImageResponse](../../models/operations/accountv1settingsupdateimageresponse.md)\>**
 ### Errors
@@ -1145,7 +1155,7 @@ run();
 ### Response
-**Promise\<[components.V1UpdateSettingsResponseBody](../../models/components/v1updatesettingsresponsebody.md)\>**
+**Promise\<[operations.AccountV1SettingsUpdateResponse](../../models/operations/accountv1settingsupdateresponse.md)\>**
 ### Errors
@@ -1169,7 +1179,7 @@ const steamSets = new SteamSets({
 });
 async function run() {
-  await steamSets.account.accountV1SettingsUploadImages({
+  const result = await steamSets.account.accountV1SettingsUploadImages({
     images: [
       {
         data: "base64_encoded_image",
@@ -1178,7 +1188,8 @@ async function run() {
     ],
   });
+  // Handle the result
+  console.log(result)
 }
 run();
@@ -1214,7 +1225,8 @@ async function run() {
   const { value: result } = res;
+  // Handle the result
+  console.log(result)
 }
 run();
@@ -1231,7 +1243,7 @@ run();
 ### Response
-**Promise\<void\>**
+**Promise\<[operations.AccountV1SettingsUploadImagesResponse](../../models/operations/accountv1settingsuploadimagesresponse.md)\>**
 ### Errors
@@ -1309,7 +1321,7 @@ run();
 ### Response
-**Promise\<[components.V1VerifyConnectionResponseBody](../../models/components/v1verifyconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionVerifyConnectionResponse](../../models/operations/accountv1connectionverifyconnectionresponse.md)\>**
 ### Errors
@@ -1387,7 +1399,7 @@ run();
 ### Response
-**Promise\<[components.V1VerifyEmailResponseBody](../../models/components/v1verifyemailresponsebody.md)\>**
+**Promise\<[operations.AccountV1SettingsVerfyEmailResponse](../../models/operations/accountv1settingsverfyemailresponse.md)\>**
 ### Errors
@@ -1395,3 +1407,77 @@ run();
 | ------------------------ | ------------------------ | ------------------------ |
 | errors.ErrorModel        | 404,422,429,500          | application/problem+json |
 | errors.SDKError          | 4xx-5xx                  | */*                      |
+## accountV1SessionCreate
+Create a new session for non logged in users
+### Example Usage
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+const steamSets = new SteamSets({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+async function run() {
+  const result = await steamSets.account.accountV1SessionCreate({});
+  // 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 { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accountAccountV1SessionCreate.js";
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+async function run() {
+  const res = await accountAccountV1SessionCreate(steamSets, {});
+  if (!res.ok) {
+    throw res.error;
+  }
+  const { value: result } = res;
+  // Handle the result
+  console.log(result)
+}
+run();
+```
+### Parameters
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.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.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
+### Errors
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 422,500                  | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |

package/docs/sdks/connection/README.md CHANGED Viewed

@@ -82,7 +82,7 @@ run();
 ### Response
-**Promise\<[components.V1ConnectResponseBody](../../models/components/v1connectresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionConnectResponse](../../models/operations/accountv1connectionconnectresponse.md)\>**
 ### Errors
@@ -160,7 +160,7 @@ run();
 ### Response
-**Promise\<[components.V1DeleteConnectionResponseBody](../../models/components/v1deleteconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionDeleteConnectionResponse](../../models/operations/accountv1connectiondeleteconnectionresponse.md)\>**
 ### Errors
@@ -240,7 +240,7 @@ run();
 ### Response
-**Promise\<[components.V1UpdateConnectionResponseBody](../../models/components/v1updateconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionUpdateConnectionResponse](../../models/operations/accountv1connectionupdateconnectionresponse.md)\>**
 ### Errors
@@ -318,7 +318,7 @@ run();
 ### Response
-**Promise\<[components.V1VerifyConnectionResponseBody](../../models/components/v1verifyconnectionresponsebody.md)\>**
+**Promise\<[operations.AccountV1ConnectionVerifyConnectionResponse](../../models/operations/accountv1connectionverifyconnectionresponse.md)\>**
 ### Errors

package/docs/sdks/liveness/README.md CHANGED Viewed

@@ -72,7 +72,7 @@ run();
 ### Response
-**Promise\<[components.V1LivenessResponseBody](../../models/components/v1livenessresponsebody.md)\>**
+**Promise\<[operations.LivenessResponse](../../models/operations/livenessresponse.md)\>**
 ### Errors