mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-09 12:47:44 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.308.1
This commit is contained in:
speakeasybot
@@ -1,12 +1,12 @@
|
||||
# Filter
|
||||
|
||||
Filter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | label |
|
||||
| `filter_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | string |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/label |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Labels |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | filter |
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `ALL` | all |
|
||||
| `AVAILABLE` | available |
|
||||
| `RELEASED` | released |
|
||||
10
docs/models/operations/gethomedataerrors.md
Normal file
10
docs/models/operations/gethomedataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetHomeDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
10
docs/models/operations/gethomedataplexresponsebody.md
Normal file
10
docs/models/operations/gethomedataplexresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetHomeDataPlexResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetHomeDataErrors](../../models/operations/gethomedataerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/gethomedataresponse.md
Normal file
12
docs/models/operations/gethomedataresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetHomeDataResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetHomeDataResponseBody)](../../models/operations/gethomedataresponsebody.md) | :heavy_minus_sign: | Home Data |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetHomeDataPlexResponseBody)](../../models/operations/gethomedataplexresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
15
docs/models/operations/gethomedataresponsebody.md
Normal file
15
docs/models/operations/gethomedataresponsebody.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetHomeDataResponseBody
|
||||
|
||||
Home Data
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1841489 |
|
||||
| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Blindkitty38's home |
|
||||
| `guest_user_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 58815432 |
|
||||
| `guest_user_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | f3df4e01bfca0787 |
|
||||
| `guest_enabled` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `subscription` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
12
docs/models/operations/getlibraryfilter.md
Normal file
12
docs/models/operations/getlibraryfilter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetLibraryFilter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | label |
|
||||
| `filter_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | string |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/label |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Labels |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | filter |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `section_id` | *::Integer* | :heavy_check_mark: | the Id of the library to query | 1 |
|
||||
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | T::Array<[::OpenApiSDK::Operations::Filter](../../models/operations/filter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | T::Array<[::OpenApiSDK::Operations::Sort](../../models/operations/sort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | T::Array<[::OpenApiSDK::Operations::Field](../../models/operations/field.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | T::Array<[::OpenApiSDK::Operations::GetLibraryFilter](../../models/operations/getlibraryfilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | T::Array<[::OpenApiSDK::Operations::Sort](../../models/operations/sort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | T::Array<[::OpenApiSDK::Operations::Field](../../models/operations/field.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,5 +5,6 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `x_plex_product` | *::String* | :heavy_check_mark: | Product name of the application shown in the list of devices<br/> | Postman |
|
||||
| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `x_plex_client_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
@@ -8,5 +8,5 @@
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetPinResponseBody)](../../models/operations/getpinresponsebody.md) | :heavy_minus_sign: | The Pin |
|
||||
| `two_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetPinResponseBody)](../../models/operations/getpinresponsebody.md) | :heavy_minus_sign: | The Pin |
|
||||
| `four_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetPinPlexResponseBody)](../../models/operations/getpinplexresponsebody.md) | :heavy_minus_sign: | X-Plex-Client-Identifier is missing |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::Metadata](../../models/operations/metadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
39
docs/models/operations/getrecentlyaddedmetadata.md
Normal file
39
docs/models/operations/getrecentlyaddedmetadata.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# GetRecentlyAddedMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `rating_key` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 59398 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Marvel Studios |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 4.7 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.3 |
|
||||
| `year` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2023 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
||||
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `originally_available_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
||||
| `added_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681803215 |
|
||||
| `updated_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681888010 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
||||
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
||||
| `media` | T::Array<[::OpenApiSDK::Operations::Media](../../models/operations/media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | T::Array<[::OpenApiSDK::Operations::Genre](../../models/operations/genre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | T::Array<[::OpenApiSDK::Operations::Director](../../models/operations/director.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | T::Array<[::OpenApiSDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::OpenApiSDK::Operations::Country](../../models/operations/country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::OpenApiSDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | |
|
||||
17
docs/models/operations/gettokenlocation.md
Normal file
17
docs/models/operations/gettokenlocation.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetTokenLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | US |
|
||||
| `european_union_member` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `continent_code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | NA |
|
||||
| `country` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States |
|
||||
| `city` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Austin |
|
||||
| `time_zone` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | America/Chicago |
|
||||
| `postal_code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 78732 |
|
||||
| `in_privacy_restricted_country` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `subdivisions` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Texas |
|
||||
| `coordinates` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 30.3768 -97.8935 |
|
||||
10
docs/models/operations/gettokenplexresponsebody.md
Normal file
10
docs/models/operations/gettokenplexresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTokenPlexResponseBody
|
||||
|
||||
X-Plex-Client-Identifier is missing
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetTokenErrors](../../models/operations/gettokenerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -3,9 +3,10 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(::OpenApiSDK::Operations::GetTokenResponseBody)](../../models/operations/gettokenresponsebody.md) | :heavy_minus_sign: | X-Plex-Client-Identifier is missing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetTokenResponseBody)](../../models/operations/gettokenresponsebody.md) | :heavy_minus_sign: | Access Token |
|
||||
| `four_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetTokenPlexResponseBody)](../../models/operations/gettokenplexresponsebody.md) | :heavy_minus_sign: | X-Plex-Client-Identifier is missing |
|
||||
@@ -1,10 +1,21 @@
|
||||
# GetTokenResponseBody
|
||||
|
||||
X-Plex-Client-Identifier is missing
|
||||
Access Token
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetTokenErrors](../../models/operations/gettokenerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | PinID for use with authentication | 1272322473 |
|
||||
| `code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 3patfx1a78ukcbr7x0n9bl26t |
|
||||
| `product` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `trusted` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `qr` | *T.nilable(::String)* | :heavy_minus_sign: | a link to a QR code hosted on plex.tv <br/>The QR code redirects to the relevant `plex.tv/link` authentication page<br/>Which then prompts the user for the 4 Digit Link Pin<br/> | https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t |
|
||||
| `client_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Postman |
|
||||
| `location` | [T.nilable(::OpenApiSDK::Operations::GetTokenLocation)](../../models/operations/gettokenlocation.md) | :heavy_minus_sign: | N/A | |
|
||||
| `expires_in` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1800 |
|
||||
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
|
||||
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
|
||||
| `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
|
||||
| `new_registration` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/operations/getwatchlisterrors.md
Normal file
10
docs/models/operations/getwatchlisterrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetWatchlistErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
16
docs/models/operations/getwatchlistrequest.md
Normal file
16
docs/models/operations/getwatchlistrequest.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetWatchlistRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `filter` | [::OpenApiSDK::Operations::Filter](../../models/operations/filter.md) | :heavy_check_mark: | Filter |
|
||||
| `sort` | *T.nilable(::String)* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> |
|
||||
| `libtype` | [T.nilable(::OpenApiSDK::Operations::Libtype)](../../models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
|
||||
| `maxresults` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
|
||||
| `include_collections` | [T.nilable(::OpenApiSDK::Operations::IncludeCollections)](../../models/operations/includecollections.md) | :heavy_minus_sign: | include collections in the results<br/> |
|
||||
| `include_external_media` | [T.nilable(::OpenApiSDK::Operations::IncludeExternalMedia)](../../models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> |
|
||||
| `x_plex_token` | *::String* | :heavy_check_mark: | User Token |
|
||||
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
|
||||
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
|
||||
12
docs/models/operations/getwatchlistresponse.md
Normal file
12
docs/models/operations/getwatchlistresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetWatchlistResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetWatchlistResponseBody)](../../models/operations/getwatchlistresponsebody.md) | :heavy_minus_sign: | Watchlist Data |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetWatchlistWatchlistResponseBody)](../../models/operations/getwatchlistwatchlistresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
16
docs/models/operations/getwatchlistresponsebody.md
Normal file
16
docs/models/operations/getwatchlistresponsebody.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetWatchlistResponseBody
|
||||
|
||||
Watchlist Data
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `library_section_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::Metadata](../../models/operations/metadata.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getwatchlistwatchlistresponsebody.md
Normal file
10
docs/models/operations/getwatchlistwatchlistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetWatchlistWatchlistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetWatchlistErrors](../../models/operations/getwatchlisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/image.md
Normal file
10
docs/models/operations/image.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Image
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `alt` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `url` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/includecollections.md
Normal file
12
docs/models/operations/includecollections.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# IncludeCollections
|
||||
|
||||
include collections in the results
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ONE` | 1 |
|
||||
| `ZERO` | 0 |
|
||||
12
docs/models/operations/includeexternalmedia.md
Normal file
12
docs/models/operations/includeexternalmedia.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# IncludeExternalMedia
|
||||
|
||||
include external media in the results
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ONE` | 1 |
|
||||
| `ZERO` | 0 |
|
||||
12
docs/models/operations/libtype.md
Normal file
12
docs/models/operations/libtype.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Libtype
|
||||
|
||||
The type of library to filter. Can be "movie" or "show", or all if not present.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `MOVIE` | movie |
|
||||
| `SHOW` | show |
|
||||
@@ -11,7 +11,7 @@
|
||||
| `country` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States |
|
||||
| `city` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Austin |
|
||||
| `time_zone` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | America/Chicago |
|
||||
| `postal_code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 78732 |
|
||||
| `postal_code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 78732 |
|
||||
| `in_privacy_restricted_country` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `subdivisions` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Texas |
|
||||
| `coordinates` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 30.3768 -97.8935 |
|
||||
@@ -3,37 +3,40 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `rating_key` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 59398 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Marvel Studios |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 4.7 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.3 |
|
||||
| `year` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2023 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
||||
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `originally_available_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
||||
| `added_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681803215 |
|
||||
| `updated_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681888010 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
||||
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
||||
| `media` | T::Array<[::OpenApiSDK::Operations::Media](../../models/operations/media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | T::Array<[::OpenApiSDK::Operations::Genre](../../models/operations/genre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | T::Array<[::OpenApiSDK::Operations::Director](../../models/operations/director.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | T::Array<[::OpenApiSDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::OpenApiSDK::Operations::Country](../../models/operations/country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::OpenApiSDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `added_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `public_pages_url` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `user_state` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A |
|
||||
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `image` | T::Array<[::OpenApiSDK::Operations::Image](../../models/operations/image.md)> | :heavy_minus_sign: | N/A |
|
||||
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
||||
| `expires_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `imdb_rating_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A |
|
||||
| `is_continuing_series` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||
| `availability_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `streaming_media_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `playable_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
Reference in New Issue
Block a user