Files
plexjs/docs/sdk/models/operations/postuserssignindataresponse.md

100 lines
5.2 KiB
Markdown

# PostUsersSignInDataResponse
## Example Usage
```typescript
import {
PostUsersSignInDataAuthenticationResponseStatus,
PostUsersSignInDataAuthenticationStatus,
PostUsersSignInDataMailingListStatus,
PostUsersSignInDataResponse,
PostUsersSignInDataState,
PostUsersSignInDataStatus,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: PostUsersSignInDataResponse = {
contentType: "<value>",
statusCode: 205,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
userPlexAccount: {
adsConsent: false,
adsConsentReminderAt: 1556281940,
adsConsentSetAt: 1556281940,
authToken: "CxoUzBTSV5hsxjTpFKaf",
country: "US",
email: "username@email.com",
friendlyName: "friendlyUsername",
entitlements: [
"[]",
],
homeSize: 1,
id: 13692262,
joinedAt: 1556281940,
locale: "es",
mailingListStatus: PostUsersSignInDataMailingListStatus.Active,
maxHomeSize: 15,
profile: {
defaultAudioLanguage: "ja",
defaultSubtitleLanguage: "en",
},
rememberExpiresAt: 1556281940,
scrobbleTypes: "<value>",
services: [
{
identifier: "metadata-dev",
endpoint: "https://epg.provider.plex.tv",
token: "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv",
secret: "<value>",
status: PostUsersSignInDataStatus.Online,
},
],
subscription: {
active: true,
subscribedAt: "2021-04-12T18:21:12Z",
status: PostUsersSignInDataAuthenticationStatus.Inactive,
},
subscriptionDescription: "<value>",
subscriptions: [
{
active: true,
subscribedAt: "2021-04-12T18:21:12Z",
status: PostUsersSignInDataAuthenticationResponseStatus.Inactive,
},
],
thumb: "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",
title: "UsernameTitle",
username: "Username",
uuid: "dae343c1f45beb4f",
attributionPartner: null,
pastSubscriptions: [
{
id: "<id>",
mode: "<value>",
renewsAt: 1556281940,
endsAt: 1556281940,
type: "plexpass",
transfer: "<value>",
state: PostUsersSignInDataState.Ended,
billing: {
internalPaymentMethod: {},
paymentMethodId: 485628,
},
},
],
trials: [
{},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `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.PostUsersSignInDataUserPlexAccount](../../../sdk/models/operations/postuserssignindatauserplexaccount.md) | :heavy_minus_sign: | Returns the user account data with a valid auth token |