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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.161.0

Browse Source
This commit is contained in:
speakeasybot
2024-02-01 00:31:41 +00:00
parent 64a942a910
commit bbed03f967
208 changed files with 3319 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
content/pages/01-reference/curl/resources/plex/plex.mdx Normal file
View File

@@ -0,0 +1,5 @@
import Tv from "./tv/tv.mdx";
## Plex
<Tv />

9
content/pages/01-reference/curl/resources/plex/tv/get_pin/_authentication.mdx Normal file
View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

7
content/pages/01-reference/curl/resources/plex/tv/get_pin/_header.mdx Normal file
View File

@@ -0,0 +1,7 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Pin
<OperationInfo method='post' path='/pins' />
Retrieve a Pin from Plex.tv for authentication flows

11
content/pages/01-reference/curl/resources/plex/tv/get_pin/_parameters.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `X-Plex-Client-Identifier` _string_
Plex Authentication Token
---
##### `strong` _boolean (optional)_
Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non\-Strong codes are used for `Plex.tv/link`

96
content/pages/01-reference/curl/resources/plex/tv/get_pin/_response.mdx Normal file
View File

@@ -0,0 +1,96 @@
{/* Autogenerated DO NOT EDIT */}
import Location from "/content/types/operations/location/curl.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `id` _number (optional)_
PinID for use with authentication
<br/>
**Example:** `1272322473`
---
##### `code` _string (optional)_
<br/>
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
---
##### `product` _string (optional)_
<br/>
**Example:** `Plex Web`
---
##### `trusted` _boolean (optional)_
---
##### `qr` _string (optional)_
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
<br/>
**Example:** `https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t`
---
##### `clientIdentifier` _string (optional)_
<br/>
**Example:** `Postman`
---
##### `location` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Location/>
</Collapsible>
---
##### `expiresIn` _number (optional)_
<br/>
**Example:** `1800`
---
##### `createdAt` _datetime (optional)_
<br/>
**Example:** `2023-04-12 17:00:03 +0000 UTC`
---
##### `expiresAt` _datetime (optional)_
<br/>
**Example:** `2023-04-12 17:30:03 +0000 UTC`
---
##### `authToken` _string (optional)_
---
##### `newRegistration` _string (optional)_
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

38
content/pages/01-reference/curl/resources/plex/tv/get_pin/_usage.mdx Normal file
View File

@@ -0,0 +1,38 @@
<CH.Code>
```bash Example Request
curl https://plex.tv/api/v2/pins?strong=false \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
--header 'X-Plex-Client-Identifier: string'
```
---
```json Example Response
{
"id": 1272322473,
"code": "3patfx1a78ukcbr7x0n9bl26t",
"product": "Plex Web",
"trusted": false,
"qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t",
"clientIdentifier": "Postman",
"location": {
"code": "US",
"european_union_member": false,
"continent_code": "NA",
"country": "United States",
"city": "Austin",
"time_zone": "America/Chicago",
"postal_code": 78732,
"in_privacy_restricted_country": false,
"subdivisions": "Texas",
"coordinates": "30.3768 -97.8935"
},
"expiresIn": 1800,
"createdAt": "2023-04-12T17:00:03Z",
"expiresAt": "2023-04-12T17:30:03Z",
"authToken": "string",
"newRegistration": "string"
}
```
</CH.Code>

12
content/pages/01-reference/curl/resources/plex/tv/get_pin/get_pin.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Plex* / *Tv*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

9
content/pages/01-reference/curl/resources/plex/tv/get_token/_authentication.mdx Normal file
View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

7
content/pages/01-reference/curl/resources/plex/tv/get_token/_header.mdx Normal file
View File

@@ -0,0 +1,7 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Token
<OperationInfo method='get' path='/pins/{pinID}' />
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

8
content/pages/01-reference/curl/resources/plex/tv/get_token/_parameters.mdx Normal file
View File

@@ -0,0 +1,8 @@
{/* Autogenerated DO NOT EDIT */}
##### `pinID` _string_
The PinID to retrieve an access token for
---
##### `X-Plex-Client-Identifier` _string_
Plex Authentication Token

22
content/pages/01-reference/curl/resources/plex/tv/get_token/_response.mdx Normal file
View File

@@ -0,0 +1,22 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

22
content/pages/01-reference/curl/resources/plex/tv/get_token/_usage.mdx Normal file
View File

@@ -0,0 +1,22 @@
<CH.Code>
```bash Example Request
curl https://plex.tv/api/v2/pins/string \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
--header 'X-Plex-Client-Identifier: string'
```
---
```json Example Response
{
"errors": [
{
"code": 1000,
"message": "X-Plex-Client-Identifier is missing",
"status": 400
}
]
}
```
</CH.Code>

12
content/pages/01-reference/curl/resources/plex/tv/get_token/get_token.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Plex* / *Tv*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

15
content/pages/01-reference/curl/resources/plex/tv/tv.mdx Normal file
View File

@@ -0,0 +1,15 @@
import GetPin from "./get_pin/get_pin.mdx";
import GetToken from "./get_token/get_token.mdx";
## Tv
### Available Operations
* [Get Pin](/curl/plex/tv/get_pin) - Get a Pin
* [Get Token](/curl/plex/tv/get_token) - Get Access Token
---
<GetPin />
---
<GetToken />

4
content/pages/01-reference/curl/resources/resources.mdx
View File

@@ -10,6 +10,7 @@ import Hubs from "./hubs/hubs.mdx";
import Search from "./search/search.mdx";
import Library from "./library/library.mdx";
import Log from "./log/log.mdx";
import Plex from "./plex/plex.mdx";
import Playlists from "./playlists/playlists.mdx";
import Security from "./security/security.mdx";
import Sessions from "./sessions/sessions.mdx";
@@ -39,6 +40,9 @@ import Video from "./video/video.mdx";
---
<Log/>
---
<Plex/>
---
<Playlists/>