LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-07 04:20:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.378.1

Browse Source
This commit is contained in:
speakeasybot
2024-08-25 00:10:39 +00:00
parent 322299ad95
commit cc8bc7366d
94 changed files with 978 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sdks/user/README.md
View File

@@ -8,9 +8,9 @@ API Calls that perform operations with Plex Media Server Users
### Available Operations
* [PostUsersSigninData](#postuserssignindata) - Get User SignIn Data
* [PostSignIn](#postsignin) - Get User SignIn Data
## PostUsersSigninData
## PostSignIn
Sign in user with username and password and return user data with Plex authentication token
@@ -23,9 +23,9 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.User.PostUsersSigninDataAsync(
var res = await sdk.User.PostSignInAsync(
xPlexClientIdentifier: "Postman",
requestBody: new PostUsersSigninDataRequestBody() {
requestBody: new PostSignInRequestBody() {
Login = "username@email.com",
Password = "password123",
});
@@ -38,16 +38,16 @@ var res = await sdk.User.PostUsersSigninDataAsync(
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `RequestBody` | [PostUsersSigninDataRequestBody](../../Models/Requests/PostUsersSigninDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `RequestBody` | [PostSignInRequestBody](../../Models/Requests/PostSignInRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[PostUsersSigninDataResponse](../../Models/Requests/PostUsersSigninDataResponse.md)**
**[PostSignInResponse](../../Models/Requests/PostSignInResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| PlexAPI.Models.Errors.PostUsersSigninDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| PlexAPI.Models.Errors.PostSignInResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |