mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-10 12:37:44 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.161.0
This commit is contained in:
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)_
|
||||
|
||||
|
||||
12
content/types/operations/get_pin_request/curl.mdx
Normal file
12
content/types/operations/get_pin_request/curl.mdx
Normal file
@@ -0,0 +1,12 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `xPlexClientIdentifier` _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`
|
||||
|
||||
|
||||
|
||||
30
content/types/operations/get_pin_response/curl.mdx
Normal file
30
content/types/operations/get_pin_response/curl.mdx
Normal file
@@ -0,0 +1,30 @@
|
||||
{/* 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` _integer (32-bit)_
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `rawResponse` _HTTP response_
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
---
|
||||
##### `twoHundredApplicationJsonObject` _object (optional)_
|
||||
The Pin
|
||||
|
||||
<Collapsible content={() => import('/content/types/operations/get_pin_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `fourHundredApplicationJsonObject` _object (optional)_
|
||||
X\-Plex\-Client\-Identifier is missing
|
||||
|
||||
<Collapsible content={() => import('/content/types/operations/get_pin_plex_tv_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
64
content/types/operations/get_pin_response_body/curl.mdx
Normal file
64
content/types/operations/get_pin_response_body/curl.mdx
Normal file
@@ -0,0 +1,64 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `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 content={() => import('/content/types/operations/location/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
##### `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)_
|
||||
|
||||
|
||||
16
content/types/operations/get_token_errors/curl.mdx
Normal file
16
content/types/operations/get_token_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`
|
||||
|
||||
|
||||
9
content/types/operations/get_token_request/curl.mdx
Normal file
9
content/types/operations/get_token_request/curl.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
|
||||
|
||||
|
||||
23
content/types/operations/get_token_response/curl.mdx
Normal file
23
content/types/operations/get_token_response/curl.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` _integer (32-bit)_
|
||||
HTTP response status code for this operation
|
||||
|
||||
---
|
||||
##### `rawResponse` _HTTP response_
|
||||
Raw HTTP response; suitable for custom response parsing
|
||||
|
||||
---
|
||||
##### `object` _object (optional)_
|
||||
X\-Plex\-Client\-Identifier is missing
|
||||
|
||||
<Collapsible content={() => import('/content/types/operations/get_token_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `errors` _array (optional)_
|
||||
|
||||
|
||||
@@ -1,11 +1,47 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `id` _integer (32-bit) (optional)_
|
||||
##### `code` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
**Example:** `US`
|
||||
|
||||
---
|
||||
##### `path` _string (optional)_
|
||||
##### `europeanUnionMember` _boolean (optional)_
|
||||
|
||||
---
|
||||
##### `continentCode` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `/movies`
|
||||
**Example:** `NA`
|
||||
|
||||
---
|
||||
##### `country` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `United States`
|
||||
|
||||
---
|
||||
##### `city` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `Austin`
|
||||
|
||||
---
|
||||
##### `timeZone` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `America/Chicago`
|
||||
|
||||
---
|
||||
##### `postalCode` _number (optional)_
|
||||
<br/>
|
||||
**Example:** `78732`
|
||||
|
||||
---
|
||||
##### `inPrivacyRestrictedCountry` _boolean (optional)_
|
||||
|
||||
---
|
||||
##### `subdivisions` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `Texas`
|
||||
|
||||
---
|
||||
##### `coordinates` _string (optional)_
|
||||
<br/>
|
||||
**Example:** `30.3768 -97.8935`
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user