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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5

Browse Source
This commit is contained in:
speakeasybot
2024-09-28 00:09:32 +00:00
parent 40e6afeb04
commit c21edf4600
116 changed files with 252 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/models/operations/connections.md
View File

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `protocol` | [::PlexRubySDK::Operations::Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
| `address` | *::String* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
| `port` | *::Integer* | :heavy_check_mark: | The port used for the connection |
| `uri` | *::String* | :heavy_check_mark: | The full URI of the connection |
| `local` | *T::Boolean* | :heavy_check_mark: | If the connection is local address |
| `relay` | *T::Boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct |
| `i_pv6` | *T::Boolean* | :heavy_check_mark: | If the connection is using IPv6 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `protocol` | [::PlexRubySDK::Operations::Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
| `address` | *::String* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
| `port` | *::Integer* | :heavy_check_mark: | The port used for the connection | |
| `uri` | *::String* | :heavy_check_mark: | The full URI of the connection | |
| `local` | *T::Boolean* | :heavy_check_mark: | If the connection is local address | |
| `relay` | *T::Boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
| `i_pv6` | *T::Boolean* | :heavy_check_mark: | If the connection is using IPv6 | |

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

@@ -3,6 +3,11 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `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/gettokendetailsuserplexaccount.md
View File

@@ -29,7 +29,7 @@ Logged in user details
| `joined_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *::String* | :heavy_check_mark: | The account locale | |
| `mailing_list_active` | *T::Boolean* | :heavy_check_mark: | If you are subscribed to the Plex newsletter | |
| `mailing_list_status` | [::PlexRubySDK::Operations::MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `mailing_list_status` | [::PlexRubySDK::Operations::MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *::Integer* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [::PlexRubySDK::Operations::UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |

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

@@ -1,6 +1,6 @@
# MailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

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

@@ -1,6 +1,6 @@
# PostUsersSignInDataMailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

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

@@ -29,7 +29,7 @@ Returns the user account data with a valid auth token
| `joined_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *::String* | :heavy_check_mark: | The account locale | |
| `mailing_list_active` | *T::Boolean* | :heavy_check_mark: | If you are subscribed to the Plex newsletter | |
| `mailing_list_status` | [::PlexRubySDK::Operations::PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `mailing_list_status` | [::PlexRubySDK::Operations::PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *::Integer* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [::PlexRubySDK::Operations::PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |