mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.656.1
This commit is contained in:
10
docs/models/components/librarysections.md
Normal file
10
docs/models/components/librarysections.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# LibrarySections
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[components.LibrarySectionsMediaContainer]](../../models/components/librarysectionsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# RequestHandlerSlashGetResponses200Directory
|
||||
# LibrarySectionsDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# RequestHandlerSlashGetResponses200MediaContainer
|
||||
# LibrarySectionsMediaContainer
|
||||
|
||||
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
||||
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
||||
@@ -62,4 +62,4 @@ The container often "hoists" common attributes from its children. For example, i
|
||||
| `updater` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
|
||||
| `version` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `voice_search` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
|
||||
| `directory` | List[[components.RequestHandlerSlashGetResponses200Directory](../../models/components/requesthandlerslashgetresponses200directory.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `directory` | List[[components.LibrarySectionsDirectory](../../models/components/librarysectionsdirectory.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# RequestHandlerSlashGetResponses200
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[components.RequestHandlerSlashGetResponses200MediaContainer]](../../models/components/requesthandlerslashgetresponses200mediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -3,9 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `request_handler_slash_get_responses_200` | [Optional[components.RequestHandlerSlashGetResponses200]](../../models/components/requesthandlerslashgetresponses200.md) | :heavy_minus_sign: | OK |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `library_sections` | [Optional[components.LibrarySections]](../../models/components/librarysections.md) | :heavy_minus_sign: | OK |
|
||||
@@ -3,9 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `request_handler_slash_get_responses_200` | [Optional[components.RequestHandlerSlashGetResponses200]](../../models/components/requesthandlerslashgetresponses200.md) | :heavy_minus_sign: | OK |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `library_sections` | [Optional[components.LibrarySections]](../../models/components/librarysections.md) | :heavy_minus_sign: | OK |
|
||||
@@ -579,10 +579,10 @@ with PlexAPI(
|
||||
|
||||
res = plex_api.library.stop_all_refreshes()
|
||||
|
||||
assert res.request_handler_slash_get_responses_200 is not None
|
||||
assert res.library_sections is not None
|
||||
|
||||
# Handle response
|
||||
print(res.request_handler_slash_get_responses_200)
|
||||
print(res.library_sections)
|
||||
|
||||
```
|
||||
|
||||
@@ -633,10 +633,10 @@ with PlexAPI(
|
||||
"type": 460221,
|
||||
})
|
||||
|
||||
assert res.request_handler_slash_get_responses_200 is not None
|
||||
assert res.library_sections is not None
|
||||
|
||||
# Handle response
|
||||
print(res.request_handler_slash_get_responses_200)
|
||||
print(res.library_sections)
|
||||
|
||||
```
|
||||
|
||||
@@ -2819,8 +2819,8 @@ with PlexAPI(
|
||||
|
||||
## autocomplete
|
||||
|
||||
The field to autocomplete on is specified by the {field}.query parameter. For example `genre.query` or `title.query`.
|
||||
Returns a set of items from the filtered items whose {field} starts with {field}.query. In the results, a {field}.queryRange will be present to express the range of the match
|
||||
The field to autocomplete on is specified by the `{field}.query` parameter. For example `genre.query` or `title.query`.
|
||||
Returns a set of items from the filtered items whose `{field}` starts with `{field}.query`. In the results, a `{field}.queryRange` will be present to express the range of the match
|
||||
|
||||
### Example Usage
|
||||
|
||||
|
||||
Reference in New Issue
Block a user