mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 12:37:46 +00:00
112 lines
67 KiB
Markdown
112 lines
67 KiB
Markdown
# GetUserDetailsResponse
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import {
|
|
AutoSelectSubtitle,
|
|
DefaultSubtitleAccessibility,
|
|
DefaultSubtitleForced,
|
|
Features,
|
|
GetUserDetailsAuthenticationResponseStatus,
|
|
GetUserDetailsAuthenticationStatus,
|
|
GetUserDetailsFeatures,
|
|
GetUserDetailsResponse,
|
|
GetUserDetailsStatus,
|
|
MailingListStatus,
|
|
MediaReviewsVisibility,
|
|
WatchedIndicator,
|
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: GetUserDetailsResponse = {
|
|
contentType: "<value>",
|
|
statusCode: 19987,
|
|
rawResponse: new Response('{"message": "hello world"}', {
|
|
headers: { "Content-Type": "application/json" },
|
|
}),
|
|
userPlexAccount: {
|
|
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: MailingListStatus.Active,
|
|
maxHomeSize: 15,
|
|
pin: "string",
|
|
profile: {
|
|
autoSelectAudio: true,
|
|
defaultAudioLanguage: "ja",
|
|
defaultSubtitleLanguage: "en",
|
|
autoSelectSubtitle: AutoSelectSubtitle.One,
|
|
defaultSubtitleAccessibility: DefaultSubtitleAccessibility.One,
|
|
defaultSubtitleForced: DefaultSubtitleForced.Zero,
|
|
watchedIndicator: WatchedIndicator.One,
|
|
mediaReviewsVisibility: MediaReviewsVisibility.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: GetUserDetailsStatus.Online,
|
|
},
|
|
],
|
|
subscription: {
|
|
features: [Features.AndroidDolbyVision],
|
|
active: true,
|
|
subscribedAt: "2021-04-12T18:21:12Z",
|
|
status: GetUserDetailsAuthenticationStatus.Inactive,
|
|
paymentService: "string",
|
|
plan: "string",
|
|
},
|
|
subscriptionDescription: "string",
|
|
subscriptions: [
|
|
{
|
|
features: [GetUserDetailsFeatures.AndroidDolbyVision],
|
|
active: true,
|
|
subscribedAt: "2021-04-12T18:21:12Z",
|
|
status: GetUserDetailsAuthenticationResponseStatus.Inactive,
|
|
paymentService: "string",
|
|
plan: "string",
|
|
},
|
|
],
|
|
thumb: "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",
|
|
title: "UsernameTitle",
|
|
twoFactorEnabled: false,
|
|
username: "Username",
|
|
uuid: "dae343c1f45beb4f",
|
|
},
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
| `userPlexAccount` | [operations.GetUserDetailsUserPlexAccount](../../../sdk/models/operations/getuserdetailsuserplexaccount.md) | :heavy_minus_sign: | Logged in user details | {<br/>"adsConsent": true,<br/>"adsConsentReminderAt": "2019-08-24T14:15:22Z",<br/>"adsConsentSetAt": "2019-08-24T14:15:22Z",<br/>"anonymous": false,<br/>"authToken": "CxoUzBTSV5hsxjTpFKaf",<br/>"backupCodesCreated": false,<br/>"confirmed": false,<br/>"country": "US",<br/>"email": "username@email.com",<br/>"emailOnlyAuth": false,<br/>"experimentalFeatures": false,<br/>"friendlyName": "friendlyUsername",<br/>"entitlements": [],<br/>"guest": false,<br/>"hasPassword": true,<br/>"home": false,<br/>"homeAdmin": false,<br/>"homeSize": 1,<br/>"id": 13692262,<br/>"joinedAt": 1721154902,<br/>"locale": null,<br/>"mailingListActive": false,<br/>"mailingListStatus": "subscribed",<br/>"maxHomeSize": 15,<br/>"pastSubscriptions": [<br/>{<br/>"id": "string",<br/>"mode": "string",<br/>"renewsAt": "string",<br/>"endsAt": "1556281940",<br/>"canceled": "0",<br/>"gracePeriod": "0",<br/>"onHold": "0",<br/>"canReactivate": "0",<br/>"canUpgrade": "0",<br/>"canDowngrade": "0",<br/>"canConvert": "0",<br/>"type": "plexpass",<br/>"transfer": "string",<br/>"state": "ended",<br/>"billing": [<br/>{<br/>"internalPaymentMethod": "string",<br/>"paymentMethodId": "string"<br/>}<br/>]<br/>}<br/>],<br/>"pin": "string",<br/>"profile": [<br/>{<br/>"autoSelectAudio": true,<br/>"defaultAudioLanguage": "ja",<br/>"defaultSubtitleLanguage": "en",<br/>"autoSelectSubtitle": 1,<br/>"defaultSubtitleAccessibility": 1,<br/>"defaultSubtitleForced": 0,<br/>"watchedIndicator": 1,<br/>"mediaReviewsVisibility": 0<br/>}<br/>],<br/>"protected": false,<br/>"rememberExpiresAt": 1722364046,<br/>"restricted": false,<br/>"roles": [<br/>"string"<br/>],<br/>"scrobbleTypes": "",<br/>"services": [<br/>{<br/>"identifier": "metadata-dev",<br/>"endpoint": "https://epg.provider.plex.tv",<br/>"token": "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv",<br/>"secret": "string",<br/>"status": "online"<br/>}<br/>],<br/>"subscription": {<br/>"features": [<br/>"Android - Dolby Vision"<br/>],<br/>"active": true,<br/>"subscribedAt": "2021-04-12T18:21:12Z",<br/>"status": "Inactive",<br/>"paymentService": "string",<br/>"plan": "string"<br/>},<br/>"subscriptionDescription": "string",<br/>"subscriptions": [<br/>{<br/>"features": [<br/>"Android - Dolby Vision"<br/>],<br/>"active": true,<br/>"subscribedAt": "2021-04-12T18:21:12Z",<br/>"status": "Inactive",<br/>"paymentService": "string",<br/>"plan": "string"<br/>}<br/>],<br/>"thumb": "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",<br/>"title": "UsernameTitle",<br/>"trials": [<br/>{}<br/>],<br/>"twoFactorEnabled": false,<br/>"username": "Username",<br/>"uuid": "dae343c1f45beb4f"<br/>} | |