LukeParke/plexruby
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexruby.git synced 2025-12-09 20:57:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.399.2

Browse Source
This commit is contained in:
speakeasybot
2024-09-19 00:10:03 +00:00
parent d840c663e4
commit 4b6c8310d2
47 changed files with 621 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/models/operations/geodata.md
View File

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 |
| `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

2
docs/models/operations/getgeodatageodata.md
View File

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 |
| `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

6
docs/models/operations/getpinauthpincontainer.md
View File

@@ -9,13 +9,13 @@ Requests a new pin id used in the authentication flow
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *::String* | :heavy_check_mark: | N/A | 0 |
| `product` | *::String* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | |
| `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [::PlexRubySDK::Operations::GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `auth_token` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |
| `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |

7
docs/models/operations/getpinrequest.md
View File

@@ -6,5 +6,8 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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/> | gcgzw5rz2xovp84b4vha3a40 |
| `x_plex_product` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `client_id` | *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/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome |

2
docs/models/operations/getserverresourcesrequest.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_id` | *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/> | gcgzw5rz2xovp84b4vha3a40 |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

6
docs/models/operations/gettokenbypinidauthpincontainer.md
View File

@@ -9,13 +9,13 @@ The Pin with a non-null authToken when it has been verified by the user
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *::String* | :heavy_check_mark: | N/A | 0 |
| `product` | *::String* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | |
| `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [::PlexRubySDK::Operations::GetTokenByPinIdGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `auth_token` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |
| `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |

2
docs/models/operations/gettokenbypinidgeodata.md
View File

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 |
| `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

2
docs/models/operations/gettokenbypinidrequest.md
View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `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/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_id` | *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/> | gcgzw5rz2xovp84b4vha3a40 |

2
docs/models/operations/postuserssignindatarequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_id` | *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/> | gcgzw5rz2xovp84b4vha3a40 |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |