mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-06 12:37:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.161.0
This commit is contained in:
speakeasybot
5
content/pages/01-reference/curl/resources/plex/plex.mdx
Normal file
5
content/pages/01-reference/curl/resources/plex/plex.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
import Tv from "./tv/tv.mdx";
|
||||
|
||||
## Plex
|
||||
|
||||
<Tv />
|
||||
@@ -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>`
|
||||
|
||||
@@ -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
|
||||
@@ -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`
|
||||
|
||||
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
@@ -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 */}
|
||||
@@ -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>`
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
@@ -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
15
content/pages/01-reference/curl/resources/plex/tv/tv.mdx
Normal 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 />
|
||||
@@ -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/>
|
||||
|
||||
|
||||
5
content/pages/01-reference/go/resources/plex/plex.mdx
Normal file
5
content/pages/01-reference/go/resources/plex/plex.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
import Tv from "./tv/tv.mdx";
|
||||
|
||||
## Plex
|
||||
|
||||
<Tv />
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -0,0 +1,19 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
---
|
||||
##### `xPlexClientIdentifier` *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `strong` *{`*bool`}*
|
||||
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`
|
||||
|
||||
|
||||
---
|
||||
##### `opts` *{`[]operations.Option`}*
|
||||
The options for this request.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetPinResponse from "/content/types/models/operations/get_pin_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetPinResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetPin.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var xPlexClientIdentifier string = "string"
|
||||
|
||||
var strong *bool = false
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Plex.Tv.GetPin(ctx, xPlexClientIdentifier, strong)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -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 */}
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
---
|
||||
##### `pinID` *{`string`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `xPlexClientIdentifier` *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `opts` *{`[]operations.Option`}*
|
||||
The options for this request.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetTokenResponse from "/content/types/models/operations/get_token_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetTokenResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetToken.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var pinID string = "string"
|
||||
|
||||
var xPlexClientIdentifier string = "string"
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Plex.Tv.GetToken(ctx, pinID, xPlexClientIdentifier)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1000,
|
||||
"message": "X-Plex-Client-Identifier is missing",
|
||||
"status": 400
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -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/go/resources/plex/tv/tv.mdx
Normal file
15
content/pages/01-reference/go/resources/plex/tv/tv.mdx
Normal 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](/go/plex/tv/get_pin) - Get a Pin
|
||||
* [Get Token](/go/plex/tv/get_token) - Get Access Token
|
||||
|
||||
---
|
||||
<GetPin />
|
||||
|
||||
---
|
||||
<GetToken />
|
||||
@@ -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/>
|
||||
|
||||
|
||||
@@ -74,5 +74,40 @@ func main() {
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
var xPlexClientIdentifier string = "string"
|
||||
|
||||
var strong *bool = false
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Plex.Tv.GetPin(ctx, operations.WithServerURL("https://plex.tv/api/v2"), xPlexClientIdentifier, strong)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{/* End Go Server Options */}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
import Tv from "./tv/tv.mdx";
|
||||
|
||||
## Plex
|
||||
|
||||
<Tv />
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -0,0 +1,15 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `x_plex_client_identifier` *{`str`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `strong` *{`Optional[bool]`}*
|
||||
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`
|
||||
|
||||
|
||||
---
|
||||
##### `server_url` *{`Optional[str]`}*
|
||||
An optional server URL to use.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetPinResponse from "/content/types/models/operations/get_pin_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetPinResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetPin.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.tv.get_pin(x_plex_client_identifier='string', strong=False)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -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 */}
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -0,0 +1,12 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pin_id` *{`str`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `x_plex_client_identifier` *{`str`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `server_url` *{`Optional[str]`}*
|
||||
An optional server URL to use.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetTokenResponse from "/content/types/models/operations/get_token_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetTokenResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetToken.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.tv.get_token(pin_id='string', x_plex_client_identifier='string')
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1000,
|
||||
"message": "X-Plex-Client-Identifier is missing",
|
||||
"status": 400
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -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/python/resources/plex/tv/tv.mdx
Normal file
15
content/pages/01-reference/python/resources/plex/tv/tv.mdx
Normal 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](/python/plex/tv/get_pin) - Get a Pin
|
||||
* [Get Token](/python/plex/tv/get_token) - Get Access Token
|
||||
|
||||
---
|
||||
<GetPin />
|
||||
|
||||
---
|
||||
<GetToken />
|
||||
@@ -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/>
|
||||
|
||||
|
||||
@@ -45,6 +45,25 @@ s = plex_api.PlexAPI(
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.tv.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='string', strong=False)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import TypeT from "/content/types/models/operations/type_t/typescript.mdx"
|
||||
import Type from "/content/types/models/operations/type/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
@@ -7,11 +7,11 @@ import Labels from "/src/lib/labels";
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type`: *{`operations.TypeT`}*
|
||||
##### `type`: *{`operations.Type`}*
|
||||
Plex content type to search for
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<TypeT />
|
||||
<Type />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<CH.Code>
|
||||
```typescript SearchLibrary.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { TypeT } from "@lukehagar/plexjs/models/operations";
|
||||
import { Type } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
@@ -10,7 +10,7 @@ async function run() {
|
||||
});
|
||||
|
||||
const sectionId = 791725;
|
||||
const type = TypeT.Four;
|
||||
const type = Type.Four;
|
||||
|
||||
const result = await sdk.library.searchLibrary(sectionId, type);
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
import Tv from "./tv/tv.mdx";
|
||||
|
||||
## Plex
|
||||
|
||||
<Tv />
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -0,0 +1,23 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `xPlexClientIdentifier`: *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `strong?`: *{`boolean`}*
|
||||
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`
|
||||
|
||||
|
||||
---
|
||||
##### `options?`: *{`RequestOptions`}*
|
||||
Options for making HTTP requests.
|
||||
|
||||
---
|
||||
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)
|
||||
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
|
||||
|
||||
---
|
||||
##### `options.serverURL?`: *{`string`}*
|
||||
An optional server URL to use.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetPinResponse from "/content/types/models/operations/get_pin_response/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`Promise<operations.GetPinResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript GetPin.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const xPlexClientIdentifier = "string";
|
||||
const strong = false;
|
||||
|
||||
const result = await sdk.plex.tv.getPin(xPlexClientIdentifier, strong);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -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 */}
|
||||
@@ -0,0 +1,3 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -0,0 +1,20 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pinID`: *{`string`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `xPlexClientIdentifier`: *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `options?`: *{`RequestOptions`}*
|
||||
Options for making HTTP requests.
|
||||
|
||||
---
|
||||
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)
|
||||
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
|
||||
|
||||
---
|
||||
##### `options.serverURL?`: *{`string`}*
|
||||
An optional server URL to use.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetTokenResponse from "/content/types/models/operations/get_token_response/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`Promise<operations.GetTokenResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript GetToken.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const pinID = "string";
|
||||
const xPlexClientIdentifier = "string";
|
||||
|
||||
const result = await sdk.plex.tv.getToken(pinID, xPlexClientIdentifier);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1000,
|
||||
"message": "X-Plex-Client-Identifier is missing",
|
||||
"status": 400
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -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 */}
|
||||
@@ -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](/typescript/plex/tv/get_pin) - Get a Pin
|
||||
* [Get Token](/typescript/plex/tv/get_token) - Get Access Token
|
||||
|
||||
---
|
||||
<GetPin />
|
||||
|
||||
---
|
||||
<GetToken />
|
||||
@@ -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/>
|
||||
|
||||
|
||||
@@ -54,5 +54,31 @@ async function run() {
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const xPlexClientIdentifier = "string";
|
||||
const strong = false;
|
||||
|
||||
const result = await sdk.plex.tv.getPin(xPlexClientIdentifier, strong, {
|
||||
serverURL: "https://plex.tv/api/v2",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
{/* End Typescript Server Options */}
|
||||
|
||||
16
content/types/models/errors/get_pin_errors/python.mdx
Normal file
16
content/types/models/errors/get_pin_errors/python.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `code` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `message` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `status` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
16
content/types/models/errors/get_pin_errors/typescript.mdx
Normal file
16
content/types/models/errors/get_pin_errors/typescript.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `code?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `message?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `status?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
14
content/types/models/errors/get_pin_response_body/python.mdx
Normal file
14
content/types/models/errors/get_pin_response_body/python.mdx
Normal file
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `errors` *{`List[errors.GetPinErrors]`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/errors/get_pin_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `errors?`: *{`errors.GetPinErrors[]`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/errors/get_pin_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
16
content/types/models/errors/get_token_errors/python.mdx
Normal file
16
content/types/models/errors/get_token_errors/python.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `code` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `message` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `status` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
16
content/types/models/errors/get_token_errors/typescript.mdx
Normal file
16
content/types/models/errors/get_token_errors/typescript.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `code?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `message?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `status?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `errors` *{`List[errors.GetTokenErrors]`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/errors/get_token_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `errors?`: *{`errors.GetTokenErrors[]`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/errors/get_token_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `Location` *{`[]operations.Location`}*
|
||||
##### `Location` *{`[]operations.GetLibrariesLocation`}*
|
||||
<br/>
|
||||
**Example:** `[{"id":1,"path":"/movies"}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_libraries_location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `location` *{`List[operations.Location]`}*
|
||||
##### `location` *{`List[operations.GetLibrariesLocation]`}*
|
||||
<br/>
|
||||
**Example:** `[{"id":1,"path":"/movies"}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_libraries_location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `location?`: *{`operations.Location[]`}*
|
||||
##### `location?`: *{`operations.GetLibrariesLocation[]`}*
|
||||
<br/>
|
||||
**Example:** `[{"id":1,"path":"/movies"}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_libraries_location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ID` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `Path` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id` *{`Optional[int]`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `path` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `path?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
|
||||
|
||||
12
content/types/models/operations/get_pin_request/go.mdx
Normal file
12
content/types/models/operations/get_pin_request/go.mdx
Normal file
@@ -0,0 +1,12 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `XPlexClientIdentifier` *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `Strong` *{`*bool`}*
|
||||
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`
|
||||
|
||||
|
||||
|
||||
12
content/types/models/operations/get_pin_request/python.mdx
Normal file
12
content/types/models/operations/get_pin_request/python.mdx
Normal file
@@ -0,0 +1,12 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `x_plex_client_identifier` *{`str`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `strong` *{`Optional[bool]`}*
|
||||
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`
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `xPlexClientIdentifier`: *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
---
|
||||
##### `strong?`: *{`boolean`}*
|
||||
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`
|
||||
|
||||
|
||||
|
||||
23
content/types/models/operations/get_pin_response/go.mdx
Normal file
23
content/types/models/operations/get_pin_response/go.mdx
Normal file
@@ -0,0 +1,23 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `ContentType` *{`string`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `StatusCode` *{`int`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
---
|
||||
##### `Object` *{`*operations.GetPinResponseBody`}*
|
||||
The Pin
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
23
content/types/models/operations/get_pin_response/python.mdx
Normal file
23
content/types/models/operations/get_pin_response/python.mdx
Normal file
@@ -0,0 +1,23 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `content_type` *{`str`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `status_code` *{`int`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
---
|
||||
##### `object` *{`Optional[operations.GetPinResponseBody]`}*
|
||||
The Pin
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `contentType`: *{`string`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `statusCode`: *{`number`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
---
|
||||
##### `object?`: *{`operations.GetPinResponseBody`}*
|
||||
The Pin
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
64
content/types/models/operations/get_pin_response_body/go.mdx
Normal file
64
content/types/models/operations/get_pin_response_body/go.mdx
Normal file
@@ -0,0 +1,64 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `ID` *{`*float64`}*
|
||||
PinID for use with authentication
|
||||
<br/>
|
||||
**Example:** `1272322473`
|
||||
|
||||
---
|
||||
##### `Code` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
|
||||
|
||||
---
|
||||
##### `Product` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `Plex Web`
|
||||
|
||||
---
|
||||
##### `Trusted` *{`*bool`}*
|
||||
|
||||
---
|
||||
##### `Qr` *{`*string`}*
|
||||
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`}*
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
---
|
||||
##### `Location` *{`*operations.Location`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `ExpiresIn` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `1800`
|
||||
|
||||
---
|
||||
##### `CreatedAt` [*{ `*time.Time` }*](https://pkg.go.dev/time#Time)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:00:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `ExpiresAt` [*{ `*time.Time` }*](https://pkg.go.dev/time#Time)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:30:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `AuthToken` *{`*string`}*
|
||||
|
||||
---
|
||||
##### `NewRegistration` *{`*string`}*
|
||||
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `id` *{`Optional[float]`}*
|
||||
PinID for use with authentication
|
||||
<br/>
|
||||
**Example:** `1272322473`
|
||||
|
||||
---
|
||||
##### `code` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
|
||||
|
||||
---
|
||||
##### `product` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `Plex Web`
|
||||
|
||||
---
|
||||
##### `trusted` *{`Optional[bool]`}*
|
||||
|
||||
---
|
||||
##### `qr` *{`Optional[str]`}*
|
||||
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`
|
||||
|
||||
---
|
||||
##### `client_identifier` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
---
|
||||
##### `location` *{`Optional[operations.Location]`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `expires_in` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `1800`
|
||||
|
||||
---
|
||||
##### `created_at` [*{ `date` }*](https://docs.python.org/3/library/datetime.html#date-objects)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:00:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `expires_at` [*{ `date` }*](https://docs.python.org/3/library/datetime.html#date-objects)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:30:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `auth_token` *{`Optional[str]`}*
|
||||
|
||||
---
|
||||
##### `new_registration` *{`Optional[str]`}*
|
||||
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `id?`: *{`number`}*
|
||||
PinID for use with authentication
|
||||
<br/>
|
||||
**Example:** `1272322473`
|
||||
|
||||
---
|
||||
##### `code?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
|
||||
|
||||
---
|
||||
##### `product?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `Plex Web`
|
||||
|
||||
---
|
||||
##### `trusted?`: *{`boolean`}*
|
||||
|
||||
---
|
||||
##### `qr?`: *{`string`}*
|
||||
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`}*
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
---
|
||||
##### `location?`: *{`operations.Location`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `expiresIn?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `1800`
|
||||
|
||||
---
|
||||
##### `createdAt?`: [*{ `Date` }*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:00:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `expiresAt?`: [*{ `Date` }*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
|
||||
<br/>
|
||||
**Example:** `2023-04-12 17:30:03 +0000 UTC`
|
||||
|
||||
---
|
||||
##### `authToken?`: *{`string`}*
|
||||
|
||||
---
|
||||
##### `newRegistration?`: *{`string`}*
|
||||
|
||||
|
||||
9
content/types/models/operations/get_token_request/go.mdx
Normal file
9
content/types/models/operations/get_token_request/go.mdx
Normal file
@@ -0,0 +1,9 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `PinID` *{`string`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `XPlexClientIdentifier` *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pin_id` *{`str`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `x_plex_client_identifier` *{`str`}*
|
||||
Plex Authentication Token
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pinID`: *{`string`}*
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `xPlexClientIdentifier`: *{`string`}*
|
||||
Plex Authentication Token
|
||||
|
||||
|
||||
13
content/types/models/operations/get_token_response/go.mdx
Normal file
13
content/types/models/operations/get_token_response/go.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ContentType` *{`string`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `StatusCode` *{`int`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `content_type` *{`str`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `status_code` *{`int`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `contentType`: *{`string`}*
|
||||
HTTP response content type for this operation
|
||||
|
||||
---
|
||||
##### `statusCode`: *{`number`}*
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
@@ -1,11 +1,47 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ID` *{`*int`}*
|
||||
##### `Code` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
**Example:** `US`
|
||||
|
||||
---
|
||||
##### `Path` *{`*string`}*
|
||||
##### `EuropeanUnionMember` *{`*bool`}*
|
||||
|
||||
---
|
||||
##### `ContinentCode` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
**Example:** `NA`
|
||||
|
||||
---
|
||||
##### `Country` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `United States`
|
||||
|
||||
---
|
||||
##### `City` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `Austin`
|
||||
|
||||
---
|
||||
##### `TimeZone` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `America/Chicago`
|
||||
|
||||
---
|
||||
##### `PostalCode` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `78732`
|
||||
|
||||
---
|
||||
##### `InPrivacyRestrictedCountry` *{`*bool`}*
|
||||
|
||||
---
|
||||
##### `Subdivisions` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `Texas`
|
||||
|
||||
---
|
||||
##### `Coordinates` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `30.3768 -97.8935`
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,47 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id` *{`Optional[int]`}*
|
||||
##### `code` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
**Example:** `US`
|
||||
|
||||
---
|
||||
##### `path` *{`Optional[str]`}*
|
||||
##### `european_union_member` *{`Optional[bool]`}*
|
||||
|
||||
---
|
||||
##### `continent_code` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
**Example:** `NA`
|
||||
|
||||
---
|
||||
##### `country` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `United States`
|
||||
|
||||
---
|
||||
##### `city` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `Austin`
|
||||
|
||||
---
|
||||
##### `time_zone` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `America/Chicago`
|
||||
|
||||
---
|
||||
##### `postal_code` *{`Optional[float]`}*
|
||||
<br/>
|
||||
**Example:** `78732`
|
||||
|
||||
---
|
||||
##### `in_privacy_restricted_country` *{`Optional[bool]`}*
|
||||
|
||||
---
|
||||
##### `subdivisions` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `Texas`
|
||||
|
||||
---
|
||||
##### `coordinates` *{`Optional[str]`}*
|
||||
<br/>
|
||||
**Example:** `30.3768 -97.8935`
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,47 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id?`: *{`number`}*
|
||||
##### `code?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
**Example:** `US`
|
||||
|
||||
---
|
||||
##### `path?`: *{`string`}*
|
||||
##### `europeanUnionMember?`: *{`boolean`}*
|
||||
|
||||
---
|
||||
##### `continentCode?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
**Example:** `NA`
|
||||
|
||||
---
|
||||
##### `country?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `United States`
|
||||
|
||||
---
|
||||
##### `city?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `Austin`
|
||||
|
||||
---
|
||||
##### `timeZone?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `America/Chicago`
|
||||
|
||||
---
|
||||
##### `postalCode?`: *{`number`}*
|
||||
<br/>
|
||||
**Example:** `78732`
|
||||
|
||||
---
|
||||
##### `inPrivacyRestrictedCountry?`: *{`boolean`}*
|
||||
|
||||
---
|
||||
##### `subdivisions?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `Texas`
|
||||
|
||||
---
|
||||
##### `coordinates?`: *{`string`}*
|
||||
<br/>
|
||||
**Example:** `30.3768 -97.8935`
|
||||
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@ import Labels from "/src/lib/labels";
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type`: *{`operations.TypeT`}*
|
||||
##### `type`: *{`operations.Type`}*
|
||||
Plex content type to search for
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/type_t/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
|
||||
16
content/types/models/sdkerrors/get_pin_errors/go.mdx
Normal file
16
content/types/models/sdkerrors/get_pin_errors/go.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `Code` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `Message` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `Status` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
14
content/types/models/sdkerrors/get_pin_response_body/go.mdx
Normal file
14
content/types/models/sdkerrors/get_pin_response_body/go.mdx
Normal file
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `Errors` *{`[]sdkerrors.GetPinErrors`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/sdkerrors/get_pin_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
16
content/types/models/sdkerrors/get_token_errors/go.mdx
Normal file
16
content/types/models/sdkerrors/get_token_errors/go.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `Code` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `Message` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `Status` *{`*float64`}*
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `Errors` *{`[]sdkerrors.GetTokenErrors`}*
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/sdkerrors/get_token_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
|
||||
11
content/types/operations/get_libraries_location/curl.mdx
Normal file
11
content/types/operations/get_libraries_location/curl.mdx
Normal file
@@ -0,0 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id` _integer (32-bit) (optional)_
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `path` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
|
||||
|
||||
16
content/types/operations/get_pin_errors/curl.mdx
Normal file
16
content/types/operations/get_pin_errors/curl.mdx
Normal file
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `code` _number (optional)_
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `message` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `X-Plex-Client-Identifier is missing`
|
||||
|
||||
---
|
||||
##### `status` _number (optional)_
|
||||
<br/>
|
||||
**Example:** `400`
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `errors` _array (optional)_
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user