mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
Normalized imports, regenerated
This commit is contained in:
Luke Hagar
169
docs/sdk/models/operations/postuserssignindatauserplexaccount.md
Normal file
169
docs/sdk/models/operations/postuserssignindatauserplexaccount.md
Normal file
@@ -0,0 +1,169 @@
|
||||
# PostUsersSignInDataUserPlexAccount
|
||||
|
||||
Returns the user account data with a valid auth token
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PostUsersSignInDataAuthenticationFeatures,
|
||||
PostUsersSignInDataAuthenticationResponseStatus,
|
||||
PostUsersSignInDataAuthenticationStatus,
|
||||
PostUsersSignInDataAutoSelectSubtitle,
|
||||
PostUsersSignInDataDefaultSubtitleAccessibility,
|
||||
PostUsersSignInDataDefaultSubtitleForced,
|
||||
PostUsersSignInDataFeatures,
|
||||
PostUsersSignInDataMailingListStatus,
|
||||
PostUsersSignInDataMediaReviewsVisibility,
|
||||
PostUsersSignInDataState,
|
||||
PostUsersSignInDataStatus,
|
||||
PostUsersSignInDataUserPlexAccount,
|
||||
PostUsersSignInDataWatchedIndicator,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: PostUsersSignInDataUserPlexAccount = {
|
||||
adsConsent: true,
|
||||
adsConsentReminderAt: new Date("2019-08-24T14:15:22Z"),
|
||||
adsConsentSetAt: new Date("2019-08-24T14:15:22Z"),
|
||||
anonymous: false,
|
||||
authToken: "CxoUzBTSV5hsxjTpFKaf",
|
||||
backupCodesCreated: false,
|
||||
confirmed: false,
|
||||
country: "US",
|
||||
email: "username@email.com",
|
||||
emailOnlyAuth: false,
|
||||
experimentalFeatures: false,
|
||||
friendlyName: "friendlyUsername",
|
||||
entitlements: ["[]"],
|
||||
guest: false,
|
||||
hasPassword: true,
|
||||
home: false,
|
||||
homeAdmin: false,
|
||||
homeSize: 1,
|
||||
id: 13692262,
|
||||
joinedAt: 1721154902,
|
||||
locale: null,
|
||||
mailingListActive: false,
|
||||
mailingListStatus: PostUsersSignInDataMailingListStatus.Active,
|
||||
maxHomeSize: 15,
|
||||
pin: "string",
|
||||
profile: {
|
||||
autoSelectAudio: true,
|
||||
defaultAudioLanguage: "ja",
|
||||
defaultSubtitleLanguage: "en",
|
||||
autoSelectSubtitle: PostUsersSignInDataAutoSelectSubtitle.One,
|
||||
defaultSubtitleAccessibility: PostUsersSignInDataDefaultSubtitleAccessibility.One,
|
||||
defaultSubtitleForced: PostUsersSignInDataDefaultSubtitleForced.One,
|
||||
watchedIndicator: PostUsersSignInDataWatchedIndicator.One,
|
||||
mediaReviewsVisibility: PostUsersSignInDataMediaReviewsVisibility.Zero,
|
||||
},
|
||||
protected: false,
|
||||
rememberExpiresAt: 1722364046,
|
||||
restricted: false,
|
||||
roles: ["string"],
|
||||
scrobbleTypes: "",
|
||||
services: [
|
||||
{
|
||||
identifier: "metadata-dev",
|
||||
endpoint: "https://epg.provider.plex.tv",
|
||||
token: "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv",
|
||||
secret: "string",
|
||||
status: PostUsersSignInDataStatus.Online,
|
||||
},
|
||||
],
|
||||
subscription: {
|
||||
features: [PostUsersSignInDataFeatures.AndroidDolbyVision],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
status: PostUsersSignInDataAuthenticationStatus.Inactive,
|
||||
paymentService: "string",
|
||||
plan: "string",
|
||||
},
|
||||
subscriptionDescription: "string",
|
||||
subscriptions: [
|
||||
{
|
||||
features: [PostUsersSignInDataAuthenticationFeatures.AndroidDolbyVision],
|
||||
active: true,
|
||||
subscribedAt: "2021-04-12T18:21:12Z",
|
||||
status: PostUsersSignInDataAuthenticationResponseStatus.Inactive,
|
||||
paymentService: "string",
|
||||
plan: "string",
|
||||
},
|
||||
],
|
||||
thumb: "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",
|
||||
title: "UsernameTitle",
|
||||
twoFactorEnabled: false,
|
||||
username: "Username",
|
||||
uuid: "dae343c1f45beb4f",
|
||||
pastSubscriptions: [
|
||||
{
|
||||
id: "string",
|
||||
mode: "string",
|
||||
renewsAt: string,
|
||||
endsAt: 1556281940,
|
||||
canceled: true,
|
||||
gracePeriod: true,
|
||||
onHold: true,
|
||||
canReactivate: true,
|
||||
canUpgrade: true,
|
||||
canDowngrade: true,
|
||||
canConvert: true,
|
||||
type: "plexpass",
|
||||
transfer: "string",
|
||||
state: PostUsersSignInDataState.Ended,
|
||||
billing: {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 216822,
|
||||
},
|
||||
},
|
||||
],
|
||||
trials: [{}],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `adsConsent` | *boolean* | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentReminderAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Unknown | |
|
||||
| `adsConsentSetAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Unknown | |
|
||||
| `anonymous` | *boolean* | :heavy_minus_sign: | Unknown | |
|
||||
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||||
| `backupCodesCreated` | *boolean* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||||
| `confirmed` | *boolean* | :heavy_minus_sign: | If the account has been confirmed | |
|
||||
| `country` | *string* | :heavy_check_mark: | The account country | US |
|
||||
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
|
||||
| `emailOnlyAuth` | *boolean* | :heavy_minus_sign: | If login with email only is enabled | |
|
||||
| `experimentalFeatures` | *boolean* | :heavy_minus_sign: | If experimental features are enabled | |
|
||||
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
|
||||
| `entitlements` | *string*[] | :heavy_check_mark: | List of devices your allowed to use with this account | |
|
||||
| `guest` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
|
||||
| `hasPassword` | *boolean* | :heavy_minus_sign: | If the account has a password | |
|
||||
| `home` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home user | |
|
||||
| `homeAdmin` | *boolean* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||||
| `homeSize` | *number* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
|
||||
| `id` | *number* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||||
| `joinedAt` | *number* | :heavy_check_mark: | Unix epoch datetime the account joined Plex | 1721154902 |
|
||||
| `locale` | *string* | :heavy_check_mark: | The account locale | |
|
||||
| `mailingListActive` | *boolean* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||||
| `mailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../../sdk/models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
| `maxHomeSize` | *number* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
|
||||
| ~~`pin`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `profile` | [operations.PostUsersSignInDataUserProfile](../../../sdk/models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
|
||||
| `protected` | *boolean* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||||
| `rememberExpiresAt` | *number* | :heavy_check_mark: | Unix epoch datetime the authtoken expires | 1722364046 |
|
||||
| `restricted` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||||
| `roles` | *string*[] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||||
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||||
| `services` | [operations.PostUsersSignInDataServices](../../../sdk/models/operations/postuserssignindataservices.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `subscription` | [operations.PostUsersSignInDataSubscription](../../../sdk/models/operations/postuserssignindatasubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||||
| `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||||
| `subscriptions` | [operations.PostUsersSignInDataAuthenticationSubscription](../../../sdk/models/operations/postuserssignindataauthenticationsubscription.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `twoFactorEnabled` | *boolean* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||
| `username` | *string* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `pastSubscriptions` | [operations.PastSubscription](../../../sdk/models/operations/pastsubscription.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `trials` | [operations.Trials](../../../sdk/models/operations/trials.md)[] | :heavy_check_mark: | N/A | |
|
||||
Reference in New Issue
Block a user