Files
plexjs/docs/models/getpinresponse.md

20 KiB
Raw Blame History

GetPinResponse

Example Usage

import { GetPinResponse } from "@lukehagar/plexjs";

let value: GetPinResponse = {
    contentType: "<value>",
    statusCode: 135218,
    rawResponse: new Response('{"message": "hello world"}', {
        headers: { "Content-Type": "application/json" },
    }),
    authPinContainer: {
        id: 308667304,
        code: "7RQZ",
        product: "0",
        trusted: false,
        qr: "https://plex.tv/api/v2/pins/qr/7RQZ",
        clientIdentifier: "string",
        location: {
            code: "VI",
            continentCode: "NA",
            country: "United States Virgin Islands",
            city: "Amsterdam",
            europeanUnionMember: true,
            timeZone: "America/St_Thomas",
            postalCode: 802,
            inPrivacyRestrictedCountry: true,
            inPrivacyRestrictedRegion: true,
            subdivisions: "Saint Thomas",
            coordinates: "18.3381, -64.8941",
        },
        expiresIn: 876,
        createdAt: new Date("2024-07-16T17:03:05Z"),
        expiresAt: new Date("2024-07-16T17:18:05Z"),
        authToken: null,
        newRegistration: null,
    },
};

Fields

Field Type Required Description Example
contentType string ✔️ HTTP response content type for this operation
statusCode number ✔️ HTTP response status code for this operation
rawResponse Response ✔️ Raw HTTP response; suitable for custom response parsing
authPinContainer models.GetPinAuthPinContainer Requests a new pin id used in the authentication flow {
"id": 308667304,
"code": "7RQZ",
"product": "0",
"trusted": false,
"qr": "https://plex.tv/api/v2/pins/qr/7RQZ",
"clientIdentifier": "string",
"location": {
"code": "VI",
"continent_code": "NA",
"country": "United States Virgin Islands",
"city": "Amsterdam",
"european_union_member": true,
"time_zone": "America/St_Thomas",
"postal_code": 802,
"in_privacy_restricted_country": true,
"in_privacy_restricted_region": true,
"subdivisions": "Saint Thomas",
"coordinates": "18.3381, -64.8941"
},
"expiresIn": 876,
"createdAt": "2024-07-16T17:03:05Z",
"expiresAt": "2024-07-16T17:18:05Z",
"authToken": null,
"newRegistration": null
}